Help Center/ CodeArts Pipeline/ API Reference/ API/ Extension Management/ Querying the Basic Extension Details
Updated on 2025-09-08 GMT+08:00

Querying the Basic Extension Details

Function

This API is used to query the basic extension details.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{domain_id}/extension/detail

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version

Yes

String

Definition:

Extension version.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

type

String

Definition:

Extension type.

Value range:

N/A

name

String

Definition:

Extension name.

Value range:

N/A

friendly_name

String

Definition:

Displayed extension name.

Value range:

N/A

category

String

Definition:

Service type.

Value range:

N/A

description

String

Definition:

Extension description.

Value range:

N/A

version

String

Definition:

Extension version.

Value range:

N/A

version_description

String

Definition:

Extension version description.

Value range:

N/A

inputs

Array of inputs objects

Definition:

Input information.

Value range:

N/A

data_source_bindings

Array of data_source_bindings objects

Definition:

Data source information.

Value range:

N/A

outputs

Array of outputs objects

Definition:

Output information.

Value range:

N/A

execution

execution object

Definition:

Extension type.

Value range:

N/A

Table 5 inputs

Parameter

Type

Description

name

String

Definition:

Name.

Value range:

N/A

type

String

Definition:

Type.

Value range:

N/A

label

String

Definition:

Label.

Value range:

N/A

description

String

Definition:

Description.

Value range:

N/A

default_value

String

Definition:

Default value.

Value range:

N/A

required

Boolean

Definition:

Mandatory or not.

Value range:

  • true: mandatory.

  • false: optional.

extend_prop

ExtensionExtendProp object

Definition:

Extended attributes.

Value range:

N/A

validation

ExtensionValidation object

Definition:

Verification details.

Value range:

N/A

Table 6 ExtensionExtendProp

Parameter

Type

Description

api_options

String

Definition:

API option.

Value range:

N/A

api_type

String

Definition:

API type.

Value range:

N/A

show_placeholder

String

Definition:

Placeholder.

Value range:

N/A

options

String

Definition:

Option.

Value range:

N/A

disabled_conditions

String

Definition:

Conditions for disabling an extension.

Value range:

N/A

visible_conditions

String

Definition:

Visible condition.

Value range:

N/A

Table 7 ExtensionValidation

Parameter

Type

Description

required_message

String

Definition:

Message displayed when the extension input item is mandatory but is not set.

Value range:

N/A

regex

String

Definition:

Regular expression used to verify the extension input value.

Value range:

N/A

regex_message

String

Definition:

Message displayed when the value of an extension input item does not meet the regular expression requirement.

Value range:

N/A

max_length

Integer

Definition:

Maximum length of an extension input value.

Value range:

N/A

min_length

Integer

Definition:

Minimum length of an extension input value.

Value range:

N/A

Table 8 data_source_bindings

Parameter

Type

Description

target

String

Definition:

Destination address.

Value range:

N/A

endpointId

String

Definition:

Endpoint ID.

Value range:

N/A

data_source_name

String

Definition:

Name of the bound data source.

Value range:

N/A

Table 9 outputs

Parameter

Type

Description

name

String

Definition:

Name.

Value range:

N/A

type

String

Definition:

Type.

Value range:

N/A

description

String

Definition:

Description.

Value range:

N/A

prop

Map<String,String>

Definition:

Extended information.

Value range:

N/A

Table 10 execution

Parameter

Type

Description

target

String

Definition:

Extension type.

Value range:

N/A

type

String

Definition:

Extension type.

Value range:

N/A

sha256

String

Definition:

SHA-256.

Value range:

N/A

Status code: 400

Table 11 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

GET http://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/detail?plugin_name=basic-CTS&version=2.3.5

Example Responses

Status code: 200

OK

{
  "type" : "Task",
  "name" : "basic-CTS",
  "category" : "Test",
  "description" : "",
  "version" : "2.3.5",
  "inputs" : [ {
    "name" : "SHELL_PLUGIN",
    "type" : "input",
    "label" : "Single-line Text Box",
    "description" : "Sample String",
    "required" : true,
    "validation" : {
      "required_message" : null,
      "regex" : null,
      "regex_message" : null,
      "max_length" : null,
      "min_length" : null
    },
    "default_value" : "",
    "extend_prop" : {
      "api_options" : null,
      "api_type" : null,
      "options" : null,
      "disabled_conditions" : null,
      "visible_conditions" : null
    }
  } ],
  "outputs" : [ {
    "name" : "problem",
    "type" : "output",
    "description" : "Number of recorded problems"
  } ],
  "execution" : {
    "type" : "scripts/test.sh",
    "target" : "Shell",
    "sha256" : "4fa52dab3fb72847e4da5f00295a96fce8892f301d384efe9b776aa1731ba8f0"
  },
  "friendly_name" : "Basic plug-in - CTS2",
  "version_description" : "Running Shell Commands"
}

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


public class ShowBasicPluginSolution {

    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();
        ShowBasicPluginRequest request = new ShowBasicPluginRequest();
        request.withDomainId("{domain_id}");
        try {
            ShowBasicPluginResponse response = client.showBasicPlugin(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
# 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 = ShowBasicPluginRequest()
        request.domain_id = "{domain_id}"
        response = client.show_basic_plugin(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
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.ShowBasicPluginRequest{}
	request.DomainId = "{domain_id}"
	response, err := client.ShowBasicPlugin(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.