Overview

This document provides an overview of APIs and SDK sample codes related to uploading and replicating objects.

Simple operations

API	Operation	Description
PUT Object	Uploading an object	Uploads an object to a bucket.

Multipart operations

API	Operation	Description
List Multipart Uploads	Querying multipart uploads	Queries in-progress multipart uploads.
Initiate Multipart Upload	Initializing a multipart upload operation	Initializes a multipart upload operation.
Upload Part	Uploading parts	Uploads an object in multiple parts.
List Parts	Querying uploaded parts	Queries the uploaded parts of a multipart upload.
Complete Multipart Upload	Completing a multipart upload	Completes the multipart upload of a file.
Abort Multipart Upload	Aborting a multipart upload	Aborts a multipart upload and deletes the uploaded parts.

SDK API References

For parameters and method description of all APIs in the SDK, please see SDK API Reference.

Advanced APIs (Recommended)

Uploading an object

The advanced APIs encapsulate the simple upload and multipart upload APIs and can intelligently select the upload method based on file size. They also support checkpoint restart for resuming interrupted operations.

Sample code 1. Uploading a local file

Objective-C

QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];
/** Path of the local file. Ensure that the URL starts with "file://" in the following format:
1. [NSURL URLWithString:@"file:////var/mobile/Containers/Data/Application/DBPF7490-D5U8-4ABF-A0AF-CC49D6A60AEB/Documents/exampleobject"]
2. [NSURL fileURLWithPath:@"/var/mobile/Containers/Data/Application/DBPF7490-D5U8-4ABF-A0AF-CC49D6A60AEB/Documents/exampleobject"]
*/
NSURL* url = [NSURL fileURLWithPath:@"file URL"];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = @"examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
put.object = @"exampleobject";
// Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
put.body =  url;
// Monitor the upload progress
[put setSendProcessBlock:^(int64_t bytesSent,
                          int64_t totalBytesSent,
                          int64_t totalBytesExpectedToSend) {
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
}];
// Monitor the upload result
[put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
   // Obtain the download link of the file uploaded using result.location
   NSString * fileUrl = result.location;
   // Obtain the CRC64 value of the object.
   NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
}];
[put setInitMultipleUploadFinishBlock:^(QCloudInitiateMultipartUploadResult *
                                       multipleUploadInitResult,
                                       QCloudCOSXMLUploadObjectResumeData resumeData) {
   // This block will be called back after the Initiate Multipart Upload operation is complete so you can get resumeData and the uploadId.
   NSString* uploadId = multipleUploadInitResult.uploadId;
}];
[[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Swift

let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
put.object = "exampleobject";
// Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
put.body = NSURL.fileURL(withPath: "Local File Path") as AnyObject;
// Monitor the upload result
put.setFinish { (result, error) in
   // Get the upload result
   if let result = result {
       // ETag of the file
       let eTag = result.eTag
       // File download link
       let location = result.location;
       // Obtain the CRC64 value of the object.
       let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
   } else {
       print(error!);
   }
}
// Monitor the upload progress
put.sendProcessBlock = { (bytesSent, totalBytesSent,
   totalBytesExpectedToSend) in
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
};
// Set the upload parameters
put.initMultipleUploadFinishBlock = {(multipleUploadInitResult, resumeData) in
   // This block will be called back after the Initiate Multipart Upload operation is complete so you can get resumeData and the uploadId.
   if let multipleUploadInitResult = multipleUploadInitResult {
       let uploadId = multipleUploadInitResult.uploadId
   }
}
QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Sample code 2. Uploading binary data

Objective-C

QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = @"examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
put.object = @"exampleobject";
// Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
put.body = [@"My Example Content" dataUsingEncoding:NSUTF8StringEncoding];
// Monitor the upload progress
[put setSendProcessBlock:^(int64_t bytesSent,
                          int64_t totalBytesSent,
                          int64_t totalBytesExpectedToSend) {
   // bytesSent                   Number of new bytes sent
   // totalBytesSent              Total number of bytes sent so far
   // totalBytesExpectedToSend    Target number of bytes expected to send
}];
// Monitor the upload result
[put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
   // Obtain the download link of the file uploaded using result.location
   NSString * fileUrl = result.location;
   // Obtain the CRC64 value of the object.
   NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
}];
[[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Swift

let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
put.object = "exampleobject";
// Content of the object to upload
let dataBody:NSData = "wrwrwrwrwrw".data(using: .utf8)! as NSData;
put.body = dataBody;
// Monitor the upload result
put.setFinish { (result, error) in
   // Get the upload result
   if let result = result {
       // ETag of the file
       let eTag = result.eTag
        // File download link
       let location = result.location;
        // Obtain the CRC64 value of the object.
       let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
   } else {
       print(error!);
   }
}
// Monitor the upload progress
put.sendProcessBlock = { (bytesSent, totalBytesSent,
   totalBytesExpectedToSend) in

   // bytesSent                   Number of new bytes sent
   // totalBytesSent              Total number of bytes sent so far
   // totalBytesExpectedToSend    Target number of bytes expected to send
};
QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Sample code 3. Suspending, resuming, and canceling an upload

Objective-C

To suspend an upload, use the code below:

NSError *error;
NSData *resmeData = [put cancelByProductingResumeData:&error];

To resume a suspended download, use the code below:

QCloudCOSXMLUploadObjectRequest *resumeRequest = [QCloudCOSXMLUploadObjectRequest requestWithRequestData:resmeData];
[[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:resumeRequest];

To cancel an upload, use the code below:

// Abort the upload.
[put abort:^(id outputObject, NSError *error) {

}];

Note：

For the complete sample, go to GitHub.

Swift

To suspend an upload, use the code below:

var error : NSError?;
var uploadResumeData:Data = put.cancel(byProductingResumeData:&error) as Data;

To resume a suspended download, use the code below:

var resumeRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>.init(request: uploadResumeData);
QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(resumeRequest);

To cancel an upload, use the code below:

// Abort the upload.
put.abort { (outputObject, error) in

}

Note：

For the complete sample, go to GitHub.

Sample code 4. Uploading multiple objects

Objective-C

for (int i = 0; i<20; i++) {
   QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = @"examplebucket-1250000000";

 // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = [NSString stringWithFormat:@"exampleobject-%d",i];

   // Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
   put.body = [@"My Example Content" dataUsingEncoding:NSUTF8StringEncoding];

   // Monitor the upload progress
   [put setSendProcessBlock:^(int64_t bytesSent,
                              int64_t totalBytesSent,
                              int64_t totalBytesExpectedToSend) {
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   }];

   // Monitor the upload result
   [put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
       // Obtain the download link of the file uploaded using result.location
       NSString * fileUrl = result.location;
        // Obtain the CRC64 value of the object.
       NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
   }];
   [[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];
}

Swift

for i in 1...10 {
   let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = "examplebucket-1250000000";

   // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = "exampleobject-".appendingFormat("%d", i);

   // Content of the object to upload
   let dataBody:NSData = "wrwrwrwrwrw".data(using: .utf8)! as NSData;
   put.body = dataBody;

   // Monitor the upload result
   put.setFinish { (result, error) in
       // Get the upload result
       if let result = result {
           // ETag of the file
           let eTag = result.eTag
            // File download link
           let location = result.location;
            // Obtain the CRC64 value of the object.
           let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
       } else {
           print(error!);
       }
   }
    // Monitor the upload progress
   put.sendProcessBlock = { (bytesSent, totalBytesSent,
       totalBytesExpectedToSend) in

   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   };

   QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);
}

Sample code 5. Customizing the threshold to trigger multipart upload

Objective-C

for (int i = 0; i<20; i++) {
   QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = @"examplebucket-1250000000";

 // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = [NSString stringWithFormat:@"exampleobject-%d",i];

   // Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
   put.body = [@"My Example Content" dataUsingEncoding:NSUTF8StringEncoding];
   // Customize the threshold to trigger multipart upload. By default, multipart upload is triggered when the file size is greater than 1 MB
   put.mutilThreshold = 10 *1024*1024;
   // Monitor the upload progress
   [put setSendProcessBlock:^(int64_t bytesSent,
                              int64_t totalBytesSent,
                              int64_t totalBytesExpectedToSend) {
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   }];

   // Monitor the upload result
   [put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
       // Obtain the download link of the file uploaded using result.location
       NSString * location = result.location;
       // Obtain the CRC64 value of the object.
       NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
   }];
   [[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];
}

Swift

for i in 1...10 {
   let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = "examplebucket-1250000000";

   // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = "exampleobject-".appendingFormat("%d", i);

   // Content of the object to upload
   let dataBody:NSData = "wrwrwrwrwrw".data(using: .utf8)! as NSData;
   put.body = dataBody;
   // Customize the threshold to trigger multipart upload. By default, multipart upload is triggered when the file size is greater than 1 MB
   put.mutilThreshold = 10 *1024*1024;
   // Monitor the upload result
   put.setFinish { (result, error) in
       // Get the upload result
       if let result = result {
           // ETag of the file
           let eTag = result.eTag
           // File download link
           let location = result.location;
           // Obtain the CRC64 value of the object.
           let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
       } else {
           print(error!);
       }
   }
    // Monitor the upload progress
   put.sendProcessBlock = { (bytesSent, totalBytesSent,
       totalBytesExpectedToSend) in

   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   };

   QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);
}

Sample code 6. Customizing the part size

Objective-C

for (int i = 0; i<20; i++) {
   QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = @"examplebucket-1250000000";

 // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = [NSString stringWithFormat:@"exampleobject-%d",i];

   // Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
   put.body = [@"My Example Content" dataUsingEncoding:NSUTF8StringEncoding];
   // Customize the part size. Default value: 1 MB
   put.sliceSize = 10 *1024*1024;
   // Monitor the upload progress
   [put setSendProcessBlock:^(int64_t bytesSent,
                              int64_t totalBytesSent,
                              int64_t totalBytesExpectedToSend) {
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   }];

   // Monitor the upload result
   [put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
       // Obtain the download link of the file uploaded using result.location
       NSString * location = result.location;
       // Obtain the CRC64 value of the object.
       NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
   }];
   [[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];
}

Swift

for i in 1...10 {
   let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = "examplebucket-1250000000";

   // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = "exampleobject-".appendingFormat("%d", i);

   // Content of the object to upload
   let dataBody:NSData = "wrwrwrwrwrw".data(using: .utf8)! as NSData;
   put.body = dataBody;
   // Customize the part size. Default value: 1 MB
   put.sliceSize = 10 *1024*1024
   // Monitor the upload result
   put.setFinish { (result, error) in
       // Get the upload result
       if let result = result {
           // ETag of the file
           let eTag = result.eTag
            // File download link
           let location = result.location;
            // Obtain the CRC64 value of the object.
           let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
       } else {
           print(error!);
       }
   }
    // Monitor the upload progress
   put.sendProcessBlock = { (bytesSent, totalBytesSent,
       totalBytesExpectedToSend) in
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   };

   QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);
}

Sample code 7. Limiting the upload speed

Note：

COS iOS SDK v5.8.0 or later is required.

Objective-C

   QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = @"examplebucket-1250000000";

 // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = [NSString stringWithFormat:@"exampleobject-%d",i];

   // Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
   put.body = [@"My Example Content" dataUsingEncoding:NSUTF8StringEncoding];

   //  Use `TrafficLimit` to limit the upload speed, in bit/s. The speed range is 819200 to 838860800, that is, 100 KB/s to 100 MB/s.
   put.trafficLimit = 819200;
   // Monitor the upload progress
   [put setSendProcessBlock:^(int64_t bytesSent,
                              int64_t totalBytesSent,
                              int64_t totalBytesExpectedToSend) {
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   }];

   // Monitor the upload result
   [put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
       // Obtain the download link of the file uploaded using result.location
       NSString * location = result.location;
       // Obtain the CRC64 value of the object.
       NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
   }];
   [[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];

Swift

    let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();

   // Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
   put.bucket = "examplebucket-1250000000";

   // Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
   put.object = "exampleobject-".appendingFormat("%d", i);

   // Content of the object to upload
   let dataBody:NSData = "wrwrwrwrwrw".data(using: .utf8)! as NSData;
   put.body = dataBody;
   // Use `TrafficLimit` to limit the upload speed, in bit/s. The speed range is 819200 to 838860800, that is, 100 KB/s to 100 MB/s.
   put.trafficLimit = 819200;
   // Monitor the upload result
   put.setFinish { (result, error) in
       // Get the upload result
       if let result = result {
           // ETag of the file
           let eTag = result.eTag
            // File download link
           let location = result.location;
           // Obtain the CRC64 value of the object.
           let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
       } else {
           print(error!);
       }
   }
    // Monitor the upload progress
   put.sendProcessBlock = { (bytesSent, totalBytesSent,
       totalBytesExpectedToSend) in
   //      bytesSent                 Number of bytes to send in this request (a large file may require multiple requests)
   //      totalBytesSent            Total number of bytes sent so far
   //      totalBytesExpectedToSend  Total number of bytes expected to send, i.e. the size of the file
   };

   QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);

