查询Lite Server Job列表 - ListDevServerJobs

功能介绍

查询Lite Server Job列表接口用于获取Lite Server Job的列表信息，并支持按照状态、ID等相关字段进行过滤。该接口适用于以下场景：当用户需要查看多个Lite Server Job的概要信息，例如在监控作业状态、排查问题或进行日常管理时，可以通过此接口获取符合过滤条件的Job列表。使用该接口的前提条件是用户具有查看权限。查询操作完成后，接口将返回符合条件的Lite Server Job列表，包括每个Job的ID、状态、创建时间等基本信息。若用户无权限操作或请求参数不正确，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
id	否	String	参数解释：Lite Server job id。约束限制：无。取值范围：1 - 64字符。默认取值：不涉及。
name	否	String	参数解释：Lite Server job的name。约束限制：无。取值范围：不涉及。默认取值：不涉及。
type	否	String	参数解释：Lite Server job的类型。约束限制：无。取值范围：不涉及。默认取值：不涉及。
status	否	String	参数解释：Lite Server job的状态。约束限制：无。取值范围：不涉及。默认取值：不涉及。
visible	否	Boolean	参数解释：是否可见。约束限制：bool。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
current	Integer	参数解释：当前页数。取值范围：不涉及。
data	Array of DevServerJobListResponse objects	参数解释：job实例列表。
pages	Integer	参数解释：总页数。取值范围：不涉及。
size	Integer	参数解释：每一页的数量。取值范围：不涉及。
total	Long	参数解释：总的记录数量。取值范围：不涉及。

表4 DevServerJobListResponse
参数	参数类型	描述
id	String	参数解释：任务id。取值范围：不涉及。
name	String	参数解释：任务名称。取值范围：不涉及。
user_name	String	参数解释：用户名。取值范围：不涉及。
description	String	参数解释：任务描述。取值范围：不涉及。
type	String	参数解释：任务类型。取值范围：- COMMON -SERVICE_DEPLOY 等。
status	String	参数解释：任务状态。取值范围：- PROCESSING, -FINISHED, -DELETED。
abnormal_count	Integer	参数解释：task失败的节点数量。取值范围：不涉及。
create_at	String	参数解释：创建时间。取值范围：不涉及。
update_at	String	参数解释：更新时间。取值范围：不涉及。

请求示例

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

{ }

响应示例

状态码：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
}