Help Center/CodeArts Pipeline/API Reference (Ally Region)/API/Extension Management/Querying the Publisher List
Updated on 2026-01-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Publisher List

Function

This API is used to query the publisher list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{domain_id}/publisher/query-all

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant ID, that is, domain ID of a user.

Constraints:

N/A

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

String

Definition:

Offset where the query starts. This parameter must be used together with limit.

Constraints:

N/A

Value range:

The offset value must be no less than 0.

Default value:

N/A

limit

Yes

String

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

1–100.

Default value:

N/A

name

No

String

Definition:

Publisher name.

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 for .

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

offset

Integer

Definition:

Query offset, which is the same as the offset of the query parameter.

Value range:

≥ 0

limit

Integer

Definition:

Number of records of each query.

Value range:

The value is no less than 0.

total

Long

Definition:

Number of records queried this time.

Value range:

N/A

data

Array of PublisherVO objects

Definition:

List of queried data.

Value range:

N/A

Table 5 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, that is, domain ID of a user.

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 6 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/query-all?name=&limit=10&offset=0

Example Responses

Status code: 200

OK

{
  "offset" : 0,
  "limit" : 10,
  "total" : 3,
  "data" : [ {
    "publisher_unique_id" : "7f1c6b0f12f94b3d9e37eee0b541d3ac",
    "user_id" : "847a5317086c41798469d0868535943a",
    "tenant_id" : "ce8df55870164338a72d7e828a966a2a",
    "description" : "",
    "logo_url" : "",
    "website" : "",
    "support_url" : "aaa@aa.com",
    "source_url" : "",
    "en_name" : "aaa",
    "name" : "aaa",
    "auth_status" : "processing",
    "is_delete" : 0,
    "last_update_user_name" : "devcloud_devcloud_h00485561_01",
    "last_update_user_id" : "847a5317086c41798469d0868535943a",
    "last_update_time" : "2023-11-07T18:54:02.411"
  }, {
    "publisher_unique_id" : "4ea3d6eb6f9d40e681d7b555161dffc2",
    "user_id" : "d61bdd3214a441b6ad630ce8a9c1015a",
    "tenant_id" : "ce8df55870164338a72d7e828a966a2a",
    "description" : "",
    "logo_url" : "",
    "website" : "",
    "support_url" : "fgddf",
    "source_url" : "",
    "en_name" : "dfdg",
    "name" : "fdfg",
    "auth_status" : "processing",
    "is_delete" : 0,
    "last_update_user_name" : "devcloud_devcloud_h00485561_01/SysReservedV3_pipel",
    "last_update_user_id" : "d61bdd3214a441b6ad630ce8a9c1015a",
    "last_update_time" : "2023-10-31T14:18:06.356"
  }, {
    "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"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.