Updated on 2024-07-04 GMT+08:00

Creating an Extension Version

Function

This API is used to create an extension version.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

unique_id

No

String

Unique ID.

icon_url

No

String

Icon URL.

runtime_attribution

Yes

String

Runtime attributes.

plugin_name

Yes

String

Extension name.

display_name

Yes

String

Display name.

business_type

Yes

String

Service type.

business_type_display_name

Yes

String

Display name of service type.

description

Yes

String

Description.

is_private

No

Integer

Private or not.

region

No

String

Region.

maintainers

No

String

Maintenance engineer.

version

Yes

String

Version number.

version_description

No

String

Version number description.

execution_info

Yes

execution_info object

Execution information.

input_info

No

Array of input_info objects

Input information.

Table 4 execution_info

Parameter

Mandatory

Type

Description

inner_execution_info

No

Object

Execution information.

Table 5 input_info

Parameter

Mandatory

Type

Description

name

No

String

Name.

default_value

No

String

Default value.

type

No

String

Input types.

validation

No

String

Verification.

layout_content

No

String

Style information.

Response Parameters

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

Example Requests

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/create

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test",
  "version" : "0.0.2",
  "version_description" : "",
  "description" : "",
  "unique_id" : "ab43c83c2ae04000afd039ad894e953b",
  "business_type" : "Normal",
  "business_type_display_name" : "General",
  "icon_url" : "",
  "runtime_attribution" : "agent",
  "input_info" : [ ],
  "execution_info" : {
    "inner_execution_info" : {
      "execution_type" : "COMPOSITE",
      "steps" : [ {
        "task" : "official_shell_plugin",
        "name" : "Executing the Shell",
        "identifier" : "16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a",
        "variables" : {
          "OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
        }
      } ]
    }
  }
}

Example Responses

Status code: 200

Whether the calling is successful.

true

SDK Sample Code

The SDK sample code is as follows.

 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
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 CreatePluginVersionSolution {

    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();
        CreatePluginVersionRequest request = new CreatePluginVersionRequest();
        PluginDTO body = new PluginDTO();
        PluginDTOExecutionInfo executionInfobody = new PluginDTOExecutionInfo();
        executionInfobody.withInnerExecutionInfo("{\"execution_type\":\"COMPOSITE\",\"steps\":[{\"identifier\":\"16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a\",\"variables\":{\"OFFICIAL_SHELL_SCRIPT_INPUT\":\"env\"},\"task\":\"official_shell_plugin\",\"name\":\"Executing the Shell\"}]}");
        body.withExecutionInfo(executionInfobody);
        body.withVersionDescription("");
        body.withVersion("0.0.2");
        body.withDescription("");
        body.withBusinessTypeDisplayName("General");
        body.withBusinessType("Normal");
        body.withDisplayName("apie_test");
        body.withPluginName("apie_test");
        body.withRuntimeAttribution("agent");
        body.withIconUrl("");
        body.withUniqueId("ab43c83c2ae04000afd039ad894e953b");
        request.withBody(body);
        try {
            CreatePluginVersionResponse response = client.createPluginVersion(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
# 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 = CreatePluginVersionRequest()
        executionInfobody = PluginDTOExecutionInfo(
            inner_execution_info="{\"execution_type\":\"COMPOSITE\",\"steps\":[{\"identifier\":\"16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a\",\"variables\":{\"OFFICIAL_SHELL_SCRIPT_INPUT\":\"env\"},\"task\":\"official_shell_plugin\",\"name\":\"Executing the Shell\"}]}"
        )
        request.body = PluginDTO(
            execution_info=executionInfobody,
            version_description="",
            version="0.0.2",
            description="",
            business_type_display_name="General",
            business_type="Normal",
            display_name="apie_test",
            plugin_name="apie_test",
            runtime_attribution="agent",
            icon_url="",
            unique_id="ab43c83c2ae04000afd039ad894e953b"
        )
        response = client.create_plugin_version(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
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.CreatePluginVersionRequest{}
	var innerExecutionInfoExecutionInfo interface{} = "{\"execution_type\":\"COMPOSITE\",\"steps\":[{\"identifier\":\"16993543666638cda5035-4854-4bc8-a88a-e1465b1bcc7a\",\"variables\":{\"OFFICIAL_SHELL_SCRIPT_INPUT\":\"env\"},\"task\":\"official_shell_plugin\",\"name\":\"Executing the Shell\"}]}"
	executionInfobody := &model.PluginDtoExecutionInfo{
		InnerExecutionInfo: &innerExecutionInfoExecutionInfo,
	}
	versionDescriptionPluginDto:= ""
	iconUrlPluginDto:= ""
	uniqueIdPluginDto:= "ab43c83c2ae04000afd039ad894e953b"
	request.Body = &model.PluginDto{
		ExecutionInfo: executionInfobody,
		VersionDescription: &versionDescriptionPluginDto,
		Version: "0.0.2",
		Description: "",
		BusinessTypeDisplayName: "General",
		BusinessType: "Normal",
		DisplayName: "apie_test",
		PluginName: "apie_test",
		RuntimeAttribution: "agent",
		IconUrl: &iconUrlPluginDto,
		UniqueId: &uniqueIdPluginDto,
	}
	response, err := client.CreatePluginVersion(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Whether the calling is successful.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.