PrevNext
search by keyword

Recent Pages

Documentation
Key Management Service
    Documentation
    Download PDF

    ArchiveKey

    Last updated: 2020-12-02 11:27:38
    Download PDF

    1. API Description

    Domain name for API request: kms.tencentcloudapi.com.

    This API is used to archive keys. The archived keys can only be used for decryption but not encryption.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ArchiveKey.
    Version Yes String Common parameter. The value used for this API: 2019-01-18.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    KeyId Yes String Unique CMK ID

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Archiving keys

    Input Example

    https://kms.tencentcloudapi.com/?Action=ArchiveKey
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
  }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.CmkUsedByCloudProduct The CMK is being used by a Tencent Cloud product.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.InvalidKeyId Invalid KeyId.
    ResourceUnavailable.CmkNotFound The CMK does not exist.
    ResourceUnavailable.CmkStateNotSupport This operation cannot be performed under the current CMK status.
    UnauthorizedOperation Unauthorized operation.
    UnsupportedOperation.NotUserCreatedCmk You can only update the CMKs created by you.
    UnsupportedOperation.ServiceTemporaryUnavailable The service is temporarily unavailable.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy