Creating a Batch Job
Function
This API is used to create a batch job, which can be a batch node upgrade, batch application deployment, or batch application upgrade.
URI
POST /v2/{project_id}/productmgr/jobs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
ief-instance-id |
No |
String |
Platinum edition instance ID. This parameter is left blank for a professional edition instance. |
Content-Type |
Yes |
String |
Message body type (format). The default value is application/json. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
job_name |
Yes |
String |
Batch job name. The value can contain a maximum of 26 characters, including lowercase letters, digits, and hyphens (-), but cannot start or end with a hyphen (-). |
job_type |
Yes |
String |
Batch job type, including: |
job_content |
No |
JobContentInfo object |
Batch job details. |
description |
No |
String |
Batch job description. |
tags |
No |
Array of Attributes objects |
Batch job tags. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
target_type |
No |
String |
Type of the batch job target, including: |
targets |
No |
Array of Target objects |
Batch job target details. |
task_data |
No |
String |
Batch job content. This parameter is mandatory only for a batch application deployment or upgrade. The value is the deployment parameter value in the request body of the API for creating a deployment compiled in the JSON format, and must be converted into a string. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
extension_info |
No |
Array of Extension objects |
Basic information about the batch job target. |
target_id |
Yes |
String |
Batch job target ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Attribute name. The value can be node_name. |
value |
No |
String |
Attribute value. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Key of a node property. The key can contain 1 to 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
value |
No |
String |
Value of a node property. The value can contain 1 to 256 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. |
Response
Status code: 201
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Batch job ID. |
job_name |
String |
Batch job name. |
created_at |
Integer |
Batch job creation time. |
Example Request
A batch application deployment job is created. The batch job target type is edge node.
{ "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" : "" }
Example Response
Status code: 201
Creation succeeded.
{ "job_name" : "aaa", "job_id" : "66273c66-f72e-4607-8769-3663d255fb83", "created_at" : 1667218308 }
Status Codes
Status Code |
Description |
---|---|
201 |
Creation succeeded. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot