控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

存储桶标签

最近更新时间:2020-04-24 18:18:36

简介

本文档提供关于存储桶标签的 API 概览以及 SDK 示例代码。

API 操作名 操作描述
PUT Bucket tagging 设置存储桶标签 为已存在的存储桶设置标签
GET Bucket tagging 查询存储桶标签 查询指定存储桶下已有的存储桶标签
DELETE Bucket tagging 删除存储桶标签 删除指定的存储桶标签

设置存储桶标签

功能说明

为已存在的存储桶设置标签。

请求示例

cos.putBucketTagging({
    Bucket: 'examplebucket-1250000000', /* 必须 */
    Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
    Tagging: {
        Tags: [
            {"Key": "k1", "Value": "v1"},
            {"Key": "k2", "Value": "v2"}
        ]
    }
}, function(err, data) {
    console.log(err || data);
});

参数说明

参数名 参数描述 类型 是否必填
Bucket 设置存储桶标签的存储桶,格式:BucketName-APPID String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
Tagging 标签信息 Object
- Tags 标签信息 ObjectArray
- - Key 标签名 String
- - Value 标签值 String

回调函数说明

function(err, data) { ... }
参数名            参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object

查询存储桶标签

功能说明

查询指定存储桶下已有的存储桶标签。

请求示例

cos.getBucketTagging({
    Bucket: 'examplebucket-1250000000', /* 必须 */
    Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
}, function(err, data) {
    console.log(err || data);
});

返回示例

{
    "Tags": [
        {"Key": "k1", "Value": "v1"},
        {"Key": "k2", "Value": "v2"}
    ],
    "statusCode": 200,
    "headers": {}
}

参数说明

参数名 参数描述 类型 是否必填
Bucket 查询存储桶标签的存储桶,格式:BucketName-APPID String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

回调函数说明

function(err, data) { ... }
参数名                 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
- Tags 标签信息 ObjectArray
- - Key 标签名 String
- - Value 标签值 String

删除存储桶标签

功能说明

删除指定的存储桶标签。

请求示例

cos.deleteBucketTagging({
    Bucket: 'examplebucket-1250000000', /* 必须 */
    Region: 'COS_REGION',     /* 存储桶所在地域,必须字段 */
}, function(err, data) {
    console.log(err || data);
});

参数说明

参数名 描述 类型 是否必填
Bucket 删除存储桶标签的存储桶,格式:BucketName-APPID String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String

回调函数说明

function(err, data) { ... }
参数名            参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误,如果请求成功则为空,更多详情请参见 错误码 文档 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
目录