更新时间:2024-11-29 GMT+08:00
分享

查询基础插件详情

功能介绍

查询基础插件详情

调用方法

请参见如何调用API

URI

GET /v3/{domain_id}/extension/detail

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

租户ID

表2 Query参数

参数

是否必选

参数类型

描述

plugin_name

String

插件名

version

String

版本

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

type

String

类型

name

String

名称

friendly_name

String

展示名

category

String

业务类型

description

String

描述

version

String

版本

version_description

String

版本说明

inputs

Array of inputs objects

输入信息

outputs

Array of outputs objects

输出信息

execution

execution object

执行信息

表5 inputs

参数

参数类型

描述

name

String

名称

type

String

类型

label

String

标签

description

String

说明

default_value

String

默认值

required

Boolean

必填

extend_prop

ExtensionExtendProp object

扩展属性

validation

ExtensionValidation object

验证

表6 ExtensionExtendProp

参数

参数类型

描述

api_options

String

API 选项

api_type

String

API 类型

options

String

选项

disabled_conditions

String

禁用条件

visible_conditions

String

可见条件

表7 ExtensionValidation

参数

参数类型

描述

required_message

String

消息

regex

String

正则

regex_message

String

正则消息

max_length

Integer

最大长度

min_length

Integer

最小长度

表8 outputs

参数

参数类型

描述

name

String

名称

type

String

类型

description

String

描述

表9 execution

参数

参数类型

描述

target

String

入口

type

String

类型

sha256

String

sha256

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释

错误信息。

取值范围

不涉及。

error_code

String

参数解释

错误码。

取值范围

不涉及。

请求示例

GET https://{endpoint}/v3/ce8df55870164338a72d7e828a966a2a/extension/detail?plugin_name=basic-CTS&version=2.3.5

响应示例

状态码: 200

OK

{
  "type" : "Task",
  "name" : "basic-CTS",
  "category" : "Test",
  "description" : "",
  "version" : "2.3.5",
  "inputs" : [ {
    "name" : "SHELL_PLUGIN",
    "type" : "input",
    "label" : "单行输入框",
    "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" : "记录问题个数"
  } ],
  "execution" : {
    "type" : "scripts/test.sh",
    "target" : "Shell",
    "sha256" : "4fa52dab3fb72847e4da5f00295a96fce8892f301d384efe9b776aa1731ba8f0"
  },
  "friendly_name" : "基础插件-CTS2",
  "version_description" : "执行Shell命令"
}

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
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.withDomainId("{domain_id}");
        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
# 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.domain_id = "{domain_id}"
        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
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.DomainId = "{domain_id}"
	response, err := client.ShowBasicPlugin(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

错误码

请参见错误码

相关文档