Sample code 8. Creating a directory

Objective-C

QCloudCOSXMLUploadObjectRequest* put = [QCloudCOSXMLUploadObjectRequest new];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = @"examplebucket-1250000000";
// Name of the directory to create
put.object = @"dir1";

// Content of the object to be uploaded. If you need to create a directory, you only need to use a null string to generate `NSData`
put.body  = [@"" dataUsingEncoding:NSUTF8StringEncoding];

   // Monitor the upload result
[put setFinishBlock:^(QCloudUploadObjectResult *result, NSError *error) {
   // Obtain the download link of the file uploaded using result.location
   NSString * location = result.location;
}];
[[QCloudCOSTransferMangerService defaultCOSTransferManager] UploadObject:put];

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Swift

let put:QCloudCOSXMLUploadObjectRequest = QCloudCOSXMLUploadObjectRequest<AnyObject>();

// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = "examplebucket-1250000000";

// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
put.object = "dir/";

// Content of the object to upload
let dataBody:NSData = "".data(using: .utf8)! as NSData;
put.body = dataBody;

// Monitor the upload result
put.setFinish { (result, error) in
   // Get the upload result
   if let result = result {
       // File download link
       let location = result.location;
        } else {
           print(error!);
       }
   }
QCloudCOSTransferMangerService.defaultCOSTransferManager().uploadObject(put);

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Copying objects

