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

文档中心

立即注册

导航

持续交付

CreateComponentStep

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

创建自定义步骤，一次只能创建一个自定义步骤。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateComponentStep	接口名称。当前 API 的名称为 `CreateComponentStep`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
ComponentStepYaml	String	是	c3RlcDogdjJjdXN0b21zdGVwCmRpc3BsYXlOYW1lOiDoh6rlrprkuYnmraXpqqR2MgppbWFnZTogYnVzeWJveDpsYXRlc3QKaW5wdXRzOgogIC0gbmFtZTogY29tbWFuZAogICAgZGlzcGxheU5hbWU6IOWRveS7pOaJp+ihjAogICAgdHlwZTogc3RyaW5nCiAgICBkZWZhdWx0VmFsdWU6IGVjaG8gaGVsbG8gd29ybGQKICAgIHJlcXVpcmVkOiB0cnVlCiAgICBkZXNjcmlwd**********	自定义步骤 YAML 描述文件的 Base64 字符编码。自定义步骤 YAML 的详细说明请参见创建自定义步骤。

请求示例

POST https://open.volcengineapi.com/?Action=CreateComponentStep&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "ComponentStepYaml": "c3RlcDogdjJjdXN0b21zdGVwCmRpc3BsYXlOYW1lOiDoh6rlrprkuYnmraXpqqR2MgppbWFnZTogYnVzeWJveDpsYXRlc3QKaW5wdXRzOgogIC0gbmFtZTogY29tbWFuZAogICAgZGlzcGxheU5hbWU6IOWRveS7pOaJp+ihjAogICAgdHlwZTogc3RyaW5nCiAgICBkZWZhdWx0VmFsdWU6IGVjaG8gaGVsbG8gd29ybGQKICAgIHJlcXVpcmVkOiB0cnVlCiAgICBkZXNjcmlwd**********"
}

返回参数

参数	类型	示例值	描述
Identifier	String	custom@1.0.0/****	自定义步骤唯一标识符。格式为：`custom@1.0.0/{stepname}@{version}`。其中，stepname 对应 yaml 中的 step 字段，version 对应yaml 中的 version 字段。说明所有存量未指定过版本号的步骤默认 version 为 1.0.0。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071957425A419917460****",
        "Action": "CreateComponentStep",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Identifier": "custom@1.0.0/****"
    }
}

错误码

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