tencent cloud

Overview

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

Creating an Inventory Job

Description

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

Method prototype

cos_status_t *cos_put_bucket_inventory(const cos_request_options_t *options,
                                    const cos_string_t *bucket,
                                    cos_inventory_params_t *inventory_params,
                                    cos_table_t **resp_headers

Sample request

#include "cos_http_io.h"
#include "cos_api.h"
#include "cos_log.h"
// `endpoint` is the COS access domain name. For more information, see https://intl.cloud.tencent.com/document/product/436/6224.
static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
// A developer-owned secret ID/key used for the project. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char *TEST_ACCESS_KEY_ID;                //your secret_id
static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
// The only user-level resource identifier for COS access. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char TEST_APPID[] = "<APPID>";    //your appid
// Region information. For more information about the enumerated values (such as ap-beijing, ap-hongkong, and eu-frankfurtplease), please visit https://intl.cloud.tencent.com/document/product/436/6224?from_cn_redirect=1.
static char TEST_REGION[] = "ap-guangzhou";    //region in endpoint
// Object owner, e.g., user UIN: 100000000001
static char TEST_UIN[] = "<Uin>";    //your uin
// COS bucket name, in the format of [bucket]-[appid], for example `mybucket-1253666666`. It can be obtained at https://console.intl.cloud.tencent.com/cos5/bucket.
static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
void log_status(cos_status_t *s)
{
  cos_warn_log("status->code: %d", s->code);
  if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);
  if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);
  if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);
}
void init_test_config(cos_config_t *config, int is_cname)
{
  cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
  cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
  cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
  cos_str_set(&config->appid, TEST_APPID);
  config->is_cname = is_cname;
}
void init_test_request_options(cos_request_options_t *options, int is_cname)
{
  options->config = cos_config_create(options->pool);
  init_test_config(options->config, is_cname);
  options->ctl = cos_http_controller_create(options->pool, 0);
}
void test_put_bucket_inventory()
{
  cos_pool_t *pool = NULL;
  int is_cname = 0;
  int inum = 3, i, len;
  char buf[inum][32];
  char dest_bucket[128];
  cos_status_t *status = NULL;
  cos_request_options_t *options = NULL;
  cos_table_t *resp_headers = NULL;
  cos_string_t bucket;
  
  // Create a memory pool
  cos_pool_create(&pool, NULL);
  
  // Initialize the request options
  options = cos_request_options_create(pool);
  init_test_request_options(options, is_cname);
  cos_str_set(&bucket, TEST_BUCKET_NAME);
  
  // put bucket inventory 
  len = snprintf(dest_bucket, 128, "qcs::cos:%s::%s", TEST_REGION, TEST_BUCKET_NAME);
  dest_bucket[len] = 0;
  // Set multiple inventories
  for (i = 0; i < inum; i++) {
      cos_inventory_params_t *params = cos_create_inventory_params(pool);
      cos_inventory_optional_t *optional;
      len = snprintf(buf[i], 32, "id%d", i);
      buf[i][len] = 0;
      cos_str_set(&params->id, buf[i]);
      cos_str_set(&params->is_enabled, "true");
      cos_str_set(&params->frequency, "Daily");
      cos_str_set(&params->filter_prefix, "myPrefix");
      cos_str_set(&params->included_object_versions, "All");
      cos_str_set(&params->destination.format, "CSV");
      cos_str_set(&params->destination.account_id, TEST_UIN);
      cos_str_set(&params->destination.bucket, dest_bucket);
      cos_str_set(&params->destination.prefix, "invent");
      params->destination.encryption = 1;
      optional = cos_create_inventory_optional(pool);
      cos_str_set(&optional->field, "Size");
      cos_list_add_tail(&optional->node, &params->fields);
      optional = cos_create_inventory_optional(pool);
      cos_str_set(&optional->field, "LastModifiedDate");
      cos_list_add_tail(&optional->node, &params->fields);
      optional = cos_create_inventory_optional(pool);
      cos_str_set(&optional->field, "ETag");
      cos_list_add_tail(&optional->node, &params->fields);
      optional = cos_create_inventory_optional(pool);
      cos_str_set(&optional->field, "StorageClass");
      cos_list_add_tail(&optional->node, &params->fields);
      optional = cos_create_inventory_optional(pool);
      cos_str_set(&optional->field, "ReplicationStatus");
      cos_list_add_tail(&optional->node, &params->fields);
  
      // Set bucket inventory
      status = cos_put_bucket_inventory(options, &bucket, params, &resp_headers);
      log_status(status);
  }
   // Destroy the memory pool
  cos_pool_destroy(pool);
}
int main(int argc, char *argv[])
{
  // Get SecretId and SecretKey from environment variables
  TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
  TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
    if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
     exit(1);
  }
   //set log level, default COS_LOG_WARN
  cos_log_set_level(COS_LOG_WARN);
   //set log output, default stderr
  cos_log_set_output(NULL);
   test_put_bucket_inventory();
   cos_http_io_deinitialize();
   return 0;
}