The advanced APIs encapsulate async requests for the simple copy and multipart copy APIs and support pausing, resuming, and canceling copy requests.

Sample code

Objective-C

QCloudCOSXMLCopyObjectRequest* request = [[QCloudCOSXMLCopyObjectRequest alloc] init];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
request.bucket = @"examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
request.object = @"exampleobject";
// Source bucket containing the file; the current account needs to have access permission for the bucket, or the bucket should have public-read permission enabled.
request.sourceBucket = @"sourcebucket-1250000000";
// Name of the source file
request.sourceObject = @"sourceObject";
// APPID of the source file
request.sourceAPPID = @"1250000000";
// Source region
request.sourceRegion= @"COS_REGION";
[request setFinishBlock:^(QCloudCopyObjectResult* result, NSError* error) {
   // outputObject contains information such as the ETag or custom headers in the response.
}];
// Note that for cross-region replication, the region used for `transferManager` must be the region of the destination bucket
[[QCloudCOSTransferMangerService defaultCOSTransferManager] CopyObject:request];
// Cancel the copy
// To cancel the copy operation, call `cancel`
[request cancel];

Note：

For the complete sample, go to GitHub.

Swift

let copyRequest =  QCloudCOSXMLCopyObjectRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
copyRequest.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
copyRequest.object = "exampleobject";
// Source bucket containing the file; the current account needs to have access permission for the bucket, or the bucket should have public-read permission enabled.
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
copyRequest.sourceBucket = "sourcebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
copyRequest.sourceObject = "sourceObject";
// APPID of the source file
copyRequest.sourceAPPID = "1250000000";
// Source region
copyRequest.sourceRegion = "COS_REGION";
copyRequest.setFinish { (copyResult, error) in
   if let copyResult = copyResult {
       // ETag of the file
       let eTag = copyResult.eTag
   } else {
       print(error!);
   }

}
// Note that for cross-region replication, the region used for `transferManager` must be the region of the destination bucket
QCloudCOSTransferMangerService.defaultCOSTransferManager().copyObject(copyRequest);
// Cancel the copy
// To cancel the copy operation, call `cancel`
copyRequest.cancel();

