查询插件版本详情
功能介绍
查询插件版本详情
调用方法
请参见如何调用API。
URI
GET /v1/{domain_id}/agent-plugin/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
参数解释: 租户ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
plugin_name |
是 |
String |
参数解释: 扩展插件名称。 约束限制: 仅支持输入大小写英文字母、数字、'-'、'_'。 取值范围: 1到50位字符。 默认取值: 不涉及。 |
version |
否 |
String |
参数解释: 插件版本号。 约束限制: 必须是类似 x.xx.xx 的格式,其中:x 是 1 到 2 位的数字(范围 0 到 99)。xx 是点后跟随的数字部分,且每部分可以是 1 位或 2 位数字。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
plugin_name |
String |
参数解释: 扩展插件名称。 取值范围: 1到50位字符。 |
display_name |
String |
参数解释: 扩展插件展示名称。 取值范围: 不涉及。 |
op_user |
String |
参数解释: 扩展插件最后更新人。 取值范围: 不涉及。 |
op_time |
String |
参数解释: 扩展插件最后更新时间。 取值范围: 不涉及。 |
version |
String |
参数解释: 扩展插件版本号。 取值范围: 不涉及。 |
unique_id |
String |
参数解释: 扩展插件唯一ID。 取值范围: 32位字符,由数字和字母组成。 |
version_description |
String |
参数解释: 扩展插件版本说明。 取值范围: 32位字符,由数字和字母组成。 |
version_attribution |
String |
参数解释: 扩展插件版本属性。 取值范围:
|
plugin_composition_type |
String |
参数解释: 用于标识扩展插件是否为多个step组成的组合插件。 取值范围:
|
plugin_attribution |
String |
参数解释: 扩展插件属性。 取值范围:
|
input_info |
Array of input_info objects |
参数解释: 插件输入项详细信息。 取值范围: 不涉及。 |
plugin_execution |
PluginExecutionVO object |
参数解释: 扩展插件执行脚本信息。 取值范围: 不涉及。 |
runtime_attribution |
String |
参数解释: 运行属性。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
unique_id |
String |
参数解释: 插件输入项唯一ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 插件输入项名称。 取值范围: 不涉及。 |
default_value |
String |
参数解释: 插件输入项默认值。 取值范围: 不涉及。 |
plugin_name |
String |
参数解释: 扩展插件名称。 取值范围: 不涉及。 |
version |
String |
参数解释: 扩展插件版本号。 取值范围: 不涉及。 |
type |
String |
参数解释: 插件输入项类型。 取值范围: 不涉及。 |
workspace_id |
String |
参数解释: 租户id。 取值范围: 32位字符,由数字和字母组成。 |
validation |
ExtensionValidation object |
参数解释: 插件输入项校验信息。 取值范围: 不涉及。 |
layout_content |
String |
参数解释: 插件输入项样式信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
required_message |
String |
参数解释: 若插件输入项为必填而实际未填写时,提示的信息。 取值范围: 不涉及。 |
regex |
String |
参数解释: 插件输入项值的校验正则表达式。 取值范围: 不涉及。 |
regex_message |
String |
参数解释: 若插件输入项的值不满足regex中的正则表达式时,提示的信息。 取值范围: 不涉及。 |
max_length |
Integer |
参数解释: 插件输入项值的最大长度。 取值范围: 不涉及。 |
min_length |
Integer |
参数解释: 插件输入项值的最小长度。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
type |
String |
参数解释: 插件执行脚本类型。 取值范围:
|
target |
String |
参数解释: 插件执行脚本入口文件。 取值范围: 不涉及。 |
file_path |
String |
参数解释: 插件的OBS存放路径。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/detail?plugin_name=apie_test&version=0.0.4
响应示例
状态码: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" : { "logic_id" : "", "plugin_name" : "apie_test", "version" : "0.0.4", "basic_instance_id" : "036d51108a0b48eeb876fb6341ee7615", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "execution_type" : "COMPOSITE", "steps" : [ { "name" : "执行Shell", "task" : "official_shell_plugin", "variables" : { "OFFICIAL_SHELL_SCRIPT_INPUT" : "env" } } ] }, "runtime_attribution" : "agent" }
SDK代码示例
SDK代码示例如下。
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 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.*; public class ShowPluginVersionSolution { 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(); ShowPluginVersionRequest request = new ShowPluginVersionRequest(); request.withDomainId("{domain_id}"); try { ShowPluginVersionResponse response = client.showPluginVersion(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 |
# 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 = ShowPluginVersionRequest() request.domain_id = "{domain_id}" response = client.show_plugin_version(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 |
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.ShowPluginVersionRequest{} request.DomainId = "{domain_id}" response, err := client.ShowPluginVersion(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。