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

文档中心

立即注册

导航

持续交付

UpgradeComponentStep

最近更新时间：2024.08.27 17:03:21首次发布时间：2024.08.16 14:58:40

升级自定义步骤。该操作不影响使用了历史版本步骤的存量流水线。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpgradeComponentStep	公共参数，本接口值：UpgradeComponentStep。
Version	String	是	2023-05-01	公共参数，本接口值：2023-05-01。
Identifier	String	是	custom@1.0.0/stepname@1.0.2	自定义步骤唯一标识符。
ComponentStepYaml	String	是	c3RlcDogdjJjdXN0b21zdGVwCmRpc3BsYXlOYW1lOiDoh6rlrprkuYnmraXpqqR2Mi3mm7TmlrAKaW1hZ2U6IGJ1c3lib3g6bGF0ZXN0CmlucHV0czoKICAtIG5hbWU6IGNvbW1hbmQKICAgIGRpc3BsYXlOYW1lOiDlkb3ku6TmiafooYwKICAgIHR5cGU6IHN0cmluZwogICAgZGVmYXVsdFZhbHVlOiBlY2hvIGhlbGxvIHdvcmxkCiAgICByZXF1aXJlZDogdHJ1ZQogICAgZGVzY3JpcHRpb246IOi+k+WHuuasoui/juWRveS7pAogICAgdWlDb25maWc6CiAgICAgIHR5cGU6IElucHV0CnNjcmlwdDogfAogICQoaW5wdXRzLmNvbW1hbmQpCmR******	自定义步骤 YAML 描述文件的 Base64 字符编码。自定义步骤 YAML 的详细说明请参见创建自定义步骤。

请求示例

POST /?Action=UpgradeComponentStep&Version=2023-05-01 HTTP/1.1
Content-Type:application/json
{
  "ComponentStepYaml": "c3RlcDogdjJjdXN0b21zdGVwCmRpc3BsYXlOYW1lOiDoh6rlrprkuYnmraXpqqR2Mi3mm7TmlrAKaW1hZ2U6IGJ1c3lib3g6bGF0ZXN0CmlucHV0czoKICAtIG5hbWU6IGNvbW1hbmQKICAgIGRpc3BsYXlOYW1lOiDlkb3ku6TmiafooYwKICAgIHR5cGU6IHN0cmluZwogICAgZGVmYXVsdFZhbHVlOiBlY2hvIGhlbGxvIHdvcmxkCiAgICByZXF1aXJlZDogdHJ1ZQogICAgZGVzY3JpcHRpb246IOi+k+WHuuasoui/juWRveS7pAogICAgdWlDb25maWc6CiAgICAgIHR5cGU6IElucHV0CnNjcmlwdDogfAogICQoaW5wdXRzLmNvbW1hbmQpCmR******",
  "Identifier": "custom@1.0.0/stepname@1.0.2"
}

返回参数

参数	类型	示例值	描述
Identifier	String	custom@1.0.0/stepname@1.0.3	自定义步骤唯一标识符。升级后会返回新版本的 identifier。

返回示例

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

错误码

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