Updated on 2026-01-12 GMT+08:00

Querying Extension Version Details

Function

This API is used to query extension version details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{domain_id}/agent-plugin/detail

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

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

Enter only letters, digits, hyphens (-), and underscores (_).

Value range:

1 to 50 characters.

Default value:

N/A

version

No

String

Definition:

Extension version number.

Constraints:

The value must be in the format of x.xx.xx, where x is a number ranging from 0 to 99. xx indicates the number following the dot (.). Each xx can be a one-digit or two-digit number.

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

plugin_name

String

Definition:

Extension name.

Value range:

1 to 50 characters.

display_name

String

Definition:

Displayed extension name.

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

version

String

Definition:

Extension version number.

Value range:

N/A

unique_id

String

Definition:

Extension ID.

Value range:

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

version_description

String

Definition:

Extension version description.

Value range:

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

version_attribution

String

Definition:

Extension version attribute.

Value range:

- draft: draft version.

- formal: formal version.

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.

input_info

Array of input_info objects

Definition:

Details of the extension input item.

Value range:

N/A

plugin_execution

PluginExecutionVO object

Definition:

Execution script information of the extension.

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.

Table 5 input_info

Parameter

Type

Description

unique_id

String

Definition:

ID of the extension input item.

Value range:

N/A

name

String

Definition:

Name of the extension input item.

Value range:

N/A

default_value

String

Definition:

Default value of the extension input item.

Value range:

N/A

plugin_name

String

Definition:

Extension name.

Value range:

N/A

version

String

Definition:

Extension version number.

Value range:

N/A

type

String

Definition:

Type of the extension input item.

Value range:

N/A

workspace_id

String

Definition:

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

Range:

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

front_data_prop

String

Definition:

Data attributes displayed on the frontend.

Value range:

N/A

label

String

Definition:

Label for extension input.

Value range:

N/A

description

String

Definition:

Description for extension input.

Value range:

N/A

required

String

Definition:

Mandatory or not.

Value range:

N/A

extend_prop

ExtensionExtendProp object

Definition:

Extended attributes.

Value range:

N/A

validation

ExtensionValidation object

Definition:

Validation information of the extension input item.

Value range:

N/A

layout_content

String

Definition:

Style information of the extension input item.

Value range:

N/A

Table 6 ExtensionExtendProp

Parameter

Type

Description

api_options

String

Definition:

API option.

Value range:

N/A

api_type

String

Definition:

API type.

Value range:

N/A

show_placeholder

String

Definition:

Placeholder.

Value range:

N/A

options

String

Definition:

Option.

Value range:

N/A

disabled_conditions

String

Definition:

Conditions for disabling an extension.

Value range:

N/A

visible_conditions

String

Definition:

Visible condition.

Value range:

N/A

Table 7 ExtensionValidation

Parameter

Type

Description

required_message

String

Definition:

Message displayed when the extension input item is mandatory but is not set.

Value range:

N/A

regex

String

Definition:

Regular expression used to verify the extension input value.

Value range:

N/A

regex_message

String

Definition:

Message displayed when the value of an extension input item does not meet the regular expression requirement.

Value range:

N/A

max_length

Integer

Definition:

Maximum length of an extension input value.

Value range:

N/A

min_length

Integer

Definition:

Minimum length of an extension input value.

Value range:

N/A

Table 8 PluginExecutionVO

Parameter

Type

Description

logic_id

String

Definition:

Logic ID of the extension execution.

Value range:

N/A

plugin_name

String

Definition:

Extension name.

Value range:

N/A

version

String

Definition:

Extension version number.

Value range:

N/A

basic_instance_id

String

Definition:

Extension instance ID.

Value range:

N/A

workspace_id

String

Definition:

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

Range:

N/A

execution_type

String

Definition:

Execution type.

Value range:

  • CONTAINER

  • ZIP

  • SHELL

  • COMPOSITE

start_command

String

Definition:

Execution command. This parameter is returned when execution_type is set to CONTAINER.

Value range:

N/A

stop_command

String

Definition:

Stop command. This parameter is returned when execution_type is set to CONTAINER.

Value range:

N/A

env

String

Definition:

Image information. This parameter is returned when execution_type is set to CONTAINER.

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

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/detail?plugin_name=apie_test&version=0.0.4

Example Responses

Status code: 200

OK

{
  "plugin_name" : "apie_test",
  "display_name" : "apie_test222",
  "op_user" : "devcloud_devcloud_h00485561_01",
  "op_time" : "1699358542000",
  "version" : "0.0.4",
  "unique_id" : "036d51108a0b48eeb876fb6341ee7615",
  "version_description" : "",
  "version_attribution" : "formal",
  "plugin_composition_type" : "multi",
  "plugin_attribution" : "custom",
  "input_info" : [ ],
  "plugin_execution" : { },
  "runtime_attribution" : "agent"
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.