Querying the Job Execution Result of a Tenant

Function

This API is used to query the task execution result.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
job_id	Yes	String	Definition Task ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
job_id	String	Definition Task ID. Range N/A
job_type	String	Definition Job type. Range masterStandbySwapJob: switching master and standby nodes modifyClientIpTransJob: modifying source IP pass-through modifyBandwidth: modifying bandwidth createDCSInstance: creating an instance closeDCSInstance: stopping an instance deleteDCSInstance: deleting an instance backupDCSInstance: backing up an instance restoreDCSInstance: restoring an instance extendDCSInstance: resizing an instance
status	String	Definition Job status. Range INIT: To be executed. RUNNING: Executing. SUCCESS: Successful. FAIL: Failed.
begin_time	String	Definition Job start timestamp, in ms. The format is 1684191545379. Range N/A
end_time	String	Definition Job start timestamp, in ms. The format is 1684191548248. Range N/A
fail_reason	String	Definition Failure cause. Range N/A

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Definition Error information. Range N/A
error_code	String	Definition Error code. Range For details, see Error Codes.
error_ext_msg	String	Definition Extended error information. This parameter is not used currently and is set to null. Range N/A

Example Requests

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

Example Responses

Status code: 200

Details of the background task queried successfully.

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

Status code: 400

Invalid request.

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

Status Codes

Status Code	Description
200	Details of the background task queried successfully.
400	Invalid request.
401	Invalid authentication information.
403	Request rejected.
404	The requested resource could not be found.
500	Internal service error.