API | Operation | Description |
Querying a bucket list | Queries the list of all buckets under a specified account | |
Creating a bucket | Creates a bucket under a specified account | |
Checking a bucket and its permissions | Checks whether a bucket exists and whether you have permission to access it | |
Deleting a bucket | Deletes an empty bucket from a specified account |
cos.getService(function(err, data) {console.log(err || data);});
cos.getService({Region: 'COS_REGION',}, function(err, data) {console.log(err || data);});
Parameter | Description | Type | Required |
Region | String | No |
function(err, data) { ... }
Parameter | Description | Type |
err | Object returned when an error (network error or service error) occurs. If the request is successful, this parameter is left empty. For more information, please see Error Codes. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
data | Content returned when the request is successful. If the request fails, this parameter is empty. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
- Owner | Object representing the bucket owner | Object |
- - ID | Complete ID of the bucket owner in the format: qcs::cam::uin/[OwnerUin]:uin/[OwnerUin] , such as qcs::cam::uin/100000000001:uin/100000000001 | string |
- - DisplayName | Name of the bucket owner | String |
- Buckets | Bucket list | Object |
- - Name | Bucket name in the format of <BucketName-APPID>, such as examplebucket-1250000000 | String |
- - Location | Bucket region, such as ap-guangzhou , ap-beijing , and ap-hongkong . For more information, please see Regions and Access Endpoints. | String |
- - CreationDate | Time when the bucket was created, in ISO 8601 format, such as 2019-05-24T10:56:40Z | string |
cos.putBucket({Bucket: 'examplebucket-1250000000',Region: 'COS_REGION'}, function(err, data) {console.log(err || data);});
Parameter | Description | Type | Required |
Bucket | Bucket name in the format of BucketName-APPID | String | Yes |
Region | String | Yes | |
ACL | Defines the access control list (ACL) attribute of the bucket. For enumerated values, such as private and public-read , see the "Preset ACLs for buckets" section in ACL Overview. Default value: private | String | No |
GrantRead | Grants a user read permission in the format: id=" ",id=" " .To authorize a sub-account, use id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>" .To authorize a root account, use id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" .Example: 'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' | String | No |
GrantWrite | Grants a user write permission in the format: id=" ",id=" " .To authorize a sub-account, use id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>" .To authorize a root account, use id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" .Examples: 'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' | String | No |
GrantReadAcp | Grants a user read permission for a bucket’s ACL and policies in the format: id=" ",id=" " .To authorize a sub-account, use id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>" .To authorize a root account, use id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" .Example: 'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' | String | No |
GrantWriteAcp | Grants a user write permission for a bucket’s ACL and policies in the format: id=" ",id=" " .To authorize a sub-account, use id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>" .To authorize a root account, use id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" .Examples: 'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' | String | No |
GrantFullControl | Grants full permission in the format: id="[OwnerUin]" . You can use commas (,) to separate multiple users.To authorize a sub-account, use id="qcs::cam::uin/<OwnerUin>:uin/<SubUin>" .To authorize a root account, use id="qcs::cam::uin/<OwnerUin>:uin/<OwnerUin>" .Example: 'id="qcs::cam::uin/100000000001:uin/100000000001", id="qcs::cam::uin/100000000001:uin/100000000011"' | String | No |
function(err, data) { ... }
Parameter | Description | Type |
err | Object returned when an error (network error or service error) occurs. If the request is successful, this parameter is left empty. For more information, please see Error Codes. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
data | Content returned when the request is successful. If the request fails, this parameter is empty. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
cos.headBucket({Bucket: 'examplebucket-1250000000', /* Required */Region: 'COS_REGION', /* Required */}, function(err, data) {console.log(err || data);});
function doesBucketExist() {cos.headBucket({Bucket: 'examplebucket-1250000000', /* Required */Region: 'COS_REGION', /* Bucket region. Required */}, function(err, data) {if (data) {console.log('The bucket exists.');} else if (err.statusCode == 404) {console.log('The bucket does not exist.');} else if (err.statusCode == 403) {console.log ('no permission to read the bucket');}});}
Parameter | Description | Type | Required |
Bucket | Bucket name in the format of BucketName-APPID | String | Yes |
Region | String | Yes |
function(err, data) { ... }
Parameter | Description | Type |
err | Object returned when an error (network error or service error) occurs. If the request is successful, this parameter is left empty. For more information, please see Error Codes. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
data | Content returned when the request is successful. If the request fails, this parameter is empty. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
cos.deleteBucket({Bucket: 'examplebucket-1250000000', /* Required */Region: 'COS_REGION', /*Required*/}, function(err, data) {console.log(err || data);});
Parameter | Description | Type | Required |
Bucket | Bucket name in the format of BucketName-APPID | String | Yes |
Region | String | Yes |
function(err, data) { ... }
Parameter | Description | Type |
err | Object returned when an error (network error or service error) occurs. If the request is successful, this parameter is left empty. For more information, please see Error Codes. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
data | Content returned when the request is successful. If the request fails, this parameter is empty. | Object |
- statusCode | HTTP status code, such as 200 , 403 , and 404 | Number |
- headers | Headers | Object |
Apakah halaman ini membantu?