Help Center/ ModelArts/ API Reference/ DevServer Management/ Obtaining Details About a DevServer Job
Updated on 2025-11-19 GMT+08:00

Obtaining Details About a DevServer Job

Function

This API is used to query details about a DevServer job.

Debugging

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

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition: DevServer job ID.

Constraints: Mandatory.

Range: 1 to 64 characters.

Default Value: N/A

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

create_at

String

Definition: Creation time.

Range: N/A

update_at

String

Definition: Update time.

Range: N/A

id

String

Definition: Task ID.

Range: N/A

name

String

Definition: Task name.

Range: N/A

type

String

Definition: Task template type.

Range: N/A

status

String

Definition: Status.

Range: N/A

items

Array of DevServerJobItem objects

Definition: Task instance list information.

tasks

Array of DevServerTaskResponse objects

Definition: Task details list.

template_id

String

Definition: Task template ID.

Range: N/A

user_name

String

Definition: Information about the user who delivers the task.

Range: N/A

abnormal_count

Integer

Definition: number of nodes where the task fails.

Range: N/A

description

String

Definition: Description.

Range: N/A

Table 3 DevServerJobItem

Parameter

Type

Description

type

String

Definition: Fine-grained task type.

Range: N/A

spec

Map<String,String>

Definition: Parameters required by the task.

Table 4 DevServerTaskResponse

Parameter

Type

Description

id

String

Definition: task ID.

Range: N/A

server_id

String

DevServer ID.

server_name

String

DevServer name.

status

String

Task status. Options:

PROCESSING: The task is being executed.

SUCCESS: The task is complete.

FAILED: The task fails to be executed.

DELETE: The task has been deleted.

cloud_server

Map<String,String>

Underlying ECS/BMS/HPS ID.

message

String

Output information.

create_at

String

Creation time.

update_at

String

Update time.

Example Requests

Query details about the job specified by job_id.

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

{ }

Example Responses

Status code: 200

OK

{
  "create_at" : 1757558550702,
  "update_at" : 1757558564458,
  "id" : "0319470a-7fad-452e-bff0-d3ba3bd83955",
  "name" : "software-query",
  "description" : "Query Huawei Cloud AI software.",
  "type" : "ASCEND_SOFTWARE_QUERY",
  "status" : "FINISHED",
  "items" : [ {
    "type" : "HDK_QUERY"
  } ],
  "tasks" : [ {
    "create_at" : 1757558550733,
    "update_at" : 1757558564470,
    "id" : "0319470a-2524-4b1e-bb91-09e776701d78",
    "server_id" : "3384bdb0-2d31-4fe9-946e-09e776701d78",
    "server_name" : "liteserver-a2-aiserver-test",
    "cloud_server" : {
      "id" : "0c12a47a-0103-4fdb-bf85-7a09a8f53ac9",
      "type" : "BMS"
    },
    "status" : "SUCCESS",
    "message" : "Driver: 24.1.0.3 | Firmware: 7.5.0.5.220"
  } ],
  "template_id" : "2b087a09-e90d-414c-9b15-ffec45e400e7",
  "user_name" : "modelarts_user",
  "abnormal_count" : 0
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.