控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

对象标签

最近更新时间:2021-12-28 15:25:25

简介

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

API 操作名 操作描述
PUT Object tagging 设置对象标签 为对象设置标签
GET Object tagging 查询对象标签 查询指定对象下已有的对象标签
DELETE Object tagging 删除对象标签 删除指定对象下已有的对象标签

设置对象标签

功能说明

PUT Object tagging 用于为对象设置标签。

方法原型

public Guzzle\Service\Resource\Model PutObjectTagging(array $args = array());

请求示例

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部,默认为http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));

try {
    $result = $cosClient->putObjectTagging(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key'    => 'exampleobject',
        'TagSet' => array(
            array('Key'=>'key1',
                  'Value'=>'value1',
            ),  
            array('Key'=>'key2',
                  'Value'=>'value2',
            ),  
        ),  
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo "$e\n";
}

参数说明

参数名称 描述 类型
Bucket 设置标签的对象所在的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
Key 设置标签的对象键,对象键(Key)是对象在存储桶中的唯一标识,详情请参见 对象键 String
TagSet 对象的标签配置集合 Array

TagSet 成员说明:

参数名称 描述 类型
Key 标签的 key String
Value 标签的 value String

查询对象标签

功能说明

GET Object tagging 用于查询指定对象下已有的对象标签。

方法原型

public Guzzle\Service\Resource\Model GetObjectTagging(array $args = array());

请求示例

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部,默认为http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));

try {
    $result = $cosClient->getObjectTagging(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key'    => 'exampleobject',
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

参数名称 描述 类型
Bucket 查询标签的对象所在的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
Key 查询标签的对象键,对象键(Key)是对象在存储桶中的唯一标识,详情请参见 对象键 String

返回结果示例

GuzzleHttp\Command\Result Object
(
    [TagSet] => Array
        (
            [0] => Array
                (
                    [Key] => key1
                    [Value] => value1
                )

            [1] => Array
                (
                    [Key] => key2
                    [Value] => value2
                )

        )
    [RequestId] => NWRmMWVkMjFfMjJiMjU4NjRfNWQ3X2EwMWVj****
)

返回结果说明

成员变量 描述 类型
Key 标签的键 String
Value 标签的值 String

删除对象标签

功能说明

DELETE Object tagging 用于删除指定对象的已有标签。

方法原型

public Guzzle\Service\Resource\Model DeleteObjectTagging(array $args = array());

请求示例

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey,请登录访问管理控制台进行查看和管理,https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region,已创建桶归属的region可以在控制台查看,https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
    array(
        'region' => $region,
        'schema' => 'https', //协议头部,默认为http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));

try {
    $result = $cosClient->deleteObjectTagging(array(
        'Bucket' => 'examplebucket-1250000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key'    => 'exampleobject',
    );
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

参数名称 描述 类型
Bucket 删除标签的对象所在的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范 String
Key 删除标签的对象键,对象键(Key)是对象在存储桶中的唯一标识,详情请参见 对象键 String
目录