Querying the Available Extensions by Page
Function
This API is used to query the available extensions by page.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{domain_id}/relation/plugins
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Tenant ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
Yes |
Integer |
Offset. |
limit |
Yes |
Integer |
Size. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
use_condition |
No |
String |
Whether the extension can be used by a pipeline or template. Options: pipeline or template. |
input_repo_type |
No |
String |
This parameter is used to distinguish the source code repository type: CodeArts Repo, GitLab, or GitHub. |
input_source_type |
No |
String |
This parameter is used to distinguish whether a pipeline has one source or multiple sources. |
business_type |
No |
String |
Service type. |
regex_name |
No |
String |
Name. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
offset |
Integer |
Offset. |
limit |
Integer |
Size. |
total |
Integer |
Total number. |
data |
Array of data objects |
Result set. |
Parameter |
Type |
Description |
---|---|---|
business_type |
String |
Service type. |
display_name |
String |
Display name. |
unique_id |
String |
Unique ID. |
editable |
Boolean |
Editable. |
removable |
Boolean |
Removable. |
cloneable |
Boolean |
Replicable. |
disabled |
Boolean |
Disabled. |
conditions |
Array of strings |
Conditions. |
plugins_list |
Array of plugins_list objects |
Extension list. |
Parameter |
Type |
Description |
---|---|---|
unique_id |
String |
Unique ID. |
display_name |
String |
Display name. |
plugin_name |
String |
Extension name. |
disabled |
Boolean |
Disabled. |
group_name |
String |
Group name. |
group_type |
String |
Group type. |
plugin_attribution |
String |
Attribute. |
plugin_composition_type |
String |
Combination extension. |
runtime_attribution |
String |
Runtime attributes. |
all_steps |
Array of all_steps objects |
Basic extension list. |
description |
String |
Description. |
version_attribution |
String |
Version attribute. |
icon_url |
String |
Icon URL. |
multi_step_editable |
Integer |
Editable. |
location |
String |
Address. |
publisher_unique_id |
String |
Publisher ID. |
manifest_version |
String |
Version. |
Parameter |
Type |
Description |
---|---|---|
plugin_name |
String |
Extension name. |
display_name |
String |
Display name. |
version |
String |
Version. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
Example Requests
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" : "" }
Example Responses
Status code: 200
OK
{ "offset" : 0, "limit" : 4, "total" : 246, "data" : { "plugins_list" : [ { "unique_id" : "1bfe2cd6b6f44fe3a918768e0391144f", "display_name" : "1030 test", "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" : "Release", "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" : "Plug-in Creation Test", "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" : "Plug-in Version Description Test", "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" : "Plug-in Version Description Test", "version_attribution" : "formal", "icon_url" : "", "multi_step_editable" : 1, "location" : "pipeline,service", "publisher_unique_id" : null, "manifest_version" : "3" } ], "display_name" : "Check", "business_type" : "Gate", "unique_id" : "032ad7e2-5e19-4e90-8517-0958deb89e12", "conditions" : null, "editable" : false, "removable" : false, "cloneable" : false, "disabled" : false } }
SDK Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot