tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Key Management Service
    Documentation
    Download PDF

    Decrypt

    Last updated: 2022-01-18 17:21:48
    Download PDF

    1. API Description

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

    This API is used to decrypt the ciphertext and obtain the plaintext data.

    A maximum of 300 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.
    This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: Decrypt.
    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.
    CiphertextBlob Yes String The ciphertext data to be decrypted.
    EncryptionContext No String JSON string of key-value pair. If this parameter is specified for Encrypt, the same parameter needs to be provided when the Decrypt API is called. The maximum length is 1,024 bytes.
    EncryptionPublicKey No String PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the Plaintext returned. If this field is left empty, the Plaintext will not be encrypted.
    EncryptionAlgorithm No String Asymmetric encryption algorithm. Valid values: SM2(C1C3C2), RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, and RSAES_OAEP_SHA_256. This field is used in combination with EncryptionPublicKey for encryption. If it is left empty, a SM2 public key will be used by default.

    3. Output Parameters

    Parameter Name Type Description
    KeyId String Globally unique CMK ID
    Plaintext String If EncryptionPublicKey is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
    If EncryptionPublicKey is specified, this field will return the Base64-encoded ciphertext encrypted with the specified public key. To get the plaintext, you need to decode the ciphertext and upload the corresponding private key.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Decrypting

    Decrypt ciphertext.

    Input Example

    https://kms.tencentcloudapi.com/?Action=Decrypt
&CiphertextBlob=Ade234dasdeEWdGVzdCUyMHBsYWlJJlIHL
&<Common request parameters>

    Output Example

    {
  "Response": {
    "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
    "Plaintext": "dGVzdCUyMHBsYWluJTIwdGV4dA==",
    "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.EncryptionError Encryption failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue.InvalidCiphertext Incorrect ciphertext format
    ResourceUnavailable.CmkDisabled The CMK has been disabled.
    ResourceUnavailable.CmkNotFound The CMK does not exist.
    UnauthorizedOperation Unauthorized operation.
    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
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy