tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    Inventory

    Last updated: 2024-02-02 14:36:36
    Download PDF

      Overview

      This document provides an overview of APIs and SDK code samples related to COS inventory.
      API
      Operation
      Description
      Creating an inventory job
      Creates an inventory job for a bucket
      Querying inventory jobs
      Queries the inventory jobs of a bucket
      Deleting an inventory job
      Deletes an inventory job from a bucket

      Creating an Inventory Job

      Description

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

      Sample code

      try
      {
        string inventoryId = "aInventoryId";
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        PutBucketInventoryRequest putRequest = new PutBucketInventoryRequest(bucket, inventoryId);
        putRequest.SetDestination("CSV", "100000000001", "examplebucket-1250000000", "ap-guangzhou","list1");
        putRequest.IsEnable(true);
        putRequest.SetScheduleFrequency("Daily");
        // Execute the request
        PutBucketInventoryResult putResult = cosXml.PutBucketInventory(putRequest); 
      
        // Request succeeded
        Console.WriteLine(putResult.GetResultInfo());
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.

      Error codes

      The following describes some common errors that may occur when you call this API:
      Error Code
      Description
      Status Code
      InvalidArgument
      Invalid parameter value
      HTTP 400 Bad Request
      TooManyConfigurations
      The number of inventories has reached the upper limit of 1,000
      HTTP 400 Bad Request
      AccessDenied
      Unauthorized access. You most likely do not have access permission for the bucket
      HTTP 403 Forbidden

      Querying Inventory Jobs

      Description

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

      Sample code

      try
      {
        string inventoryId = "aInventoryId";
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        GetBucketInventoryRequest getRequest = new GetBucketInventoryRequest(bucket);
        getRequest.SetInventoryId(inventoryId);
      
        GetBucketInventoryResult getResult = cosXml.GetBucketInventory(getRequest);
      
        InventoryConfiguration configuration = getResult.inventoryConfiguration;
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.

      Deleting an Inventory Job

      Description

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

      Sample code

      try
      {
        string inventoryId = "aInventoryId";
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        DeleteBucketInventoryRequest deleteRequest = new DeleteBucketInventoryRequest(bucket);
        deleteRequest.SetInventoryId(inventoryId);
        DeleteBucketInventoryResult deleteResult = cosXml.DeleteBucketInventory(deleteRequest);
      
        // Request succeeded
        Console.WriteLine(deleteResult.GetResultInfo());
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy