DeleteSecret - Key Management Service - Alibaba Cloud Documentation Center

Deletes a secret.

Operation description

If you call this operation without specifying a recovery period, the deleted secret can be recovered within 30 days.

If you specify a recovery period, the deleted secret can be recovered within the recovery period. You can also forcibly delete a secret. A forcibly deleted secret cannot be recovered.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SecretName	string	Yes	The name of the secret.	secret001
ForceDeleteWithoutRecovery	string	No	Specifies whether to forcibly delete the secret. If this parameter is set to true, the secret cannot be recovered. Valid values: true false (default value)	false
RecoveryWindowInDays	string	No	Specifies the recovery period of the secret if you do not forcibly delete it. Default value: 30. Unit: Days.	10

Response parameters

Parameter	Type	Description	Example
	object
SecretName	string	The name of the secret.	secret001
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	38bbed2a-15e0-45ad-98d4-816ad2ccf4ea
PlannedDeleteTime	string	The time when the secret is scheduled to be deleted.	2022-09-15T07:02:14Z

Examples

Sample success responses

JSONformat

{
  "SecretName": "secret001",
  "RequestId": "38bbed2a-15e0-45ad-98d4-816ad2ccf4ea",
  "PlannedDeleteTime": "2022-09-15T07:02:14Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is not valid.	An invalid value is specified for the parameter.
404	Forbidden.ResourceNotFound	Resource not found	-
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	-
409	Rejected.ResourceInDeleteWindow	secret in delete peroid	-
500	InternalFailure	Internal Failure	-

For a list of error codes, visit the Service error codes.