文档首页/ 虚拟专用网络 VPN/ API参考/ API/ 站点入云VPN API/ 站点入云VPN网关/ 查询资源任务列表
更新时间：2025-07-10 GMT+08:00
查看PDF
分享

查询资源任务列表

功能介绍

查询资源任务列表。

调用方法

请参见如何调用API。

URI

GET /v5/{project_id}/vpn-gateways/jobs

表1 参数说明

名称

类型

是否必选

说明

project_id

String

是

项目ID，可以通过获取项目ID获取项目ID。
表2 请求Query参数列表

名称

类型

是否必选

描述

resource_id

String

否

资源ID。

请求消息

  • 请求参数

    无。

  • 请求样例
    1. 查询所有资源任务。 
      GET https://{Endpoint}/v5/{project_id}/vpn-gateways/jobs
    2. 根据resource_id查询资源任务。 
      GET https://{Endpoint}/v5/{project_id}/vpn-gateways/jobs?resource_id={resource_id}

响应消息

  • 响应参数

    返回状态码为 200: 查询成功。

    表3 响应Body参数列表

    名称

    类型

    描述

    jobs

    Array of Job objects

    任务信息。

    request_id

    String

    请求ID。
    表4 Job

    名称

    类型

    描述

    id

    String
    • 功能说明：任务ID。
    • 格式：36位UUID。

    resource_id

    String
    • 功能说明：VPN网关资源ID。
    • 格式：36位UUID。

    job_type

    String
    • 功能说明：任务类型。
    • 取值范围：upgrade，rollback。

    status

    String
    • 功能说明：VPN网关状态。
    • 取值范围：

      upgrading：升级中。

      pending_upgrade_confirm：等待升级确认。

      success：升级成功。

      rolling_back：回滚中。

      rollback_success：回滚成功。

      fail：升级失败。

    created_at

    String
    • 功能说明：创建时间。
    • UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。

    finished_at

    String
    • 功能说明：结束时间。
    • UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。
    表5 SubJob

    名称

    类型

    描述

    id

    String
    • 功能说明：任务ID。
    • 格式：36位UUID。

    job_type

    String
    • 功能说明：任务类型。
    • 取值范围：
      • prepare_resource
      • upgrade_worker_1
      • upgrade_worker_2

    status

    String
    • 功能说明：任务状态。
    • 取值范围：
      • init：初始化
      • upgrading：升级中
      • success：升级成功
      • fail：升级失败

    created_at

    String
    • 功能说明：创建时间。
    • UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。

    finished_at

    String
    • 功能说明：结束时间。
    • UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。

    error_message

    String
    • 功能说明：错误信息
  • 响应样例 
    {
    "request_id": "8dfd314d50caab38ccc40e4df2213eda",
    "jobs": [
        {
            "id": "e3be04c3-0b62-45d8-b1dc-f4785c96412e",
            "resource_id": "b3eb2b86-2a6d-41f2-835f-879021764b84",
            "job_type": "upgrade",
            "status": "success",
            "created_at": "2025-06-04T03:29:01.855Z",
            "finished_at": "2025-06-04T03:29:33.085Z",
             "sub_jobs": [
               {
                    "id": "80c103ab-61b9-4e74-8e47-fd78ac6177eb",
                    "job_type": "prepare_resource",
                    "status": "success",
                    "created_at": "2025-06-04T11:28:01.926+08:00",
                    "finished_at": "2025-06-04T11:29:03.993+08:00",
                    "error_message": ""
                },
                {
                    "id": "b035cd1c-b9f4-4b05-b9af-b8fcf75eae6a",
                    "job_type": "upgrade_worker_1",
                    "status": "success",
                    "created_at": "2025-06-04T11:29:01.926+08:00",
                    "finished_at": "2025-06-04T11:29:14.993+08:00",
                    "error_message": ""
                },
                {
                    "id": "db3dabe1-60a0-45ff-91b7-735aff90a3dd",
                    "job_type": "upgrade_worker_2",
                    "status": "success",
                    "created_at": "2025-06-04T11:29:01.931+08:00",
                    "finished_at": "2025-06-04T11:29:33.037+08:00",
                    "error_message": ""
                }
            ]
        }
}

状态码

请参见状态码。

父主题： 站点入云VPN网关

相关文档