全部產品
Search
文件中心

Object Storage Service:設定對象標籤(Python SDK V2)

更新時間:Jul 31, 2025

OSS支援使用對象標籤(Object Tagging)對儲存空間(Bucket)中的檔案(Object)進行分類,本文介紹如何使用Python SDK V2設定對象標籤。

注意事項

  • 本文範例程式碼以華東1(杭州)的地區IDcn-hangzhou為例,預設使用外網Endpoint,如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見OSS地區和訪問網域名稱

  • 要設定對象標籤,您必須具有oss:PutObjectTagging許可權。具體操作,請參見為RAM使用者授予自訂的權限原則

方法定義

put_object_tagging(request: PutObjectTaggingRequest, **kwargs) → PutObjectTaggingResult

請求參數列表

參數名

類型

說明

request

PutObjectTaggingRequest

佈建要求參數,具體請參見PutObjectTaggingRequest

傳回值列表

類型

說明

PutObjectTaggingResult

傳回值,具體請參見PutObjectTaggingResult

關於設定對象標籤方法的完整定義,請參見put_object_tagging

範例程式碼

您可以使用以下代碼設定指定檔案的標籤資訊。

import argparse
import alibabacloud_oss_v2 as oss

# 建立一個命令列參數解析器,並添加必要的參數
parser = argparse.ArgumentParser(description="put object tagging sample")
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the object.', required=True)
parser.add_argument('--tag_key', help='The name of the tag key.', required=True)
parser.add_argument('--tag_value', help='The name of the tag value.', required=True)

def main():
    # 解析命令列參數
    args = parser.parse_args()

    # 從環境變數中載入憑證資訊
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK的預設配置
    cfg = oss.config.load_default()
    # 設定憑證提供者
    cfg.credentials_provider = credentials_provider
    # 設定地區
    cfg.region = args.region
    # 如果指定了endpoint,則設定endpoint
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 建立OSS用戶端
    client = oss.Client(cfg)

    # 構建標籤對象
    # 如果需要設定多個標籤,可以按照以下格式添加更多的oss.Tag對象
    # tags = [oss.Tag(key=args.tag_key, value=args.tag_value), oss.Tag(key=args.tag_key2, value=args.tag_value2)]

    tags = [oss.Tag(
        key=args.tag_key,
        value=args.tag_value,
    )]

    # 執行設定對象標籤的請求
    result = client.put_object_tagging(oss.PutObjectTaggingRequest(
        bucket=args.bucket,
        key=args.key,
        tagging=oss.Tagging(
            tag_set=oss.TagSet(
                tags=tags,
            ),
        ),
    ))

    # 列印請求結果
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'
    )

if __name__ == "__main__":
    main()

相關文檔