Domain name for API request: ssm.tencentcloudapi.com.
This API is used to delete a Secret. You can set whether to delete the Secret immediately or on schedule using the RecoveryWindowInDays
parameter. For a Secret to be deleted on schedule, its status will be PendingDelete
before the scheduled deletion time. You can use RestoreSecret
to restore a deleted Secret during this time. A deleted Secret will not be restorable after the scheduled deletion time. A Secret can only be deleted after being disabled using DisableSecret
.
A maximum of 50 requests can be initiated per second for this API.
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: DeleteSecret. |
Version | Yes | String | Common parameter. The value used for this API: 2019-09-23. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
SecretName | Yes | String | Name of the Secret to be deleted. |
RecoveryWindowInDays | No | Integer | Scheduled deletion time (in days), indicating the number of retention days for the secret. Value range: 0-30. If it is 0 , the secret is deleted immediately.For an SSH key secret, this field can only be 0 . |
CleanSSHKey | No | Boolean | Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only valid for SSH key secrets. Valid values:True : deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.False : only deletes the SSH key information in the secret. |
Parameter Name | Type | Description |
---|---|---|
SecretName | String | Name of deleted Secret. |
DeleteTime | Integer | Secret deletion time, formatted as a Unix timestamp. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://ssm.tencentcloudapi.com/?Action=DeleteSecret
&SecretName=test
&RecoveryWindowInDays=1
&<Common request parameters>
{
"Response": {
"RequestId": "2609a8fd-4584-4f89-98be-8c7ae1b81ef4",
"SecretName": "test",
"DeleteTime": 1574247268
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Operation failed. |
InternalError | An internal error occurred. |
InvalidParameterValue | The parameter value is invalid. |
ResourceNotFound | The resource does not exist. |
ResourceUnavailable.NotPurchased | The service is not purchased. |
ResourceUnavailable.ResourceUninitialized | The credential has not been initialized. |
UnauthorizedOperation | The operation is unauthorized. |
Was this page helpful?