Updated on 2025-09-08 GMT+08:00

Updating an Extension Draft

Function

This API is used to update an extension draft.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

unique_id

No

String

Definition:

Extension ID. Obtain the ID by calling the API for querying the extension details. unique_id indicates extension ID.

Constraints:

N/A

Value range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

icon_url

No

String

Definition:

URL of the extension icon.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

runtime_attribution

Yes

String

Definition:

Running attribute.

Constraints:

N/A

Value range:

  • agent: agent-based running.

  • agentless: agentless running.

Default value:

N/A

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

Enter only letters, digits, hyphens (-), and underscores (_).

Value range:

1 to 50 characters.

Default value:

N/A

display_name

Yes

String

Definition:

Display name.

Constraints:

Enter only letters, spaces, digits, hyphens (-), underscores (_), and periods (.).

Value range:

1 to 50 characters.

Default value:

N/A

business_type

Yes

String

Definition:

Service type.

Constraints:

Enter only letters, digits, hyphens (-), and underscores (_).

Value range:

1 to 50 characters.

Default value:

N/A

business_type_display_name

Yes

String

Definition:

Service type of the extension.

Constraints:

N/A

Value range:

  • Build.

  • Check.

  • Deploy.

  • Test.

  • Normal.

Default value:

N/A

description

Yes

String

Definition:

Extension description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

is_private

No

Integer

Definition:

Whether the extension is private.

Constraints:

N/A

Value range:

  • 1: private.

  • 0: public.

Default value:

0.

region

No

String

Definition:

Region.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

maintainers

No

String

Definition:

Extension maintainer.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

plugin_composition_type

No

String

Definition:

Combination type of an extension.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

manifest_version

No

String

Definition:

It is used to distinguish data of the new and old versions.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version

Yes

String

Definition:

Extension version number.

Constraints:

The value must be in the format of x.xx.xx (for example, 1.0.2), where x is a number ranging from 0 to 99. xx indicates the number following the dot (.). Each xx can be a one-digit or two-digit number.

Value range:

N/A

Default value:

N/A

version_description

No

String

Definition:

Description of the minor version of the extension.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

execution_info

Yes

execution_info object

Definition:

Execution information.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

output_info

No

Array of output_info objects

Definition:

Extension output content.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

input_info

No

Array of input_info objects

Definition:

Input Information.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 4 execution_info

Parameter

Mandatory

Type

Description

inner_execution_info

Yes

inner_execution_info object

Definition:

Extension execution information.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 5 inner_execution_info

Parameter

Mandatory

Type

Description

execution_type

No

String

Definition:

Extension type.

Constraints:

N/A

Value range:

CONTAINER, ZIP, SHELL, or COMPOSITE.

Default value:

N/A

steps

No

Array of steps objects

Definition:

Step list.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Table 6 steps

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Task name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

task

No

String

Definition:

Task type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

variables

No

Map<String,Object>

Definition:

Parameter information.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 7 output_info

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Unique identifier of the extension output configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version

No

String

Definition:

Extension output version number.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

Description of extension output configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

source

No

String

Definition:

Source of extension output configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

type

No

String

Definition:

Output type of extension output configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Table 8 input_info

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Unique identifier of the extension input configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

default_value

No

String

Definition:

Default value of the extension input configuration. If this parameter is not set, the default value is displayed.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

type

No

String

Definition:

Input type of the extension input configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

validation

No

String

Definition:

Regular expression verification rule of the input content in the extension input configuration.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

layout_content

No

String

Definition:

Style information.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 9 Response body parameters

Parameter

Type

Description

-

Boolean

Definition:

Whether the calling is successful.

Value range:

  • true: The calling is successful.

  • false: The calling fails.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

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

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test",
  "business_type" : "Normal",
  "description" : "",
  "maintainers" : "",
  "business_type_display_name" : "General",
  "icon_url" : "",
  "version" : "0.0.1",
  "version_description" : "",
  "input_info" : [ ],
  "execution_info" : {
    "inner_execution_info" : {
      "execution_type" : "COMPOSITE",
      "steps" : [ {
        "task" : "official_shell_plugin",
        "name" : "Executing the Shell",
        "identifier" : "16993543005962cb6e5e8-458a-4382-adfe-9702345ecddb",
        "variables" : {
          "OFFICIAL_SHELL_SCRIPT_INPUT" : "env"
        }
      } ]
    }
  },
  "runtime_attribution" : "agent"
}

Example Responses

Status code: 200

OK

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

    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();
        UpdatePluginDraftRequest request = new UpdatePluginDraftRequest();
        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\":\"Executing the Shell\"}]}");
        body.withExecutionInfo(executionInfobody);
        body.withVersionDescription("");
        body.withVersion("0.0.1");
        body.withMaintainers("");
        body.withDescription("");
        body.withBusinessTypeDisplayName("General");
        body.withBusinessType("Normal");
        body.withDisplayName("apie_test");
        body.withPluginName("apie_test");
        body.withRuntimeAttribution("agent");
        body.withIconUrl("");
        request.withBody(body);
        try {
            UpdatePluginDraftResponse response = client.updatePluginDraft(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 = UpdatePluginDraftRequest()
        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\":\"Executing the Shell\"}]}"
        )
        request.body = PluginDTO(
            execution_info=executionInfobody,
            version_description="",
            version="0.0.1",
            maintainers="",
            description="",
            business_type_display_name="General",
            business_type="Normal",
            display_name="apie_test",
            plugin_name="apie_test",
            runtime_attribution="agent",
            icon_url=""
        )
        response = client.update_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.UpdatePluginDraftRequest{}
	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\":\"Executing the 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: "General",
		BusinessType: "Normal",
		DisplayName: "apie_test",
		PluginName: "apie_test",
		RuntimeAttribution: "agent",
		IconUrl: &iconUrlPluginDto,
	}
	response, err := client.UpdatePluginDraft(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

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.