查询失败任务列表 - ListFailureJobs
功能介绍
查询所有保护组失败任务列表或者指定保护组下的所有失败任务列表。
接口约束
无
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/task-center/failure-jobs
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| failure_status | 否 | String | 失败任务状态。createFail:表示创建失败。deleteFail:表示删除失败。attachFail:表示挂载失败。detachFail:表示卸载失败。expandFail:表示扩容失败。resizeFail:表示变更规格失败。startFail:表示开启保护失败。stopFail:表示停止保护失败。reverseFail:表示切换失败。failoverFail:表示故障切换失败。reprotectFail : 表示重保护失败。 枚举值: |
| limit | 否 | Integer | 每次请求返回结果个数限制。取值范围为[0,1000]的正整数,默认值为1000。 最小值:0 最大值:1000 缺省值:1000 |
| offset | 否 | Integer | 每次请求开始的下标,即偏移量,默认值为0。offset必须为数字,不能为负数。 最小值:0 缺省值:0 |
| resource_name | 否 | String | 保护组资源名称。 |
| resource_type | 否 | String | 资源类型。server_groups:表示保护组。protected_instances:表示保护实例。replications:表示复制对。disaster_recovery_drills:表示容灾演练。 枚举值: |
| server_group_id | 否 | String | 保护组ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| failure_jobs | Array of FailureJobParams objects | 失败任务信息列表。 |
| count | Integer | 列表中失败任务个数。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_type | String | 任务名称。 |
| job_status | String | 任务状态。当前仅支持“FAIL”。FAIL:表示任务失败。 枚举值: |
| begin_time | String | 任务操作时间。默认格式为:"yyyy-MM-ddTHH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。 |
| job_id | String | 任务id。执行异步API命令下发成功的返回参数。 |
| failure_status | String | 失败任务状态。createFail:表示创建失败。deleteFail:表示删除失败。attachFail:表示挂载失败。detachFail:表示卸载失败。expandFail:表示扩容失败。resizeFail:表示变更规格失败。startFail:表示开启保护失败。stopFail:表示停止保护失败。reverseFail:表示切换失败。failoverFail:表示故障切换失败。reprotectFail : 表示重保护失败。 枚举值: |
| resource_id | String | 资源ID。 |
| resource_name | String | 资源名称。 |
| error_code | String | 任务失败错误码。 |
| fail_reason | String | 任务失败原因。 |
| resource_type | String | 资源类型。 server_groups:表示保护组。 protected_instances:表示保护实例。 replications:表示复制对。 disaster_recovery_drills:表示容灾演练。 枚举值: |
状态码: 400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
状态码: 401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 406
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 407
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 501
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 502
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
状态码: 504
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | ErrorInfo object | 失败返回结构 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| message | String | 错误信息 |
| code | String | 错误码 |
请求示例
GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs?server_group_id=XXXXX 响应示例
状态码: 200
OK
{
"count" : 2,
"failure_jobs" : [ {
"job_status" : "FAIL",
"resource_id" : "17984002-ad8a-438b-8ba6-b850224634c5",
"resource_name" : "Protected-Instance-ab14",
"resource_type" : "protectedInstance",
"failure_status" : "createFail",
"job_id" : "ff808082686f229a0168707beaab014e",
"job_type" : "createProtectedInstance",
"begin_time" : "2019-01-21T12:56:35.754Z",
"error_code" : "EVS.2024",
"fail_reason" : "SdrsGenerateNativeServerParamsTask-fail:volume is error!"
}, {
"job_status" : "FAIL",
"resource_id" : "897f57b2-6e94-4179-b414-9532726c59f2",
"resource_name" : "Protected-Instance-5e2e",
"resource_type" : "protectedInstance",
"failure_status" : "createFail",
"job_id" : "ff808082686f229a0168707b9be9013e",
"job_type" : "createProtectedInstance",
"begin_time" : "2019-01-21T12:56:15.591Z",
"error_code" : "EVS.2024",
"fail_reason" : "SdrsGenerateNativeServerParamsTask-fail:volume is error!"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 407 | Proxy Authentication Required |
| 408 | Request Timeout |
| 409 | Conflict |
| 500 | Internal Server Error |
| 501 | Not Implemented |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
| 504 | Gateway Timeout |
错误码
请参见错误码。