Overview

This document provides an overview of APIs and SDK code samples related to simple operations, multipart operations, and advanced APIs.

Simple operations

Multipart upload operations

Simple Operations

Querying an object list

API description

This API is used to query some or all objects in a bucket.

Method prototype

java
public ObjectListing listObjects(ListObjectsRequest listObjectsRequest) throws CosClientException, CosServiceException;

Sample request

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
ListObjectsRequest listObjectsRequest = new ListObjectsRequest();
// Set the bucket name.
listObjectsRequest.setBucketName(bucketName);
// The prefix indicates that the key of the object to be listed must start with this value
listObjectsRequest.setPrefix("images/");
// Set the delimiter to "/" to list objects in the current directory. To list all objects, leave it empty.
listObjectsRequest.setDelimiter("/");
// Set the maximum number of traversed objects (up to 1,000 per listobject request).
listObjectsRequest.setMaxKeys(1000);
ObjectListing objectListing = null;
do {
   try {
       objectListing = cosClient.listObjects(listObjectsRequest);
   } catch (CosServiceException e) {
       e.printStackTrace();
       return;
   } catch (CosClientException e) {
       e.printStackTrace();
       return;
   }
   // A common prefix indicates paths that end with the delimiter. If the delimiter is set to "/", the common prefix indicates the paths of all subdirectories.
   List<String> commonPrefixs = objectListing.getCommonPrefixes();
    // The object summary shows all listed objects.
   List<COSObjectSummary> cosObjectSummaries = objectListing.getObjectSummaries();
   for (COSObjectSummary cosObjectSummary : cosObjectSummaries) {
       // File path key
       String key = cosObjectSummary.getKey();
       // File ETag
       String etag = cosObjectSummary.getETag();
       // File size
       long fileSize = cosObjectSummary.getSize();
       // File storage class
       String storageClasses = cosObjectSummary.getStorageClass();
   }
    String nextMarker = objectListing.getNextMarker();
   listObjectsRequest.setMarker(nextMarker);
} while (objectListing.isTruncated());

Parameter description

Request members:

Response description

• Success: returns ObjectListing, including all members and nextMarker.
• Failure: throws a "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Querying object metadata

API description

This API is used to query whether a specified object exists in a certain bucket.

Method prototype

java
public ObjectMetadata getObjectMetadata(String bucketName, String key)
          throws CosClientException, CosServiceException;

Sample request

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
ObjectMetadata objectMetadata = cosClient.getObjectMetadata(bucketName, key);

Parameter description

Response description

• Success: returns ObjectMetadata, including the user-defined headers and object metadata such as the ETag.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Response parameters

The ObjectMetadata class is used to record the metadata of an object. The main members are described as follows:

Uploading an object (creating a directory)

API description

This API (PUT Object) is used to upload objects to the specified bucket. It can upload a local file or an input stream of a known length to COS. It is suitable for uploading small image files (below 20 MB), with a maximum of 5 GB (inclusive) supported. Please use Multipart Upload or Advanced API if the file is larger than 5 GB.

• The file length and MD5 hash are checked by default during upload (see the sample code for disabling MD5 check).
• If an object with the same key already exists in COS, it will be overwritten by the newly-uploaded one.
• Once uploaded, you can download the file by calling the GetObject API with the same key, or by generating a pre-signed URL and sending the file to another device for download (Please specify GET as the download method; see the section below for API instructions.)
• COS uses slashes (/) to separate object paths to simulate the effect of directories. Therefore, you can upload an empty stream and append a slash to its name to create an empty directory in COS.
  You can also upload an object whose name is separated with slashes. In this way, the directory that contains this object will be created automatically. If you need to upload new objects to this COS directory, you can set the prefix of the key to this directory.

Method prototype

java
// Method 1. Upload a local file to COS.
public PutObjectResult putObject(String bucketName, String key, File file)
          throws CosClientException, CosServiceException;
// Method 2. Upload an input stream to COS.
public PutObjectResult putObject(String bucketName, String key, InputStream input, ObjectMetadata metadata)
          throws CosClientException, CosServiceException;
// Method 3. Encapsulate the two methods above to support more fine-grained parameter control, such as content-type and content-disposition.
public PutObjectResult putObject(PutObjectRequest putObjectRequest)
          throws CosClientException, CosServiceException;

Sample 1. Uploading a file

// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";

File localFile = new File(localFilePath);
String key = "exampleobject";
PutObjectResult putObjectResult = cosClient.putObject(bucketName, key, localFile);
String etag = putObjectResult.getETag();  // Obtain the file ETag.

Sample 2. Uploading an object to a COS directory

// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";

File localFile = new File(localFilePath);
// In COS, a directory is a prefix that ends with a slash (/).
String dir = "exampledir/";
String filename = "exampleobject";

String key = dir+filename;
PutObjectResult putObjectResult = cosClient.putObject(bucketName, key, localFile);
String etag = putObjectResult.getETag();  // Obtain the file ETag.

Sample 3. Uploading using a stream (the stream length should be set. Otherwise, OOM error may occur)

// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";

FileInputStream fileInputStream = new FileInputStream(localFile);
ObjectMetadata objectMetadata = new ObjectMetadata();
// Set the length of the input stream to 500.
objectMetadata.setContentLength(500);
// Set the content type. Default: application/octet-stream
objectMetadata.setContentType("application/pdf");
PutObjectResult putObjectResult = cosClient.putObject(bucketName, key, fileInputStream, objectMetadata);
String etag = putObjectResult.getETag();
// Close the input stream.

