文档首页/魔坊（ModelArts）模型训推平台/API参考/Lite Server管理/获取Lite Server Job模板列表 - ListServerJobTemplates
更新时间：2026-01-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取Lite Server Job模板列表 - ListServerJobTemplates

功能介绍

获取Lite Server Job模板列表接口用于获取可用的Lite Server Job模板列表。该接口适用于以下场景：当用户需要查看可用的Job模板，以便选择合适的模板来创建新的Lite Server任务时，可以通过此接口获取模板列表。查询操作完成后，接口将返回所有可用的Lite Server Job模板列表，包括模板ID、名称、描述等信息。若系统中无可用模板，接口将返回相应的信息。

调试

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

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：1 - 64字符，字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

参数解释：DevServerJob的模板id。

约束限制：1 - 64字符，字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

name

否

String

参数解释：DevServerJob的模板name。

约束限制：字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

type

否

String

参数解释：DevServerJob的模板类型。

约束限制：字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

current

Integer

参数解释：当前页数。

取值范围：不涉及。

data

Array of DevServerTemplateListResponse objects

参数解释：模板列表。

取值范围：不涉及。

pages

Integer

参数解释：总的页数。

取值范围：不涉及。

size

Integer

参数解释：每一页的数量。

取值范围：不涉及。

total

Long

参数解释：总的记录数量。

取值范围：不涉及。

表4 DevServerTemplateListResponse

参数

参数类型

描述

id

String

参数解释：任务模板id。

取值范围：不涉及。

name

String

参数解释：任务模板名。

取值范围：不涉及。

description

String

参数解释：任务模板描述。

取值范围：不涉及。

type

String

参数解释：任务模板类型。

取值范围：- COMMON - LOG_COLLECT等。

flavor_type

String

参数解释：规格类型。

取值范围：-ASCEND_SNT9B -ASCEND_SNT9C -ASCEND_GENERIC。

params

Array of TemplateParam objects

参数解释：模板的一些任务所需额外params参数。

表5 TemplateParam

参数

参数类型

描述

name

String

参数解释：参数名称。

取值范围：不涉及。

description

String

参数解释：参数描述。

取值范围：不涉及。

value

String

参数解释：参数取值。

取值范围：不涉及。

visible

String

参数解释：是否展示在console。

取值范围：- true -false。

regex

String

参数解释：正则校验。

取值范围：不涉及。

请求示例

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

{ }

响应示例

状态码：200

OK

{
  "current" : 0,
  "data" : [ {
    "id" : "2b087a09-e90d-414c-9b15-ffec45e400e9",
    "type" : "ASCEND_SYSTEM_CONFIG",
    "flavor_type" : "ASCEND_GENERIC",
    "params" : [ {
      "description" : "Configure the RoCE network uplink ports properly and set up the parameter plane network with correct IP addresses, subnet masks, and gateways.",
      "name" : "JOB_ITEM_RDMA_CONFIG",
      "regex" : "^[A-Za-z0-9-_]{1,128}$",
      "value" : "Parameter Plane Network Configuration",
      "visible" : "true"
    }, {
      "description" : "Detect and fix security vulnerabilities in the HCE2.0 system.",
      "name" : "JOB_ITEM_SYSTEM_FIX",
      "regex" : "^[A-Za-z0-9-_]{1,128}$",
      "value" : "System Bug Fixes",
      "visible" : "true"
    }, {
      "description" : "Timeout of RDMA_CONFIG job item",
      "name" : "TIMEOUT_RDMA_CONFIG",
      "regex" : "^[A-Za-z0-9-_]{1,128}$",
      "value" : "300",
      "visible" : "false"
    }, {
      "description" : "Timeout of SYSTEM_FIX job item",
      "name" : "TIMEOUT_SYSTEM_FIX",
      "regex" : "^[A-Za-z0-9-_]{1,128}$",
      "value" : "300",
      "visible" : "false"
    } ]
  } ],
  "pages" : 1,
  "size" : 10,
  "total" : 1
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：Lite Server管理