tencent cloud

文档反馈

最后更新时间:2024-01-22 11:43:35

    简介

    本文档提供关于清单的 API 概览以及 SDK 示例代码。
    API
    操作名
    操作描述
    设置清单任务
    设置存储桶的清单任务
    查询清单任务
    查询存储桶的清单任务
    删除清单任务
    删除存储桶的清单任务

    设置清单任务

    功能说明

    PUT Bucket inventory 用于在存储桶中创建清单任务。

    方法原型

    put_bucket_inventory(Bucket, Id, InventoryConfiguration={}, **kwargs)

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import os
    import logging
    
    # 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    
    # 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
    token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    
    response = client.put_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string',
    InventoryConfiguration={
    'Destination': {
    'COSBucketDestination': {
    'AccountId': '100000000001',
    'Bucket': 'qcs::cos:ap-guangzhou::examplebucket-1250000000',
    'Format': 'CSV',
    'Prefix': 'string',
    'Encryption': {
    'SSECOS': {}
    }
    }
    },
    'IsEnabled': 'true'|'false',
    'Filter': {
    'Prefix': 'string'
    },
    'IncludedObjectVersions':'All'|'Current',
    'OptionalFields': {
    'Field': [
    'Size',
    'LastModifiedDate',
    'ETag',
    'StorageClass',
    'IsMultipartUploaded',
    'ReplicationStatus'
    ]
    },
    'Schedule': {
    'Frequency': 'Daily'|'Weekly'
    }
    }
    )

    参数说明

    参数名称
    参数描述
    类型
    是否必填
    Bucket
    设置清单任务的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
    String
    Id
    清单任务的名称,合法字符:a-z,A-Z,0-9,-,_,.
    String
    Destination
    清单任务投递的目的信息
    Dict
    COSBucketDestination
    清单任务结果投递的目的存储桶信息
    Dict
    AccountId
    目的存储桶的账号信息
    String
    Bucket
    目的存储桶的名称
    String
    Format
    清单结果文件的格式,可选值 CSV
    String
    Prefix
    目的存储桶投递路径的前缀
    String
    Encryption
    目的存储桶投递文件的加密信息,可选值 SSECOS
    Dict
    IsEnabled
    清单任务是否启用的标识,可选值 true、flase
    String
    Filter
    清单分析对象的过滤条件
    Dict
    Prefix
    清单分析对象的过滤前缀
    String
    IncludedObjectVersions
    包含多版本的情况,可选值 All、Current
    String
    OptionalFields
    清单可选的字段
    Dict
    Field
    字段名,包括 Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、ReplicationStatus
    List
    Schedule
    清单任务执行的计划
    Dict
    Frequency
    清单任务执行的频率,可选值 Daily、Weekly
    String

    返回结果说明

    该方法返回值为 None。

    错误码说明

    该请求可能会发生的一些常见的特殊错误如下:
    错误码
    描述
    状态码
    InvalidArgument
    不合法的参数值
    HTTP 400 Bad Request
    TooManyConfigurations
    清单数量已经达到1000条的上限
    HTTP 400 Bad Request
    AccessDenied
    未授权的访问。您可能不具备访问该存储桶的权限
    HTTP 403 Forbidden

    查询清单任务

    功能说明

    GET Bucket inventory 用于查询存储桶中用户的清单任务信息。

    方法原型

    get_bucket_inventory(Bucket, Id, **kwargs)

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import os
    import logging
    
    # 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    
    # 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
    token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    
    response = client.get_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string'
    )

    参数说明

    参数名称
    参数描述
    类型
    是否必填
    Bucket
    查询清单任务的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
    String
    Id
    清单任务的名称,合法字符:a-z,A-Z,0-9,-,_,.
    String

    返回结果说明

    Bucket 清单任务配置,类型为 dict。
    {
    'Id': 'string',
    'Destination': {
    'COSBucketDestination': {
    'AccountId': '100000000001',
    'Bucket': 'qcs::cos:ap-guangzhou::examplebucket-1250000000',
    'Format': 'CSV',
    'Prefix': 'string',
    'Encryption': {
    'SSECOS': {}
    }
    }
    },
    'IsEnabled': 'true'|'false',
    'Filter': {
    'Prefix': 'string'
    },
    'IncludedObjectVersions':'All'|'Current',
    'OptionalFields': {
    'Field': [
    'Size',
    'LastModifiedDate',
    'ETag',
    'StorageClass',
    'IsMultipartUploaded',
    'ReplicationStatus'
    ]
    },
    'Schedule': {
    'Frequency': 'Daily'|'Weekly'
    }
    }
    参数名称
    参数描述
    类型
    Id
    清单任务的名称,合法字符:a-z,A-Z,0-9,-,_,.
    String
    Destination
    清单任务投递的目的信息
    Dict
    COSBucketDestination
    清单任务结果投递的目的存储桶信息
    Dict
    AccountId
    目的存储桶的账号信息
    String
    Bucket
    目标存储桶的名称
    String
    Format
    清单结果文件的格式,可选值 CSV
    String
    Prefix
    目的存储桶投递路径的前缀
    String
    Encryption
    目的存储桶投递文件的加密信息,可选值 SSECOS
    Dict
    IsEnabled
    清单任务是否启用的标识,可选值 true、flase
    String
    Filter
    清单分析对象的过滤条件
    Dict
    Prefix
    清单分析对象的过滤前缀
    String
    IncludedObjectVersions
    包含多版本的情况,可选值 All、Current
    String
    OptionalFields
    清单可选的字段
    Dict
    Field
    字段名,包括 Size、LastModifiedDate、ETag、StorageClass、IsMultipartUploaded、ReplicationStatus
    List
    Schedule
    清单任务执行的计划
    Dict
    Frequency
    清单任务执行的频率,可选值 Daily、Weekly
    String

    删除清单任务

    功能说明

    DELETE Bucket inventory 用于删除存储桶中指定的清单任务。

    方法原型

    delete_bucket_inventory(Bucket, Id, **kwargs)

    请求示例

    # -*- coding=utf-8
    from qcloud_cos import CosConfig
    from qcloud_cos import CosS3Client
    import sys
    import os
    import logging
    
    # 正常情况日志级别使用 INFO,需要定位时可以修改为 DEBUG,此时 SDK 会打印和服务端的通信信息
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    
    # 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除,请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
    secret_id = os.environ['COS_SECRET_ID'] # 用户的 SecretId,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    secret_key = os.environ['COS_SECRET_KEY'] # 用户的 SecretKey,建议使用子账号密钥,授权遵循最小权限指引,降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
    region = 'ap-beijing' # 替换为用户的 region,已创建桶归属的 region 可以在控制台查看,https://console.tencentcloud.com/cos5/bucket
    # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
    token = None # 如果使用永久密钥不需要填入 token,如果使用临时密钥需要填入,临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
    scheme = 'https' # 指定使用 http/https 协议来访问 COS,默认为 https,可不填
    
    config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
    client = CosS3Client(config)
    
    response = client.delete_bucket_inventory(
    Bucket='examplebucket-1250000000',
    Id='string'
    )

    参数说明

    参数名称
    参数描述
    类型
    是否必填
    Bucket
    被删除清单任务的存储桶,格式为 BucketName-APPID ,详情请参见 命名规范
    String
    Id
    清单任务的名称,合法字符:a-z,A-Z,0-9,-,_,.
    String

    返回结果说明

    该方法返回值为 None。
    联系我们

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

    技术支持

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

    7x24 电话支持