Inventory

Note

This document provides an overview of inventory's API and SDK sample code.

Set up inventory job

Function description

PUT Bucket inventory is used to create inventory and job in Bucket.

Method prototype

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

Request Sample

try {
    $result = $cosClient->putBucketInventory(array(
        'Bucket' => 'examplebucket-1250000000', 
        '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";
}

Parameter description

For other inventory configuration parameters, please refer to API Documentation.

Error code description

Some common special errors that may occur in this request are as follows:

Inquire about inventory job

Function description

The GET Bucket inventory API is used to query the inventory task information in a bucket.

Method prototype

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

Request Sample

try {
    $result = $cosClient->getBucketInvnetory(array(
        'Bucket' => 'examplebucket-1250000000', 
        'Id' => 'string',
    ));
    print_r($result);
} catch (\Exception $e) {
    echo($e);
}

Parameter description

Return an example of the 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****
)

Return result description

Delete inventory job

Function description

DELETE Bucket inventory deletes inventory and job as specified in Bucket.

Method prototype

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

Request Sample

try {
    $result = $cosClient->deleteBucketInvnetory(array(
        'Bucket' => 'examplebucket-1250000000', 
        'Id' => 'string',
    ));
    print_r($result);
} catch (\Exception $e) {
    echo($e);
}

Parameter description