Note：

For the complete sample, go to GitHub.

Simple Operations

Uploading an object using simple upload

Description

This API (PUT Object) is used to upload an object smaller than 5 GB to a specified bucket. To call this API, you need to have permission to write to the bucket. If the object size is larger than 5 GB, please use Multipart Upload or Advanced APIs for the upload.

Note：

The Key (filename) cannot end with /; otherwise, it will be identified as a folder.

Sample code

Objective-C

QCloudPutObjectRequest* put = [QCloudPutObjectRequest new];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
put.bucket = @"examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
put.object = @"exampleobject";
// Content of the object. You can pass in variables in `NSData*` or `NSURL*` format.
put.body =  [@"testFileContent" dataUsingEncoding:NSUTF8StringEncoding];
[put setFinishBlock:^(id result, NSError *error) {
   // "result" contains response headers.
   // Obtain the CRC64 value of the object.
   NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
}];
[[QCloudCOSXMLService defaultCOSXML] PutObject:put];

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Swift

let putObject = QCloudPutObjectRequest<AnyObject>.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
putObject.bucket = "examplebucket-1250000000";
// Content of the object to be uploaded. You can pass variables of the `NSData*` or `NSURL*` type
let dataBody:NSData? = "wrwrwrwrwrw".data(using: .utf8) as NSData?;
putObject.body =  dataBody!;
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
putObject.object = "exampleobject";
putObject.finishBlock = {(result,error) in
   if let result = result {
       // Obtain the CRC64 value of the object.
       let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
   } else {
       print(error!);
   }
}
QCloudCOSXMLService.defaultCOSXML().putObject(putObject);

