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 application 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" : [ ] }
SDK Sample Code
The SDK sample code is as follows.
Java
This API is used to deploy an application by deployment application ID.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; import java.util.List; import java.util.ArrayList; public class StartDeployTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); StartDeployTaskRequest request = new StartDeployTaskRequest(); request.withTaskId("{task_id}"); try { StartDeployTaskResponse response = client.startDeployTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
This API is used to deploy an application by deployment application ID.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = StartDeployTaskRequest() request.task_id = "{task_id}" response = client.start_deploy_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
This API is used to deploy an application by deployment application ID.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.StartDeployTaskRequest{} request.TaskId = "{task_id}" response, err := client.StartDeployTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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