Deleting Secrets in Batches

Function

This API is used to delete secrets in batches immediately. The 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	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
instance_id	No	String	ID of the Huawei Cloud service instance associated with the secret, for example, the RDS instance ID. The request will delete all secrets associated with the instance ID in batches. This operation cannot be undone.
instance_type	No	String	Type of the Huawei Cloud service, which can be RDS, TaurusDB, GaussDB, or APIG.

Response Parameters

Status code: 200

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

**Table 5** FailedDeletedSecrets
Parameter	Type	Description
secret_name	String	Secret name.
error_msg	String	Cause of the secret deletion failure.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 502

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 504

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

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."
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	Username and password are required for the requested page.
403	Authentication failed.
404	The resource does not exist.
500	Internal server error.
502	Failed to complete the request. The server has received an invalid response.
504	Gateway timed out.