Parameter description

Response description

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

cos_status_t *cos_get_bucket_inventory(const cos_request_options_t *options,
                                    const cos_string_t *bucket,
                                    cos_inventory_params_t *inventory_params,
                                    cos_table_t **resp_headers);

Sample request

#include "cos_http_io.h"
#include "cos_api.h"
#include "cos_log.h"
// `endpoint` is the COS access domain name. For more information, see https://intl.cloud.tencent.com/document/product/436/6224.
static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
// A developer-owned secret ID/key used for the project. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char *TEST_ACCESS_KEY_ID;                //your secret_id
static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
// The only user-level resource identifier for COS access. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char TEST_APPID[] = "<APPID>";    //your appid
// COS bucket name, in the format of [bucket]-[appid], for example `mybucket-1253666666`. It can be obtained at https://console.intl.cloud.tencent.com/cos5/bucket.
static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
void log_status(cos_status_t *s)
{
  cos_warn_log("status->code: %d", s->code);
  if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);
  if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);
  if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);
}
void init_test_config(cos_config_t *config, int is_cname)
{
  cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
  cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
  cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
  cos_str_set(&config->appid, TEST_APPID);
  config->is_cname = is_cname;
}
void init_test_request_options(cos_request_options_t *options, int is_cname)
{
  options->config = cos_config_create(options->pool);
  init_test_config(options->config, is_cname);
  options->ctl = cos_http_controller_create(options->pool, 0);
}
void test_get_bucket_inventory()
{
  cos_pool_t *pool = NULL;
  int is_cname = 0;
  int inum = 3;
  char buf[inum][32];
  cos_status_t *status = NULL;
  cos_request_options_t *options = NULL;
  cos_table_t *resp_headers = NULL;
  cos_string_t bucket;
  cos_inventory_params_t *get_params = NULL;
  cos_inventory_optional_t *optional = NULL;
  
  // Create a memory pool
  cos_pool_create(&pool, NULL);
  
  // Initialize the request options
  options = cos_request_options_create(pool);
  init_test_request_options(options, is_cname);
  cos_str_set(&bucket, TEST_BUCKET_NAME);
  
  // get inventory 
  get_params = cos_create_inventory_params(pool);
  cos_str_set(&get_params->id, buf[inum/2]);
  status = cos_get_bucket_inventory(options, &bucket, get_params, &resp_headers);
  log_status(status); 
   printf("id: %s\nis_enabled: %s\nfrequency: %s\nfilter_prefix: %s\nincluded_object_versions: %s\n", 
          get_params->id.data, get_params->is_enabled.data, get_params->frequency.data, get_params->filter_prefix.data, get_params->included_object_versions.data);
  printf("destination:\n");
  printf("\tencryption: %d\n", get_params->destination.encryption);
  printf("\tformat: %s\n", get_params->destination.format.data);
  printf("\taccount_id: %s\n", get_params->destination.account_id.data);
  printf("\tbucket: %s\n", get_params->destination.bucket.data);
  printf("\tprefix: %s\n", get_params->destination.prefix.data);
  cos_list_for_each_entry(cos_inventory_optional_t, optional, &get_params->fields, node) {
      printf("field: %s\n", optional->field.data);
  }
   // Destroy the memory pool
  cos_pool_destroy(pool);
}
int main(int argc, char *argv[])
{
  // Get SecretId and SecretKey from environment variables
  TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
  TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
    if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
     exit(1);
  }
   //set log level, default COS_LOG_WARN
  cos_log_set_level(COS_LOG_WARN);
   //set log output, default stderr
  cos_log_set_output(NULL);
   test_get_bucket_inventory();
   cos_http_io_deinitialize();
   return 0;
}