Note：

• For the complete sample, go to GitHub.
• You can generate a download URL for the uploaded file using the same key. For detailed directions, please see Generating a Pre-Signed Link. Please note that for private-read files, the download URL is only valid for a limited period of time.

Multipart Operations

The multipart upload process is outlined below.

Multipart upload/copy process

1. Initialize the multipart upload with Initiate Multipart Upload and get the UploadId.
2. Use the UploadId to upload parts with Upload Part or copy parts with Upload Part Copy
3. Complete the multipart upload with Complete Multipart Upload.

Resuming a multipart upload/copy operation

1. If you did not record the UploadId of the multipart upload, you can query the multipart upload job with List Multipart Uploads to get the UploadId of the corresponding file.
2. Use the UploadId to list the uploaded parts with List Parts.
3. Use the UploadId to upload the remaining parts with Upload Part or copy the remaining parts with Upload Part Copy.
4. Complete the multipart upload with Complete Multipart Upload.

Aborting a multipart upload

1. If you did not record the UploadId of the multipart upload, you can query the multipart upload job with List Multipart Uploads to get the UploadId of the corresponding file.
2. Abort the multipart upload and delete the uploaded parts with Abort Multipart Upload.

Initializing a multipart upload

Description

This API is used to initialize a multipart upload operation and get its uploadId.

Sample code

Objective-C

QCloudInitiateMultipartUploadRequest* initRequest = [QCloudInitiateMultipartUploadRequest new];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
initRequest.bucket = @"examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
initRequest.object = @"exampleobject";
// This will be returned as object metadata
initRequest.cacheControl = @"cacheControl";
initRequest.contentDisposition = @"contentDisposition";
// Define the ACL attribute of the object. Valid values: private (default), public-read-write, public-read
initRequest.accessControlList = @"public";
// Grant read permission.
initRequest.grantRead = @"grantRead";
// Grant full permissions to the grantee.
initRequest.grantFullControl = @"grantFullControl";
[initRequest setFinishBlock:^(QCloudInitiateMultipartUploadResult* outputObject,
                             NSError *error) {
   // Get the `uploadId` of the multipart upload. This ID is required for subsequent uploads. Please save it for future use.
   self->uploadId = outputObject.uploadId;

}];
[[QCloudCOSXMLService defaultCOSXML] InitiateMultipartUpload:initRequest];

Note：

For the complete sample, go to GitHub.

Swift

let initRequest = QCloudInitiateMultipartUploadRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
initRequest.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
initRequest.object = "exampleobject";
initRequest.setFinish { (result, error) in
   if let result = result {
       // Get the `uploadId` of the multipart upload. This ID is required for subsequent uploads. Please save it for future use.
       self.uploadId = result.uploadId;
   } else {
       print(error!);
   }
}
QCloudCOSXMLService.defaultCOSXML().initiateMultipartUpload(initRequest);

Note：

For the complete sample, go to GitHub.

Uploading parts

This API (Upload Part) is used to upload an object in parts.

Sample code

Objective-C

