查询当前火山引擎账号下的自定义步骤。
请求方式:POST
请求地址:https://open.volcengineapi.com/?Action=ListComponentStep&Version=2023-05-01
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListComponentStep | 公共参数,本接口值:ListComponentStep。 |
Version | String | 是 | 2023-05-01 | 公共参数,本接口值:2023-05-01。 |
Filter | Object ComponentStepFilter | 否 | 自定义步骤的过滤条件。 | |
PageNumber | Integer | 否 | 1 | 分页查询时的起始页码,从 1 开始,默认为 1。 |
PageSize | Integer | 否 | 10 | 分页查询时每页显示的记录数,取值:
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
IsBuiltin | Boolean | 否 | false | 是否是预置步骤,本场景为 false。 |
Name | String | 否 | demo | 根据自定义步骤名称过滤,模糊筛选。 |
Category | String | 否 | Test | 按类别过滤自定义步骤:
|
POST /?Action=ListComponentStep&Version=2023-05-01 HTTP/1.1 Content-Type:application/json { "PageNumber": 1, "PageSize": 10, "Filter": { "IsBuiltin": false } }
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TotalCount | Integer | 10 | 自定义步骤总数。 |
Items | Array of ComponentStep | 自定义步骤列表。 | |
PageSize | Integer | 10 | 分页大小。 |
PagetNumber | Integer | 1 | 当前页码。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
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 | 自定义步骤类别:
|
Yaml | String | 自定义步骤 YAML 描述信息。 | |
Creator | Object IAMUser | 自定义步骤创建人。 | |
CreateTime | String | 2023-05-10T21:33:20Z | 自定义步骤创建时间。 |
UpdateTime | String | 2023-05-10T21:33:20Z | 自定义步骤更新时间。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | version | Input 名称。 |
DisplayName | String | version | Input 展示名称。 |
Type | String | string | Input 类型:
|
DefaultValue | String | v1 | 默认值。 |
Required | String | true | Input 是否必填:
|
Description | String | 这是一段描述 | Input 描述信息。 |
UiConfig | Object UiField | Input 的 UI 配置。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | Input | UI 组件类型, 映射到前端 UI 组件。
|
DataSource | Object DataSource | UI 组件数据源。 | |
ValidateRule | Array of String | 校验规则名称,会映射到前端预置的一些校验规则。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String | value | 数据源类型, 默认值为 value, 暂时只支持 value。 |
Value | Array of String | ["v1"] | 与对应组件匹配的数据值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String | count | Output 名称。 |
DisplayName | String | count | Output 展示名称。 |
Type | String | string | Output 类型:
|
DefaultValue | String | 1 | 默认值。 |
Description | String | 数量 | 描述。 |
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 } }
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。