批量删除作业
功能介绍
批量删除作业。
URI
POST /v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-delete
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
eihealth_project_id |
是 |
String |
参数解释: 平台空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ids |
是 |
Array of strings |
参数解释: 批量操作的作业ID列表。 约束限制: 仅支持字母、数字、下划线和中划线,长度为[1-128]个字符。最多支持设置50个作业ID。 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of BatchOperateJobRsp objects |
批量操作响应体 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 作业ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
status |
String |
参数解释: 批量操作作业的结果。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
message |
String |
操作结果失败信息,仅在操作失败时会返回。 |
状态码:207
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of BatchOperateJobRsp objects |
批量操作响应体 |
请求示例
批量删除作业,删除如下两个作业。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/jobs/batch-delete { "ids" : [ "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2" ] }
响应示例
状态码:200
OK
[ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" } ]
状态码:207
MULTI_STATUS
[ { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba1", "status" : "SUCCEEDED", "message" : "string" }, { "id" : "baabcb56-5bb6-11eb-8a0d-fa163e3ddba2", "status" : "FAILED", "message" : "string" } ]
状态码
状态码 |
描述 |
---|---|
200 |
OK |
207 |
MULTI_STATUS |
错误码
请参见错误码。