QCloudUploadPartRequest* request = [QCloudUploadPartRequest new];
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
request.bucket = @"examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
request.object = @"exampleobject";
// Part number
request.partNumber = 1;
// The ID of the multipart upload. When you use the `Initiate Multipart Upload` API to initialize a multipart upload, you will get an `uploadId`
request.uploadId = uploadId;
// Uploaded data. NSData *, NSURL (local URL), and QCloudFileOffsetBody * are supported.
request.body = [@"testFileContent" dataUsingEncoding:NSUTF8StringEncoding];
[request setSendProcessBlock:^(int64_t bytesSent,
                             int64_t totalBytesSent,
                             int64_t totalBytesExpectedToSend) {
  // Upload progress
  // bytesSent                   Number of new bytes sent
  // totalBytesSent              Total number of bytes sent so far
  // totalBytesExpectedToSend    Target number of bytes expected to send
}];
[request setFinishBlock:^(QCloudUploadPartResult* outputObject, NSError *error) {
  QCloudMultipartInfo *part = [QCloudMultipartInfo new];
  // Get the ETag of the uploaded part.
  part.eTag = outputObject.eTag;
  part.partNumber = @"1";
  // Save it for future use after the upload is complete
  self.parts = @[part];
  // Obtain the CRC64 value of the object.
  NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];

}];
[[QCloudCOSXMLService defaultCOSXML]  UploadPart:request];

Note：

For the complete sample, go to GitHub.

Swift

let uploadPart = QCloudUploadPartRequest<AnyObject>.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
uploadPart.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
uploadPart.object = "exampleobject";
uploadPart.partNumber = 1;
// ID of the multipart upload
if let uploadId = self.uploadId {
   uploadPart.uploadId = uploadId;
}
// Example file
let dataBody:NSData? = "wrwrwrwrwrwwrwrwrwrwrwwwrwrw"
   .data(using: .utf8) as NSData?;
uploadPart.body = dataBody!;
uploadPart.setFinish { (result, error) in
   if let result = result {
       let mutipartInfo = QCloudMultipartInfo.init();
       // Get the ETag of the part.
       mutipartInfo.eTag = result.eTag;
       mutipartInfo.partNumber = "1";
       // Save it for completing the upload
       self.parts = [mutipartInfo];
       // Obtain the CRC64 value of the object.
       let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
   } else {
       print(error!);
   }
}
uploadPart.sendProcessBlock = {(bytesSent,totalBytesSent,
                               totalBytesExpectedToSend) in
   // Upload progress
   // bytesSent                   Number of new bytes sent
   // totalBytesSent              Total number of bytes sent so far
   // totalBytesExpectedToSend    Target number of bytes expected to send

}
QCloudCOSXMLService.defaultCOSXML().uploadPart(uploadPart);

Note：

For the complete sample, go to GitHub.

Querying uploaded parts

Description

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

Sample code

Objective-C

QCloudListMultipartRequest* request = [QCloudListMultipartRequest new];
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
request.object = @"exampleobject";
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
request.bucket = @"examplebucket-1250000000";
// The Initiate Multipart Upload request returns an upload ID that uniquely identifies the upload.
request.uploadId = uploadId;
[request setFinishBlock:^(QCloudListPartsResult * _Nonnull result,
                         NSError * _Nonnull error) {

   // Get the information on uploaded parts from `result`
   // Information on each part
   NSArray<QCloudMultipartUploadPart*> *parts = result.parts;
}];
[[QCloudCOSXMLService defaultCOSXML] ListMultipart:request];

Note：

For the complete sample, go to GitHub.

Swift

let req = QCloudListMultipartRequest.init();
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
req.object = "exampleobject";
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
req.bucket = "examplebucket-1250000000";
// The Initiate Multipart Upload request returns an upload ID that uniquely identifies the upload.
if let uploadId = self.uploadId {
   req.uploadId = uploadId;
}
req.setFinish { (result, error) in
   if let result = result {
       // All uploaded parts
       let parts = result.parts
   } else {
       print(error!);
   }
}
QCloudCOSXMLService.defaultCOSXML().listMultipart(req);

Note：

For the complete sample, go to GitHub.

Completing a multipart upload

Description

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

Sample code

Objective-C

