文档首页/ 云硬盘备份 VBS/ API参考/ API说明/ 备份策略/ 查询策略下的备份任务
更新时间:2022-02-22 GMT+08:00

查询策略下的备份任务

功能介绍

根据条件查询指定策略下备份任务的执行情况。

URI

  • URI格式

    GET /v2/{project_id}/backuppolicy/{policy_id}/backuptasks

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID

    policy_id

    策略ID

  • Request filter参数说明

    参数

    是否必选

    参数类型

    描述

    sort_dir

    string

    降序或升序(分别为desc和asc)。

    limit

    integer

    指定返回结果个数限制,不指定默认返回20条。

    marker

    string

    用于分页,表示从哪个任务开始查询,取值为任务ID。

    job_id

    string

    任务ID

    status

    string

    任务状态

    • RUNNING
    • EXECUTE_TIMEOUT
    • WAITING
    • EXECUTE_FAIL
    • EXECUTE_SUCCESS
    • SKIP

    sort_key

    string

    排序关键字(目前只支持created_at)

    offset

    integer

    指定偏移量条数,不指定默认偏移为0。

  • 请求示例
    GET /v2/{project_id}/backuppolicy/{policy_id}/backuptasks?limit=10

请求

响应

  • 要素说明

    参数

    参数类型

    描述

    count

    integer

    任务总数。

    tasks

    list<dict>

    备份任务详情

    status

    string

    任务状态

    • RUNNING
    • EXECUTE_TIMEOUT
    • WAITING
    • EXECUTE_FAIL
    • EXECUTE_SUCCESS
    • SKIP

    job_id

    string

    备份任务ID

    created_at

    string

    备份任务创建时间,UTC时间,形如"2016-12-02T09:06:46.706"

    finished_at

    string

    备份任务结束时间,UTC时间,形如"2016-12-02T13:00:00.121"

    backup_name

    string

    备份名称

    resource_id

    string

    资源ID

    resource_type

    string

    资源类型

    vbs_job_id

    string

    VBS侧的备份任务ID

    message

    string

    出现错误时,返回的错误消息。

    code

    string

    出现错误时,返回的错误码。

    错误码的具体含义请参考错误码

  • 响应样例
    {
      "tasks": [
        {
          "status": "RUNNING",
          "job_id": "0781095c-b8ab-4ce5-99f3-4c5f6ff75319",
          "created_at": "2016-12-03T06:24:34.467",
          "backup_name": "autobk_a61d",
          "resource_id": "f47a4ab5-11f5-4509-97f5-80ce0dd74e37",
          "resource_type": "volume"
        },
        {
          "status": "EXECUTE_SUCCESS",
          "job_id": "c11b5a18-4559-4731-b7b3-58e2bd89cdb9",
          "created_at": "2016-12-02T09:06:46.706",
          "finished_at": "2016-12-02T13:00:00.121",
          "backup_name": "autobk_e6d2",
          "resource_id": "f47a4ab5-11f5-4509-97f5-80ce0dd74e37",
          "resource_type": "volume"
        }
      ],
      "count": 2
    }

    {
        "error": {
            "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

    网关超时。

错误码

请参考错误码