Querying the Basic Extension Details
Function
This API is used to query the basic extension details.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{domain_id}/extension/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Tenant ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
plugin_name |
Yes |
String |
Extension name. |
version |
Yes |
String |
Version. |
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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
type |
String |
Type. |
name |
String |
Name. |
friendly_name |
String |
Display name. |
category |
String |
Service type. |
description |
String |
Description. |
version |
String |
Version. |
version_description |
String |
Version description. |
inputs |
Array of inputs objects |
Input information. |
outputs |
Array of outputs objects |
Output information. |
execution |
execution object |
Execution information. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Name. |
type |
String |
Type. |
label |
String |
Label. |
description |
String |
Description. |
default_value |
String |
Default value. |
required |
Boolean |
This parameter is mandatory. |
extend_prop |
ExtensionExtendProp object |
Extended attribute. |
validation |
ExtensionValidation object |
Verification. |
Parameter |
Type |
Description |
---|---|---|
api_options |
String |
API option. |
api_type |
String |
API type. |
options |
String |
Option. |
disabled_conditions |
String |
Disabling condition. |
visible_conditions |
String |
Visibility condition. |
Parameter |
Type |
Description |
---|---|---|
required_message |
String |
Message. |
regex |
String |
Regex. |
regex_message |
String |
Regular expression message. |
max_length |
Integer |
Maximum length. |
min_length |
Integer |
Minimum length. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Name. |
type |
String |
Type. |
description |
String |
Description. |
Parameter |
Type |
Description |
---|---|---|
target |
String |
Entry. |
type |
String |
Type. |
sha256 |
String |
sha256 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
Example Requests
GET https://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/detail?plugin_name=basic-CTS&version=2.3.5
Example Responses
Status code: 200
OK
{ "type" : "Task", "name" : "basic-CTS", "category" : "Test", "description" : "", "version" : "2.3.5", "inputs" : [ { "name" : "SHELL_PLUGIN", "type" : "input", "label" : "Single-line Text Box", "description" : "Sample String", "required" : true, "validation" : { "required_message" : null, "regex" : null, "regex_message" : null, "max_length" : null, "min_length" : null }, "default_value" : "", "extend_prop" : { "api_options" : null, "api_type" : null, "options" : null, "disabled_conditions" : null, "visible_conditions" : null } } ], "outputs" : [ { "name" : "problem", "type" : "output", "description" : "Number of recorded problems" } ], "execution" : { "type" : "scripts/test.sh", "target" : "Shell", "sha256" : "4fa52dab3fb72847e4da5f00295a96fce8892f301d384efe9b776aa1731ba8f0" }, "friendly_name" : "Basic plug-in - CTS2", "version_description" : "Running Shell Commands" }
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 |
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 ShowBasicPluginSolution { 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(); ShowBasicPluginRequest request = new ShowBasicPluginRequest(); request.withPluginName("<plugin_name>"); request.withVersion("<version>"); try { ShowBasicPluginResponse response = client.showBasicPlugin(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 |
# 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 = ShowBasicPluginRequest() request.plugin_name = "<plugin_name>" request.version = "<version>" response = client.show_basic_plugin(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 |
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.ShowBasicPluginRequest{} request.PluginName = "<plugin_name>" request.Version = "<version>" response, err := client.ShowBasicPlugin(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