tencent cloud

Feedback

Restoring Archived Objects

Last updated: 2022-05-11 12:10:08

    Overview

    This document provides an overview of APIs and SDK code samples for restoring an archived object.

    API Operation Description
    POST Object restore Restoring an archived object Restores an archived object for access.

    Restoring an Archived Object

    Description

    This API (POST Object restore) is used to restore an archived object for access.

    Method prototype

    restore_object(Bucket, Key, RestoreRequest={}, **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.restore_object(
      Bucket='examplebucket-1250000000',
      Key='exampleobject',
      RestoreRequest={
          'Days': 100,
          'CASJobParameters': {
              'Tier': 'Standard'
          }
      }
    )
    

    Sample request with all parameters

    response = client.restore_object(
      Bucket='examplebucket-1250000000',
      Key='exampleobject',
      RestoreRequest={
          'Days': 100,
          'CASJobParameters': {
              'Tier': 'Expedited'|'Standard'|'Bulk'
          }
      }
    )
    

    Parameter description

    Parameter Description Type Required
    Bucket Bucket name in the format of BucketName-APPID String Yes
    Key Object key, which uniquely identifies an object in a bucket. For example, if an object's access endpoint is examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg, its key is doc/pic.jpg. String Yes
    RestoreRequest Rules for restoration Dict Yes
    Days Number of days before the temporary object expires Int Yes
    CASJobParameters Configuration of the restoration mode Dict No
    Tier Object restoration mode. For ARCHIVE objects, valid values are Expedited, Standard, and Bulk. For DEEP ARCHIVE objects, valid values are Standard and Bulk String No

    Response description

    This API returns None.

    Contact Us

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

    Technical Support

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

    7x24 Phone Support