Sample 4. Creating a directory (uploading an empty-stream object)

// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";

// Set the name of the directory, which must end with a slash (/).
String key = "cos_dir/";
// Create a stream whose size is 0.
InputStream emptyContent = new ByteArrayInputStream(new byte[0]);
ObjectMetadata metadata = new ObjectMetadata();
metadata.setContentLength(0);
PutObjectResult putObjectResult = cosClient.putObject(bucketName, key, emptyContent, objectMetadata);
String etag = putObjectResult.getETag();
// Close the input stream.

Sample 5. More refined control

// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";

// 1 storage-class. Enumerated values are `Standard` (default), `Standard_IA`, and `Archive`. For more information, please see: https://intl.cloud.tencent.com/document/product/436/30925
// 2. content-type. For local file upload, the files are mapped based on the suffix by default. For example, a JPG file is mapped as image/jpeg.
// For input stream upload, the default is application/octet-stream.
// 3 To disable MD5 upload verification globally, set the system environment variable. This will affect all upload verification. Verification is performed by default.
// Disable M5 verification: System.setProperty(SkipMd5CheckStrategy.DISABLE_PUT_OBJECT_MD5_VALIDATION_PROPERTY, "true");
// Enable M5 verification: System.setProperty(SkipMd5CheckStrategy.DISABLE_PUT_OBJECT_MD5_VALIDATION_PROPERTY, null);
File localFile = new File(localFilePath);
String key = "picture.jpg";
PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, localFile);
// Set the storage class to STANDARD_IA.
putObjectRequest.setStorageClass(StorageClass.Standard_IA);
// Set custom attributes (such as content-type, content-disposition).
objectMetadata = new ObjectMetadata();
// Here, set the upload bandwidth limit (in bit/s) to 10 MB/s.
putObjectRequest.setTrafficLimit(80*1024*1024);
// Set the content type. Default: application/octet-stream
objectMetadata.setContentType("image/jpeg");
putObjectRequest.setMetadata(objectMetadata);
PutObjectResult putObjectResult = cosClient.putObject(putObjectRequest);
// Get Etag of the object
String etag = putObjectResult.getETag();
// Get CRC64 value of the object
String crc64Ecma = putObjectResult.getCrc64Ecma();

Parameter description

Request members:

The ObjectMetadata class is used to record the metadata of an object. The main members are described below:

Response description

• Success: returns PutObjectResult, including the file ETag.
• Failure: an error (such as authentication failure) occurs, with a CosClientException or CosServiceException thrown. For details, see Troubleshooting.

Response parameters

The PutObjectResult class is used to return result information. Its main members are described as follows:

Downloading an object

API description

This API is used to download an object.

Method prototype

java
// Method 1. Download a file and get the input stream.
public COSObject getObject(GetObjectRequest getObjectRequest)
          throws CosClientException, CosServiceException;
// Method 2. Download the file locally.
public ObjectMetadata getObject(GetObjectRequest getObjectRequest, File destinationFile)
          throws CosClientException, CosServiceException;

Sample 1. Obtaining the input stream

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
// Here, set the download bandwidth limit in bit/s to 10 MB/s
getObjectRequest.setTrafficLimit(80*1024*1024);
COSObject cosObject = cosClient.getObject(getObjectRequest);
COSObjectInputStream cosObjectInput = cosObject.getObjectContent();
// Download the CRC64 value of the object.
String crc64Ecma = cosObject.getObjectMetadata().getCrc64Ecma();
// Close the input stream.
cosObjectInput.close();
// Method 2. Download the file locally.
String outputFilePath = "exampleobject";
File downFile = new File(outputFilePath);
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
ObjectMetadata downObjectMeta = cosClient.getObject(getObjectRequest, downFile);

Sample 2. Downloading the object

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
String outputFilePath = "exampleobject";
File downFile = new File(outputFilePath);
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
ObjectMetadata downObjectMeta = cosClient.getObject(getObjectRequest, downFile);

Parameter description

Request members:

Response description

• Method 1 (Get the input stream of the downloaded file)
  • Success: returns the COSObject class, including the input stream and object attributes.
  • Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.
• Method 2 (Download the file locally)
  • Success: returns objectMetadata, including the file's custom headers, content-type, and other attributes.
  • Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Response parameters

The COSObject class is used to return request results. Its main members as described as follows:

Copying an object

API description

This API (Put Object Cop) is used to copy an object. You can copy an object up to 5 GB in size across regions, accounts, and buckets, provided that you have read permission for the source file and write permission for the destination file. To copy files larger than 5 GB, use the advanced replication API.

Method prototype

java
public CopyObjectResult copyObject(CopyObjectRequest copyObjectRequest)
          throws CosClientException, CosServiceException

Sample request

