查询资源任务列表 - QueryResourceTasks

功能介绍

查询资源任务列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
vpn:vpnGateways:listResourceJobs	list	-	-	-	-

URI

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

表1 参数说明
名称	类型	是否必选	说明
project_id	String	是	项目ID，可以通过获取项目ID获取项目ID。

表2 请求Query参数列表
名称	类型	是否必选	描述
resource_id	String	否	资源ID。
limit	Integer	否	分页查询时每页返回的记录数量。
marker	String	否	功能说明：查询本页的起始标记位，为空时为查询第一页。查询下一页的marker可以根据上一页响应的page_info对象中的next_marker填写。约束：必须与limit一起使用。

请求消息

请求参数
 无。

请求样例

查询所有资源任务。

GET https://{Endpoint}/v5/{project_id}/vpn-gateways/jobs

根据resource_id查询资源任务。

GET https://{Endpoint}/v5/{project_id}/vpn-gateways/jobs?resource_id={resource_id}

响应消息

响应参数

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

表3 响应Body参数列表
名称	类型	描述
jobs	Array of Job objects	任务信息。
total_count	Integer	网关总数。
page_info	PageInfo object	分页查询页的信息。
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网关状态。取值范围： init：初始化 running：执行中 upgrading：升级中。 pending_upgrade_confirm：等待升级确认。 success：升级成功。 rolling_back：回滚中。 rollback_success：回滚成功。 fail：升级失败。
expected_time_seconds	Integer	功能说明：预期剩余执行时间。单位：秒。
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 migrate_traffic_1 migrate_traffic_2 migrate_network_1 migrate_network_2 service_ready_check_1 service_ready_check_2
entity	SubJobEntity object	功能说明：资源信息
status	String	功能说明：任务状态。取值范围： init：初始化 running：执行中 upgrading：升级中 success：升级成功 fail：升级失败
expected_time_seconds	Integer	功能说明：预期执行时间。单位：秒。
created_at	String	功能说明：创建时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。
finished_at	String	功能说明：结束时间。 UTC时间格式：yyyy-MM-ddTHH:mm:ss.SSSZ。
error_message	String	功能说明：错误信息

表6 PageInfo
名称	类型	描述
next_marker	String	下一页的marker,值为上一次查询响应中最后一个资源的创建时间。
current_count	Integer	当前列表中资源数量。

表7 SubJobEntity
名称	类型	描述
ip_address	String	功能说明：IP地址。

响应样例

{
    "request_id": "7c938e41c510f1bf53b4cb3d142b841c",
    "jobs": [
        {
            "id": "5968875c-8c28-447c-bd36-7b4917e5b742",
            "resource_id": "f8576538-0ffa-45d7-97f5-9783e0228cb5",
            "job_type": "upgrade",
            "status": "success",
            "created_at": "2026-03-18T15:08:53.679462Z",
            "finished_at": "2026-03-18T15:10:26.953831Z",
            "sub_jobs": [
                {
                    "id": "ae7e8440-ce63-4fd0-98ae-84209fa4219d",
                    "job_type": "prepare_resource",
                    "entity": {},
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.200096878Z",
                    "finished_at": "2026-03-18T15:09:38.104329871Z"
                },
                {
                    "id": "c36cc41e-dc09-4e1f-9033-55bfc46628e0",
                    "job_type": "migrate_traffic_1",
                    "entity": {
                        "ip_address": "192.168.1.2"
                    },
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.47287635Z",
                    "finished_at": "2026-03-18T15:09:50.056544567Z"
                },
                {
                    "id": "046158d6-9565-4696-b291-d86a4f76a387",
                    "job_type": "migrate_network_1",
                    "entity": {
                        "ip_address": "192.168.1.2"
                    },
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.513965159Z",
                    "finished_at": "2026-03-18T15:10:02.279932603Z"
                },
                {
                    "id": "4f57ac3f-3052-4e17-a195-17a7d7e47b62",
                    "job_type": "service_ready_check_1",
                    "entity": {
                        "ip_address": "192.168.1.2"
                    },
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.556529748Z",
                    "finished_at": "2026-03-18T15:10:02.502339602Z"
                },
                {
                    "id": "41b9976e-5ff2-49db-8449-3abf804d9a57",
                    "job_type": "migrate_traffic_2",
                    "entity": {
                        "ip_address": "192.168.1.20"
                    },
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.594430844Z",
                    "finished_at": "2026-03-18T15:10:14.503148811Z"
                },
                {
                    "id": "2505809a-bf52-4905-80fb-64ce2a204946",
                    "job_type": "migrate_network_2",
                    "entity": {
                        "ip_address": "192.168.1.20"
                    },
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.631862559Z",
                    "finished_at": "2026-03-18T15:10:26.675384941Z"
                },
                {
                    "id": "5b56c1e4-d564-4089-811b-60effd36b062",
                    "job_type": "service_ready_check_2",
                    "entity": {
                        "ip_address": "192.168.1.20"
                    },
                    "status": "success",
                    "expected_time_seconds": 0,
                    "created_at": "2026-03-18T15:08:53.669949909Z",
                    "finished_at": "2026-03-18T15:10:26.876399281Z"
                }
            ]
        }
    ],
    "total_count": 1,
    "page_info": {
        "current_count": 1
    }
}