批量删除凭据 - BatchDeleteSecrets

功能介绍

立即批量删除凭据，且无法恢复

接口约束

调用此接口批量删除凭据后，不可恢复

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。可参考获取项目ID获取。约束限制：不涉及取值范围：以IAM服务接口返回值为准，字符长度32-32 默认取值：不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。使用AK、SK等认证方式，此处非必选约束限制：不涉及取值范围： IAM服务查询用户Token接口为准默认取值：不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
instance_id	否	String	参数解释：凭据关联的云服务实例 ID（如 RDS 数据库实例 ID），请求会批量删除所有关联该实例 ID 的凭据，且无法恢复约束限制：不涉及取值范围：不涉及默认取值：不涉及
instance_type	否	String	参数解释：云服务类型，可传入类型 RDS（云数据库 RDS）、TaurusDB（云数据库 TaurusDB）、GaussDB（云数据库 GaussDB）、APIG（API 网关 APIG）约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
total	Integer	参数解释：符合请求参数条件的凭据数量取值范围：不涉及
success_secrets	Array of strings	参数解释：符合请求参数条件且删除成功的凭据取值范围：不涉及
failed_secrets	Array of FailedDeletedSecrets objects	参数解释：符合请求参数条件且删除失败的凭据，以及失败原因取值范围：不涉及

表5 FailedDeletedSecrets
参数	参数类型	描述
secret_name	String	参数解释：凭据的名称取值范围：不涉及
error_msg	String	参数解释：凭据删除失败的原因取值范围：不涉及

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total" : 3,
  "success_secrets" : [ "secretName1", "secretName2" ],
  "failed_secrets" : [ {
    "secret_name" : "secretName3",
    "error_msg" : "CSMS.0107 : 凭据已处于计划删除状态。"
  } ]
}