更新时间:2025-11-14 GMT+08:00

查询租户Job执行结果

功能介绍

查询租户Job执行结果。

URI

GET /v2/{project_id}/jobs/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

job_id

String

参数解释

任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

job_id

String

参数解释

任务ID。

取值范围

不涉及。

job_type

String

参数解释

Job类型。

取值范围

  • masterStandbySwapJob:主备倒换任务。

  • modifyClientIpTransJob:修改源IP透传。

  • modifyBandwidth:修改带宽任务。

  • createDCSInstance:创建实例。

  • closeDCSInstance:关闭实例。

  • deleteDCSInstance:删除实例任务。

  • backupDCSInstance:备份实例任务。

  • restoreDCSInstance:恢复实例任务。

  • extendDCSInstance:实例扩容任务。

status

String

参数解释

Job状态。

取值范围

  • INIT:任务待执行。

  • RUNNING:任务正在执行。

  • SUCCESS:任务执行成功。

  • FAIL:任务执行失败。

begin_time

String

参数解释

Job开始时间戳,单位为ms,格式为:1684191545379。

取值范围

不涉及。

end_time

String

参数解释

Job开始时间戳,单位为ms,格式为:1684191548248。

取值范围

不涉及。

fail_reason

String

参数解释

失败原因。

取值范围

不涉及。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:401

表4 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

请参见错误码

error_ext_msg

String

参数解释

扩展错误信息(暂未使用,赋值为null)。

取值范围

不涉及。

请求示例

GET https://{dcs_endpoint}/v2/{project_id}/jobs/{job_id}

响应示例

状态码:200

查询后台任务详情成功。

{
  "job_id" : "ff8080818822bbf70188235afc24141a",
  "job_type" : "masterStandbySwapJob",
  "status" : "SUCCESS",
  "begin_time" : "1684191545379",
  "end_time" : "1684191548248",
  "fail_reason" : null
}

状态码:400

非法请求。

{
  "error_code" : "111400063",
  "error_msg" : "Invalid {0} parameter in the request."
}

状态码

状态码

描述

200

查询后台任务详情成功。

400

非法请求。

401

认证信息非法。

403

请求被拒绝访问。

404

所请求的资源不存在。

500

内部服务错误。

错误码

请参见错误码