文档首页/ AI开发平台ModelArts/ API参考/ Lite Server管理/ 获取Lite Server Job模板详情 - ShowServerJobTemplate
更新时间:2026-01-08 GMT+08:00
分享

获取Lite Server Job模板详情 - ShowServerJobTemplate

功能介绍

获取Lite Server 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/templates/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

String

参数解释:Lite Server任务模板id。

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

取值范围:不涉及。

默认取值:不涉及。

project_id

String

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

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

取值范围:不涉及。

默认取值:不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释:模板id。

取值范围:不涉及。

name

String

参数解释:模板名称。

取值范围:不涉及。

description

String

参数解释:模板描述。

取值范围:不涉及。

cmd

String

参数解释:容器启动命令。

取值范围:不涉及。

swr_path

String

参数解释:任务镜像。

取值范围:不涉及。

resources

String

参数解释:任务规格。

取值范围:不涉及。

volumes

String

参数解释:卷。

取值范围:不涉及。

volumes_mount

String

参数解释:卷挂载。

取值范围:不涉及。

flavor_type

String

参数解释:规格类型。

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

timeout

String

参数解释:任务超时时间。

取值范围:不涉及。

check_interval

String

参数解释:任务的轮询周期。

取值范围:不涉及。

type

String

参数解释:任务类型。

取值范围:-LOG_COLLECT -COMMON 等

status

String

参数解释:模板状态。

取值范围:ACTIVE。

params

Array of TemplateParam objects

参数解释:模板的其他参数。

表3 TemplateParam

参数

参数类型

描述

name

String

参数解释:参数名称。

取值范围:不涉及。

description

String

参数解释:参数描述。

取值范围:不涉及。

value

String

参数解释:参数取值。

取值范围:不涉及。

visible

String

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

取值范围:- true -false。

regex

String

参数解释:正则校验。

取值范围:不涉及。

请求示例

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

{ }

响应示例

状态码:200

OK

{
  "id" : "2b087a09-e90d-414c-9b15-ffec45e400e9",
  "cmd" : "/root/script/start_system_config.sh",
  "swr_path" : "swr.cn-north-7.myhuaweicloud.com/atelier/aiserver_service_aarch64:ai_server-py_3.11-hce_2.0.2506-aarch64-20251020164959-113183f",
  "resources" : "{\"limits\":{\"cpu\":\"250m\",\"memory\":\"512Mi\"},\"requests\":{\"cpu\":\"250m\",\"memory\":\"512Mi\"}}",
  "volumes" : "[{\"hostPath\":{\"path\":\"/tmp\"},\"name\":\"tmp\"}]",
  "volumes_mount" : "[{\"mountPath\":\"/tmp\",\"name\":\"tmp\"}]",
  "flavor_type" : "ASCEND_GENERIC",
  "timeout" : "300",
  "check_interval" : "10",
  "type" : "ASCEND_SYSTEM_CONFIG",
  "status" : "ACTIVE",
  "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"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档