QCloudCompleteMultipartUploadRequest *completeRequst = [QCloudCompleteMultipartUploadRequest new];
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
completeRequst.object = @"exampleobject";
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
completeRequst.bucket = @"examplebucket-1250000000";
// `uploadId` of the multipart upload to be queried. This ID can be obtained from `QCloudInitiateMultipartUploadResult`, i.e. the result of the multipart upload initialization request
completeRequst.uploadId = uploadId;
// Information on the uploaded parts
QCloudCompleteMultipartUploadInfo *partInfo = [QCloudCompleteMultipartUploadInfo new];
NSMutableArray * parts = [self.parts mutableCopy];
// Sort the uploaded parts.
[parts sortUsingComparator:^NSComparisonResult(QCloudMultipartInfo*  _Nonnull obj1,
                                             QCloudMultipartInfo*  _Nonnull obj2) {
  int a = obj1.partNumber.intValue;
  int b = obj2.partNumber.intValue;

  if (a < b) {
      return NSOrderedAscending;
  } else {
      return NSOrderedDescending;
  }
}];
partInfo.parts = [parts copy];
completeRequst.parts = partInfo;
[completeRequst setFinishBlock:^(QCloudUploadObjectResult * _Nonnull result,
                               NSError * _Nonnull error) {
  // Get the upload result from "result".
  // Obtain the CRC64 value of the object.
  NSString * crc64 = [[outputObject __originHTTPURLResponse__].allHeaderFields valueForKey:@"x-cos-hash-crc64ecma"];
}];
[[QCloudCOSXMLService defaultCOSXML] CompleteMultipartUpload:completeRequst];

Note：

For the complete sample, go to GitHub.

Swift

let  complete = QCloudCompleteMultipartUploadRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
complete.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
complete.object = "exampleobject";
// `uploadId` of the multipart upload to be queried. This ID can be obtained from
// `QCloudInitiateMultipartUploadResult`, i.e., the result of the multipart upload initialization request
complete.uploadId = "exampleUploadId";
if let uploadId = self.uploadId {
   complete.uploadId = uploadId;
}
// Information on the uploaded parts
let completeInfo = QCloudCompleteMultipartUploadInfo.init();
if self.parts == nil {
   print ("parts that have not completed yet");
   return;
}
if self.parts != nil {
   completeInfo.parts = self.parts ?? [];
}
complete.parts = completeInfo;
complete.setFinish { (result, error) in
   if let result = result {
       // ETag of the file
       let eTag = result.eTag
       // Unsigned file URL
       let location = result.location

       // Obtain the CRC64 value of the object.
       let crc64 = result?.__originHTTPURLResponse__.allHeaderFields["x-cos-hash-crc64ecma"];
   } else {
       print(error!);
   }
}
QCloudCOSXMLService.defaultCOSXML().completeMultipartUpload(complete);

Note：

For the complete sample, go to GitHub.

Aborting a multipart upload

Description

This API (Abort Multipart Upload) is used to abort a multipart upload and delete the uploaded parts.

Sample code

Objective-C

QCloudAbortMultipfartUploadRequest *abortRequest = [QCloudAbortMultipfartUploadRequest new];
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
abortRequest.object = @"exampleobject";
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
abortRequest.bucket = @"examplebucket-1250000000";
// `uploadId` of the multipart upload to be aborted.
// This ID can be obtained from `QCloudInitiateMultipartUploadResult`, i.e. the result of the multipart upload initialization request
abortRequest.uploadId = @"exampleUploadId";
[abortRequest setFinishBlock:^(id outputObject, NSError *error) {
   // outputObject contains information such as the ETag or custom headers in the response.
   NSDictionary * result = (NSDictionary *)outputObject;
}];
[[QCloudCOSXMLService defaultCOSXML]AbortMultipfartUpload:abortRequest];

Note：

For the complete sample, go to GitHub.

Swift

let abort = QCloudAbortMultipfartUploadRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
abort.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
abort.object = "exampleobject";
// `uploadId` of the multipart upload to be queried. This ID can be obtained from
// `QCloudInitiateMultipartUploadResult`, i.e., the result of the multipart upload initialization request
abort.uploadId = self.uploadId!;
abort.finishBlock = {(result,error)in
   if let result = result {
       // You can get the header information returned by the server from `result`
   } else {
       print(error!)
   }
}
QCloudCOSXMLService.defaultCOSXML().abortMultipfartUpload(abort);

Note：

For the complete sample, go to GitHub.