创建Lite Server任务 - CreateServerJobs
功能介绍
创建Lite Server任务接口用于在Lite Server上创建新的任务。该接口适用于以下场景：当用户需要在Lite Server上启动新的开发、测试或部署任务时，可以通过此接口创建并配置任务。使用该接口的前提条件是用户具有创建任务的权限，并且提供的任务配置参数符合要求。创建操作完成后，新的Lite Server任务将被成功创建，并返回任务ID和其他相关信息。若用户无权限操作、提供的参数不正确或系统资源不足，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/dev-servers/jobs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释：任务名称。 约束限制：^[-_.a-zA-Z0-9]{1,64}$。 取值范围：不涉及。 默认取值：不涉及。 |
|
description |
否 |
String |
参数解释：任务描述。 约束限制：^[-_.a-zA-Z0-9]{1,64}$。 取值范围：不涉及。 默认取值：不涉及。 |
|
server_ids |
是 |
Array of strings |
参数解释：DevServer实例id列表。 取值范围：不涉及。 |
|
type |
是 |
String |
参数解释：任务模板类型。 约束限制：^[-_.a-zA-Z0-9]{1,64}$。 取值范围：-COMMON -SERVICE_DEPLOY 等。 默认取值：不涉及。 |
|
is_reboot |
否 |
Boolean |
参数解释：任务失败后是否重启。 约束限制：不涉及。 取值范围：- true -false。 默认取值：fasle。 |
|
items |
是 |
Array of DevServerJobItem objects |
参数解释：任务实例列表。 取值范围：不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_at |
String |
参数解释：创建时间。 取值范围：不涉及。 |
|
update_at |
String |
参数解释：更新时间。 取值范围：不涉及。 |
|
id |
String |
参数解释：任务ID。 取值范围：不涉及。 |
|
name |
String |
参数解释：任务名称。 取值范围：不涉及。 |
|
type |
String |
参数解释：任务模板类型。 取值范围：- COMMON -SERVICE_DEPLOY 等。 |
|
status |
String |
参数解释：状态。 取值范围：- ACTIVE。 |
|
items |
Array of DevServerJobItem objects |
参数解释：任务实例列表信息。 |
|
tasks |
Array of DevServerTaskResponse objects |
参数解释：task详情列表。 |
|
template_id |
String |
参数解释：任务模板ID。 取值范围：不涉及。 |
|
user_name |
String |
参数解释：下发任务的用户信息。 取值范围：不涉及。 |
|
abnormal_count |
Integer |
参数解释：task失败的节点数量。 取值范围：不涉及。 |
|
description |
String |
参数解释：描述。 取值范围：不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释：细粒度任务类型。 取值范围：- COMMON - DEVICE_LOG_COLLECT 等 |
|
spec |
Map<String,String> |
参数解释：任务所需参数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释：task的ID。 取值范围：不涉及。 |
|
server_id |
String |
参数解释：devserver机器ID。 取值范围：不涉及。 |
|
server_name |
String |
参数解释：devserver机器名称。 取值范围：不涉及。 |
|
status |
String |
参数解释：task状态。 取值范围：- PROCESSING -SUCCESS - FAILED - SKIPPED |
|
cloud_server |
Map<String,String> |
参数解释：底层ECS/BMS/HPS ID。 |
|
message |
String |
参数解释：输出信息。 取值范围：不涉及。 |
|
create_at |
String |
参数解释：创建时间。 取值范围：不涉及。 |
|
update_at |
String |
参数解释：更新时间。 取值范围：不涉及。 |
请求示例
POST https://{endpoint}/v1/{project_id}/dev-servers/jobs
{
"server_ids" : [ "66d210bc-023c-490a-8664-afd321a163ad" ],
"type" : "HDK_UPGRADE",
"items" : [ {
"spec" : {
"version" : "24.1.rc3.10"
},
"type" : "HDK_UPGRADE"
} ],
"name" : "hdk_upgrade_task",
"description" : "任务说明"
}
响应示例
状态码：200
OK
{
"create_at" : 1755005748201,
"update_at" : 1755005931007,
"id" : "64e004ec-6cb0-401f-a7c0-ec2557626b16",
"name" : "hdk_upgrade_task",
"description" : "任务说明",
"type" : "ASCEND_SOFTWARE_UPGRADE",
"status" : "FINISHED",
"items" : [ {
"spec" : {
"version" : "24.1.rc3.10"
},
"type" : "HDK_UPGRADE"
} ],
"tasks" : [ {
"create_at" : 1755005748201,
"update_at" : 1755005931355,
"id" : "64e004ec-ad30-4038-9af1-afd321a163ad",
"server_id" : "66d210bc-023c-490a-8664-afd321a163ad",
"server_name" : "liteserver-978c-00001",
"cloud_server" : {
"hps_ecs_id" : "e2cb187a-4c4d-495c-a5f8-3de83a4e44ce",
"id" : "39aab8e4-add9-4c2a-8fb7-c3e477e23855",
"type" : "HPS"
},
"status" : "SUCCESS",
"message" : "the message"
} ],
"template_id" : "6f02d33b-a5d6-485c-8d73-480da5870512",
"user_name" : "modelarts_user",
"abnormal_count" : 0
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。
