Help Center/ Distributed Cache Service/ API Reference/ API V2/ Background Task Management/ Querying the Job Execution Result of a Tenant
Updated on 2025-05-13 GMT+08:00
View PDF

Querying the Job Execution Result of a Tenant

Function

This API is used to query the task execution result.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

job_id

Yes

String

Task ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

job_type

String

Job type. Options:

  • masterStandbySwapJob: switching master and standby nodes

  • modifyClientIpTransJob: modifying source IP pass-through

status

String

Job status. Values:

  • INIT: To be executed.

  • RUNNING: Executing.

  • SUCCESS: Successful.

  • FAIL: Failed.

begin_time

String

Job start timestamp, in ms. The format is 1684191545379.

end_time

String

Job start timestamp, in ms. The format is 1684191548248.

fail_reason

String

Failure cause.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

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.

Error Codes

See Error Codes.