Help Center/ CodeArts Pipeline/ API Reference/ API/ Extension Management/ Querying the Available Extensions by Page
Updated on 2025-09-08 GMT+08:00

Querying the Available Extensions by Page

Function

This API is used to query the available extensions by page.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{domain_id}/relation/plugins

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

offset

Yes

Integer

Definition:

Offset where the query starts.

Constraints:

N/A

Value range:

The offset value must be no less than 0.

Default value:

N/A

limit

Yes

Integer

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

The value is no less than 0.

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

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

use_condition

No

String

Definition:

Whether the extension can be used by a pipeline or template.

Constraints:

N/A

Value range:

  • pipeline: The extension can be used by a pipeline.

  • template: The extension can be used by a template.

Default value:

N/A

input_repo_type

No

String

Definition:

Source code repository type, such as CodeArts Repo, GitLab, and GitHub.

Constraints:

N/A

Value range:

  • CodeArts Repo.

  • Gitee.

  • GitHub.

  • GitCode.

  • GitLab.

Default value:

N/A

input_source_type

No

String

Definition:

Single-source or multi-source.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

business_type

No

String

Definition:

Service type.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

regex_name

No

String

Definition:

Matching name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

offset

Integer

Definition:

Offset where the query starts.

Constraints:

N/A

Value range:

The offset value must be no less than 0.

Default value:

N/A

limit

Integer

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

The value is no less than 0.

Default value:

N/A

total

Integer

Definition:

Total number of items.

Value range:

The value is no less than 0.

data

Array of data objects

Definition:

Result set.

Value range:

N/A

Table 6 data

Parameter

Type

Description

business_type

String

Definition:

Service type.

Value range:

N/A

display_name

String

Definition:

Display name.

Value range:

N/A

unique_id

String

Definition:

ID.

Value range:

N/A

editable

Boolean

Definition:

Editable parameter or not.

Value range:

  • true: editable.

  • false: not editable.

removable

Boolean

Definition:

Removable or not.

Value range:

  • true: removable.

  • false: not removable.

cloneable

Boolean

Definition:

Whether the extension can be cloned.

Value range:

  • true: The extension can be cloned.

  • false: The extension cannot be cloned.

disabled

Boolean

Definition:

Disabled or not.

Value range:

  • true: disabled.

  • false: not disabled.

addables

Array of Map<String,Boolean> objects

Definition:

Whether the object can be added.

Value range:

N/A

conditions

Array of strings

Definition:

Condition.

Value range:

N/A

plugins_list

Array of plugins_list objects

Definition:

Extension list.

Value range:

N/A

Table 7 plugins_list

Parameter

Type

Description

unique_id

String

Definition:

ID.

Value range:

N/A

display_name

String

Definition:

Display name.

Value range:

N/A

plugin_name

String

Definition:

Extension name.

Value range:

N/A

disabled

Boolean

Definition:

Disabled or not.

Value range:

  • true: disabled.

  • false: not disabled.

group_name

String

Definition:

Group name.

Value range:

N/A

group_type

String

Definition:

Group type.

Value range:

N/A

standard

Boolean

Definition:

Whether the extension is standardized.

Value range:

  • true: Yes.

  • false: No.

db_record_name

String

Definition:

Extension record name.

Value range:

N/A

plugin_attribution

String

Definition:

Extension attribute.

Value range:

N/A

plugin_composition_type

String

Definition:

Multi-step extension.

Value range:

N/A

runtime_attribution

String

Definition:

Extension running attribute.

Value range:

N/A

all_steps

Array of all_steps objects

Definition:

Basic extension list.

Value range:

N/A

description

String

Definition:

Extension description.

Value range:

N/A

version_attribution

String

Definition:

Extension version attribute.

Value range:

N/A

icon_url

String

Definition:

URL of the extension icon.

Value range:

N/A

multi_step_editable

Integer

Definition:

The extension can be edited.

Value range:

N/A

location

String

Definition:

Extension address.

Value range:

N/A

publisher_unique_id

String

Definition:

Extension publisher ID.

Value range:

N/A

manifest_version

