创建批量处理任务
功能介绍
创建批量处理作业。该API用于创建批量处理作业,当前支持:批量节点升级、批量应用部署、批量应用升级
URI
POST /v2/{project_id}/productmgr/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
ief-instance-id |
否 |
String |
铂金版实例ID,专业版实例为空值 |
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json” |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_name |
是 |
String |
批量作业名称,允许输入小写字母,数字,中划线,不能以中划线开头或结尾,最大长度为26位 |
job_type |
是 |
String |
批量作业类型,支持以下选项:
|
job_content |
否 |
JobContentInfo object |
批量作业详细信息 |
description |
否 |
String |
批量作业描述 |
tags |
否 |
Array of Attributes objects |
批量作业标签 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
target_type |
否 |
String |
批量作业对象类型,支持如下选项:
|
targets |
否 |
Array of Target objects |
批量作业对象详情 |
task_data |
否 |
String |
批量作业内容,仅在批量应用部署和批量应用升级时需要填写,填入的内容为:使用json结构体编写的创建应用部署接口请求体deployment参数,并将其转换为字符串 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
extension_info |
否 |
Array of Extension objects |
批量处理对象基本信息 |
target_id |
是 |
String |
批量处理对象ID |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
批量处理作业ID |
job_name |
String |
批量处理作业名称 |
created_at |
Integer |
批量处理作业创建时间戳 |
请求示例
创建批量处理任务,批量处理类型为“应用部署”,批量作业对象类型为“边缘节点”。
{ "job_name" : "aaa", "job_type" : "deployment_deploy", "job_content" : { "target_type" : "node", "targets" : [ { "target_id" : "72eb5df1-295b-41f6-baed-d1a56728b0e0", "extension_info" : [ { "key" : "node_name", "value" : "test1" } ] }, { "target_id" : "b1c0e722-ee98-4ae3-9224-881224cb32c9", "extension_info" : [ { "key" : "node_name", "value" : "test-node" } ] } ], "task_data" : "{\"deployment\":{\"replicas\":1,\"template\":{\"configs\":{\"host_network\":false,\"restart_policy\":\"Always\",\"host_pid\":false},\"containers\":[{\"name\":\"container-06fefd36\",\"version\":\"latest\",\"image_url\":\"sample:latest\",\"envs\":[],\"volumes\":[],\"resources\":{\"limits\":{\"cpu\":\"0.25\",\"memory\":\"512\"},\"requests\":{\"cpu\":\"0.25\",\"memory\":\"512\"}},\"privileged\":false,\"ports\":[]}]}},\"source\":\"userdefined\",\"name_prex\":\"aaa\",\"tags\":[],\"description\":\"\"}" }, "tags" : [ ], "description" : "" }
响应示例
状态码: 201
创建成功
{ "job_name" : "aaa", "job_id" : "66273c66-f72e-4607-8769-3663d255fb83", "created_at" : 1667218308 }
状态码
状态码 |
描述 |
---|---|
201 |
创建成功 |
错误码
请参见错误码。