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

文档中心

立即注册

导航

持续交付

UpdateComponentStep

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

更新自定义步骤。该操作允许更新部分描述性字段，如 description、inputs 的 defaultvalue 等。建议在兼容性升级场景使用。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateComponentStep	接口名称。当前 API 的名称为 `UpdateComponentStep`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
Identifier	String	是	custom@1.0.0/****	自定义步骤唯一标识符。
ComponentStepYaml	String	否	c3RlcDogdjJjdXN0b21zdGVwCmRpc3BsYXlOYW1lOiDoh6rlrprkuYnmraXpqqR2Mi3mm7TmlrAKaW1hZ2U6IGJ1c3lib3g6bGF0ZXN0CmlucHV0czoKICAtIG5hbWU6IGNvbW1hbmQKICAgIGRpc3BsYXlOYW1lOiDlkb3ku6TmiafooYwKICAgIHR5cGU6IHN0cmluZwogICAgZGVmYXVsdFZhbHVlOiBlY2hvIGhlbGxvIHdvcmxkCiAgICByZXF1aXJlZDogdHJ1ZQogICAgZGVzY3JpcHRpb246IOi+k+WHuuasoui/juWRveS7pAogICAgdWlDb25maWc6CiAgICAgIHR5cGU6IElucHV0CnNjcmlwdDogfAogICQoaW5wdXRzLmNvbW1hbmQpCmR******	自定义步骤 YAML 描述文件的 Base64 字符编码。自定义步骤 YAML 的详细说明请参见创建自定义步骤。

请求示例

POST https://open.volcengineapi.com/?Action=UpdateComponentStep&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
  "ComponentStepYaml": "c3RlcDogdjJjdXN0b21zdGVwCmRpc3BsYXlOYW1lOiDoh6rlrprkuYnmraXpqqR2Mi3mm7TmlrAKaW1hZ2U6IGJ1c3lib3g6bGF0ZXN0CmlucHV0czoKICAtIG5hbWU6IGNvbW1hbmQKICAgIGRpc3BsYXlOYW1lOiDlkb3ku6TmiafooYwKICAgIHR5cGU6IHN0cmluZwogICAgZGVmYXVsdFZhbHVlOiBlY2hvIGhlbGxvIHdvcmxkCiAgICByZXF1aXJlZDogdHJ1ZQogICAgZGVzY3JpcHRpb246IOi+k+WHuuasoui/juWRveS7pAogICAgdWlDb25maWc6CiAgICAgIHR5cGU6IElucHV0CnNjcmlwdDogfAogICQoaW5wdXRzLmNvbW1hbmQpCmR******",
  "Identifier": "custom@1.0.0/****"
}

返回参数

本接口无特有的返回参数。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "202404071710430739950998FB****",
        "Action": "UpdateComponentStep",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

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