Overview

This document provides an overview of APIs and SDK code samples related to inventory.

Setting Inventory Job

Feature description

This API (PUT Bucket inventory) is used to create an inventory job in a bucket.

Method prototype

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

Sample request

try {
   $result = $cosClient->putBucketInventory(array(
       'Bucket' => 'examplebucket-1250000000', // Format: 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',
       )
   ));
   // Request succeeded
   print_r($result);
} catch (\Exception $e) {
   // Request failed
   echo "$e\n";
}

Parameter description

For more information on other inventory configuration parameters, please see the API documentation.

Error code description

Some frequent special errors that may occur with this request are listed below:

Querying Inventory Job

Feature description

This API (GET Bucket inventory) is used to query the inventory job information in a bucket.

Method prototype

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

Sample request

try {
   $result = $cosClient->getBucketInvnetory(array(
       'Bucket' => 'examplebucket-1250000000', // Format: BucketName-APPID
       'Id' => 'string',
   ));
   // Request succeeded
   print_r($result);
} catch (\Exception $e) {
   // Request failed
   echo($e);
}

Parameter description

Sample return result

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****
)

Returned result description

Deleting Inventory Job

Feature description

This API (DELETE Bucket inventory) is used to delete a specified inventory job of a bucket.

Method prototype

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

Sample request

try {
   $result = $cosClient->deleteBucketInvnetory(array(
       'Bucket' => 'examplebucket-1250000000', // Format: BucketName-APPID
       'Id' => 'string',
   ));
   // Request succeeded
   print_r($result);
} catch (\Exception $e) {
   // Request failed
   echo($e);
}

Parameter description