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 following table lists only the request parameters unique to this interface and some common parameters. For more information, see common parameters.

Parameter	Type	Required	Example Value	Description
Action	String	yes	ScheduleSecretDeletion	the action to perform, values: ScheduleSecretDeletion.
Version	String	yes	2021-02-18	API version, value: 2021-02-18.
SecretName	String	yes	secret-9527	Secret name, length between 2 and 128 characters. Allowed characters: [a-zA-Z0-9/_+=.@-]
ForceDelete	Boolean	No	false	Delete immediately
PendingWindowInDays	Integer	No	7	Pre-deletion period for the secret. Within this period, you can revoke the deletion of secrets in pending deletion status; after this period, deletion cannot be undone. Range: 7 to 30. Unit: days. Default: 7.

Response parameters

This API has no unique return parameters. For more information, see Response Structure.

Request example

GET /?Action=ScheduleSecretDeletion&Version=2021-02-18&SecretName=secret-9527&ForceDelete=false&PendingWindowInDays=7 HTTP/1.1 
Host: kms.cn-beijing.volcengineapi.com 
X-Date: 20240808T080534Z 
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240808/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

Response example

{ 
  "ResponseMetadata": { 
    "RequestId": "20240808160557217199219074153C9E", 
    "Action": "ScheduleSecretDeletion", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  }, 
  "Result": {} 
}

Error code

The table below lists the error codes related to the business logic of this API. For public error codes, refer to the Public Error Codes document.

Status Code	Error Code	Error Message
400	InvalidParameter	The request parameter %s is invalid.
400	InvalidSecretStatus	The secret status [PendingDelete] does not allow to perform this action.
403	Reject.Throttling.Action	The request of Action: %s upper limit is exceeded.
403	AccessDenied	User is not authorized to do this action
404	Not Found	Not found %s [%s].
500	UndefinedError	Undefined Internal Error. Pls Contact With Admin.

Last updated: 2025.06.27 15:24:19

Key Management System

debug #

request parameters #

Response parameters #

Request example #