更新时间:2021-11-30 GMT+08:00
分享

查询失败任务列表

功能介绍

查询所有保护组失败任务列表或者指定保护组下的所有失败任务列表。

接口约束

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/{project_id}/task-center/failure-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

failure_status

String

失败任务状态。createFail:表示创建失败。deleteFail:表示删除失败。attachFail:表示挂载失败。detachFail:表示卸载失败。expandFail:表示扩容失败。resizeFail:表示变更规格失败。startFail:表示开启保护失败。stopFail:表示停止保护失败。reverseFail:表示切换失败。failoverFail:表示故障切换失败。reprotectFail : 表示重保护失败。

枚举值:

  • 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_groups

  • protected_instances

  • replications

  • disaster_recovery_drills

server_group_id

String

保护组ID。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

failure_jobs

Array of FailureJobParams objects

失败任务信息列表。

count

Integer

列表中失败任务个数。

表5 FailureJobParams

参数

参数类型

描述

job_type

String

任务名称。

job_status

String

任务状态。当前仅支持“FAIL”。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 : 表示重保护失败。

枚举值:

  • 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:表示容灾演练。

枚举值:

  • server_groups

  • protected_instances

  • replications

  • disaster_recovery_drills

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表7 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 401

表8 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表9 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 403

表10 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表11 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 404

表12 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表13 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 405

表14 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表15 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 406

表16 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表17 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 407

表18 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表19 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 408

表20 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表21 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 409

表22 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表23 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 500

表24 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表25 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 501

表26 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表27 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 502

表28 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表29 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 503

表30 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表31 ErrorInfo

参数

参数类型

描述

message

String

错误信息

code

String

错误码

状态码: 504

表32 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

失败返回结构

表33 ErrorInfo

参数

参数类型

描述

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

错误码

请参见错误码

相关文档