更新时间:2024-06-14 GMT+08:00

查询可选插件列表

功能介绍

查询可选插件列表

调用方法

请参见如何调用API

URI

POST /v1/{domain_id}/relation/stage-plugins

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

租户ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表3 请求Body参数

参数

是否必选

参数类型

描述

use_condition

String

用于区分插件为流水线可使用/模板可使用

comp_id

String

微服务ID

comp_name

String

微服务名

cloud_id

String

局点ID

strategy_id

String

策略ID

category

String

流水线类型

publish_tab

String

是否发布流水线

platform

String

部署平台

comp_extend_type

String

组件类型

deploy_type

String

部署类型

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

full_stage_plugins_item_list

Array of full_stage_plugins_item_list objects

结果集

表5 full_stage_plugins_item_list

参数

参数类型

描述

plugins_list

Array of plugins_list objects

插件列表

display_name

String

展示名

business_type

String

业务类型

unique_id

String

唯一ID

conditions

Array of strings

条件

addables

Array of addables objects

额外属性

editable

Boolean

是否可编辑

removable

Boolean

是否可移除

cloneable

Boolean

是否可复制

disabled

Boolean

禁用

表6 plugins_list

参数

参数类型

描述

unique_id

String

唯一ID

display_name

String

展示名

plugin_name

String

插件名

disabled

Boolean

禁用

group_name

String

组名

group_type

String

组类型

plugin_attribution

String

插件属性

plugin_composition_type

String

组合插件

runtime_attribution

String

运行属性

all_steps

Array of all_steps objects

基础插件列表

description

String

描述

version_attribution

String

版本属性

icon_url

String

图标URL

multi_step_editable

Integer

是否可编辑

standard

Boolean

标准

表7 all_steps

参数

参数类型

描述

plugin_name

String

插件名

display_name

String

展示名

version

String

版本

表8 addables

参数

参数类型

描述

additionalProp1

Boolean

额外属性1

additionalProp2

Boolean

额外属性2

additionalProp3

Boolean

额外属性3

状态码: 400

表9 响应Body参数

参数

参数类型

描述

error_msg

String

错误信息

error_code

String

错误码

请求示例

POST https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/relation/stage-plugins

{
  "use_condition" : "pipeline"
}

响应示例

状态码: 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-构建.png-ce8df55870164338a72d7e828a966a2a",
      "multi_step_editable" : 0,
      "standard" : true
    } ],
    "display_name" : "构建",
    "business_type" : "Build",
    "unique_id" : "f44ca008-ae9b-45ee-905d-711429382c71",
    "conditions" : null,
    "addables" : null,
    "editable" : false,
    "removable" : false,
    "cloneable" : false,
    "disabled" : false
  } ]
}

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
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();
        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
# 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.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
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{}
	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)
    }
}

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

状态码

状态码

描述

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码