文档首页/ AI开发平台ModelArts/ API参考/ DevServer管理/ 获取DevServer Job模板列表
更新时间:2025-11-17 GMT+08:00
分享

获取DevServer Job模板列表

功能介绍

获取DevServer Job模板列表

调试

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

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

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

取值范围:不涉及。

flavor_type

String

参数解释:规格类型。

取值范围:不涉及。

params

Array of TemplateParam objects

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

表5 TemplateParam

参数

参数类型

描述

name

String

参数解释:参数名称。

取值范围:不涉及。

description

String

参数解释:参数描述。

取值范围:不涉及。

value

String

参数解释:参数取值。

取值范围:不涉及。

visible

String

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

取值范围:不涉及。

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

错误码

请参见错误码

相关文档