java
// Intra-region and intra-account replication
// Enter the bucket name in the format: BucketName-APPID
String srcBucketName = "sourcebucket-1250000000";
// The source file to be copied
String srcKey = "sourceObject";
// Enter the destination bucket name in the format of BucketName-APPID.
String destBucketName = "examplebucket-1250000000";
// The destination file to be copied into
String destKey = "exampleobject";
CopyObjectRequest copyObjectRequest = new CopyObjectRequest(srcBucketName, srcKey, destBucketName, destKey);
CopyObjectResult copyObjectResult = cosClient.copyObject(copyObjectRequest);
// Cross-account and cross-region replication (read permission for the source file and write permission for the destination file are required)
String srcBucketNameOfDiffAppid = "bucket-own-by-others-1251668577";
Region srcBucketRegion = new Region("ap-shanghai");
CopyObjectRequest copyObjectRequest = new CopyObjectRequest(srcBucketRegion, srcBucketNameOfDiffAppid, srcKey, destBucketName, destKey);
CopyObjectResult copyObjectResult = cosClient.copyObject(copyObjectRequest);
// Get the CRC64 value of the object
String crc64Ecma = copyObjectResult.getCrc64Ecma();

Parameter description

Request members:

Response description

• Success: returns CopyObjectResult, including the ETag and other information on the new file.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Deleting an object

API description

This API is used to delete a specified object (file/object) from a bucket.

Method prototype

java
public void deleteObject(String bucketName, String key)
          throws CosClientException, CosServiceException;

Sample request

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
cosClient.deleteObject(bucketName, key);

Parameter description

Response description

• Success: No value is returned.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Delete objects in batch

API description

The API (DELETE Multiple Objects) is used to delete multiple objects.

Method prototype

java
public DeleteObjectsResult deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
  throws MultiObjectDeleteException, CosClientException, CosServiceException;

Sample request

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
DeleteObjectsRequest deleteObjectsRequest = new DeleteObjectsRequest(bucketName);
// Set the list of keys to be deleted. A maximum of 1,000 keys can be deleted at a time.
ArrayList<DeleteObjectsRequest.KeyVersion> keyList = new ArrayList<DeleteObjectsRequest.KeyVersion>();
// Pass the names of files to be deleted.
keyList.add(new DeleteObjectsRequest.KeyVersion("project/folder1/picture.jpg"));
keyList.add(new DeleteObjectsRequest.KeyVersion("project/folder2/text.txt"));
keyList.add(new DeleteObjectsRequest.KeyVersion("project/folder2/music.mp3"));
deleteObjectsRequest.setKeys(keyList);
// Delete multiple files in a single request.
try {
   DeleteObjectsResult deleteObjectsResult = cosClient.deleteObjects(deleteObjectsRequest);
   List<DeleteObjectsResult.DeletedObject> deleteObjectResultArray = deleteObjectsResult.getDeletedObjects();
} catch (MultiObjectDeleteException mde) { // If not all the objects are deleted successfully, MultiObjectDeleteException is returned
   List<DeleteObjectsResult.DeletedObject> deleteObjects = mde.getDeletedObjects();
   List<MultiObjectDeleteException.DeleteError> deleteErrors = mde.getErrors();
} catch (CosServiceException e) { // Throws a CosServiceException for other errors such as parameter errors and authentication failure
   e.printStackTrace();
   throw e;
} catch (CosClientException e) { // Throws this exception for client errors, such as COS connection failure
   e.printStackTrace();
   throw e;
}

Parameter description

Request members:

DeleteObjectsRequest.KeyVersion members are described as follows:

Response description

• Success: no value is returned.
• Failure: an error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Restoring an archived object

API description

This (POST Object restore) API is used to restore an archived object for access.

Method prototype

java
public void restoreObject(RestoreObjectRequest restoreObjectRequest)
  throws CosClientException, CosServiceException;

Sample request

java
// Enter the bucket name in the format of BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
// Sets the number of days before a restored temporary copy expires to 1
RestoreObjectRequest restoreObjectRequest = new RestoreObjectRequest(bucketName, key, 1);
// Set the restoration mode to “Standard”. You can set it to “Standard”, “Expedited”, or “Bulk” if the object’s storage class is ARCHIVE. For DEEP ARCHIVE, you can set it to “Standard” or “Bulk”. Each restoration mode offers different restoration speeds and costs differently.
CASJobParameters casJobParameters = new CASJobParameters();
casJobParameters.setTier(Tier.Standard);
restoreObjectRequest.setCASJobParameters(casJobParameters);
cosClient.restoreObject(restoreObjectRequest);

Parameter description

Request members:

Response description

• Success: no value is returned.
• Failure: an error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Multipart Operations

Operations related to multipart uploads are as follows:

• Multipart upload: initializing a multipart upload operation, uploading parts, and completing a multipart upload operation
• Resuming a multipart upload operation: querying uploaded parts, uploading remaining parts, and completing a multipart upload operation
• Deleting uploaded parts.

Querying a multipart upload

API description

This API is used to query in-progress multipart uploads in a specified bucket.

Method prototype

java
public MultipartUploadListing listMultipartUploads(
          ListMultipartUploadsRequest listMultipartUploadsRequest)
          throws CosClientException, CosServiceException

Sample request

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
ListMultipartUploadsRequest listMultipartUploadsRequest = new ListMultipartUploadsRequest(bucketName);
listMultipartUploadsRequest.setDelimiter("/");
listMultipartUploadsRequest.setMaxUploads(100);
listMultipartUploadsRequest.setPrefix("");
listMultipartUploadsRequest.setEncodingType("url");
MultipartUploadListing multipartUploadListing = cosClient.listMultipartUploads(listMultipartUploadsRequest);

Parameter description

Request members:

Response description

• Success: returns MultipartUploadListing, including the in-progress multipart uploads.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Initializing a multipart upload

