查询基础插件列表
功能介绍
查询基础插件列表
调用方法
请参见如何调用API。
URI
GET /v1/{domain_id}/relation/plugin/single
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
参数解释: 租户ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
attribution |
是 |
String |
参数解释: 插件属性。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
offset |
是 |
String |
参数解释: 偏移量,表示从此偏移量开始查询需配合limit一起使用。 约束限制: 不涉及。 取值范围: offset大于等于0。 默认取值: 不涉及。 |
limit |
是 |
String |
参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 1到100。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询。 取值范围: offset大于等于0。 |
limit |
Integer |
参数解释: 每次查询的条目数量。 取值范围: 大于等于0。 |
total |
Integer |
参数解释: 本次查询的静态规则总数。 取值范围: 不涉及。 |
data |
Array of data objects |
参数解释: 结果集。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 扩展插件唯一标识。 取值范围: 不涉及。 |
display_name |
String |
参数解释: 扩展插件在插件市场和流水线显示的名称。 取值范围: 不涉及。 |
plugin_attribution |
String |
参数解释: 标识是否为官方插件。 取值范围: 不涉及。 |
icon_url |
String |
参数解释: 图标URL。 取值范围: 不涉及。 |
description |
String |
参数解释: 插件描述。 取值范围: 不涉及。 |
publisher_id |
String |
参数解释: 发布商ID。 取值范围: 不涉及。 |
manifest_version |
String |
参数解释: 版本。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugin/single?limit=10&offset=0&attribution=official&_=1699356895028
响应示例
状态码:200
OK
{ "offset" : 0, "limit" : 10, "total" : 3, "data" : [ { "name" : "official_shell_plugin", "display_name" : "执行Shell", "plugin_attribution" : "official", "icon_url" : "", "description" : "用于执行用户Shell命令", "publisher_id" : null, "manifest_version" : "3" }, { "name" : "test_plugin_230725", "display_name" : "测试新版插件流程2307251", "plugin_attribution" : "official", "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=test_plugin_230725-b7b10ddbbae14356ab16d649a43d7776-20210811-153521(WeLinkPC).png-ce8df55870164338a72d7e828a966a2a&icon_type=plugin", "description" : "这里是描述", "publisher_id" : null, "manifest_version" : "3" }, { "name" : "official_git_clone", "display_name" : "official_git_clone", "plugin_attribution" : "official", "icon_url" : "", "description" : "下载流水线源中配置的代码库。", "publisher_id" : null, "manifest_version" : null } ] }
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 ListBasePluginsSolution { 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(); ListBasePluginsRequest request = new ListBasePluginsRequest(); request.withDomainId("{domain_id}"); try { ListBasePluginsResponse response = client.listBasePlugins(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 = ListBasePluginsRequest() request.domain_id = "{domain_id}" response = client.list_base_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 |
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.ListBasePluginsRequest{} request.DomainId = "{domain_id}" response, err := client.ListBasePlugins(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 |
错误码
请参见错误码。