新建应用 (推荐)
功能介绍
新建应用。
调用方法
请参见如何调用API。
URI
POST /v1/applications
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式) |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id |
name |
是 |
String |
应用名称 |
description |
否 |
String |
描述 |
group_id |
否 |
String |
分组id |
is_draft |
是 |
Boolean |
是否为草稿 |
create_type |
是 |
String |
创建类型,创建类型只有一个'template',即根据模板创建 |
slave_cluster_id |
否 |
String |
自定义slave资源池id |
trigger |
否 |
TaskTriggerVO object |
部署任务触发场景配置 |
arrange_infos |
否 |
Array of TaskV2RequestBody objects |
部署任务列表信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
trigger_source |
否 |
String |
部署任务允许执行的场景。其中0:所有执行请求均可,1:只允许流水线触发 |
artifact_source_system |
否 |
String |
当任务只允许流水线触发执行时,流水线传递的来源信息,当前只有CodeArtsArtifact |
artifact_type |
否 |
String |
当任务只允许流水线触发执行时,对应流水线源的制品仓库类型(generic、docker) |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
template_id |
否 |
String |
模板id |
operation_list |
否 |
Array of DeployV2OperationsDO objects |
部署编排列表信息 |
响应参数
状态码: 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 { "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" : [ ] }
响应示例
状态码: 200
OK 请求响应成功
{ "result" : { "id" : "e700f15965694253940502911220d76b", "name" : "testApp", "region" : "cn-north-7", "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 |
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 CreateAppSolution { 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(); CreateAppRequest request = new CreateAppRequest(); CreateAppRequestBody body = new CreateAppRequestBody(); TaskTriggerVO triggerbody = new TaskTriggerVO(); triggerbody.withTriggerSource("0") .withArtifactSourceSystem("") .withArtifactType(""); body.withTrigger(triggerbody); body.withSlaveClusterId(""); body.withCreateType(CreateAppRequestBody.CreateTypeEnum.fromValue("template")); body.withIsDraft(true); body.withDescription("使用空白模板创建应用"); body.withName("deployenv20230822192953"); body.withProjectId("55837d272adf4eee90319800e2da6961"); request.withBody(body); try { CreateAppResponse response = client.createApp(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 |
# 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 = CreateAppRequest() triggerbody = TaskTriggerVO( trigger_source="0", artifact_source_system="", artifact_type="" ) request.body = CreateAppRequestBody( trigger=triggerbody, slave_cluster_id="", create_type="template", is_draft=True, description="使用空白模板创建应用", name="deployenv20230822192953", project_id="55837d272adf4eee90319800e2da6961" ) response = client.create_app(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 |
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.CreateAppRequest{} triggerSourceTrigger:= "0" artifactSourceSystemTrigger:= "" artifactTypeTrigger:= "" triggerbody := &model.TaskTriggerVo{ TriggerSource: &triggerSourceTrigger, ArtifactSourceSystem: &artifactSourceSystemTrigger, ArtifactType: &artifactTypeTrigger, } slaveClusterIdCreateAppRequestBody:= "" descriptionCreateAppRequestBody:= "使用空白模板创建应用" request.Body = &model.CreateAppRequestBody{ Trigger: triggerbody, SlaveClusterId: &slaveClusterIdCreateAppRequestBody, CreateType: model.GetCreateAppRequestBodyCreateTypeEnum().TEMPLATE, IsDraft: true, Description: &descriptionCreateAppRequestBody, Name: "deployenv20230822192953", ProjectId: "55837d272adf4eee90319800e2da6961", } response, err := client.CreateApp(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK 请求响应成功 |
错误码
请参见错误码。