批量删除凭据 - DeleteCredentials
功能介绍
批量删除凭据
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/credentials/batch-delete
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32~64个字符。 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间ID,用于明确工作空间归属,配置后可通过该ID查询工作空间下资产,可以通过调用API获取,也可以从控制台获取。 约束限制: 不涉及 取值范围: 只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。 默认取值: 不涉及 |
请求参数
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于任务追踪。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of CredentialDeleteCheckResult objects | 参数解释: 凭据删除检查结果。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resource_id | String | 参数解释: 凭据ID,用于标识被检查的凭据。 取值范围: 只能由英文字母、数字、中划线组成,UUID格式,且长度为0~36个字符。 |
| resource_name | String | 参数解释: 凭据名称,用于标识被检查的凭据名称。 取值范围: 只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。 |
| relation_resources | Array of RelationResource objects | 参数解释: 关联资源列表,用于展示该凭据关联的资源信息。 取值范围: 0~100条记录 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释: 关联资源类型,用于标识关联资源的类型。 取值范围: 只能由英文字母、数字、下划线组成,且长度为0~64个字符。 |
| count | Integer | 参数解释: 关联资源数量,用于统计该类型的关联资源数量。 取值范围: 0~10000 |
| detail_url | String | 参数解释: 关联资源详情URL,用于跳转到关联资源的详情页面。 取值范围: URL格式字符串,且长度为0~1024个字符。 |
| data | Array of RelationResourceData objects | 参数解释: 关联资源数据列表,用于展示关联资源的详细信息。 取值范围: 0~100条记录 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释: 关联资源名称,用于标识关联资源的名称。 取值范围: 只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。 |
| id | String | 参数解释: 关联资源ID,用于唯一标识关联资源。 取值范围: 只能由英文字母、数字、中划线组成,UUID格式,且长度为0~36个字符。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于任务追踪。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,用于标识错误类型。 取值范围: 只能由英文字母、数字、点号组成,且长度为0~64个字符。 |
| error_msg | String | 参数解释: 错误描述,用于描述错误的详细信息。 取值范围: 长度为0~1024个字符。 |
请求示例
在某个工作空间批量删除凭据的请求样例
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/credentials/batch-delete
{
"ids" : [ "28f61af50fc9452aa0ed5ea25c3cc3d3" ],
"is_delete" : true
} 响应示例
状态码:200
[ {
"resource_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
"resource_name" : "demo_credential",
"relation_resources" : [ ]
} ] 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 凭据删除检查结果列表 |
| 400 | 错误响应 |
错误码
请参见错误码。