Parameter description

Response description

Querying All Inventories

Description

This API is used to query all inventory jobs set for a bucket. You can configure up to 1,000 inventory jobs for a bucket.

Method prototype

cos_status_t *cos_list_bucket_inventory(const cos_request_options_t *options,
                                    const cos_string_t *bucket,
                                    cos_list_inventory_params_t *inventory_params,
                                    cos_table_t **resp_headers);

Sample request

#include "cos_http_io.h"
#include "cos_api.h"
#include "cos_log.h"
// `endpoint` is the COS access domain name. For more information, see https://intl.cloud.tencent.com/document/product/436/6224.
static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
// A developer-owned secret ID/key used for the project. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char *TEST_ACCESS_KEY_ID;                //your secret_id
static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
// The only user-level resource identifier for COS access. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char TEST_APPID[] = "<APPID>";    //your appid
// COS bucket name, in the format of [bucket]-[appid], for example `mybucket-1253666666`. It can be obtained at https://console.intl.cloud.tencent.com/cos5/bucket.
static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
void log_status(cos_status_t *s)
{
  cos_warn_log("status->code: %d", s->code);
  if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);
  if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);
  if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);
}
void init_test_config(cos_config_t *config, int is_cname)
{
  cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
  cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
  cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
  cos_str_set(&config->appid, TEST_APPID);
  config->is_cname = is_cname;
}
void init_test_request_options(cos_request_options_t *options, int is_cname)
{
  options->config = cos_config_create(options->pool);
  init_test_config(options->config, is_cname);
  options->ctl = cos_http_controller_create(options->pool, 0);
}
void test_list_bucket_inventory()
{
  cos_pool_t *pool = NULL;
  int is_cname = 0;
  cos_status_t *status = NULL;
  cos_request_options_t *options = NULL;
  cos_table_t *resp_headers = NULL;
  cos_string_t bucket;
  cos_inventory_params_t *get_params = NULL;
  cos_inventory_optional_t *optional = NULL;
  cos_list_inventory_params_t *list_params = NULL;
  
  // Create a memory pool
  cos_pool_create(&pool, NULL);
  
  // Initialize the request options
  options = cos_request_options_create(pool);
  init_test_request_options(options, is_cname);
  cos_str_set(&bucket, TEST_BUCKET_NAME);
  
  // list inventory
  list_params = cos_create_list_inventory_params(pool); 
  status = cos_list_bucket_inventory(options, &bucket, list_params, &resp_headers);
  log_status(status);
   // View results
  get_params = NULL;
  cos_list_for_each_entry(cos_inventory_params_t, get_params, &list_params->inventorys, node) {
      printf("id: %s\nis_enabled: %s\nfrequency: %s\nfilter_prefix: %s\nincluded_object_versions: %s\n",  get_params->id.data, get_params->is_enabled.data, get_params->frequency.data, get_params->filter_prefix.data, get_params->included_object_versions.data);
      printf("destination:\n");
      printf("\tencryption: %d\n", get_params->destination.encryption);
      printf("\tformat: %s\n", get_params->destination.format.data);
      printf("\taccount_id: %s\n", get_params->destination.account_id.data);
      printf("\tbucket: %s\n", get_params->destination.bucket.data);
      printf("\tprefix: %s\n", get_params->destination.prefix.data);
      cos_list_for_each_entry(cos_inventory_optional_t, optional, &get_params->fields, node) {
          printf("field: %s\n", optional->field.data);
      }
  }
   // Destroy the memory pool
  cos_pool_destroy(pool);
}
int main(int argc, char *argv[])
{
  // Get SecretId and SecretKey from environment variables
  TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
  TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
    if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
     exit(1);
  }
   //set log level, default COS_LOG_WARN
  cos_log_set_level(COS_LOG_WARN);
   //set log output, default stderr
  cos_log_set_output(NULL);
   test_list_bucket_inventory();
   cos_http_io_deinitialize();
   return 0;
}

