Deploying an Application
Function
This API is used to deploy an application of a specified ID.
URI
POST /v2/tasks/{task_id}/start
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
task_id |
Yes |
String |
Deployment task ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). Possible values: application/json;charset=utf-8 application/json Default: application/json;charset=utf-8 Enumeration values:
|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. Minimum: 0 Maximum: 20000 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
params |
No |
Array of DynamicConfigInfo objects |
Parameters transferred during application deployment. Array Length: 0 - 500 |
record_id |
No |
String |
Deployment ID of the application. You can use record_id to roll back the application to the previous deployment status. Select the historical deployment record of the application and obtain it from the URL. |
trigger_source |
No |
String |
This API is used to specify the trigger source. 0 indicates that no deployment request source is restricted. 1 indicates that deployment can be triggered only through pipeline. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Parameter name transferred during application deployment. Minimum: 1 Maximum: 128 |
value |
No |
String |
Parameter value transferred during application deployment. Minimum: 1 Maximum: 8192 |
type |
No |
String |
Type. If a dynamic parameter is set, the type is mandatory. Enumeration values:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Deployment record ID. |
task_id |
String |
Deployment task ID. |
job_name |
String |
Name of the task to be executed Minimum: 45 Maximum: 55 |
app_component_list |
Array of AppComponentDao objects |
Mapping between Applications and AOM Application Components |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Deployment task ID. |
app_id |
String |
AOM application ID. |
app_name |
String |
AOM application name. |
comp_id |
String |
AOM application component ID. |
comp_name |
String |
AOM application component name. Minimum: 0 Maximum: 128 |
domain_id |
String |
Tenant ID. |
region |
String |
Site information. Minimum: 1 Maximum: 256 |
state |
String |
Whether the AOM application component takes effect. 0 indicates that the component is initialized. 1 indicates that the execution is successful and the component has taken effect. Minimum: 1 Maximum: 32 |
Example Requests
This API is used to deploy an application by deployment task ID.
https://{endpoint}/v2/tasks/d2dc947ec2424d8789bb3984bb3adf45/start { "params" : [ ] }
Example Responses
Status code: 200
OK: The request is successful.
{ "id" : "0ee9c8e6a7dc44109541e53c6dccf47c", "task_id" : "d2dc947ec2424d8789bb3984bb3adf45", "job_name" : "job_0ee9c8e6a7dc44109541e53c6dccf47c_1620810492008", "app_component_list" : [ ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
Error Codes
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