更新时间:2025-08-19 GMT+08:00
分享

创建插件草稿版本

功能介绍

创建插件草稿版本

调用方法

请参见如何调用API

URI

POST /v1/{domain_id}/agent-plugin/create-draft

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

租户ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

unique_id

String

参数解释

扩展插件唯一ID。可以通过查询插件版本详情接口,获取响应参数中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

参数解释

业务类型。

约束限制

仅支持输入大小写英文字母、数字、'-'、'_'。

取值范围

1到50位字符。

默认取值

不涉及。

business_type_display_name

String

参数解释

插件业务类型展示名。

约束限制

不涉及。

取值范围

  • 构建。

  • 代码检查。

  • 部署。

  • 测试。

  • 通用。

默认取值

不涉及。

description

String

参数解释

插件描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_private

Integer

参数解释

是否私有插件。

约束限制

不涉及。

取值范围

  • 1:私有插件。

  • 0:公开插件。

默认取值

0。

region

String

参数解释

局点。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

maintainers

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

参数解释

执行信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

input_info

Array of input_info objects

参数解释

输入信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 execution_info

参数

是否必选

参数类型

描述

inner_execution_info

Object

参数解释

插件执行信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表5 input_info

参数

是否必选

参数类型

描述

name

String

参数解释

插件输入配置的唯一标识。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

default_value

String

参数解释

插件输入配置的默认值,未填写时默认显示。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

type

String

参数解释

插件输入配置的输入类型。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

validation

String

参数解释

插件输入配置的输入内容的正则校验规则。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

layout_content

String

参数解释

样式信息。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

-

String

参数解释

是否调用成功。

取值范围

  • true:调用成功。

  • false:调用失败。

状态码:400

表7 响应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",
        "identifier" : "16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb",
        "variables" : {
          "OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
        }
      } ]
    }
  },
  "runtime_attribution" : "agent"
}

响应示例

状态码:200

OK

true

SDK代码示例

SDK代码示例如下。

 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
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;

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("<YOUR REGION>"))
                .build();
        CreatePluginDraftRequest request = new CreatePluginDraftRequest();
        request.withDomainId("{domain_id}");
        PluginDTO body = new PluginDTO();
        PluginDTOExecutionInfo executionInfobody = new PluginDTOExecutionInfo();
        executionInfobody.withInnerExecutionInfo("{\"execution_type\":\"COMPOSITE\",\"steps\":[{\"identifier\":\"16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb\",\"variables\":{\"OFFICIAL_SHELL_SCRIPT_INPUT\":\"env\"},\"task\":\"official_shell_plugin\",\"name\":\"执行Shell\"}]}");
        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());
        }
    }
}
 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
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = CreatePluginDraftRequest()
        request.domain_id = "{domain_id}"
        executionInfobody = PluginDTOExecutionInfo(
            inner_execution_info="{\"execution_type\":\"COMPOSITE\",\"steps\":[{\"identifier\":\"16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb\",\"variables\":{\"OFFICIAL_SHELL_SCRIPT_INPUT\":\"env\"},\"task\":\"official_shell_plugin\",\"name\":\"执行Shell\"}]}"
        )
        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)
 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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartspipeline.NewCodeArtsPipelineClient(
        codeartspipeline.CodeArtsPipelineClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreatePluginDraftRequest{}
	request.DomainId = "{domain_id}"
	var innerExecutionInfoExecutionInfo interface{} = "{\"execution_type\":\"COMPOSITE\",\"steps\":[{\"identifier\":\"16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb\",\"variables\":{\"OFFICIAL_SHELL_SCRIPT_INPUT\":\"env\"},\"task\":\"official_shell_plugin\",\"name\":\"执行Shell\"}]}"
	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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档