API description

This API (Initiate Multipart Upload) is used to initialize a multipart upload.

Method prototype

java
public InitiateMultipartUploadResult initiateMultipartUpload(
  InitiateMultipartUploadRequest request) throws CosClientException, CosServiceException;

Sample request

java
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
InitiateMultipartUploadRequest initRequest = new InitiateMultipartUploadRequest(bucketName, key);
InitiateMultipartUploadResult initResponse = cosClient.initiateMultipartUpload(initRequest);
uploadId = initResponse.getUploadId();

Parameter description

Request member description:

Response description

• Success: returns InitiateMultipartUploadResult, including the uploadId that identifies the multipart upload.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Uploading a part

This API (Upload Part) is used to upload parts in a multipart upload.

Method prototype

java
public UploadPartResult uploadPart(UploadPartRequest uploadPartRequest) throws CosClientException, CosServiceException;

Sample request

java
// Up to 10,000 parts can be uploaded, ranging from 1 MB to 5 GB in size.
// Set the size of each part to 4 MB. If there are a total of n parts, the size of part 1 through part n-1 is the same, while the last part is less than or equal to it.
List<PartETag> partETags = new ArrayList<PartETag>();
int partNumber = 1;
int partSize = 4 * 1024 * 1024;
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
byte data[] = new byte[partSize];
ByteArrayInputStream partStream = new ByteArrayInputStream(data);
// partStream represents the input stream of the part data. The length of the input stream is the partSize.
UploadPartRequest uploadRequest = new UploadPartRequest().withBucketName(bucketName).
       withUploadId(uploadId).withKey(key).withPartNumber(partNumber).
       withInputStream(partStream).withPartSize(partSize);
UploadPartResult uploadPartResult = cosClient.uploadPart(uploadRequest);
// Get the ETag of the part.
String etag = uploadPartResult.getETag();
// Get the CRC64 value of the part.
String crc64Ecma = uploadPartResult.getCrc64Ecma();
partETags.add(new PartETag(partNumber, eTag));  // partETags records the ETags of all the uploaded parts.
// ... Upload parts with the partNumber of 2 to n

Parameter description

Request member description:

Response description

• Success: returns UploadPartResult, including the ETags of the uploaded parts.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Response parameters

The UploadPartResult class is used to return request results. Its main members are described as follows:

Copying a part

API description

This API (Upload Part - Copy) is used to copy an object as a part from a source path to a destination path.

Method prototype

java
public CopyPartResult copyPart(CopyPartRequest copyPartRequest) throws CosClientException, CosServiceException

Sample request

java
// Bucket name in the format of BucketName-APPID
// Set destination bucket name, object name, and multipart upload ID.
String destinationBucketName = "examplebucket-1250000000";
String destinationTargetKey = "exampleobject";
int partNumber = 1;
CopyPartRequest copyPartRequest = new CopyPartRequest();
copyPartRequest.setDestinationBucketName(destinationBucketName);
copyPartRequest.setDestinationKey(destinationTargetKey);
copyPartRequest.setUploadId(uploadId);
copyPartRequest.setPartNumber(partNumber);
// Set the region and name of the source bucket, object name, and offset range.
String sourceBucketRegion = "COS_REGION";
String sourceBucketName = "sourcebucket-1250000000";
String sourceKey = "sourceObject";
Long firstByte = 1L;
Long lastByte = 1048576L;
copyPartRequest.setSourceBucketRegion(new Region(sourceBucketRegion));
copyPartRequest.setSourceBucketName(sourceBucketName);
copyPartRequest.setSourceKey(sourceKey);
copyPartRequest.setFirstByte(firstByte);
copyPartRequest.setLastByte(lastByte);
CopyPartResult copyPartResult = cosClient.copyPart(copyPartRequest);
List<PartETag> partETags = new ArrayList<PartETag>();
partETags.add(copyPartResult.getPartETag());

Parameter description

Request member description:

Response description

• Success: returns CopyPartResult, including the ETag of the part.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Querying uploaded parts

API description

This API (List Parts) is used to query the uploaded parts of a multipart upload.

Method prototype

java
public PartListing listParts(ListPartsRequest request)
          throws CosClientException, CosServiceException;

Sample request

java
// ListPart is used to list uploaded parts using the uploadId before a multipart upload is completed or aborted, and also to construct partEtags.
List<PartETag> partETags = new ArrayList<PartETag>();
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
ListPartsRequest listPartsRequest = new ListPartsRequest(bucketName, key, uploadId);
PartListing partListing = null;
do {
   partListing = cosClient.listParts(listPartsRequest);
   for (PartSummary partSummary : partListing.getParts()) {
       partETags.add(new PartETag(partSummary.getPartNumber(), partSummary.getETag()));
   }
   listPartsRequest.setPartNumberMarker(partListing.getNextPartNumberMarker());
} while (partListing.isTruncated());

Parameter description

Response description

• Success: returns PartListing, including the ETag and number of each part as well as the starting marker of the next list.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Completing a multipart upload

API description

This API (Complete Multipart Upload) is used to complete the multipart upload of the entire file.

Method prototype

java
public CompleteMultipartUploadResult completeMultipartUpload(CompleteMultipartUploadRequest request) throws CosClientException, CosServiceException;

Sample request

