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

Querying the Available Publisher

Function

This API is used to query the available publisher.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{domain_id}/publisher/optional-publisher

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of PublisherVO objects

Parameter description: List of available publishers. Constraints: None.

Table 4 PublisherVO

Parameter

Type

Description

publisher_unique_id

String

Definition:

Publisher ID. Obtain the ID by calling the API for querying publisher details.

Value range:

N/A

user_id

String

Definition:

User ID.

Value range:

N/A

tenant_id

String

Definition:

Tenant ID.

Value range:

N/A

description

String

Definition:

Publisher description.

Value range:

N/A

logo_url

String

Definition:

Publisher icon URL.

Value range:

N/A

website

String

Definition:

Web page URL entered during publisher creation.

Value range:

N/A

support_url

String

Definition:

Help address entered during publisher creation.

Value range:

N/A

source_url

String

Definition:

Source address entered during publisher creation.

Value range:

N/A

en_name

String

Definition:

Publisher name (English).

Value range:

N/A

name

String

Definition:

Publisher name (Chinese).

Value range:

N/A

auth_status

String

Definition:

Authorization status.

Value range:

N/A

is_delete

Integer

Definition:

Deleted or not.

Value range:

  • 0: not deleted.

  • 1: deleted.

last_update_user_name

String

Definition:

Name of the user who last updated the information.

Value range:

N/A

last_update_user_id

String

Definition:

ID of the user who last updated the information.

Value range:

N/A

last_update_time

String

Definition:

Last update time.

Value range:

N/A

Status code: 400

Table 5 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 https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/publisher/optional-publisher

Example Responses

Status code: 200

OK

[ {
  "publisher_unique_id" : "b9fc8fb6d9194536ac66dd74c2212126",
  "user_id" : "847a5317086c41798469d0868535943a",
  "tenant_id" : "ce8df55870164338a72d7e828a966a2a",
  "description" : "Here is the description.",
  "logo_url" : "/api/v1/ce8df55870164338a72d7e828a966a2a/common/get-plugin-icon?object_key=default-cfb6036d13404631a04a5e7f3a5899b2-kubernetes.png-ce8df55870164338a72d7e828a966a2a&icon_type=publish",
  "website" : "https://demo.com/rp/team/ptnixbayoz",
  "support_url" : "5555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555",
  "source_url" : "",
  "en_name" : "kejiyouxiangongsi",
  "name" : "Hangzhou XXX Technology Co., Ltd.",
  "auth_status" : "accept",
  "is_delete" : 0,
  "last_update_user_name" : "devcloud_devcloud_h00485561_01",
  "last_update_user_id" : "847a5317086c41798469d0868535943a",
  "last_update_time" : "2023-02-21T09:22:34.528"
} ]

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

    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();
        ListAvailablePublisherRequest request = new ListAvailablePublisherRequest();
        request.withDomainId("{domain_id}");
        try {
            ListAvailablePublisherResponse response = client.listAvailablePublisher(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 = ListAvailablePublisherRequest()
        request.domain_id = "{domain_id}"
        response = client.list_available_publisher(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.ListAvailablePublisherRequest{}
	request.DomainId = "{domain_id}"
	response, err := client.ListAvailablePublisher(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.