清单

简介

本文档提供关于清单的 API 概览以及 SDK 示例代码。

设置清单任务

功能说明

PUT Bucket inventory 用于在存储桶中创建清单任务，您可以对清单任务命名后，使用该请求创建清单任务，详细信息请参见 清单功能概述。

注意：

• COS 支持在每个存储桶中创建最多1000条清单任务。
• 您必须在目标存储桶中写入存储桶策略，以供 COS 将清单任务的结果文件写入该存储桶中。
• 调用该请求时，请确保您有足够的权限对存储桶的清单任务进行操作。存储桶所有者默认拥有该权限，若您无该项权限，请先向存储桶所有者申请该项操作的权限。

请求示例

示例1：创建清单任务，并设置服务端加密。

cos.putBucketInventory({
    Bucket: 'sourcebucket-1250000000',  /* 必须 */
    Region: 'ap-beijing',               /* 必须 */
    Id: 'inventory_test',               /* 必须 */
    InventoryConfiguration: {
        Id: 'inventory_test',
        IsEnabled: 'true',
        Destination: {
            COSBucketDestination: {
                Format: 'CSV',
                AccountId: '100000000001',
                Bucket: 'qcs::cos:ap-beijing::targetbucket-1250000000',
                Prefix: 'inventory_test_prefix',
                Encryption: {
                    SSECOS: ''
                }
            }
        },
        Schedule: {
            Frequency: 'Daily'
        },
        Filter: {
            Prefix: 'filter_prefix'
        },
        IncludedObjectVersions: 'All',
        OptionalFields: [
            'Size',
            'LastModifiedDate',
            'StorageClass',
            'ETag'
        ]
    }
}, function(err, data) {
    console.log(err || data);
});

示例2：创建清单任务，不设置服务端加密。

cos.putBucketInventory({
    Bucket: 'sourcebucket-1250000000', /* 必须 */
    Region: 'ap-beijing',    /* 必须 */
    Id: 'inventory_test',       /* 必须 */
    InventoryConfiguration: {
        Id: 'inventory_test',
        IsEnabled: 'true',
        Destination: {
            COSBucketDestination: {
                Format: 'CSV',
                AccountId: '100000000001',
                Bucket: 'qcs::cos:ap-beijing::targetbucket-1250000000',
                Prefix: 'inventory_test_prefix'
            }
        },
        Schedule: {
            Frequency: 'Daily'
        },
        Filter: {
            Prefix: 'filter_prefix'
        },
        IncludedObjectVersions: 'All',
        OptionalFields: [
            'Size',
            'LastModifiedDate',
            'StorageClass',
            'ETag'
        ]
    }
}, function(err, data) {
    console.log(err || data);
});

参数说明

回调函数说明

function(err, data) { ... }

查询清单任务

功能说明

GET Bucket inventory 用于查询存储桶中用户的清单任务信息。用户在发起该请求时，需要用户提供清单任务的名称，发起该请求时需获得请求签名，表明该请求已获得许可。有关清单的详细介绍，请参见 清单功能概述。

注意：

• 调用该请求时，请确保您有足够的权限对存储桶的清单任务进行操作。
• 存储桶所有者默认拥有该权限，若您无该项权限，请先向存储桶所有者申请该项操作的权限。

请求示例

cos.getBucketInventory({
    Bucket: 'sourcebucket-1250000000',  /* 必须 */
    Region: 'ap-beijing',               /* 必须 */
    Id: 'inventory_test'                /* 必须 */
}, function(err, data) {
    console.log(err || data);
});

返回示例

{
    "InventoryConfiguration": {
        "Id":"inventory_test",
        "IsEnabled":"true",
        "Destination":{
            "COSBucketDestination": {
                "Format":"CSV",
                "AccountId":"100000000001",
                "Bucket":"qcs::cos:ap-beijing::targetbucket-1250000000",
                "Prefix":"inventory_test_prefix",
                "Encryption": {
                    "SSECOS":""
                }
            }
        },
        "Schedule": {
            "Frequency":"Daily"
        },
        "Filter": {
            "Prefix":"filter_prefix"
        },
        "IncludedObjectVersions":"All",
        "OptionalFields": [
            "Size",
            "LastModifiedDate",
            "StorageClass",
            "ETag"
        ]
    }
    "statusCode": 200,
    "headers": {}
}

参数说明

回调函数说明

function(err, data) { ... }

删除清单任务

功能说明

DELETE Bucket inventory 用于删除存储桶中指定的清单任务，用户需提供待删除的清单任务的名称。
有关清单的详细介绍，请参见 清单功能概述。

注意：

• 调用该请求时，请确保您有足够的权限对存储桶的清单任务进行操作。
• 存储桶所有者默认拥有该权限，如您无该项权限，请先向存储桶所有者申请该项操作的权限。

请求示例

cos.deleteBucketInventory({
    Bucket: 'sourcebucket-1250000000',  /* 必须 */
    Region: 'ap-beijing',               /* 必须 */
    Id: 'inventory_test'                /* 必须 */
}, function(err, data) {
    console.log(err || data);
});

参数说明

回调函数说明

function(err, data) { ... }