分页查询可选插件列表
功能介绍
分页查询可选插件列表
调用方法
请参见如何调用API。
URI
POST /v1/{domain_id}/relation/plugins
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
参数解释: 租户ID。 约束限制: 不涉及。 取值范围: 32位字符,由数字和字母组成。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: offset大于等于0。 默认取值: 不涉及。 |
limit |
是 |
Integer |
参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
use_condition |
否 |
String |
参数解释: 用于区分插件为流水线可使用/模板可使用。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
input_repo_type |
否 |
String |
参数解释: 用于区分源的代码仓类型codehub/gitlab/github等。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
input_source_type |
否 |
String |
参数解释: 用于区分单源/多源的情况。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
business_type |
否 |
String |
参数解释: 业务类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
regex_name |
否 |
String |
参数解释: 匹配名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
参数解释: 偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: offset大于等于0。 默认取值: 不涉及。 |
limit |
Integer |
参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 不涉及。 |
total |
Integer |
参数解释: 总条目数量。 取值范围: 大于等于0。 |
data |
Array of data objects |
参数解释: 结果集。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
business_type |
String |
参数解释: 业务类型。 取值范围: 不涉及。 |
display_name |
String |
参数解释: 展示名。 取值范围: 不涉及。 |
unique_id |
String |
参数解释: 唯一ID。 取值范围: 不涉及。 |
editable |
Boolean |
参数解释: 是否可编辑。 取值范围:
|
removable |
Boolean |
参数解释: 是否可移除。 取值范围:
|
cloneable |
Boolean |
参数解释: 是否可复制。 取值范围:
|
disabled |
Boolean |
参数解释: 是否禁用。 取值范围:
|
conditions |
Array of strings |
参数解释: 条件。 取值范围: 不涉及。 |
plugins_list |
Array of plugins_list objects |
参数解释: 插件列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
unique_id |
String |
参数解释: 唯一ID。 取值范围: 不涉及。 |
display_name |
String |
参数解释: 展示名。 取值范围: 不涉及。 |
plugin_name |
String |
参数解释: 插件名。 取值范围: 不涉及。 |
disabled |
Boolean |
参数解释: 是否禁用。 取值范围:
|
group_name |
String |
参数解释: 组名。 取值范围: 不涉及。 |
group_type |
String |
参数解释: 组类型。 取值范围: 不涉及。 |
plugin_attribution |
String |
参数解释: 插件属性。 取值范围: 不涉及。 |
plugin_composition_type |
String |
参数解释: 组合插件。 取值范围: 不涉及。 |
runtime_attribution |
String |
参数解释: 插件运行属性。 取值范围: 不涉及。 |
all_steps |
Array of all_steps objects |
参数解释: 基础插件列表。 取值范围: 不涉及。 |
description |
String |
参数解释: 插件描述。 取值范围: 不涉及。 |
version_attribution |
String |
参数解释: 插件版本属性。 取值范围: 不涉及。 |
icon_url |
String |
参数解释: 插件图标URL。 取值范围: 不涉及。 |
multi_step_editable |
Integer |
参数解释: 插件可编辑。 取值范围: 不涉及。 |
location |
String |
参数解释: 插件地址。 取值范围: 不涉及。 |
publisher_unique_id |
String |
参数解释: 插件发布商ID。 取值范围: 不涉及。 |
manifest_version |
String |
参数解释: 插件版本。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
plugin_name |
String |
参数解释: 插件名。 取值范围: 不涉及。 |
display_name |
String |
参数解释: 展示名。 取值范围: 不涉及。 |
version |
String |
参数解释: 版本。 取值范围: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/plugins?limit=4&offset=0 { "input_repo_type" : "codehub", "input_source_type" : "single", "use_condition" : "pipeline", "business_type" : "", "regex_name" : "" }
响应示例
状态码:200
OK
{ "offset" : 0, "limit" : 4, "total" : 246, "data" : { "plugins_list" : [ { "unique_id" : "1bfe2cd6b6f44fe3a918768e0391144f", "display_name" : "1030测试", "plugin_name" : "132132132231", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "single", "runtime_attribution" : "agent", "all_steps" : null, "description" : "", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" }, { "unique_id" : "84b6d96b240644b8a9c529981759a6d2", "display_name" : "插件发布", "plugin_name" : "create_test_2", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "multi", "runtime_attribution" : "agent", "all_steps" : null, "description" : "test", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" }, { "unique_id" : "816c527f9ba34904b84823718633ecdf", "display_name" : "插件创建测试", "plugin_name" : "create_test.plugin_draft", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "multi", "runtime_attribution" : "agent", "all_steps" : null, "description" : "test", "version_attribution" : "draft", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" }, { "unique_id" : "6e7a5fe5e7214ce6858087357a4bf79b", "display_name" : "插件版本描述测试", "plugin_name" : "plugin_version_test", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "custom", "plugin_composition_type" : "single", "runtime_attribution" : "agent", "all_steps" : null, "description" : "插件版本描述测试", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" } ], "display_name" : "代码检查", "business_type" : "Gate", "unique_id" : "032ad7e2-5e19-4e90-8517-0958deb89e12", "conditions" : null, "editable" : false, "removable" : false, "cloneable" : false, "disabled" : false } }
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 |
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 ListBasePluginsNewPostSolution { 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(); ListBasePluginsNewPostRequest request = new ListBasePluginsNewPostRequest(); request.withDomainId("{domain_id}"); BusinessTypePluginsQueryDTO body = new BusinessTypePluginsQueryDTO(); body.withRegexName(""); body.withBusinessType(""); body.withInputSourceType("single"); body.withInputRepoType("codehub"); body.withUseCondition("pipeline"); request.withBody(body); try { ListBasePluginsNewPostResponse response = client.listBasePluginsNewPost(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 |
# 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 = ListBasePluginsNewPostRequest() request.domain_id = "{domain_id}" request.body = BusinessTypePluginsQueryDTO( regex_name="", business_type="", input_source_type="single", input_repo_type="codehub", use_condition="pipeline" ) response = client.list_base_plugins_new_post(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 |
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.ListBasePluginsNewPostRequest{} request.DomainId = "{domain_id}" regexNameBusinessTypePluginsQueryDto:= "" businessTypeBusinessTypePluginsQueryDto:= "" inputSourceTypeBusinessTypePluginsQueryDto:= "single" inputRepoTypeBusinessTypePluginsQueryDto:= "codehub" useConditionBusinessTypePluginsQueryDto:= "pipeline" request.Body = &model.BusinessTypePluginsQueryDto{ RegexName: ®exNameBusinessTypePluginsQueryDto, BusinessType: &businessTypeBusinessTypePluginsQueryDto, InputSourceType: &inputSourceTypeBusinessTypePluginsQueryDto, InputRepoType: &inputRepoTypeBusinessTypePluginsQueryDto, UseCondition: &useConditionBusinessTypePluginsQueryDto, } response, err := client.ListBasePluginsNewPost(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 |
错误码
请参见错误码。