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

查询插件输入配置

功能介绍

查询插件输入配置

调用方法

请参见如何调用API

URI

POST /v1/{domain_id}/agent-plugin/plugin-input

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

租户ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of PluginPartQueryDTO objects

查询请求体

表4 PluginPartQueryDTO

参数

是否必选

参数类型

描述

plugin_name

String

插件名

display_name

String

展示名

version

String

版本号

plugin_attribution

String

插件属性,custom/official

version_attribution

String

版本属性,draft/formal

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of PluginPartQueryVOListAgentPluginInputVO objects

参数解释: 插件输入配置列表。 约束限制: 不涉及。

表6 PluginPartQueryVOListAgentPluginInputVO

参数

参数类型

描述

plugin_name

String

插件名

display_name

String

展示名

data

Array of data objects

结果集

表7 data

参数

参数类型

描述

unique_id

String

唯一ID

name

String

名称

default_value

String

默认值

plugin_name

String

插件名

version

String

版本

type

String

类型

workspace_id

String

租户ID

validation

ExtensionValidation object

验证

layout_content

String

样式信息

表8 ExtensionValidation

参数

参数类型

描述

required_message

String

消息

regex

String

正则

regex_message

String

正则消息

max_length

Integer

最大长度

min_length

Integer

最小长度

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

参数解释: 错误信息。 取值范围: 不涉及。

error_code

String

参数解释: 错误码。 取值范围: 不涉及。

请求示例

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/plugin-input

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "执行Shell",
  "version" : "0.0.2",
  "plugin_attribution" : "official",
  "version_attribution" : "formal"
} ]

响应示例

状态码: 200

参数解释: 插件输入配置列表。 约束限制: 不涉及。

[ {
  "plugin_name" : "official_shell_plugin",
  "display_name" : "执行Shell",
  "data" : [ {
    "unique_id" : "aac7e571b0d4462ba7962ce1735c4ec3",
    "name" : "OFFICIAL_SHELL_SCRIPT_INPUT",
    "default_value" : "",
    "plugin_name" : "official_shell_plugin",
    "version" : "0.0.2",
    "type" : "shell",
    "workspace_id" : "*",
    "layout_content" : null,
    "front_data_prop" : null,
    "label" : "Shell命令",
    "description" : "用户在此处输入Shell命令",
    "required" : "true",
    "extend_prop" : {
      "api_options" : null,
      "api_type" : null,
      "options" : null,
      "disabled_conditions" : null,
      "visible_conditions" : null
    },
    "validation" : {
      "required_message" : null,
      "regex" : null,
      "regex_message" : null,
      "max_length" : null,
      "min_length" : null
    }
  } ]
} ]

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
55
56
57
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.*;

import java.util.List;
import java.util.ArrayList;

public class ShowPluginInputsSolution {

    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();
        ShowPluginInputsRequest request = new ShowPluginInputsRequest();
        List<PluginPartQueryDTO> listbodyBody = new ArrayList<>();
        listbodyBody.add(
            new PluginPartQueryDTO()
                .withPluginName("official_shell_plugin")
                .withDisplayName("执行Shell")
                .withVersion("0.0.2")
                .withPluginAttribution("official")
                .withVersionAttribution("formal")
        );
        request.withBody(listbodyBody);
        try {
            ShowPluginInputsResponse response = client.showPluginInputs(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
40
# 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 = ShowPluginInputsRequest()
        listBodybody = [
            PluginPartQueryDTO(
                plugin_name="official_shell_plugin",
                display_name="执行Shell",
                version="0.0.2",
                plugin_attribution="official",
                version_attribution="formal"
            )
        ]
        request.body = listBodybody
        response = client.show_plugin_inputs(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
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.ShowPluginInputsRequest{}
	versionAttributionBody:= "formal"
	var listBodybody = []model.PluginPartQueryDto{
        {
            PluginName: "official_shell_plugin",
            DisplayName: "执行Shell",
            Version: "0.0.2",
            PluginAttribution: "official",
            VersionAttribution: &versionAttributionBody,
        },
    }
	request.Body = &listBodybody
	response, err := client.ShowPluginInputs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

参数解释: 插件输入配置列表。 约束限制: 不涉及。

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档