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
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 |
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
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
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:
|
plugin_attribution | String | Definition: Extension attribute. Value range:
|
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:
|
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 |
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 |
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 |
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:
|
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
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
