Querying the Extension List

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

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

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

plugin_name

No

String

Definition:

Search criteria-extension name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

regex_name

No

String

Definition:

Search criteria-match name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

maintainer

No

String

Definition:

Maintainer.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

business_type

No

Array of strings

Definition:

Service type.

Constraints:

N/A

Value range:

• Build.

• Gate.

• Deploy.

• Test.

• Normal.

Default value:

N/A

plugin_attribution

No

String

Definition:

Extension attribute.

Constraints:

N/A

Value range:

• official: custom extension.

• custom: basic extension.

Default value:

N/A

offset

Integer

Definition:

Offset where the query starts.

Constraints:

N/A

Value range:

The offset value must be no less than 0.

Default value:

0.

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 PluginBasicVO objects

Definition:

Extension list.

Value range:

N/A

plugin_name

String

Definition:

Extension name.

Value range:

1 to 50 characters.

display_name

String

Definition:

Extension name.

Value range:

N/A

db_record_name

String

Definition:

Display name of extension record.

Value range:

N/A

version

String

Definition:

Extension version number.

Value range:

N/A

version_description

String

Definition:

Extension version number description.

Value range:

N/A

description

String

Definition:

Extension description.

Value range:

N/A

version_attribution

String

Definition:

Extension version attribute.

Value range:

- draft: draft version.

- formal: formal version.

unique_id

String

Definition:

Extension ID.

Value range:

N/A

op_user

String

Definition:

User who last updated the extension.

Value range:

N/A

op_time

String

Definition:

Time when the extension was last updated.

Value range:

N/A

plugin_composition_type

String

Definition:

Whether the extension consists of multiple steps.

Value range:

• multi: multi-step extension.

• single: single-step extension.

plugin_attribution

String

Definition:

Extension attribute.

Value range:

• custom: custom extension.

• official: official extension.

• published: extension published by the publisher.

workspace_id

String

Definition:

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

Value range:

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

business_type

String

Definition:

Extension service type.

Range:

• Build.

• Gate.

• Deploy.

• Test.

• Normal.

business_type_display_name

String

Definition:

Displayed service type of the extension.

Value range:

N/A

maintainers

String

Definition:

Extension maintainer.

Value range:

N/A

icon_url

String

Definition:

Extension icon address.

Value range:

N/A

refer_count

Integer

Definition:

Number of times that the extension is referenced by pipelines.

Value range:

N/A

usage_count

Integer

Definition:

Number of times that the extension is used by pipelines.

Value range:

N/A

runtime_attribution

String

Definition:

Running attribute.

Value range:

• agent: Pipeline agent is required for running.

• agentLess: No pipeline agent is required.

active

Integer

Definition:

Whether the extension is activated.

Value range:

• true: activated.

• false: not activated.

version_state

String

Definition:

Status of the current extension version.

Value range:

N/A

publisher_unique_id

String

Definition:

Publisher ID.

Value range:

N/A

creator

String

Definition:

Creator name.

Value range:

N/A

create_time

String

Definition:

Creation time.

Value range:

N/A

manifest_version

String

Definition:

Extension version identifier.

Value range:

N/A

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found