debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

request parameters

The table below lists only unique request parameters for this interface and some common parameters. For more information, see common parameters.

Parameter	Type	Is Required	Example Value	Description
Action	String	Yes	AsymmetricDecrypt	The operation to perform, values: AsymmetricDecrypt.
Version	String	yes	2021-02-18	API version, value: 2021-02-18.
KeyringName	String	No	keyring-test	Keyring name, length 2 - 31 characters. Valid characters: [a-zA-Z0-9-_]
KeyName	String	No	key-test	Primary key name, length 2 - 31 characters. Valid characters: [a-zA-Z0-9-_]
KeyID	String	No	39a0e7c6-b7dd-4c83-b400-3449bb95403a	Primary key ID, choose one of the following: KeyringName and KeyName KeyID
CiphertextBlob	String		43y7grE9TjamX4P7ZOHFbwAAqoNHFtMZ6RNyblKlEhIhrfP6zy034cwJN6MSqFGiDm8oiGqu2Rahs1aKPIcMjaOuodVCE1zYpDFg1QvgOHtVQxkQWhfpE8i8NibiJ1pL8ILgAE+TogQZuIglAoo=
Algorithm	String	Yes	RSAES_OAEP_SHA_256	Note: must match the algorithm used by AsymEncrypt Encryption algorithm, one of the following enumerations: RSAES_OAEP_SHA_256 SM2PKE

response parameters

The table below lists only the response parameters unique to this interface. For more information, see response structure.

Parameter	Type	Example Value	Description
KeyID	String	39a0e7c6-b7dd-4c83-b400-3449bb95403a	Unique identifier of the master key, in UUID format
Plaintext	String	encryptPlaintext=	plaintext after ciphertext decryption, Base64 encoded

request example

POST /?Action=AsymmetricDecrypt&Version=2021-02-18&KeyringName=demo&KeyName=demo&Algorithm= RSAES_OAEP_SHA_256 HTTP/1.1 
Host: kms.cn-beijing.volcengineapi.com 
Content-Type: application/json; charset=UTF-8 
X-Date: 20240708T144018Z 
X-Content-Sha256: 287e874e******d653b44d21e 
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f 

{ 
  "CiphertextBlob": "43y7grE9TjamX4P7ZOHFbwAAqoNHFtMZ6RNyblKlEhIhrfP6zy034cwJN6MSqFGiDm8oiGqu2Rahs1aKPIcMjaOuodVCE1zYpDFg1QvgOHtVQxkQWhfpE8i8NibiJ1pL8ILgAE+TogQZuIglAoo=" 
}

Response example

{ 
  "ResponseMetadata": { 
    "RequestId": "2024070822411815919311418488C93F", 
    "Action": "AsymmetricDecrypt", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  }, 
  "Result": { 
    "KeyID": "39a0e7c6-b7dd-4c83-b400-3449bb95403a", 
    "Plaintext": "encryptPlaintext=" 
  } 
}

Error Codes

The table below lists the error codes related to this interface's business logic. Refer to the Common Error Codes document for public error codes.

Status Code	Error Code	Error Message
400	MissingParameter	The request is missing %s parameter.
400	InvalidParameter	The request parameter %s is invalid.
400	InvalidKeyStatus	Current key status: %s does not allow to perform this action
400	InvalidKeyUsage	Current key usage only allows: %s. Please use different keys for encryption/decryption and signing/verification.
403	AccessDenied	User is not authorized to do this action
403	Reject.Throttling.CMK	The request of CMK: %s upper limit is exceeded.
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.

Last updated: 2025.06.27 15:24:17

Key Management System

debug #

request parameters #

response parameters #

request example #