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

Query Extension Output Configuration

Function

This API is used to query extension output configuration.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{domain_id}/agent-plugin/plugin-output

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

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

No

Array of PluginPartQueryDTO objects

Definition:

Request body for querying the extension output.

Constraints:

N/A

Value range:

N/A

Default value:

N/A
Table 4 PluginPartQueryDTO

Parameter

Mandatory

Type

Description

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

display_name

Yes

String

Definition:

Display name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

version

Yes

String

Definition:

Version number.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

plugin_attribution

Yes

String

Definition:

Extension attribute.

Constraints:

N/A

Value range:

  • custom: custom extension.

  • official: official extension.

Default value:

N/A

version_attribution

No

String

Definition:

Version attribute.

Constraints:

N/A

Value range:

- draft: draft version.

- formal: formal version.

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of PluginVersionPartQueryVOListAgentPluginOutputVO objects

Parameter description: List of extension output configurations. Constraints: N/A.
Table 6 PluginVersionPartQueryVOListAgentPluginOutputVO

Parameter

Type

Description

plugin_name

String

Definition:

Extension name.

Value range:

N/A

display_name

String

Definition:

Extension display name.

Value range:

N/A

version

String

Definition:

Extension version number.

Value range:

N/A

data

Array of data objects

Definition:

Extension output details.

Value range:

N/A
Table 7 data

Parameter

Type

Description

basic_instance_id

String

Definition:

ID.

Value range:

N/A

workspace_id

String

Definition:

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

Range:

N/A

plugin_name

String

Definition:

Extension name.

Value range:

N/A

name

String

Definition:

Display name.

Value range:

N/A

version

String

Definition:

Extension version number.

Value range:

N/A

type

String

Definition:

Type.

Value range:

N/A

description

String

Definition:

Description.

Value range:

N/A

source

String

Definition:

Source.

Value range:

N/A

prop

OutputPropVO object

Definition:

Extended attributes.

Value range:

N/A
Table 8 OutputPropVO

Parameter

Type

Description

group

String

Definition:

Group name.

Value range:

N/A

default_value

String

Definition:

Default value.

Value range:

N/A

display_type

String

Definition:

Display type.

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 https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-output

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "",
  "plugin_attribution" : "official",
  "version_attribution" : "formal"
} ]

Example Responses

Status code: 200

OK

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "",
  "data" : [ ]
} ]

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Extension Management