CreateJobTemplate - 创建任务模板

更新时间:
复制 MD 格式

创建任务模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidlc:CreateJobTemplate

create

*全部资源

*

无 无

请求语法

POST /api/v1/jobtemplates HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

body

object

否

请求 Body 参数。

Constraints

object

否

字段约束规则。Key 为 JSONPath 表达式,Value 为约束类型:locked(锁定不可覆盖)、overridable(可覆盖)、required(必填)。

{\"JobSpecs[0].Image\":\"locked\",\"UserCommand\":\"locked\",\"JobType\":\"locked\"}

Content

string

是

任务模板的配置内容,包含作业配置参数,以 JSON String 格式传入。

{\"WorkspaceId\":\"15****05\",\"JobType\":\"PyTorchJob\",\"UserCommand\":\"echo hello\",\"JobSpecs\":[{\"Type\":\"Worker\",\"PodCount\":1,\"Image\":\"dsw-registry-vpc.cn-hangzhou.cr.aliyuncs.com/pai/pytorch:2.8.0-gpu-py313-cu129-ubuntu22.04-3995b779-1764361782\",\"EcsSpec\":\"ecs.gn7i-c8g1.2xlarge\"}],\"ResourceType\":\"ECS\",\"_ResourcePaymentType\":\"PostPaid\",\"CredentialConfig\":{\"EnableCredentialInject\":false},\"Accessibility\":\"PRIVATE\",\"Settings\":{\"JobReservedMinutes\":0,\"Tags\":{}}}

Description

string

否

任务模板的描述信息

Template description

Metadata

object

否

自定义的键值对元数据

{}

TemplateName

string

是

任务模板的名称

job-template-example-1778047****

WorkspaceId

string

是

模板所属的工作空间 ID

15****05

返回参数

名称

类型

描述

示例值

object

DefaultVersion

integer

当前使用的默认版本号

1

Description

string

任务模板的描述信息

Template description

GmtCreateTime

string

模板的创建时间

2025-12-31T02:18:09Z

GmtModifyTime

string

模板的最后修改时间

2026-01-12T14:36:00Z

LastUsedTime

string

使用该模板成功创建任务的最近时间。新建模板尚未使用时不返回。

2026-09-03T11:30:00Z

Metadata

object

用户自定义的键值对元数据

{}

RequestId

string

本次请求的 ID,用于诊断和答疑。

8762921A-911C-515F-A3A4-*********

TemplateId

string

任务模板的唯一标识

tplmceolmf2****

TemplateName

string

任务模板的名称

job-template-example-1778047****

TenantId

string

模板所属的租户 ID

10**************14

UserId

string

创建模板的用户 ID

20**************02

Version

integer

当前返回的版本的号

1

WorkspaceId

string

模板所属的工作空间 ID

15****05

示例

正常返回示例

JSON格式

{
  "DefaultVersion": 1,
  "Description": "Template description\n",
  "GmtCreateTime": "2025-12-31T02:18:09Z",
  "GmtModifyTime": "2026-01-12T14:36:00Z",
  "LastUsedTime": "2026-09-03T11:30:00Z",
  "Metadata": {},
  "RequestId": "8762921A-911C-515F-A3A4-*********",
  "TemplateId": "tplmceolmf2****",
  "TemplateName": "job-template-example-1778047****\t",
  "TenantId": "10**************14",
  "UserId": "20**************02",
  "Version": 1,
  "WorkspaceId": "15****05"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。