Querying Details About a Microservice Engine Job

Updated on 2025-04-25 GMT+08:00

View PDF

Function

This API is used to query details about a microservice engine job.

URI

GET /v2/{project_id}/enginemgr/engines/{engine_id}/jobs/{job_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which must be unique. The value contains 1 to 64 characters.
engine_id	Yes	String	Microservice engine ID.
job_id	Yes	String	Job ID.

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Enterprise-Project-ID	No	String	If this parameter is not set, the default enterprise project is default and the ID is 0.
Content-Type	Yes	String	Set it to application/json;charset=UTF-8.
Accept	Yes	String	Set it to application/json.

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	Integer	Job ID.
engineId	String	ID of the engine to which a job belongs.
type	String	Job type. Enumerated values: Create Delete Upgrade Modify
description	String	Job description.
status	String	Job status. Enumerated values: Init Executing Error Timeout Finished
scheduling	Integer	Whether a job is being executed. 0: no; 1: yes.
createUser	String	Job creator.
startTime	Long	Start time of a job.
endTime	Long	End time of a job.
context	String	Job execution context.
tasks	Array of TaskSteps objects	Job phases.

**Table 4** TaskSteps
Parameter	Type	Description
taskName	String	Phase name.
taskNames	Array of strings	List of procedures contained in the current phase.
status	String	Status of a phase. Enumerated values: Init Executing Error Timeout Finished
startTime	Long	Start time of a phase.
endTime	Long	End time of a phase.
taskExecutorBrief	TaskExecutorBrief object	Metadata of a phase.
tasks	Array of Task objects	Procedure.

**Table 5** Task
Parameter	Type	Description
jobId	Integer	ID of the job to which the sub-job belongs.
id	Long	Sub-job ID, which is in UUID format.
type	String	Sub-job type. Enumerated values: Create Delete Upgrade Modify
assigned	String	Executor of a sub-job.
taskName	String	Sub-job name.
engineName	String	Name of the engine to which the sub-job belongs.
taskOrder	Integer	Sequence in which sub-jobs are executed, in ascending order.
status	String	Sub-job status. Enumerated values: Init Executing Error Timeout Finished
startTime	Long	Start time of a sub-job.
endTime	Long	End time of a sub-job.
createTime	Long	Creation time of a sub-job.
updateTime	Long	Update time of a sub-job.
timeout	Integer	Whether a sub-job times out.
log	String	Sub-job details, which are auxiliary information generated during the execution.
output	String	Sub-job output information. Default value: {}
taskExecutorBrief	TaskExecutorBrief object	Job metadata.

**Table 6** TaskExecutorBrief
Parameter	Type	Description
duration	Long	Duration of a sub-job.
description	String	Sub-job description.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
detail	String	Location details.

Example Request

GET https://{endpoint}/v2/{project_id}/enginemgr/engines/{engine_id}/jobs/{job_id}

Example Response

Status code: 200

Structure for querying details about a microservice engine job.

{
  "id" : 12339,
  "engineId" : "ad76972c-a743-4770-859c-c98a680f4d98",
  "type" : "Create",
  "description" : "",
  "status" : "Finished",
  "scheduling" : 0,
  "createUser" : "test",
  "startTime" : 1636540095901,
  "endTime" : 1636540460230,
  "context" : "string",
  "tasks" : [ {
    "taskName" : "resourcePrepare",
    "taskNames" : [ "TenantTaskExecutor" ],
    "status" : "Finished",
    "startTime" : 1636540100216,
    "endTime" : 1636540110215,
    "taskExecutorBrief" : {
      "duration" : 6000,
      "description": "Resource preparation"
    },
    "tasks" : [ {
      "jobId" : 12339,
      "id" : 89117,
      "type" : "Create",
      "assigned" : "string",
      "taskName" : "TenantTaskExecutor",
      "engineName" : "test",
      "taskOrder" : 0,
      "status" : "Init",
      "startTime" : 1636540100216,
      "endTime" : 1636540110215,
      "createTime" : 1636540095910,
      "updateTime" : 1636540110230,
      "timeout" : -1,
      "log" : "string",
      "output" : "{}",
      "taskExecutorBrief" : {
        "duration" : 6000,
        "description": "Tenant processing"
      }
    } ]
  } ]
}