tencent cloud

Overview

This document provides an overview of APIs and SDK code samples for COS inventory.

Creating an Inventory Job

Description

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

Method prototype

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

Sample request

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging
# In most cases, set the log level to INFO. If you need to debug, you can set it to DEBUG and the SDK will print the communication information of the client.
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
# 1. Set user attributes such as secret_id, secret_key, and region. Appid has been removed from CosConfig and thus needs to be specified in Bucket, which is formatted as BucketName-Appid.
secret_id = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
scheme = 'https'           # Specify whether to use HTTP or HTTPS protocol to access COS. This field is optional and is `https` by default
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'
      }
  }
)

Parameter description

Response description

This API returns None.

Error codes

The following describes some common errors that may occur when you call this API:

Querying Inventory Jobs

Description

This API is used to query the inventory jobs of a bucket.

Method prototype

get_bucket_inventory(Bucket, Id, **kwargs)

Sample request

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging
# In most cases, set the log level to INFO. If you need to debug, you can set it to DEBUG and the SDK will print the communication information of the client.
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
# 1. Set user attributes such as secret_id, secret_key, and region. Appid has been removed from CosConfig and thus needs to be specified in Bucket, which is formatted as BucketName-Appid.
secret_id = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
scheme = 'https'           # Specify whether to use HTTP or HTTPS protocol to access COS. This field is optional and is `https` by default
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'
)

Parameter description

Response description

Inventory job configuration of the bucket in dict type.

{
  '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'
  }
}

Deleting an Inventory Job

Description

This API is used to delete a specified inventory job from a bucket.

Method prototype

delete_bucket_inventory(Bucket, Id, **kwargs)

Sample request

# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import logging
# In most cases, set the log level to INFO. If you need to debug, you can set it to DEBUG and the SDK will print the communication information of the client.
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
# 1. Set user attributes such as secret_id, secret_key, and region. Appid has been removed from CosConfig and thus needs to be specified in Bucket, which is formatted as BucketName-Appid.
secret_id = 'SecretId'     # Replace it with the actual SecretId, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
secret_key = 'SecretKey'     # Replace it with the actual SecretKey, which can be viewed and managed at https://console.intl.cloud.tencent.com/cam/capi
region = 'ap-beijing'      # Replace it with the actual region, which can be viewed in the console at https://console.intl.cloud.tencent.com/cos5/bucket
                         # For the list of regions supported by COS, see https://intl.cloud.tencent.com/document/product/436/6224
token = None               # Token is required for temporary keys but not permanent keys. For more information about how to generate and use a temporary key, visit https://intl.cloud.tencent.com/document/product/436/14048
scheme = 'https'           # Specify whether to use HTTP or HTTPS protocol to access COS. This field is optional and is `https` by default
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'
)

Parameter description

Response description

This API returns None.