创建任务模板。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/jobtemplates HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body 参数。 |
|
| TemplateName |
string |
是 |
任务模板的名称 |
job-template-example-1778047**** |
| Description |
string |
否 |
任务模板的描述信息 |
Template description |
| WorkspaceId |
string |
是 |
模板所属的工作空间 ID |
15****05 |
| Metadata |
object |
否 |
自定义的键值对元数据 |
{} |
| 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\":{}}} |
| Constraints |
object |
否 |
字段约束规则。Key 为 JSONPath 表达式,Value 为约束类型:locked(锁定不可覆盖)、overridable(可覆盖)、required(必填)。 |
{\"JobSpecs[0].Image\":\"locked\",\"UserCommand\":\"locked\",\"JobType\":\"locked\"} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| TemplateId |
string |
任务模板的唯一标识 |
tplmceolmf2**** |
| TemplateName |
string |
任务模板的名称 |
job-template-example-1778047**** |
| Description |
string |
任务模板的描述信息 |
Template description |
| Metadata |
object |
用户自定义的键值对元数据 |
{} |
| WorkspaceId |
string |
模板所属的工作空间 ID |
15****05 |
| UserId |
string |
创建模板的用户 ID |
20**************02 |
| TenantId |
string |
模板所属的租户 ID |
10**************14 |
| DefaultVersion |
integer |
当前使用的默认版本号 |
1 |
| Version |
integer |
当前返回的版本的号 |
1 |
| GmtCreateTime |
string |
模板的创建时间 |
2025-12-31T02:18:09Z |
| GmtModifyTime |
string |
模板的最后修改时间 |
2026-01-12T14:36:00Z |
| RequestId |
string |
本次请求的 ID,用于诊断和答疑。 |
8762921A-911C-515F-A3A4-********* |
示例
正常返回示例
JSON格式
{
"TemplateId": "tplmceolmf2****",
"TemplateName": "job-template-example-1778047****\t",
"Description": "Template description\n",
"Metadata": {},
"WorkspaceId": "15****05",
"UserId": "20**************02",
"TenantId": "10**************14",
"DefaultVersion": 1,
"Version": 1,
"GmtCreateTime": "2025-12-31T02:18:09Z",
"GmtModifyTime": "2026-01-12T14:36:00Z",
"RequestId": "8762921A-911C-515F-A3A4-*********"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。