查询插件列表
功能介绍
查询插件列表
调用方法
请参见如何调用API。
URI
POST /v1/{domain_id}/agent-plugin/query-all
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
租户ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
String |
偏移 |
limit |
是 |
String |
大小 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
plugin_name |
否 |
String |
可选的查询条件-插件名 |
regex_name |
否 |
String |
可选的查询条件-匹配名称 |
maintainer |
否 |
String |
维护者 |
business_type |
否 |
Array of strings |
业务类型,[Build,Gate,Deploy,Test,Normal] |
plugin_attribution |
否 |
String |
插件属性,official/custom |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
偏移 |
limit |
Integer |
大小 |
total |
Integer |
总数 |
data |
Array of PluginBasicVO objects |
结果集 |
参数 |
参数类型 |
描述 |
---|---|---|
plugin_name |
String |
插件名 |
display_name |
String |
展示名 |
version |
String |
版本 |
version_description |
String |
版本说明 |
description |
String |
描述 |
version_attribution |
String |
版本属性 |
unique_id |
String |
唯一ID |
op_user |
String |
操作人 |
op_time |
String |
操作时间 |
plugin_composition_type |
String |
组合类型 |
plugin_attribution |
String |
属性 |
workspace_id |
String |
租户ID |
business_type |
String |
业务类型 |
business_type_display_name |
String |
业务类型展示名 |
maintainers |
String |
维护者 |
icon_url |
String |
图标URL |
refer_count |
Integer |
引用次数 |
usage_count |
Integer |
使用次数 |
runtime_attribution |
String |
运行属性 |
active |
Integer |
是否激活 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息 |
error_code |
String |
错误码 |
请求示例
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/query-all?offset=0&limit=3 { "plugin_name" : "", "maintainer" : "", "business_type" : [ "Build", "Gate", "Deploy", "Test", "Normal" ], "plugin_attribution" : "custom" }
响应示例
状态码: 200
OK
{ "offset" : 0, "limit" : 3, "total" : 32, "data" : [ { "plugin_name" : "basic_plugin", "display_name" : "basic_plugin", "version" : "", "version_description" : null, "description" : "", "version_attribution" : "init", "unique_id" : "83edd75a8be5406496d9fc63ce6c984e", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699355741000", "plugin_composition_type" : "single", "plugin_attribution" : "custom", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "business_type" : "Normal", "business_type_display_name" : "通用", "maintainers" : "", "icon_url" : "", "refer_count" : null, "usage_count" : null, "runtime_attribution" : "agent", "active" : 1 }, { "plugin_name" : "apie_test", "display_name" : "apie_test", "version" : "0.0.2", "version_description" : "", "description" : "", "version_attribution" : "formal", "unique_id" : "8287cdb4908741f889ed307d265677d1", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699354371000", "plugin_composition_type" : "multi", "plugin_attribution" : "custom", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "business_type" : "Normal", "business_type_display_name" : "通用", "maintainers" : "", "icon_url" : "", "refer_count" : 0, "usage_count" : null, "runtime_attribution" : "agent", "active" : 0 }, { "plugin_name" : "asdasadsas", "display_name" : "dasddasas", "version" : "", "version_description" : null, "description" : "", "version_attribution" : "init", "unique_id" : "4fccd9e61c424d1298cc9e5f71e7c9e7", "op_user" : "devcloud_devcloud_h00485561_01", "op_time" : "1699325617000", "plugin_composition_type" : "single", "plugin_attribution" : "custom", "workspace_id" : "ce8df55870164338a72d7e828a966a2a", "business_type" : "Gate", "business_type_display_name" : "代码检查", "maintainers" : "", "icon_url" : "", "refer_count" : null, "usage_count" : null, "runtime_attribution" : "agent", "active" : 1 } ] }
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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
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 ListPluginsSolution { 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(); ListPluginsRequest request = new ListPluginsRequest(); request.withOffset("<offset>"); request.withLimit("<limit>"); AgentPluginInfoQueryDTO body = new AgentPluginInfoQueryDTO(); List<String> listbodyBusinessType = new ArrayList<>(); listbodyBusinessType.add("Build"); listbodyBusinessType.add("Gate"); listbodyBusinessType.add("Deploy"); listbodyBusinessType.add("Test"); listbodyBusinessType.add("Normal"); body.withPluginAttribution("custom"); body.withBusinessType(listbodyBusinessType); body.withMaintainer(""); body.withPluginName(""); request.withBody(body); try { ListPluginsResponse response = client.listPlugins(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 41 42 43 44 45 |
# 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 = ListPluginsRequest() request.offset = "<offset>" request.limit = "<limit>" listBusinessTypebody = [ "Build", "Gate", "Deploy", "Test", "Normal" ] request.body = AgentPluginInfoQueryDTO( plugin_attribution="custom", business_type=listBusinessTypebody, maintainer="", plugin_name="" ) response = client.list_plugins(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 47 48 49 50 51 52 53 54 55 |
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.ListPluginsRequest{} offsetRequest:= "<offset>" request.Offset = &offsetRequest limitRequest:= "<limit>" request.Limit = &limitRequest var listBusinessTypebody = []string{ "Build", "Gate", "Deploy", "Test", "Normal", } pluginAttributionAgentPluginInfoQueryDto:= "custom" maintainerAgentPluginInfoQueryDto:= "" pluginNameAgentPluginInfoQueryDto:= "" request.Body = &model.AgentPluginInfoQueryDto{ PluginAttribution: &pluginAttributionAgentPluginInfoQueryDto, BusinessType: &listBusinessTypebody, Maintainer: &maintainerAgentPluginInfoQueryDto, PluginName: &pluginNameAgentPluginInfoQueryDto, } response, err := client.ListPlugins(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 |
错误码
请参见错误码。