文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 凭据管理服务/ 生命周期管理/ 批量删除凭据
更新时间：2025-09-18 GMT+08:00
查看PDF
分享

批量删除凭据

功能介绍

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

接口约束

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

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-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

凭据删除失败的原因。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：502

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：504

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

请求已成功

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

状态码

状态码

描述

200

请求已成功

400

请求参数有误

401

被请求的页面需要用户名和密码

403

认证失败

404

资源不存在，资源未找到

500

服务内部错误

502

请求未完成。服务器从上游服务器收到一个无效的响应

504

网关超时

错误码

请参见错误码。

父主题： 生命周期管理

相关文档