Querying the Engine Job List

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

View PDF

Function

This API is used to query the engine job list.

URI

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

**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.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	String	Page number.
limit	No	String	Number of records displayed on each page.
from-time	No	String	Start time of the query date range.
to-time	No	String	End time of the query date range.

Request

**Table 3** 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. Default value: 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 4** Response body parameters
Parameter	Type	Description
OK	Array of JobGetListResp objects	Query result.

**Table 5** JobGetListResp
Parameter	Type	Description
total	Integer	Total number of engine jobs.
data	Array of Job objects	Job list.

**Table 6** Job
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 Updated Upgrade Configure Modify
description	String	Job description.
status	String	Job status. Enumerated values: PreInit 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 Task objects	Job phases.

**Table 7** 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 Updated Upgrade Configure 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: PreInit 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 8** TaskExecutorBrief
Parameter	Type	Description
duration	Long	Duration of a sub-job.
description	String	Sub-job description.

Status code: 400

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

Status code: 500

**Table 10** 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

Example Response

Status code: 200

{
  "total": 100,
  "data": [
    {
      "id": 12339,
      "engineId": "ad76972c-a743-4770-859c-c98a680f4d98",
      "type": "Create",
      "description": "",
      "status": "Finished",
      "scheduling": 0,
      "createUser": "test",
      "startTime": 1636540095901,
      "endTime": 1636540460230,
      "context": "string",
      "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"
          }
        }
      ]
    }
  ]
}