Querying the Lite Server Job List

Function

This API is used to obtain the Lite Server job list and filter jobs by status and ID. It is used when you need to view the brief information about multiple Lite Server jobs. For example, you can use this API to obtain the jobs that meet the filter criteria during job status monitoring, troubleshooting, or routine management. Before using this API, ensure that you have the view permission. After the query, the API returns the Lite Server jobs that meet the search criteria, including the ID, status, and creation time. If you do not have the required permission or the request parameters are incorrect, the API returns an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/dev-servers/jobs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
id	No	String	Definition: Lite Server job ID. Constraints: None Range: 1 to 64 characters Default Value: N/A
name	No	String	Definition: Lite Server job name. Constraints: None Range: N/A Default Value: N/A
type	No	String	Definition: Lite Server job type. Constraints: None Range: N/A Default Value: N/A
status	No	String	Definition: Lite Server job status. Constraints: None Range: N/A Default Value: N/A
visible	No	Boolean	Definition: Visible or not. Constraints: bool Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
current	Integer	Definition: Current page number. Range: N/A
data	Array of DevServerJobListResponse objects	Definition: Job instance list.
pages	Integer	Definition: Total number of pages. Range: N/A
size	Integer	Definition: Number of records on each page. Range: N/A
total	Long	Definition: Total number of records. Range: N/A

**Table 4** DevServerJobListResponse
Parameter	Type	Description
id	String	Task ID.
name	String	Task name.
user_name	String	Username.
description	String	Task description.
type	String	Definition: Task type. Range: COMMON, SERVICE_DEPLOY, and others.
status	String	Definition: Task status. Range: PROCESSING, FINISHED, and DELETED.
abnormal_count	Integer	Number of nodes where the task fails.
create_at	String	Creation time.
update_at	String	Update time.

Example Requests

GET https://{endpoint}/v1/{project_id}/dev-servers/jobs

{ }

Example Responses

Status code: 200

{
  "current" : 1,
  "data" : [ {
    "create_at" : 1749536420547,
    "update_at" : 1749536603947,
    "id" : "03af7361-5cba-44d4-b29b-4dcc5d9dff51",
    "name" : "software-upgrade-792a",
    "user_name" : "modelarts_user",
    "type" : "ASCEND_SOFTWARE_UPGRADE",
    "status" : "FINISHED",
    "abnormal_count" : 0
  }, {
    "create_at" : 1749523685137,
    "update_at" : 1749523899848,
    "id" : "62c89f77-fc81-45a8-9647-d6e457e73954",
    "name" : "diagnosis-81ef",
    "user_name" : "modelarts_user",
    "description" : "POC",
    "type" : "ASCEND_DIAGNOSIS",
    "status" : "FINISHED",
    "abnormal_count" : 0
  } ],
  "pages" : 1,
  "size" : 2,
  "total" : 2
}