更新应用
功能介绍
更新应用。
调用方法
请参见如何调用API。
URI
PUT /v1/applications
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串,长度不超过20000个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
应用id |
project_id |
是 |
String |
项目id |
name |
是 |
String |
应用名称 |
description |
否 |
String |
描述 |
is_draft |
是 |
Boolean |
是否为草稿 |
create_type |
是 |
String |
创建类型,template:部署模板创建 |
slave_cluster_id |
否 |
String |
自定义slave资源池id |
trigger |
否 |
TaskTriggerVO object |
部署应用执行触发设置 |
arrange_infos |
否 |
Array of UpdateTaskV2RequestBody objects |
部署任务列表信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
trigger_source |
否 |
String |
参数解释: 部署任务允许执行的场景。。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
artifact_source_system |
否 |
String |
参数解释: 当任务只允许流水线触发执行时,流水线传递的来源信息。。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
artifact_type |
否 |
String |
参数解释: 当任务只允许流水线触发执行时,对应流水线源的制品仓库类型。。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
部署任务id |
deploy_system |
否 |
String |
部署系统,deployTemplate:部署模板 |
template_id |
否 |
String |
模板id |
operation_list |
否 |
Array of DeployV2OperationsDO objects |
部署编排列表信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
参数解释: 步骤id。 约束限制: 不涉及。 取值范围: 只能由数字组成。 默认取值: 不涉及。 |
name |
否 |
String |
参数解释: 步骤名称。 约束限制: 不涉及。 取值范围: 长度为1~128个字符。 默认取值: 不涉及。 |
description |
否 |
String |
参数解释: 步骤描述。 约束限制: 不涉及。 取值范围: 长度最长为1024个字符。 默认取值: 不涉及。 |
code |
否 |
String |
参数解释: 步骤下载地址。 约束限制: 不涉及。 取值范围: 长度最长为102400个字符。 默认取值: 不涉及。 |
params |
否 |
String |
参数解释: 步骤详细定义。 约束限制: 不涉及。 取值范围: 长度最长为204800个字符。 默认取值: 不涉及。 |
entrance |
否 |
String |
参数解释: 步骤入口函数。 约束限制: 不涉及。 取值范围: 长度最长为1024个字符。 默认取值: 不涉及。 |
version |
否 |
String |
参数解释: 步骤版本。 约束限制: 不涉及。 取值范围: 长度最长为1024个字符。 默认取值: 不涉及。 |
module_id |
否 |
String |
参数解释: 步骤模块id。 约束限制: 不涉及。 取值范围: 长度最长为1024个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 请求成功失败状态。 取值范围:
|
result |
AppBaseResponse object |
参数解释: 创建和删除应用响应体。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 应用id。 取值范围: 由英文字母、数字组成,且长度为32个字符。 |
name |
String |
参数解释: 应用名称。 取值范围: 由中文字符、英文字母、数字及“_”、“-”组成,且长度为[3-128]个字符。 |
region |
String |
参数解释: 应用所属区域。 取值范围: 不涉及。 |
arrange_infos |
Array of TaskBaseBody objects |
参数解释: 部署任务列表。 |
请求示例
更新应用
https://{endpoint}/v1/applications
{
"id" : "e700f15965694253940502911220d76b",
"name" : "deployenv20230822192953",
"project_id" : "55837d272adf4eee90319800e2da6961",
"description" : "更新应用",
"trigger" : {
"trigger_source" : 0,
"artifact_source_system" : "",
"artifact_type" : ""
},
"slave_cluster_id" : "",
"create_type" : "template",
"is_draft" : true,
"arrange_infos" : [ {
"id" : "e700f15965694253940502911220d76b",
"deploy_system" : "deployTemplate",
"template_id" : "ec939bdf63194aca9fad45b3ba05643e",
"operation_list" : [ ]
} ]
}
响应示例
状态码:200
OK 请求响应成功
{
"result" : {
"id" : "e700f15965694253940502911220d76b",
"name" : "testApp",
"region" : "region-a",
"arrange_infos" : [ {
"id" : "e700f15965694253940502911220d76b"
} ]
},
"status" : "success"
}
SDK代码示例
SDK代码示例如下。
Java
更新应用
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
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 UpdateAppInfoSolution {
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();
UpdateAppInfoRequest request = new UpdateAppInfoRequest();
UpdateAppInfoRequestBody body = new UpdateAppInfoRequestBody();
List<UpdateTaskV2RequestBody> listbodyArrangeInfos = new ArrayList<>();
listbodyArrangeInfos.add(
new UpdateTaskV2RequestBody()
.withId("e700f15965694253940502911220d76b")
.withDeploySystem(UpdateTaskV2RequestBody.DeploySystemEnum.fromValue("deployTemplate"))
.withTemplateId("ec939bdf63194aca9fad45b3ba05643e")
.withOperationList()
);
TaskTriggerVO triggerbody = new TaskTriggerVO();
triggerbody.withTriggerSource("0")
.withArtifactSourceSystem("")
.withArtifactType("");
body.withArrangeInfos(listbodyArrangeInfos);
body.withTrigger(triggerbody);
body.withSlaveClusterId("");
body.withCreateType(UpdateAppInfoRequestBody.CreateTypeEnum.fromValue("template"));
body.withIsDraft(true);
body.withDescription("更新应用");
body.withName("deployenv20230822192953");
body.withProjectId("55837d272adf4eee90319800e2da6961");
body.withId("e700f15965694253940502911220d76b");
request.withBody(body);
try {
UpdateAppInfoResponse response = client.updateAppInfo(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
更新应用
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 49 50 51 52 53 |
# 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 = UpdateAppInfoRequest()
listArrangeInfosbody = [
UpdateTaskV2RequestBody(
id="e700f15965694253940502911220d76b",
deploy_system="deployTemplate",
template_id="ec939bdf63194aca9fad45b3ba05643e",
)
]
triggerbody = TaskTriggerVO(
trigger_source="0",
artifact_source_system="",
artifact_type=""
)
request.body = UpdateAppInfoRequestBody(
arrange_infos=listArrangeInfosbody,
trigger=triggerbody,
slave_cluster_id="",
create_type="template",
is_draft=True,
description="更新应用",
name="deployenv20230822192953",
project_id="55837d272adf4eee90319800e2da6961",
id="e700f15965694253940502911220d76b"
)
response = client.update_app_info(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
更新应用
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
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.UpdateAppInfoRequest{}
idArrangeInfos:= "e700f15965694253940502911220d76b"
deploySystemArrangeInfos:= model.GetUpdateTaskV2RequestBodyDeploySystemEnum().DEPLOY_TEMPLATE
templateIdArrangeInfos:= "ec939bdf63194aca9fad45b3ba05643e"
var listArrangeInfosbody = []model.UpdateTaskV2RequestBody{
{
Id: &idArrangeInfos,
DeploySystem: &deploySystemArrangeInfos,
TemplateId: &templateIdArrangeInfos,
},
}
triggerSourceTrigger:= "0"
artifactSourceSystemTrigger:= ""
artifactTypeTrigger:= ""
triggerbody := &model.TaskTriggerVo{
TriggerSource: &triggerSourceTrigger,
ArtifactSourceSystem: &artifactSourceSystemTrigger,
ArtifactType: &artifactTypeTrigger,
}
slaveClusterIdUpdateAppInfoRequestBody:= ""
descriptionUpdateAppInfoRequestBody:= "更新应用"
request.Body = &model.UpdateAppInfoRequestBody{
ArrangeInfos: &listArrangeInfosbody,
Trigger: triggerbody,
SlaveClusterId: &slaveClusterIdUpdateAppInfoRequestBody,
CreateType: model.GetUpdateAppInfoRequestBodyCreateTypeEnum().TEMPLATE,
IsDraft: true,
Description: &descriptionUpdateAppInfoRequestBody,
Name: "deployenv20230822192953",
ProjectId: "55837d272adf4eee90319800e2da6961",
Id: "e700f15965694253940502911220d76b",
}
response, err := client.UpdateAppInfo(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。