Parameter description

Response description

Deleting an Inventory Job

Description

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

Method prototype

cos_status_t *cos_delete_bucket_inventory(const cos_request_options_t *options,
                                    const cos_string_t *bucket,
                                    const cos_string_t *id,
                                    cos_table_t **resp_headers);

Sample request

#include "cos_http_io.h"
#include "cos_api.h"
#include "cos_log.h"
// `endpoint` is the COS access domain name. For more information, see https://intl.cloud.tencent.com/document/product/436/6224.
static char TEST_COS_ENDPOINT[] = "cos.ap-guangzhou.myqcloud.com";
// A developer-owned secret ID/key used for the project. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char *TEST_ACCESS_KEY_ID;                //your secret_id
static char *TEST_ACCESS_KEY_SECRET;            //your secret_key
// The only user-level resource identifier for COS access. It can be obtained at https://console.intl.cloud.tencent.com/cam/capi.
static char TEST_APPID[] = "<APPID>";    //your appid
// COS bucket name, in the format of [bucket]-[appid], for example `mybucket-1253666666`. It can be obtained at https://console.intl.cloud.tencent.com/cos5/bucket.
static char TEST_BUCKET_NAME[] = "<bucketname-appid>";
void log_status(cos_status_t *s)
{
  cos_warn_log("status->code: %d", s->code);
  if (s->error_code) cos_warn_log("status->error_code: %s", s->error_code);
  if (s->error_msg) cos_warn_log("status->error_msg: %s", s->error_msg);
  if (s->req_id) cos_warn_log("status->req_id: %s", s->req_id);
}
void init_test_config(cos_config_t *config, int is_cname)
{
  cos_str_set(&config->endpoint, TEST_COS_ENDPOINT);
  cos_str_set(&config->access_key_id, TEST_ACCESS_KEY_ID);
  cos_str_set(&config->access_key_secret, TEST_ACCESS_KEY_SECRET);
  cos_str_set(&config->appid, TEST_APPID);
  config->is_cname = is_cname;
}
void init_test_request_options(cos_request_options_t *options, int is_cname)
{
  options->config = cos_config_create(options->pool);
  init_test_config(options->config, is_cname);
  options->ctl = cos_http_controller_create(options->pool, 0);
}
void test_delete_bucket_inventory()
{
  cos_pool_t *pool = NULL;
  int is_cname = 0;
  cos_status_t *status = NULL;
  cos_request_options_t *options = NULL;
  cos_table_t *resp_headers = NULL;
  cos_string_t bucket;
  int inum = 3, i;
  char buf[inum][32];
  
  // Create a memory pool
  cos_pool_create(&pool, NULL);
  
  // Initialize the request options
  options = cos_request_options_create(pool);
  init_test_request_options(options, is_cname);
  cos_str_set(&bucket, TEST_BUCKET_NAME);
  
  // delete inventory
  for (i = 0; i < inum; i++) {
      cos_string_t id;
      cos_str_set(&id, buf[i]);
      status = cos_delete_bucket_inventory(options, &bucket, &id, &resp_headers);
      log_status(status);
  }
   // Destroy the memory pool
  cos_pool_destroy(pool);
}
int main(int argc, char *argv[])
{
  // Get SecretId and SecretKey from environment variables
  TEST_ACCESS_KEY_ID     = getenv("COS_SECRETID");
  TEST_ACCESS_KEY_SECRET = getenv("COS_SECRETKEY");
    if (cos_http_io_initialize(NULL, 0) != COSE_OK) {
     exit(1);
  }
   //set log level, default COS_LOG_WARN
  cos_log_set_level(COS_LOG_WARN);
   //set log output, default stderr
  cos_log_set_output(NULL);
   test_delete_bucket_inventory();
   cos_http_io_deinitialize();
   return 0;
}

Parameter description

Response description