Querying the List of Batch Jobs

Function

This API is used to query the list of batch jobs.

URI

GET /v2/{project_id}/productmgr/jobs

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
job_type	No	String	Batch job type, including: node_upgrade: node upgrade deployment_deploy: application deployment deployment_upgrade: application upgrade
limit	No	Integer	Maximum number of records that can be returned.
offset	No	Integer	Offset. The records after this offset will be queried.
sort	No	String	Sorting style of the query results. created_at:desc indicates that the query results are sorted by creation time in descending order. created_at:asc indicates that the query results are sorted by creation time in ascending order.

Request

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
ief-instance-id	No	String	Platinum edition instance ID. This parameter is left blank for a professional edition instance.
Content-Type	Yes	String	Message body type (format). The default value is application/json.

Response

Status code: 200

**Table 4** Parameters in the response body
Parameter	Type	Description
job_count	Integer	Batch job quantity.
jobs	Array of BatchJobForList objects	Batch job details.

**Table 5** BatchJobForList
Parameter	Type	Description
job_id	String	Batch job ID.
job_name	String	Batch job name.
job_type	String	Batch job type, including: node_upgrade: node upgrade deployment_deploy: application deployment deployment_upgrade: application upgrade
created_at	Integer	Creation time.
status	String	Execution status.
task_total_count	Integer	Total number of tasks.
task_success_count	Integer	Number of successfully tasks.
task_failed_count	Integer	Number of failed tasks.
status_last_updated_at	Integer	Time when the status was updated.
description	String	Task description.

Example Request

None

Example Response

Status code: 200

Query succeeded.

{
  "job_count" : 2,
  "jobs" : [ {
    "job_name" : "aaa",
    "job_type" : "deployment_deploy",
    "job_id" : "66273c66-f72e-4607-8769-3663d255fb83",
    "status" : "Successful",
    "created_at" : 1667218308,
    "status_last_updated_at" : 1667218329,
    "task_total_count" : 2,
    "task_failed_count" : 0,
    "task_success_count" : 2,
    "description" : ""
  }, {
    "job_name" : "test0929-pm",
    "job_type" : "deployment_deploy",
    "job_id" : "0a95c8df-eab5-4a8b-a63b-df9f208ad0ce",
    "status" : "Successful",
    "created_at" : 1664444410,
    "status_last_updated_at" : 1664444411,
    "task_total_count" : 1,
    "task_failed_count" : 0,
    "task_success_count" : 1,
    "description" : ""
  } ]
}