更新时间:2023-11-21 GMT+08:00

查询失败任务列表

功能介绍

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

约束与限制

URI

  • URI格式

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

  • 参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID。

    获取方法请参见获取项目ID

  • Request filter参数说明

    参数名

    是否必选

    参数类型

    说明

    failure_status

    String

    失败任务状态。

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

    resource_name

    String

    保护组资源名称。

    server_group_id

    String

    保护组ID。

    具体信息请参见查询保护组列表接口。

    resource_type

    String

    资源类型。

    • server_groups:表示保护组。
    • protected_instances:表示保护实例。
    • replications:表示复制对。
    • disaster_recovery_drills:表示容灾演练。

    limit

    Integer

    每次请求返回结果个数限制。

    取值范围为[0,1000]的正整数,默认值为1000。

    offset

    Integer

    每次请求开始的下标,即偏移量,默认值为0。

    offset必须为数字,不能为负数。

请求消息

  • 请求参数

  • 请求样例

    GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs

    GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs?server_group_id=XXXXX

    • 接口调用请求,没有filter参数时,只能查询到保护组层级的失败任务,创建、删除保护组失败等。
    • 查询某个保护组内的失败任务,需要在filter参数中,增加server_group_id参数。

响应

  • 要素说明

    参数名称

    参数类型

    说明

    failure_jobs

    list

    失败任务信息列表。

    详情请参见表1

    count

    Integer

    列表中失败任务个数。

    表1 failure_jobs字段说明

    参数名称

    参数类型

    说明

    job_status

    String

    任务状态。

    当前仅支持“FAIL”。

    • FAIL:表示任务失败。

    resource_id

    String

    资源ID。

    resource_name

    String

    资源名称。

    resource_type

    String

    资源类型。

    • server_groups:表示保护组。
    • protected_instances:表示保护实例。
    • replications:表示复制对。
    • disaster_recovery_drills:表示容灾演练。

    failure_status

    String

    失败任务状态。

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

    job_id

    String

    任务id。

    执行异步API命令下发成功的返回参数,任务执行结果请参考查询job状态接口。

    job_type

    String

    任务名称。

    begin_time

    String

    任务操作时间。

    默认格式为:"yyyy-MM-ddTHH:mm:ss.SSSZ",例:"2019-04-01T12:00:00.000Z"。

    error_code

    String

    任务失败错误码。

    fail_reason

    String

    任务失败原因。

  • 响应样例
    {
        "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!"
            }
        ]
    }
    {  
          "error": {  
              "message": "XXXX",   
              "code": "XXX"  
          }  
      }
    其中error是泛指的错误,有badrequest、itemNotFound等,如报错为:
    {  
          "badrequest": {  
              "message": "XXXX",   
              "code": "XXX"  
          }  
      }

返回值

  • 正常

    返回值

    说明

    200

    服务器已接受请求。

  • 异常

    返回值

    说明

    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

    网关超时。