java
// Complete a multipart upload.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
CompleteMultipartUploadRequest compRequest = new CompleteMultipartUploadRequest(bucketName, key, uploadId, partETags);
CompleteMultipartUploadResult result = cosClient.completeMultipartUpload(compRequest);

Parameter description

Response description

• Success: returns CompleteMultipartUploadResult, including the ETag of the completed object.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Aborting a multipart upload

API description

This API is used to abort a multipart upload and delete the uploaded parts.

Method prototype

java
public void abortMultipartUpload(AbortMultipartUploadRequest request)  throws CosClientException, CosServiceException;

Sample request

java
// abortMultipartUpload is used to abort an uncompleted multipart upload
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
AbortMultipartUploadRequest abortMultipartUploadRequest = new AbortMultipartUploadRequest(bucketName, key, uploadId);
cosClient.abortMultipartUpload(abortMultipartUploadRequest);

Parameter description

Response description

• Success: No value is returned.
• Failure: An error occurs (such as authentication failure), throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Advanced APIs (Recommended)

The advanced APIs encapsulate upload and download APIs using the TransferManger class. They have a thread pool to receive upload and download requests, so that you can choose to submit tasks asynchronously.

// We recommend setting the size of your thread pool to 16 or 32 to maximize network resource utilization, provided your client and COS networks are sufficient (for example, by using Tencent Cloud CVM and uploading to COS in the same region).
// We recommend using a smaller value to avoid timeout due to slow network speed if you are transferring data over a public network with poor bandwidth quality.
ExecutorService threadPool = Executors.newFixedThreadPool(32);
// Pass a threadpool. Otherwise, a single-thread pool will be generated in TransferManager by default.
TransferManager transferManager = new TransferManager(cosClient, threadPool);
// Set the threshold and part size for multipart upload through the advanced upload API to 10 MB.
TransferManagerConfiguration transferManagerConfiguration = new TransferManagerConfiguration();
transferManagerConfiguration.setMultipartUploadThreshold(10 * 1024 * 1024);
transferManagerConfiguration.setMinimumUploadPartSize(10 * 1024 * 1024);
transferManager.setConfiguration(transferManagerConfiguration);

Close transferManager manually after use to prevent resource leakage.

java
// Close TransferManger.
transferManager.shutdownNow();

Parameter description

The TransferManagerConfiguration class is used to record the configuration of advanced APIs. Its main members are described as follows:

Uploading an object (querying the progress)

API description

This advanced version of the PUT Object API automatically determines whether to use simple or multipart upload based on the length and data type of your file, as shown below:

• Simple upload (for streams) will be used if the object size is below the multipart upload threshold or the Content-Length header is not carried.
• Multipart upload (for streams) will be used if the object size is above the multipart upload threshold and the Content-Length header is not carried.
• Determines multipart upload with concurrent threads for files with File as the data type.
• Advanced APIs support calling the getProgress() method to obtain the multipart upload progress.

Note：

For more information about other attributes, storage classes, and MD5 checksum, please see PUT Object API.

Method prototype

java
// Upload an object
public Upload upload(final PutObjectRequest putObjectRequest)
          throws CosServiceException, CosClientException;

Sample 1. Uploading with advanced APIs

java
// Enter the bucket name in the format of BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
File localFile = new File(localFilePath);
PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, localFile);
// Upload a local file.
Upload upload = transferManager.upload(putObjectRequest);
// Wait for the upload to finish (call waitForCompletion if you want to wait synchronously for the upload to complete).
UploadResult uploadResult = upload.waitForUploadResult();

Sample 2. Uploading with advanced APIs and querying the upload progress

java
// Write the callback function to print the upload progress.
void showTransferProgress(Transfer transfer) {
   System.out.println(transfer.getDescription());
   do {
       try {
           Thread.sleep(2000);
       } catch (InterruptedException e) {
           return;
       }
       TransferProgress progress = transfer.getProgress();
       long so_far = progress.getBytesTransferred();
       long total = progress.getTotalBytesToTransfer();
       double pct = progress.getPercentTransferred();
       System.out.printf("[%d / %d] = %.02f%%\n", so_far, total, pct);
   } while (transfer.isDone() == false);
   System.out.println(transfer.getState());
}
// Enter the bucket name in the format: BucketName-APPID
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
File localFile = new File(localFilePath);
PutObjectRequest putObjectRequest = new PutObjectRequest(bucketName, key, localFile);
// Upload a local file.
Upload upload = transferManager.upload(putObjectRequest);
// Print the upload progress synchronously.
showTransferProgress(upload);
// Wait for the upload to finish (call waitForCompletion if you want to wait synchronously for the upload to complete).
UploadResult uploadResult = upload.waitForUploadResult();

Parameter description

Request members:

Note：

When a file is uploaded in concurrent parts, trafficLimit is the limit on the upload speed of each part. In this case, you need to adjust the number of threads in your thread pool to control the upload speed.

Returned values

• Success: returns Upload. You can query whether the upload is complete, or wait until the upload is finished.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Response parameters

The UploadResult class records the object upload results requested by calling the waitForUploadResult() method from the Upload class. Its main class members are as follows:

Description of progress obtaining

You can use the getProgress() method of the Upload class to obtain the TransferProgress class, which has the following three methods to obtain the upload progress:

Downloading an object (checkpoint restart)

API description

This API is used to download a COS object.

Method prototype