String

Definition:

Extension version.

Value range:

N/A

Table 8 all_steps

Parameter

Type

Description

plugin_name

String

Definition:

Extension name.

Value range:

N/A

display_name

String

Definition:

Display name.

Value range:

N/A

version

String

Definition:

Version.

Value range:

N/A

Status code: 400

Table 9 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 http://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugins?limit=4&offset=0

{
  "input_repo_type" : "codehub",
  "input_source_type" : "single",
  "use_condition" : "pipeline",
  "business_type" : "",
  "regex_name" : ""
}

Example Responses

Status code: 200

OK

{
  "offset" : 0,
  "limit" : 4,
  "total" : 246,
  "data" : {
    "plugins_list" : [ {
      "unique_id" : "1bfe2cd6b6f44fe3a918768e0391144f",
      "display_name" : "1030 test",
      "plugin_name" : "132132132231",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "84b6d96b240644b8a9c529981759a6d2",
      "display_name" : "Release",
      "plugin_name" : "create_test_2",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "multi",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "test",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "816c527f9ba34904b84823718633ecdf",
      "display_name" : "Plug-in Creation Test",
      "plugin_name" : "create_test.plugin_draft",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "multi",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "test",
      "version_attribution" : "draft",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    }, {
      "unique_id" : "6e7a5fe5e7214ce6858087357a4bf79b",
      "display_name" : "Plug-in Version Description Test",
      "plugin_name" : "plugin_version_test",
      "disabled" : false,
      "group_name" : null,
      "group_type" : null,
      "plugin_attribution" : "custom",
      "plugin_composition_type" : "single",
      "runtime_attribution" : "agent",
      "all_steps" : null,
      "description" : "Plug-in Version Description Test",
      "version_attribution" : "formal",
      "icon_url" : "",
      "multi_step_editable" : 1,
      "location" : "pipeline,service",
      "publisher_unique_id" : null,
      "manifest_version" : "3"
    } ],
    "display_name" : "Check",
    "business_type" : "Gate",
    "unique_id" : "032ad7e2-5e19-4e90-8517-0958deb89e12",
    "conditions" : null,
    "editable" : false,
    "removable" : false,
    "cloneable" : false,
    "disabled" : false
  }
}

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

    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();
        ListBasePluginsNewPostRequest request = new ListBasePluginsNewPostRequest();
        request.withDomainId("{domain_id}");
        BusinessTypePluginsQueryDTO body = new BusinessTypePluginsQueryDTO();
        body.withRegexName("");
        body.withBusinessType("");
        body.withInputSourceType("single");
        body.withInputRepoType("codehub");
        body.withUseCondition("pipeline");
        request.withBody(body);
        try {
            ListBasePluginsNewPostResponse response = client.listBasePluginsNewPost(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
# 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 = ListBasePluginsNewPostRequest()
        request.domain_id = "{domain_id}"
        request.body = BusinessTypePluginsQueryDTO(
            regex_name="",
            business_type="",
            input_source_type="single",
            input_repo_type="codehub",
            use_condition="pipeline"
        )
        response = client.list_base_plugins_new_post(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
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.ListBasePluginsNewPostRequest{}
	request.DomainId = "{domain_id}"
	regexNameBusinessTypePluginsQueryDto:= ""
	businessTypeBusinessTypePluginsQueryDto:= ""
	inputSourceTypeBusinessTypePluginsQueryDto:= "single"
	inputRepoTypeBusinessTypePluginsQueryDto:= "codehub"
	useConditionBusinessTypePluginsQueryDto:= "pipeline"
	request.Body = &model.BusinessTypePluginsQueryDto{
		RegexName: &regexNameBusinessTypePluginsQueryDto,
		BusinessType: &businessTypeBusinessTypePluginsQueryDto,
		InputSourceType: &inputSourceTypeBusinessTypePluginsQueryDto,
		InputRepoType: &inputRepoTypeBusinessTypePluginsQueryDto,
		UseCondition: &useConditionBusinessTypePluginsQueryDto,
	}
	response, err := client.ListBasePluginsNewPost(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.