# 创建插件草稿版本 - CreatePluginDraft #### 功能介绍 创建插件草稿版本 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI POST /v1/{domain_id}/agent-plugin/create-draft 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 租户ID，用户的domainId。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用[IAM服务获取用户Token接口](https://support.huaweicloud.com/api-iam/iam_30_0003.html)获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | unique_id | 否 | String | **参数解释**： 扩展插件唯一ID。可以通过[查询插件版本详情](https://support.huaweicloud.com/api-pipeline/ShowPluginVersion.html)接口，获取响应参数中unique_id。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | | icon_url | 否 | String | **参数解释**： 插件展示图标URL。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | runtime_attribution | 是 | String | **参数解释**： 运行属性。 **约束限制**： 不涉及。 **取值范围**： - agent：基于agent运行。 - agentless：无需agent运行。 **默认取值**： 不涉及。 | | plugin_name | 是 | String | **参数解释**： 插件名。 **约束限制**： 仅支持输入大小写英文字母、数字、'-'、'_'。 **取值范围**： 1到50位字符。 **默认取值**： 不涉及。 | | display_name | 是 | String | **参数解释**： 展示名。 **约束限制**： 仅支持输入大小写英文字母、中文、空格、数字、'-'、'_'、'.'。 **取值范围**： 1到50位字符。 **默认取值**： 不涉及。 | | business_type | 是 | String | **参数解释**： 业务类型。 **约束限制**： 仅支持输入大小写英文字母、数字、'-'、'_'。 **取值范围**： - Build。 - Gate。 - Deploy。 - Test。 - Normal。 **默认取值**： 不涉及。 | | business_type_display_name | 是 | String | **参数解释**： 插件业务类型展示名。 **约束限制**： 不涉及。 **取值范围**： - 构建。 - 代码检查。 - 部署。 - 测试。 - 通用。 **默认取值**： 不涉及。 | | description | 是 | String | **参数解释**： 插件描述。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | is_private | 否 | Integer | **参数解释**： 是否私有插件。 **约束限制**： 不涉及。 **取值范围**： - 1：私有插件。 - 0：公开插件。 **默认取值**： 0。 | | region | 否 | String | **参数解释**： 局点。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | maintainers | 否 | String | **参数解释**： 插件维护者。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | plugin_composition_type | 否 | String | **参数解释**： 插件的组合类型。 **约束限制**： 不涉及。 **取值范围**： - single：单step插件。 - multi：组合插件。 **默认取值**： 不涉及。 | | manifest_version | 否 | String | **参数解释**： 用于区分新旧版数据版本。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | version | 是 | String | **参数解释**： 插件版本号。 **约束限制**： 必须是类似 x.xx.xx（例如：1.0.2） 的格式，其中：x 是 1 到 2 位的数字（范围 0 到 99）。xx 是点后跟随的数字部分，且每部分可以是 1 位或 2 位数字。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | version_description | 否 | String | **参数解释**： 插件小版本版本号说明。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | execution_info | 是 | [execution_info] object | **参数解释**： 执行信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | output_info | 否 | Array of [output_info] objects | **参数解释**： 插件输出相关内容。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | input_info | 否 | Array of [input_info] objects | **参数解释**： 输入信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4execution_info | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | inner_execution_info | 是 | [inner_execution_info] object | **参数解释**： 插件执行信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表5inner_execution_info | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | execution_type | 否 | String | **参数解释**： 插件类型。 **约束限制**： 不涉及。 **取值范围**： CONTAINER, ZIP, SHELL, COMPOSITE。 **默认取值**： 不涉及。 | | steps | 否 | Array of [steps] objects | **参数解释**： 步骤列表。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表6steps | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 任务名称。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | task | 否 | String | **参数解释**： 任务类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | variables | 否 | Map\ | **参数解释**： 参数信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | identifier | 否 | String | **参数解释**： step的标识。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表7output_info | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 插件输出配置的唯一标识。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | version | 否 | String | **参数解释**： 插件输出版本号。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 插件输出配置的描述。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | source | 否 | String | **参数解释**： 插件输出配置的源。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | type | 否 | String | **参数解释**： 插件输出配置的输出类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表8input_info | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 插件输入配置的唯一标识。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | default_value | 否 | String | **参数解释**： 插件输入配置的默认值，未填写时默认显示。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | type | 否 | String | **参数解释**： 插件输入配置的输入类型。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | validation | 否 | String | **参数解释**： 插件输入配置的输入内容的正则校验规则。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | layout_content | 否 | String | **参数解释**： 样式信息。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | **参数解释**： 是否调用成功。 **取值范围**： - true：调用成功。 - false：调用失败。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/create-draft { "plugin_name" : "apie_test", "display_name" : "apie_test", "business_type" : "Normal", "description" : "", "maintainers" : "", "business_type_display_name" : "通用", "icon_url" : "", "version" : "0.0.1", "version_description" : "", "input_info" : [ ], "execution_info" : { "inner_execution_info" : { "execution_type" : "COMPOSITE", "steps" : [ { "task" : "official_shell_plugin", "name" : "执行Shell", "variables" : { "OFFICIAL_SHELL_SCRIPT_INPUT" : "env" } } ] } }, "runtime_attribution" : "agent" } ``` #### 响应示例 **状态码：200** OK ``` true ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.util.HashMap; public class CreatePluginDraftSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("")) .build(); CreatePluginDraftRequest request = new CreatePluginDraftRequest(); request.withDomainId("{domain_id}"); PluginDTO body = new PluginDTO(); Map listStepsVariables = new HashMap<>(); listStepsVariables.put("OFFICIAL_SHELL_SCRIPT_INPUT", "env"); List listInnerExecutionInfoSteps = new ArrayList<>(); listInnerExecutionInfoSteps.add( new PluginDTOExecutionInfoInnerExecutionInfoSteps() .withName("执行Shell") .withTask("official_shell_plugin") .withVariables(listStepsVariables) ); PluginDTOExecutionInfoInnerExecutionInfo innerExecutionInfoExecutionInfo = new PluginDTOExecutionInfoInnerExecutionInfo(); innerExecutionInfoExecutionInfo.withExecutionType("COMPOSITE") .withSteps(listInnerExecutionInfoSteps); PluginDTOExecutionInfo executionInfobody = new PluginDTOExecutionInfo(); executionInfobody.withInnerExecutionInfo(innerExecutionInfoExecutionInfo); body.withExecutionInfo(executionInfobody); body.withVersionDescription(""); body.withVersion("0.0.1"); body.withMaintainers(""); body.withDescription(""); body.withBusinessTypeDisplayName("通用"); body.withBusinessType("Normal"); body.withDisplayName("apie_test"); body.withPluginName("apie_test"); body.withRuntimeAttribution("agent"); body.withIconUrl(""); request.withBody(body); try { CreatePluginDraftResponse response = client.createPluginDraft(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] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("")) \ .build() try: request = CreatePluginDraftRequest() request.domain_id = "{domain_id}" listVariablesSteps = { "OFFICIAL_SHELL_SCRIPT_INPUT": "env" } listStepsInnerExecutionInfo = [ PluginDTOExecutionInfoInnerExecutionInfoSteps( name="执行Shell", task="official_shell_plugin", variables=listVariablesSteps ) ] innerExecutionInfoExecutionInfo = PluginDTOExecutionInfoInnerExecutionInfo( execution_type="COMPOSITE", steps=listStepsInnerExecutionInfo ) executionInfobody = PluginDTOExecutionInfo( inner_execution_info=innerExecutionInfoExecutionInfo ) request.body = PluginDTO( execution_info=executionInfobody, version_description="", version="0.0.1", maintainers="", description="", business_type_display_name="通用", business_type="Normal", display_name="apie_test", plugin_name="apie_test", runtime_attribution="agent", icon_url="" ) response = client.create_plugin_draft(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] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartspipeline.NewCodeArtsPipelineClient(hcClient) request := &model.CreatePluginDraftRequest{} request.DomainId = "{domain_id}" var listVariablesSteps = map[string]interface{}{ "OFFICIAL_SHELL_SCRIPT_INPUT": "env", } nameSteps:= "执行Shell" taskSteps:= "official_shell_plugin" var listStepsInnerExecutionInfo = []model.PluginDtoExecutionInfoInnerExecutionInfoSteps{ { Name: &nameSteps, Task: &taskSteps, Variables: listVariablesSteps, }, } executionTypeInnerExecutionInfo:= "COMPOSITE" innerExecutionInfoExecutionInfo := &model.PluginDtoExecutionInfoInnerExecutionInfo{ ExecutionType: &executionTypeInnerExecutionInfo, Steps: &listStepsInnerExecutionInfo, } executionInfobody := &model.PluginDtoExecutionInfo{ InnerExecutionInfo: innerExecutionInfoExecutionInfo, } versionDescriptionPluginDto:= "" maintainersPluginDto:= "" iconUrlPluginDto:= "" request.Body = &model.PluginDto{ ExecutionInfo: executionInfobody, VersionDescription: &versionDescriptionPluginDto, Version: "0.0.1", Maintainers: &maintainersPluginDto, Description: "", BusinessTypeDisplayName: "通用", BusinessType: "Normal", DisplayName: "apie_test", PluginName: "apie_test", RuntimeAttribution: "agent", IconUrl: &iconUrlPluginDto, } response, err := client.CreatePluginDraft(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsPipeline/sdk?api=CreatePluginDraft)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。