ListComponentStep--持续交付-火山引擎

文档中心

立即注册

导航

ListComponentStep

最近更新时间：2024.09.27 14:46:38首次发布时间：2024.07.02 21:03:14

查询当前火山引擎账号下的自定义步骤。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=ListComponentStep&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListComponentStep	接口名称。当前 API 的名称为 `ListComponentStep`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
Filter	Object of ComponentStepFilter	否	-	自定义步骤的过滤条件。
PageNumber	Long	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Long	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

ComponentStepFilter

参数	类型	是否必选	示例值	描述
IsBuiltin	Boolean	否	false	是否是预置步骤，本场景为 false。
Name	String	否	demo	根据自定义步骤名称过滤，模糊筛选。
Category	String	否	Test	按类别过滤自定义步骤： Other：其他 Build：构建 Test：测试 Deploy：部署 Registry：镜像仓库 Command：命令执行

参数

类型

是否必选

示例值

描述

IsBuiltin

Boolean

否

false

是否是预置步骤，本场景为 false。

Name

String

否

demo

根据自定义步骤名称过滤，模糊筛选。

请求示例

POST https://open.volcengineapi.com/?Action=ListComponentStep&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
  "PageNumber": 1,
  "PageSize": 10,
  "Filter": {
    "IsBuiltin": false
  }
}

返回参数

参数	类型	示例值	描述
TotalCount	Long	10	自定义步骤总数。
Items	Array of ComponentStep	-	自定义步骤列表。
PageSize	Long	10	分页大小。
PageNumber	Long	1	当前页码。

ComponentStep

参数	类型	示例值	描述
Identifier	String	custom@1.0.0/v2customstep	自定义步骤唯一标识符。
Name	String	v2customstep	自定义步骤名称。
DisplayName	String	自定义步骤v2	自定义步骤显示名称。
Image	String	busybox:latest	自定义步骤执行镜像。
Inputs	Array of ComponentInput	-	自定义步骤输入。
Outputs	Array of ComponentOutput	-	自定义步骤输出。
WorkingDirectory	String		工作目录。
Script	String		自定义步骤执行脚本。
Description	String	这是一段描述	自定义步骤描述信息。
Category	String	Command	自定义步骤类别： Other：其他 Build：构建 Test：测试 Deploy：部署 Registry：镜像仓库 Command：命令执行
Yaml	String		自定义步骤 YAML 描述信息。
Creator	Object of IAMUser	-	自定义步骤创建人。
CreateTime	String	2023-05-10T21:33:20Z	自定义步骤创建时间。
UpdateTime	String	2023-05-10T21:33:20Z	自定义步骤更新时间。

ComponentInput

参数	类型	示例值	描述
Name	String	version	Input 名称。
DisplayName	String	version	Input 展示名称。
Type	String	string	Input 类型： string（默认值）：字符串 array：数组
DefaultValue	String	v1	默认值。
Required	Boolean	true	Input 是否必填： true：是 false：否
Description	String	这是一段描述	Input 描述信息。
UiConfig	Object of UiField	-	Input 的 UI 配置。

UiField

参数	类型	示例值	描述
Type	String	Input	UI 组件类型, 映射到前端 UI 组件。 Input（默认值）：输入框 Select：下拉单选框 CheckBoxGroup：复选框 CodeEditor：命令行，默认支持 Bash 命令 Password：界面显示为星号的输入框 Text：固定文本，显示一段只读文本。
DataSource	Object of DataSource	-	UI 组件数据源。
ValidateRule	Array of String		校验规则名称，会映射到前端预置的一些校验规则。

参数

类型

示例值

描述

Type

String

Input

UI 组件类型, 映射到前端 UI 组件。

Input（默认值）：输入框
Select：下拉单选框
CheckBoxGroup：复选框
CodeEditor：命令行，默认支持 Bash 命令
Password：界面显示为星号的输入框
Text：固定文本，显示一段只读文本。

DataSource

Object of DataSource

UI 组件数据源。

ValidateRule

Array of String

校验规则名称，会映射到前端预置的一些校验规则。

DataSource

参数	类型	示例值	描述
Type	String	value	数据源类型, 默认值为 value, 暂时只支持 value。
Value	Array of String	["v1"]	与对应组件匹配的数据值。

ComponentOutput

参数	类型	示例值	描述
Name	String	count	Output 名称。
DisplayName	String	count	Output 展示名称。
Type	String	string	Output 类型： string（默认值）：字符串 array：数组
DefaultValue	String	1	默认值。
Description	String	数量	描述。

IAMUser

参数	类型	示例值	描述
AccountId	Long	210048****	火山引擎账号（主账号）ID。
UserId	Long	28****	子用户（IAM 用户）ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071831008065A83CB2C0585****",
        "Action": "ListComponentStep",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Identifier": "custom@1.0.0/autotest-****",
                "Name": "autotest-VXd4O9",
                "DisplayName": "自定义步骤—0330030017",
                "Image": "cp-enterprise-cn-beijing.cr.volces.com/cp-auto-test/****",
                "Inputs": [
                    {
                        "Name": "cmd",
                        "DisplayName": "自定义步骤命令执行",
                        "Type": "string",
                        "DefaultValue": "\"echo 'hello world'\"",
                        "Required": true,
                        "Description": "欢迎输入命令",
                        "UiConfig": {
                            "Type": "Input",
                            "DataSource": null,
                            "ValidateRule": null
                        }
                    }
                ],
                "WorkingDirectory": "",
                "Script": "$(inputs.cmd)",
                "Description": null,
                "Category": "Command",
                "Status": "Enabled",
                "Yaml": "step: autotest-VXd4O9\ndisplayName: 自定义步骤—0330030017\nimage: cp-enterprise-cn-beijing.cr.volces.com/cp-auto-test/****\ninputs:\n    - name: cmd\n      displayName: 自定义步骤命令执行\n      type: string\n      defaultValue: echo 'hello world'\n      required: true\n      description: 欢迎输入命令\n      uiConfig:\n        type: Input\nscript: $(inputs.cmd)\ncategory: Command\n",
                "Creator": {
                    "AccountId": 210048****,
                    "UserId": 539****
                },
                "CreateTime": "2024-03-30T03:00:17+08:00",
                "UpdateTime": "2024-03-30T03:00:17+08:00"
            }
        ],
        "PageSize": 1,
        "PageNumber": 1,
        "TotalCount": 1
    }
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。