Deploying an Application
Function
This API is used to deploy an application by deployment task ID.
Calling Method
For details, see Calling APIs.
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). |
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
params |
No |
Array of DynamicConfigInfo objects |
Parameters transferred during application deployment |
record_id |
No |
String |
Deployment ID of an 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 the record ID from the URL. |
trigger_source |
No |
String |
Trigger source. 0: Deployment can be triggered through all requests. 1: Deployment can be triggered only through pipeline. |
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 application to be executed |
app_component_list |
Array of AppComponentDao objects |
Mapping between applications and AOM application components |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Parameter description: Deployment application ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
app_id |
String |
Parameter description: AOM application ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
app_name |
String |
Parameter description: AOM application name. Value range: The value consists of letters and digits. |
comp_id |
String |
Parameter description: AOM application component ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
comp_name |
String |
Parameter description: AOM application component name. Value range: The value consists of 0 to 128 characters. |
domain_id |
String |
Parameter description: Tenant ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
region |
String |
Parameter description: Region information. Value range: The value consists of 1 to 256 characters. |
state |
String |
Parameter description: Whether the AOM application component takes effect. Value range:
|
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.