java
// Download an object.
public Download download(final GetObjectRequest getObjectRequest, final File file);
// Use checkpoint restart to download the object.
public Download download(final GetObjectRequest getObjectRequest, final File file,
      boolean resumableDownload, String resumableTaskFile,
      int multiThreadThreshold, int partSize);

Sample 1. Download an object with advanced APIs

java
// Enter the bucket name in the format of BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
File localDownFile = new File(localFilePath);
GetObjectRequest getObjectRequest = new GetObjectRequest(bucketName, key);
// Here, set the download bandwidth limit in bit/s to 10 MB/s
getObjectRequest.setTrafficLimit(80*1024*1024);
// Download a file.
Download download = transferManager.download(getObjectRequest, localDownFile);
// Wait for the upload to finish (call waitForCompletion if you want to wait synchronously for the upload to complete).
download.waitForCompletion();

Sample 2. Using advanced APIs to download an object with checkpoint restart

java
// Write the callback function to print the download progress.
void showTransferProgress(Transfer transfer) {
  System.out.println(transfer.getDescription());
  do {
      try {
          Thread.sleep(2000);
      } catch (InterruptedException e) {
          return;
      }
      TransferProgress progress = transfer.getProgress();
      long so_far = progress.getBytesTransferred();
      long total = progress.getTotalBytesToTransfer();
      double pct = progress.getPercentTransferred();
      System.out.printf("[%d / %d] = %.02f%%\n", so_far, total, pct);
  } while (transfer.isDone() == false);
  System.out.println(transfer.getState());
}
// Enter the bucket name in the format of BucketName-APPID.
String bucketName = "examplebucket-1250000000";
String key = "exampleobject";
File localDownFile = new File(localFilePath);
GetObjectRequest getObj = new GetObjectRequest(bucketName, key);
Download download = transferManager.download(getObj, localDownFile, true);
showTransferProgress(download);
try {
  download.waitForCompletion();
} catch (CosServiceException e) {
  e.printStackTrace();
} catch (CosClientException e) {
  e.printStackTrace();
} catch (InterruptedException e) {
  e.printStackTrace();
}
transferManager.shutdownNow();
cosclient.shutdown();

Parameter description

Request members:

Returned values

• Success: returns Download. You can query whether the download is complete, or wait until the download is finished.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Copying an object

API description

This advanced replication API automatically determines whether to use simple replication or multipart replication based on the size of an object.

Method prototype

java
// Upload an object
public Copy copy(final CopyObjectRequest copyObjectRequest);

Sample 1. Intra-region replication

Note：

Intra-region replication refers to replicating objects to a bucket that resides in the same region.

java
String secretId = "COS_SECRETID";
String secretKey = "COS_SECRETKEY";
// Region of the source bucket
COSCredentials credentials = new BasicCOSCredentials(secretId, secretKey);
Region bucketRegion = new Region("COS_REGION");
// Enter the bucket name in the format of BucketName-APPID.
String srcBucketName = "sourcebucket-1250000000";
// The source file to copy
String srcKey = "sourceObject";
// Enter the destination bucket name in the format of BucketName-APPID.
String destBucketName = "examplebucket-1250000000";
// Destination file
String destKey = "exampleobject";
COSClient cosClient = new COSClient(credentials, new ClientConfig(bucketRegion));
ExecutorService threadPool = Executors.newFixedThreadPool(5);
// Pass a threadpool. Otherwise, a single-thread pool will be generated in TransferManager by default.
TransferManager transferManager = new TransferManager(cosClient, threadPool);
CopyObjectRequest copyObjectRequest = new CopyObjectRequest(bucketRegion, srcBucketName,
       srcKey, destBucketName, destKey);
try {
   Copy copy = transferManager.copy(copyObjectRequest);
   // Returns an asynchronous result "copy". You can call waitForCopyResult to wait synchronously for the replication to end. If successful, CopyResult is returned; otherwise, an exception will be thrown.
   CopyResult copyResult = copy.waitForCopyResult();
   // Get the CRC64 value of the replicated object.
   String crc64Ecma = copyResult.getCrc64Ecma();
} catch (CosServiceException e) {
   e.printStackTrace();
} catch (CosClientException e) {
   e.printStackTrace();
} catch (InterruptedException e) {
   e.printStackTrace();
}

Sample 2. Cross-region replication

Note：

• Cross-region replication refers to replicating objects to a bucket that resides in another region, such as copying objects from the Beijing region to the Guangzhou region.
• Copying objects from Finance Cloud regions to Public Cloud regions (and vice versa) is not supported as they are not interconnected.

