This document provides an overview of APIs and SDK code samples related to listing objects.
API | Operation Name | Description |
---|---|---|
GET Bucket (List Objects) | Querying an object list | Queries some or all objects in a bucket |
GET Bucket Object Versions | Querying a list of objects and their version history | Queries some or all objects in a bucket as well as their version history |
For the parameters and method descriptions of all the APIs in the SDK, please see SDK API Reference.
This API is used to query some or all objects in a bucket.
try
{
string bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketRequest request = new GetBucketRequest(bucket);
// Execute the request
GetBucketResult result = cosXml.GetBucket(request);
// Bucket information
ListBucket info = result.listBucket;
if (info.isTruncated) {
// Record the marker for the next page of truncated listing
this.nextMarker = info.nextMarker;
}
}
catch (COSXML.CosException.CosClientException clientEx)
{
// Request failed
Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
// Request failed
Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}
Note:
For the complete sample, go to GitHub.
try
{
string bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketRequest request = new GetBucketRequest(bucket);
// Use the “nextMarker” from the previous request
request.SetMarker(this.nextMarker);
// Execute the request
GetBucketResult result = cosXml.GetBucket(request);
// Bucket information
ListBucket info = result.listBucket;
}
catch (COSXML.CosException.CosClientException clientEx)
{
// Request failed
Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
// Request failed
Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}
Note:
For the complete sample, go to GitHub.
try
{
string bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketRequest request = new GetBucketRequest(bucket);
// List objects and common prefixes under a/
request.SetPrefix("a/");
// Execute the request
GetBucketResult result = cosXml.GetBucket(request);
// Bucket information
ListBucket info = result.listBucket;
// List objects
List<ListBucket.Contents> objects = info.contentsList;
// List common prefixes
List<ListBucket.CommonPrefixes> subDirs = info.commonPrefixesList;
}
catch (COSXML.CosException.CosClientException clientEx)
{
// Request failed
Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
// Request failed
Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}
Note:
For the complete sample, go to GitHub.
This API is used to query some or all objects in a versioning-enabled bucket.
try
{
string bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
ListBucketVersionsRequest request = new ListBucketVersionsRequest(bucket);
// Execute the request
ListBucketVersionsResult result = cosXml.ListBucketVersions(request);
// Bucket information
ListBucketVersions info = result.listBucketVersions;
List<ListBucketVersions.Version> objects = info.objectVersionList;
List<ListBucketVersions.CommonPrefixes> prefixes = info.commonPrefixesList;
if (info.isTruncated) {
// Record the marker for the next page of truncated listing
this.keyMarker = info.nextKeyMarker;
this.versionIdMarker = info.nextVersionIdMarker;
}
}
catch (COSXML.CosException.CosClientException clientEx)
{
// Request failed
Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
// Request failed
Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}
Note:
For the complete sample, go to GitHub.
try
{
string bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
ListBucketVersionsRequest request = new ListBucketVersionsRequest(bucket);
// Use the “nextMarker” from the previous request
request.SetKeyMarker(this.keyMarker);
request.SetVersionIdMarker(this.versionIdMarker);
// Execute the request
ListBucketVersionsResult result = cosXml.ListBucketVersions(request);
ListBucketVersions info = result.listBucketVersions;
if (info.isTruncated) {
// Record the marker for the next page of truncated listing
this.keyMarker = info.nextKeyMarker;
this.versionIdMarker = info.nextVersionIdMarker;
}
}
catch (COSXML.CosException.CosClientException clientEx)
{
// Request failed
Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
// Request failed
Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}
Note:
For the complete sample, go to GitHub.
Was this page helpful?