部署应用
功能介绍
根据部署任务id部署应用。
调用方法
请参见如何调用API。
URI
POST /v2/tasks/{task_id}/start
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
task_id |
是 |
String |
参数解释: 部署任务id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
params |
否 |
Array of DynamicConfigInfo objects |
参数解释: 部署应用时传递的参数。 |
record_id |
否 |
String |
参数解释: 应用的部署id。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
trigger_source |
否 |
String |
参数解释: 是否限制触发来源。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
key |
否 |
String |
参数解释: 部署应用时传递的参数名称。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字、-、_、.组成。 默认取值: 不涉及。 |
value |
否 |
String |
参数解释: 部署应用时传递的参数值。 约束限制: 不涉及。 取值范围: 长度最长为8192个字符,不支持“{{”、“{%”、“{#”字符。 默认取值: 不涉及。 |
type |
否 |
String |
参数解释: 部署参数类型。 约束限制: 如果填写动态参数,则类型必选。 取值范围:
默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 部署任务id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
task_id |
String |
参数解释: 部署任务id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
job_name |
String |
参数解释: 执行任务名称。 取值范围: 由英文字母、数字组成,且长度为[45~55]个字符。 |
app_component_list |
Array of AppComponentDao objects |
参数解释: 应用和AOM应用组件对应关系。 |
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
参数解释: 部署任务id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
app_id |
String |
参数解释: AOM应用id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
app_name |
String |
参数解释: AOM应用名称。 取值范围: 由英文字母、数字组成。 |
comp_id |
String |
参数解释: AOM应用组件id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
comp_name |
String |
参数解释: AOM应用组件名称。 取值范围: 长度为[0,128]个字符。 |
domain_id |
String |
参数解释: 租户id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
region |
String |
参数解释: 局点信息。 取值范围: 长度为[1,256]个字符。 |
state |
String |
参数解释: AOM应用组件是否生效。 取值范围:
|
请求示例
根据部署任务id部署应用。
https://{endpoint}/v2/tasks/d2dc947ec2424d8789bb3984bb3adf45/start
{
"params" : [ ]
}
响应示例
状态码:200
OK 请求响应成功
{
"id" : "0ee9c8e6a7dc44109541e53c6dccf47c",
"task_id" : "d2dc947ec2424d8789bb3984bb3adf45",
"job_name" : "job_0ee9c8e6a7dc44109541e53c6dccf47c_1620810492008",
"app_component_list" : [ ]
}
SDK代码示例
SDK代码示例如下。
Java
根据部署任务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
根据部署任务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
根据部署任务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)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。