分页查询可选插件列表
功能介绍
分页查询可选插件列表
调用方法
请参见如何调用API。
URI
POST /v1/{domain_id}/relation/plugins
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
租户ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
偏移 |
limit |
是 |
Integer |
大小 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
use_condition |
否 |
String |
用于区分插件为流水线可使用/模板可使用,可选pipeline/template |
input_repo_type |
否 |
String |
用于区分源的代码仓类型codehub/gitlab/github等 |
input_source_type |
否 |
String |
用于区分单源/多源的情况 |
business_type |
否 |
String |
业务类型 |
regex_name |
否 |
String |
名称 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
offset |
Integer |
偏移 |
limit |
Integer |
大小 |
total |
Integer |
总数 |
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 |
版本 |
状态码: 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 54 |
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.withOffset(<offset>); request.withLimit(<limit>); 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 39 |
# 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.offset = <offset> request.limit = <limit> 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 49 |
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.Offset = int32(<offset>) request.Limit = int32(<limit>) 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 |
错误码
请参见错误码。