清单

简介

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

设置清单任务

功能说明

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

方法原型

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

请求示例

try {
   $result = $cosClient->putBucketInventory(array(
       'Bucket' => 'examplebucket-1250000000', //格式：BucketName-APPID
       'Id' => 'string',
       'Destination' => array(
           'COSBucketDestination'=>array(
               'Format' => 'CSV',
               'AccountId' => '100000000001',
               'Bucket' => 'qcs::cos:ap-chengdu::examplebucket-1250000000',
               'Prefix' => 'string',
           )
       ),      
       'IsEnabled' => 'True',
       'Schedule' => array(
           'Frequency' => 'Daily',
       ),  
       'Filter' => array(
           'Prefix' => 'string',
       ),  
       'IncludedObjectVersions' => 'Current',
       'OptionalFields' => array(
           'Size', 
           'ETag',
       )
   ));
   // 请求成功
   print_r($result);
} catch (\Exception $e) {
   // 请求失败
   echo "$e\n";
}

参数说明

其他清单配置参数请参考API文档。

错误码说明

该请求可能会发生的一些常见的特殊错误如下：

查询清单任务

功能说明

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

方法原型

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

请求示例

try {
   $result = $cosClient->getBucketInvnetory(array(
       'Bucket' => 'examplebucket-1250000000', //格式：BucketName-APPID
       'Id' => 'string',
   ));
   // 请求成功
   print_r($result);
} catch (\Exception $e) {
   // 请求失败
   echo($e);
}

参数说明

返回结果示例

GuzzleHttp\Command\Result Object
(
  [Destination] => Array
      (
          [COSBucketDestination] => Array
              (
                  [Format] => CSV
                  [AccountId] => 100000000001
                  [Bucket] => qcs::cos:ap-chengdu::examplebucket-1250000000
                  [Prefix] => String
              )
       )
   [Schedule] => Array
      (
          [Frequency] => Daily
      )
   [OptionalFields] => Array
      (
          [0] => Size
          [1] => ETag
      )
   [IsEnabled] => true
  [Id] => string
  [IncludedObjectVersions] => Current
  [RequestId] => NWRmMzQwMDVfMjNiMjU4NjRfOGQ4MV9iN2Jk****
)

返回结果说明

删除清单任务

功能说明

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

方法原型

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

请求示例

try {
   $result = $cosClient->deleteBucketInvnetory(array(
       'Bucket' => 'examplebucket-1250000000', //格式：BucketName-APPID
       'Id' => 'string',
   ));
   // 请求成功
   print_r($result);
} catch (\Exception $e) {
   // 请求失败
   echo($e);
}

参数说明