tencent cloud

文档反馈

对象标签

最后更新时间:2024-01-19 16:15:11

    简介

    本文档提供关于对象标签的 API 概览以及 SDK 示例代码。
    API
    操作名
    操作描述
    设置对象标签
    为已存在的对象设置标签
    查询对象标签
    查询指定对象下已有的对象标签
    删除对象标签
    删除指定的对象标签

    设置对象标签

    功能说明

    为已存在的对象设置标签。

    请求示例

    cos.putObjectTagging({
    Bucket: 'examplebucket-1250000000', /* 必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
    Key: '1.png', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
    Tags: [
    {"Key": "k1", "Value": "v1"},
    {"Key": "k2", "Value": "v2"}
    ],
    // VersionId: 'MTg0NDUwOTMyODM1MDg2MTA1xxx' /* 对象版本 ID,非必须 */
    }, function(err, data) {
    console.log(err || data);
    });

    参数说明

    参数名
    参数描述
    类型
    是否必填
    Bucket
    设置对象标签的存储桶,格式:BucketName-APPID
    String
    Region
    存储桶所在地域,枚举值请参见 地域和访问域名
    String
    Key
    对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
    String
    Tags
    标签信息
    ObjectArray
    - Key
    标签名
    String
    - Value
    标签值
    String
    VersionId
    当启用版本控制时,指定要操作的对象版本 ID,如不指定则将添加标签到最新版本的对象
    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.getObjectTagging({
    Bucket: 'examplebucket-1250000000', /* 必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
    Key: '1.png', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
    }, 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
    Key
    对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
    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.deleteObjectTagging({
    Bucket: 'examplebucket-1250000000', /* 必须 */
    Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
    Key: '1.png', /* 存储在桶里的对象键(例如1.jpg,a/b/test.txt),必须字段 */
    }, function(err, data) {
    console.log(err || data);
    });

    参数说明

    参数名
    描述
    类型
    是否必填
    Bucket
    删除对象标签的存储桶,格式:BucketName-APPID
    String
    Region
    存储桶所在地域,枚举值请参见 地域和访问域名
    String
    Key
    对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述
    String

    回调函数说明

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

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持