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 the specific request parameters and some common parameters for this interface. For more information, see common parameters.

Parameter	Type	Required	Example Value	Description
Action	String	yes	ArchiveKey	The action to perform, value: ArchiveKey.
Version	String	Yes	2021-02-18	API version, value: 2021-02-18.
KeyID	String	No	39a0e7c6-b7dd-4c83-b400-3449bb95403a	Primary key ID, choose one of two: KeyringName and KeyName KeyID
KeyringName	String	No	keyring-test	Keyring name, length between 2 and 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-_]

response parameters

This API has no unique response parameters. For more information, see response structure.

Request example

GET /?Action=ArchiveKey&Version=2021-02-18&KeyringName=demo&KeyName=demo HTTP/1.1 
Host: kms.cn-beijing.volcengineapi.com 
X-Date: 20240708T082605Z 
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

Response example

{ 
  "ResponseMetadata": { 
    "RequestId": "20240708162618205044209092C4EF3E", 
    "Action": "ArchiveKey", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  } 
}

Error Code

The following table lists the error codes related to this interface and business logic. For common error codes, please refer to the Common Error Codes document.

Status Code	Error Code	Error Message
400	InvalidParameter	The request parameter %s is invalid.
400	InvalidKeyStatus	Current key status: %s does not allow to perform this action
403	AccessDenied	User is not authorized to do this action
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.

Last updated: 2025.06.27 15:24:16

Key Management System

Debug #

Request parameters #

response parameters #

Request example #