Deleting Secrets in Batches

Function

This API is used to delete secrets in batches immediately. This operation cannot be undone.

Constraints

Secrets deleted in batches via this API cannot be restored.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/secrets/batch-delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
instance_id	No	String	Definition ID of the cloud service instance associated with the secret, for example, the RDS instance ID. This request deletes all secrets associated with the instance ID in batches. This operation cannot be undone. Constraints N/A Range N/A Default Value N/A
instance_type	No	String	Definition Cloud service type, which can be RDS, TaurusDB, GaussDB, or APIG. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Definition Number of secrets that meet the request parameter conditions. Range N/A
success_secrets	Array of strings	Definition Secrets that meet the request parameter conditions and are deleted. Range N/A
failed_secrets	Array of FailedDeletedSecrets objects	Definition Secrets that meet the request parameter conditions but fail to be deleted, and the failure cause. Range N/A

**Table 5** FailedDeletedSecrets
Parameter	Type	Description
secret_name	String	Definition Secret name Range N/A
error_msg	String	Definition Reason for secret deletion failure Range N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 3,
  "success_secrets" : [ "secretName1", "secretName2" ],
  "failed_secrets" : [ {
    "secret_name" : "secretName3",
    "error_msg" : "CSMS.0107: Secret is already in the **Pending deletion** state."
  } ]
}