Querying the Available Extension List
Function
This API is used to query available extensions.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{domain_id}/relation/stage-plugins
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
use_condition |
No |
String |
Definition: Whether the extension can be used by a pipeline or template. Constraints: N/A Value range:
Default value: N/A |
comp_id |
No |
String |
Definition: Microservice ID. Constraints: N/A Value range: N/A Default value: N/A |
comp_name |
No |
String |
Definition: Microservice name. Constraints: N/A Value range: N/A Default value: N/A |
cloud_id |
No |
String |
Definition: Region ID. Constraints: N/A Value range: N/A Default value: N/A |
strategy_id |
No |
String |
Definition: Policy ID. Constraints: N/A Value range: N/A Default value: N/A |
category |
No |
String |
Definition: Pipeline type. Constraints: N/A Value range: N/A Default value: N/A |
publish_tab |
No |
String |
Definition: Whether to release the pipeline. Constraints: N/A Value range: N/A Default value: N/A |
platform |
No |
String |
Definition: Deployment platform. Constraints: N/A Value range: N/A Default value: N/A |
comp_extend_type |
No |
String |
Definition: Component type. Constraints: N/A Value range: N/A Default value: N/A |
deploy_type |
No |
String |
Definition: Deployment type. Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
full_stage_plugins_item_list |
Array of full_stage_plugins_item_list objects |
Definition: Result set. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
plugins_list |
Array of plugins_list objects |
Definition: Extension list. Value range: N/A |
display_name |
String |
Definition: Displayed extension name. Value range: N/A |
business_type |
String |
Definition: Extension service type. Value range: N/A |
unique_id |
String |
Definition: Extension ID. Default value: N/A |
conditions |
Array of strings |
Definition: Running conditions. Value range: N/A |
addables |
Array of addables objects |
Definition: Additional attribute. Value range: N/A |
editable |
Boolean |
Definition: Editable parameter or not. Value range:
|
removable |
Boolean |
Definition: Removable or not. Value range:
|
cloneable |
Boolean |
Definition: Whether the extension can be cloned. Value range:
|
disabled |
Boolean |
Definition: Disabled or not. Value range:
|
Parameter |
Type |
Description |
---|---|---|
unique_id |
String |
Definition: ID. Value range: N/A |
display_name |
String |
Definition: Display name. Value range: N/A |
plugin_name |
String |
Definition: Extension name. Value range: N/A |
disabled |
Boolean |
Definition: Whether the current extension is disabled for subsequent pipelines. The default value is false. Value range:
|
db_record_name |
String |
Definition: Display name of an extension record. Value range: N/A |
group_name |
String |
Definition: Name of the group in a pipeline stage. Value range: N/A |
group_type |
String |
Definition: Group type in a pipeline stage. Value range: N/A |
plugin_attribution |
String |
Definition: Whether the extension is an official one. Value range: N/A |
plugin_composition_type |
String |
Definition: Whether a group consists of multiple steps. Value range:
|
runtime_attribution |
String |
Definition: Running attribute. Value range:
|
all_steps |
Array of all_steps objects |
Definition: Basic extension list. Value range: N/A |
description |
String |
Definition: Extension description. Value range: N/A |
version_attribution |
String |
Definition: Whether it is a draft extension. Value range: N/A |
icon_url |
String |
Definition: Extension icon URL. Value range: N/A |
multi_step_editable |
Integer |
Definition: Whether steps can be added. The default value is 1, indicating that steps can be added. Value range:
|
location |
String |
Definition: Usage position. Value range: N/A |
publisher_unique_id |
String |
Definition: Publisher ID. Value range: N/A |
manifest_version |
String |
Definition: Extension version identifier. Value range: N/A |
standard |
Boolean |
Definition: Whether the extension is standardized. Value range:
|
Parameter |
Type |
Description |
---|---|---|
plugin_name |
String |
Definition: Extension name. Value range: N/A |
display_name |
String |
Definition: Displayed extension name. Value range: N/A |
version |
String |
Definition: Extension version number. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
additionalProp1 |
Boolean |
Definition: Additional attribute 1. Value range: N/A |
additionalProp2 |
Boolean |
Definition: Additional attribute 2. Value range: N/A |
additionalProp3 |
Boolean |
Definition: Additional attribute 3. Value range: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: N/A |
Example Requests
POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/stage-plugins { "use_condition" : "pipeline" }
Example Responses
Status code: 200
OK
{ "full_stage_plugins_item_list" : [ { "plugins_list" : [ { "unique_id" : "47d48e84-8a98-4ad1-8bc0-59c112a05c5b", "display_name" : "CloudBuild", "plugin_name" : "official_devcloud_cloudBuild", "disabled" : false, "group_name" : null, "group_type" : null, "plugin_attribution" : "official", "plugin_composition_type" : "single", "runtime_attribution" : "agent", "all_steps" : null, "description" : "CloudBuild capabilities can be called on the pipeline for building.CloudBuild provides an easy-to-use, cloud-based build platform that supports multiple programming languages, helping you achieve continuous delivery, with shorter delivery period and higher delivery efficiency. With CloudBuild, you can create, configure, and run build tasks with a few clicks. CloudBuild also supports automation of code retrieval, building, and packaging, as well as real-time status monitoring.", "version_attribution" : "formal", "icon_url" : "/api/v1/*/common/get-plugin-icon?object_key=official_devcloud_cloudBuild-d81c87f9977d4923a546d067a0001914- Build.png-ce8df55870164338a72d7e828a966a2a", "multi_step_editable" : 0, "standard" : true } ], "display_name" : "Build", "business_type" : "Build", "unique_id" : "f44ca008-ae9b-45ee-905d-711429382c71", "conditions" : null, "addables" : 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 |
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 ListStagePluginsSolution { 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(); ListStagePluginsRequest request = new ListStagePluginsRequest(); request.withDomainId("{domain_id}"); StagePluginsQueryDTO body = new StagePluginsQueryDTO(); body.withUseCondition("pipeline"); request.withBody(body); try { ListStagePluginsResponse response = client.listStagePlugins(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 |
# 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 = ListStagePluginsRequest() request.domain_id = "{domain_id}" request.body = StagePluginsQueryDTO( use_condition="pipeline" ) response = client.list_stage_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 |
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.ListStagePluginsRequest{} request.DomainId = "{domain_id}" useConditionStagePluginsQueryDto:= "pipeline" request.Body = &model.StagePluginsQueryDto{ UseCondition: &useConditionStagePluginsQueryDto, } response, err := client.ListStagePlugins(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