Query Extension Input Configuration
Function
This API is used to query extension input configuration.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{domain_id}/agent-plugin/plugin-input
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Tenant ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
[items] |
No |
Array of PluginPartQueryDTO objects |
Query request body. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
plugin_name |
Yes |
String |
Extension name. |
display_name |
Yes |
String |
Display name. |
version |
Yes |
String |
Version number. |
plugin_attribution |
Yes |
String |
Extension attribute: custom or official. |
version_attribution |
No |
String |
Version attribute: draft or formal. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of PluginPartQueryVOListAgentPluginInputVO objects |
OK |
Parameter |
Type |
Description |
---|---|---|
plugin_name |
String |
Extension name. |
display_name |
String |
Display name. |
data |
Array of data objects |
Result set. |
Parameter |
Type |
Description |
---|---|---|
unique_id |
String |
Unique ID. |
name |
String |
Name. |
default_value |
String |
Default value. |
plugin_name |
String |
Extension name. |
version |
String |
Version. |
type |
String |
Type. |
workspace_id |
String |
Tenant ID. |
validation |
ExtensionValidation object |
Verification. |
layout_content |
String |
Style information. |
Parameter |
Type |
Description |
---|---|---|
required_message |
String |
Message. |
regex |
String |
Regex. |
regex_message |
String |
Regular expression message. |
max_length |
Integer |
Maximum length. |
min_length |
Integer |
Minimum length. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
Example Requests
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-input [ { "plugin_name" : "official_shell_plugin", "display_name" : "Executing the Shell", "version" : "0.0.2", "plugin_attribution" : "official", "version_attribution" : "formal" } ]
Example Responses
Status code: 200
OK
[ { "plugin_name" : "official_shell_plugin", "display_name" : "Executing the Shell", "data" : [ { "unique_id" : "aac7e571b0d4462ba7962ce1735c4ec3", "name" : "OFFICIAL_SHELL_SCRIPT_INPUT", "default_value" : "", "plugin_name" : "official_shell_plugin", "version" : "0.0.2", "type" : "shell", "workspace_id" : "*", "layout_content" : null, "front_data_prop" : null, "label" : "Shell Commands", "description" : "The user enters the shell command here.", "required" : "true", "extend_prop" : { "api_options" : null, "api_type" : null, "options" : null, "disabled_conditions" : null, "visible_conditions" : null }, "validation" : { "required_message" : null, "regex" : null, "regex_message" : null, "max_length" : null, "min_length" : null } } ] } ]
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; import java.util.List; import java.util.ArrayList; public class ShowPluginInputsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); ShowPluginInputsRequest request = new ShowPluginInputsRequest(); List<PluginPartQueryDTO> listbodyBody = new ArrayList<>(); listbodyBody.add( new PluginPartQueryDTO() .withPluginName("official_shell_plugin") .withDisplayName("Executing the Shell") .withVersion("0.0.2") .withPluginAttribution("official") .withVersionAttribution("formal") ); request.withBody(listbodyBody); try { ShowPluginInputsResponse response = client.showPluginInputs(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowPluginInputsRequest() listBodybody = [ PluginPartQueryDTO( plugin_name="official_shell_plugin", display_name="Executing the Shell", version="0.0.2", plugin_attribution="official", version_attribution="formal" ) ] request.body = listBodybody response = client.show_plugin_inputs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowPluginInputsRequest{} versionAttributionBody:= "formal" var listBodybody = []model.PluginPartQueryDto{ { PluginName: "official_shell_plugin", DisplayName: "Executing the Shell", Version: "0.0.2", PluginAttribution: "official", VersionAttribution: &versionAttributionBody, }, } request.Body = &listBodybody response, err := client.ShowPluginInputs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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