查询Lite Server Job详情 - ShowServerJob
功能介绍
查询Lite Server Job详情接口用于获取指定Lite Server Job的详细信息。该接口适用于以下场景:当用户需要查看某个Lite Server Job的执行状态、配置参数、日志信息等详细数据时,可以通过此接口获取相关信息。使用该接口的前提条件是目标Lite Server Job已存在且用户具有查看权限。查询操作完成后,接口将返回指定Lite Server Job的详细信息,包括但不限于Job ID、状态、创建时间、执行时间、配置参数和日志等。若目标Lite Server Job不存在或用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/dev-servers/jobs/{id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
是 |
String |
参数解释:Lite Server job id。 约束限制:必填。 取值范围:1 - 64字符。 默认取值:不涉及。 |
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_at |
String |
参数解释:创建时间。 取值范围:不涉及。 |
|
update_at |
String |
参数解释:更新时间。 取值范围:不涉及。 |
|
id |
String |
参数解释:任务ID。 取值范围:不涉及。 |
|
name |
String |
参数解释:任务名称。 取值范围:不涉及。 |
|
type |
String |
参数解释:任务模板类型。 取值范围:- COMMON -SERVICE_DEPLOY 等。 |
|
status |
String |
参数解释:状态。 取值范围:- ACTIVE。 |
|
items |
Array of DevServerJobItem objects |
参数解释:任务实例列表信息。 |
|
tasks |
Array of DevServerTaskResponse objects |
参数解释:task详情列表。 |
|
template_id |
String |
参数解释:任务模板ID。 取值范围:不涉及。 |
|
user_name |
String |
参数解释:下发任务的用户信息。 取值范围:不涉及。 |
|
abnormal_count |
Integer |
参数解释:task失败的节点数量。 取值范围:不涉及。 |
|
description |
String |
参数解释:描述。 取值范围:不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释:细粒度任务类型。 取值范围:- COMMON - DEVICE_LOG_COLLECT 等 |
|
spec |
Map<String,String> |
参数解释:任务所需参数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释:task的ID。 取值范围:不涉及。 |
|
server_id |
String |
参数解释:devserver机器ID。 取值范围:不涉及。 |
|
server_name |
String |
参数解释:devserver机器名称。 取值范围:不涉及。 |
|
status |
String |
参数解释:task状态。 取值范围:- PROCESSING -SUCCESS - FAILED - SKIPPED |
|
cloud_server |
Map<String,String> |
参数解释:底层ECS/BMS/HPS ID。 |
|
message |
String |
参数解释:输出信息。 取值范围:不涉及。 |
|
create_at |
String |
参数解释:创建时间。 取值范围:不涉及。 |
|
update_at |
String |
参数解释:更新时间。 取值范围:不涉及。 |
请求示例
查询job_id的任务详情
GET https://{endpoint}/v1/{project_id}/dev-servers/jobs/{job_id}
{ }
响应示例
状态码:200
OK
{
"create_at" : 1757558550702,
"update_at" : 1757558564458,
"id" : "0319470a-7fad-452e-bff0-d3ba3bd83955",
"name" : "software-query",
"description" : "昇腾软件查询",
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。