关闭凭据泄露检测作业 - StopLeakJob
功能介绍
功能介绍:关闭凭据泄露检测作业。停止该作业下的全部任务;job_id 非 UUID 返回400,作业不存在或作业未开启返回404。
响应:请求成功返回HTTP 200,响应体仅包含 status。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/credential-leakage/scan-jobs/{job_id}/stop
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,长度为32个字符,满足正则匹配"^[a-z0-9]{32}$" 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 凭据泄露检测作业ID,可通过调用查询凭据泄露检测作业列表接口获取 约束限制: 必须为合法 UUID 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 请求状态,success表示成功。 取值范围: 不涉及 |
| msg | String | 参数解释: 提示信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识操作返回对应的资源对象 取值范围: 不涉及 |
请求示例
关闭凭据泄露检测作业请求示例
/v1/2b31ed5200000ebedb6e570000000000/credential-leakage/scan-jobs/826314dd-1b5b-4037-b976-5f9b7a17df46/stop
响应示例
状态码:200
{
"status" : "success"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 关闭凭据泄露检测作业成功 |
错误码
请参见错误码。