java
String secretId = "COS_SECRETID";
String secretKey = "COS_SECRETKEY";
COSCredentials credentials = new BasicCOSCredentials(secretId, secretKey);
// Region of the source bucket
Region srcBucketRegion = new Region("COS_SRC_REGION");
Region destBucketRegion = new Region("COS_DEST_REGION");
// Enter the bucket name in the format of BucketName-APPID.
String srcBucketName = "sourcebucket-1250000000";
// The source file to copy
String srcKey = "sourceObject";
// Enter the destination bucket name in the format of BucketName-APPID.
String destBucketName = "examplebucket-1250000000";
// Destination file
String destKey = "exampleobject";
// transferManager uses the destination file’s cosclient.
COSClient destCOSClient = new COSClient(cred, new ClientConfig(destBucketRegion));
ExecutorService threadPool = Executors.newFixedThreadPool(5);
// Pass a threadpool. Otherwise, a single-thread pool will be generated in TransferManager by default.
TransferManager transferManager = new TransferManager(destCOSClient, threadPool);
// Generate srcCOSClient to get source file information.
COSClient srcCOSClient = new COSClient(cred, new ClientConfig(srcBucketRegion));
try {
  Copy copy = transferManager.copy(copyObjectRequest, srcCOSClient, null);
  // Return an asynchronous result "copy". You can synchronously call waitForCopyResult to wait for the replication to end. If the replication is successful, CopyResult is returned; otherwise, an exception will be thrown.
  CopyResult copyResult = copy.waitForCopyResult();
  // Get the CRC64 value of the replicated object.
  String crc64Ecma = copyResult.getCrc64Ecma();
} catch (CosServiceException e) {
  e.printStackTrace();
} catch (CosClientException e) {
  e.printStackTrace();
} catch (InterruptedException e) {
  e.printStackTrace();
}

Parameter description

Request members:

Returned values

• Success: returns Copy. You can query whether the copy is completed, or wait until the copy finishes synchronously.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Uploading multiple objects

API description

This API is used to upload all files in a folder.

Method prototype

java
public MultipleFileUpload uploadDirectory(String bucketName, String virtualDirectoryKeyPrefix,
          File directory, boolean includeSubdirectories);

Sample request

java
// Write the callback function to print the upload progress.
void showTransferProgress(Transfer transfer) {
   System.out.println(transfer.getDescription());
   do {
       try {
           Thread.sleep(2000);
       } catch (InterruptedException e) {
           return;
       }
       TransferProgress progress = transfer.getProgress();
       long so_far = progress.getBytesTransferred();
       long total = progress.getTotalBytesToTransfer();
       double pct = progress.getPercentTransferred();
       System.out.printf("[%d / %d] = %.02f%%\n", so_far, total, pct);
   } while (transfer.isDone() == false);
   System.out.println(transfer.getState());
}
// Set the prefix of the directory to upload the objects to. If this parameter is set to “”, objects will be uploaded to the root directory of the bucket.
String cos_path = "/prefix";
// Absolute path of the folder to upload
String dir_path = "/to/mydir";
// Whether to upload subdirectories in the folder recursively. If this parameter is set to “true”, objects in subdirectories will also be uploaded with the original directory structure retained.
Boolean recursive = false;
try {
   // Return an asynchronous result “Upload”. You can synchronously call waitForUploadResult to wait for the upload to end. If the upload is successful, UploadResult is returned; otherwise, an exception will be thrown.
   MultipleFileUpload upload = transferManager.uploadDirectory(bucketName, cos_path, new File(dir_path), recursive);
    // You can view the upload progress.
   showTransferProgress(upload);
    // You can also wait for the upload to complete.
   upload.waitForCompletion();
    System.out.println("upload directory done.");
} catch (CosServiceException e) {
   e.printStackTrace();
} catch (CosClientException e) {
   e.printStackTrace();
} catch (InterruptedException e) {
   e.printStackTrace();
}

Parameter description

Returned values

• Success: returns MultipleFileUpload. You can query whether the upload is complete, or wait until the upload is finished.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Downloading multiple objects

API description

This API is used to download objects that have a specified prefix.

Method prototype

