# 查询插件输入配置 - ShowPluginInputs #### 功能介绍 查询插件输入配置 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-pipeline/pipeline_03_0006.html)。 #### URI POST /v1/{domain_id}/agent-plugin/plugin-input 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | **参数解释**： 租户ID，用户的domainId。 **约束限制**： 不涉及。 **取值范围**： 32位字符，由数字和字母组成。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。通过调用[IAM服务获取用户Token接口](https://support.huaweicloud.com/api-iam/iam_30_0003.html)获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | \[数组元素\] | 否 | Array of [PluginPartQueryDTO] objects | **参数解释**： 查询插件输入请求体。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表4PluginPartQueryDTO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | plugin_name | 是 | String | **参数解释**： 插件名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | display_name | 是 | String | **参数解释**： 展示名。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | version | 是 | String | **参数解释**： 版本号。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | plugin_attribution | 是 | String | **参数解释**： 插件属性。 **约束限制**： 不涉及。 **取值范围**： - custom：自定义插件。 - official：官方插件。 **默认取值**： 不涉及。 | | version_attribution | 否 | String | **参数解释**： 版本属性。 **约束限制**： 不涉及。 **取值范围**： - draft：草稿版本。 - formal：正式版本。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [PluginPartQueryVOListAgentPluginInputVO] objects | **参数解释**： 插件输入配置列表。 **约束限制**： 不涉及。 | 表6PluginPartQueryVOListAgentPluginInputVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | plugin_name | String | **参数解释**： 扩展插件名称。 **取值范围**： 1到50位字符。 | | display_name | String | **参数解释**： 扩展插件展示名称。 **取值范围**： 不涉及。 | | data | Array of [data] objects | **参数解释**： 插件输入项详细信息。 **取值范围**： 不涉及。 | 表7data | 参数 | 参数类型 | 描述 | |:---|:---|:---| | unique_id | String | **参数解释**： 插件输入项唯一ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 插件输入项名称。 **取值范围**： 不涉及。 | | default_value | String | **参数解释**： 插件输入项默认值。 **取值范围**： 不涉及。 | | plugin_name | String | **参数解释**： 插件名称。 **取值范围**： 不涉及。 | | version | String | **参数解释**： 插件版本。 **取值范围**： 不涉及。 | | type | String | **参数解释**： 插件输入项类型。 **取值范围**： 不涉及。 | | workspace_id | String | **参数解释**： 租户ID，用户的domainId。 **取值范围**： 32位字符，由数字和字母组成。 | | validation | [ExtensionValidation] object | **参数解释**： 插件输入项校验信息。 **取值范围**： 不涉及。 | | layout_content | String | **参数解释**： 插件输入项样式信息。 **取值范围**： 不涉及。 | | extend_prop | [ExtensionExtendProp] object | **参数解释**： 插件输入扩展信息。 **取值范围**： 不涉及。 | | front_data_prop | String | **参数解释**： 前端渲染使用的数据信息。 **取值范围**： 不涉及。 | | label | String | **参数解释**： 标签。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 描述。 **取值范围**： 不涉及。 | | required | String | **参数解释**： 是否必须。 **取值范围**： 不涉及。 | 表8ExtensionValidation | 参数 | 参数类型 | 描述 | |:---|:---|:---| | required_message | String | **参数解释**： 若插件输入项为必填而实际未填写时，提示的信息。 **取值范围**： 不涉及。 | | regex | String | **参数解释**： 插件输入项值的校验正则表达式。 **取值范围**： 不涉及。 | | regex_message | String | **参数解释**： 若插件输入项的值不满足regex中的正则表达式时，提示的信息。 **取值范围**： 不涉及。 | | max_length | Integer | **参数解释**： 插件输入项值的最大长度。 **取值范围**： 不涉及。 | | min_length | Integer | **参数解释**： 插件输入项值的最小长度。 **取值范围**： 不涉及。 | 表9ExtensionExtendProp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | api_options | String | **参数解释**： API选项。 **取值范围**： 不涉及。 | | api_type | String | **参数解释**： API类型。 **取值范围**： 不涉及。 | | show_placeholder | String | **参数解释**： 显示占位符。 **取值范围**： 不涉及。 | | options | String | **参数解释**： 选项。 **取值范围**： 不涉及。 | | disabled_conditions | String | **参数解释**： 禁用条件。 **取值范围**： 不涉及。 | | visible_conditions | String | **参数解释**： 可见条件。 **取值范围**： 不涉及。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 不涉及。 | | error_code | String | **参数解释**： 错误码。 **取值范围**： 不涉及。 | #### 请求示例 ``` POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-input [ { "plugin_name" : "official_shell_plugin", "display_name" : "执行Shell", "version" : "0.0.2", "plugin_attribution" : "official", "version_attribution" : "formal" } ] ``` #### 响应示例 **状态码：200** OK ``` [ { "plugin_name" : "official_shell_plugin", "display_name" : "执行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命令", "description" : "用户在此处输入Shell命令", "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .build(); ShowPluginInputsRequest request = new ShowPluginInputsRequest(); request.withDomainId("{domain_id}"); List listbodyBody = new ArrayList<>(); listbodyBody.add( new PluginPartQueryDTO() .withPluginName("official_shell_plugin") .withDisplayName("执行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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowPluginInputsRequest() request.domain_id = "{domain_id}" listBodybody = [ PluginPartQueryDTO( plugin_name="official_shell_plugin", display_name="执行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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartspipeline.NewCodeArtsPipelineClient(hcClient) request := &model.ShowPluginInputsRequest{} request.DomainId = "{domain_id}" versionAttributionBody:= "formal" var listBodybody = []model.PluginPartQueryDto{ { PluginName: "official_shell_plugin", DisplayName: "执行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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsPipeline/sdk?api=ShowPluginInputs)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pipeline/ErrorCode.html)。