java
public MultipleFileDownload downloadDirectory(String bucketName, String keyPrefix,
      File destinationDirectory) {

Sample request

java
// Write the progress callback function.
void showTransferProgress(Transfer transfer) {
   System.out.println(transfer.getDescription());
   do {
       try {
           Thread.sleep(2000);
       } catch (InterruptedException e) {
           return;
       }
       TransferProgress progress = transfer.getProgress();
       long so_far = progress.getBytesTransferred();
       long total = progress.getTotalBytesToTransfer();
       double pct = progress.getPercentTransferred();
       System.out.printf("[%d / %d] = %.02f%%\n", so_far, total, pct);
   } while (transfer.isDone() == false);
   System.out.println(transfer.getState());
}
// Set the prefix of objects to download (similar to downloading a folder in COS). If this parameter is set to “”, the entire bucket will be downloaded.
String cos_path = "/prefix";
// Absolute path of the destination folder
String dir_path = "/to/mydir";
try {
   // Return an asynchronous result “download”. You can synchronously call waitForUploadResult to wait for the download to end.
   MultipleFileDownload download = transferManager.downloadDirectory(bucketName, cos_path, new File(dir_path));
    // You can view the download progress.
   showTransferProgress(download);
    // You can also wait for the download to complete.
   download.waitForCompletion();
    System.out.println("download directory done.");
} catch (CosServiceException e) {
   e.printStackTrace();
} catch (CosClientException e) {
   e.printStackTrace();
} catch (InterruptedException e) {
   e.printStackTrace();
}
transferManager.shutdownNow();
cosclient.shutdown();

Parameter description

Returned values

• Success: returns MultipleFileUpload. You can query whether the download is complete, or wait until the download is finished.
• Failure: An error (such as authentication failure) occurs, throwing the "CosClientException" or "CosServiceException" exception. For more information, please see Troubleshooting.

Deleting a folder and the files contained

COS does not have folders, but users can use slashes (/) as the delimiter to stimulate folders.

In COS, deleting a folder and the objects contained actually means deleting objects that have the same specified prefix. Currently, COS’s Java SDK does not provide a standalone API to perform this operation. However, you can still do so with a combination of basic operations (query object list and batch delete objects).

Sample request

java
// For batch delete
public void delete(ArrayList<DeleteObjectsRequest.KeyVersion> keyList) {
 DeleteObjectsRequest deleteObjectsRequest = new DeleteObjectsRequest(bucketName);
 deleteObjectsRequest.setKeys(keyList);

 // Delete multiple files in a single request.
 try {
     DeleteObjectsResult deleteObjectsResult = cosClient.deleteObjects(deleteObjectsRequest);
     List<DeleteObjectsResult.DeletedObject> deleteObjectResultArray = deleteObjectsResult.getDeletedObjects();
 } catch (MultiObjectDeleteException mde) { // If not all the objects are deleted successfully, MultiObjectDeleteException is returned
     List<DeleteObjectsResult.DeletedObject> deleteObjects = mde.getDeletedObjects();
     List<MultiObjectDeleteException.DeleteError> deleteErrors = mde.getErrors();
 } catch (CosServiceException e) { // Throws a CosServiceException for other errors such as parameter errors and authentication failure
     e.printStackTrace();
     throw e;
 } catch (CosClientException e) { // Throws this exception for client errors, such as COS connection failure
     e.printStackTrace();
     throw e;
 }
}
// Enter the bucket name in the format: BucketName-APPID.
String bucketName = "examplebucket-1250000000";
ListObjectsRequest listObjectsRequest = new ListObjectsRequest();
// Set the bucket name.
listObjectsRequest.setBucketName(bucketName);
// “prefix” indicates the directory to delete.
listObjectsRequest.setPrefix("images/");
// Set the delimiter to "/" to list objects in the current directory. To list all objects, leave it empty.
listObjectsRequest.setDelimiter("/");
// Set the maximum number of traversed objects (up to 1,000 per listobject request).
listObjectsRequest.setMaxKeys(1000);
ObjectListing objectListing = null;
do {
 // Set the list of keys to be deleted. A maximum of 1,000 keys can be deleted at a time.
 ArrayList<DeleteObjectsRequest.KeyVersion> keyList = new ArrayList<DeleteObjectsRequest.KeyVersion>();
  try {
     objectListing = cosClient.listObjects(listObjectsRequest);
 } catch (CosServiceException e) {
     e.printStackTrace();
     return;
 } catch (CosClientException e) {
     e.printStackTrace();
     return;
 }
 // A common prefix indicates paths that end with the delimiter. If the delimiter is set to "/", the common prefix indicates the paths of all subdirectories.
 List<String> commonPrefixs = objectListing.getCommonPrefixes();
  // The object summary shows all listed objects.
 List<COSObjectSummary> cosObjectSummaries = objectListing.getObjectSummaries();
 for (COSObjectSummary cosObjectSummary : cosObjectSummaries) {
     // File path key
     String key = cosObjectSummary.getKey();
     keyList.add(new DeleteObjectsRequest.KeyVersion(key));
 }
  try {
     delete(keyList);
 } catch (CosServiceException e) {
     e.printStackTrace();
     return;
 } catch (CosClientException e) {
     e.printStackTrace();
     return;
 }
  String nextMarker = objectListing.getNextMarker();
 listObjectsRequest.setMarker(nextMarker);
} while (objectListing.isTruncated());

Moving an object

Since COS uses the bucket name (Bucket) and object key (ObjectKey) to identify objects, moving an object will change the object identifier. Currently, COS’s Java SDK does not provide a standalone API to change object identifiers. However, you can still move the object with a combination of basic operations (object copy and object delete).

For example, if you want to move the picture.jpg object to the “doc” path that is in the same bucket (mybucket-1250000000), you can copy the picture.jpg to doc/picture.jpg and then delete the source object.

Likewise, if you need to move picture.jpg in the mybucket-1250000000 bucket to another bucket myanothorbucket-1250000000, you can copy the object to the myanothorbucket-1250000000 bucket first and then delete the source object.

Sample request

java
// Intra-region replication. You can refer to the “copying an object” request sample.
public void copySameRegion(String srcBucket, String srcKey, String destBucket, String destKey) {
 CopyObjectRequest copyObjectRequest = new CopyObjectRequest(srcBucket, srcKey, destBucket, destKey);
 CopyObjectResult copyObjectResult = cosClient.copyObject(copyObjectRequest);
}
// Cross-region replication. You can refer to the “copying an object” request sample.
public void copyDiffRegion(String srcRegion, String srcBucket, String srcKey,
     String destRegion, String destBucket, String destKey){
 CopyObjectRequest copyObjectRequest = new CopyObjectRequest(srcBucketRegion, srcBucket, srcKey, destBucketName, destKey);
 CopyObjetResult copyObjectResult = cosClient.copyObject(copyObjectRequest);
}
// Information about the source object to move
String srcRegion = "ap-shanghai";
String srcBucket = "mybucket-1250000000";
String srcKey = "picture.jpg";
// Information about the destination object
String destRegion = "ap-shanghai";
String destBucket = "myanotherbucket-1250000000";
String destKey = "doc/picture.jpg";
// The following uses intra-region replication as an example. You can use cross-region replication as needed.
copySameRegion(srcBcuket, srcKey, destBucket, destKey);
// Information about the source object to delete after the replication
cosClient.deleteObject(srcBucket, srcKey);