You need to enable JavaScript to run this app.
导航
UpdateRelease
最近更新时间:2024.09.24 19:03:21首次发布时间:2024.08.07 11:48:17

更新函数发布 (更新发布流量占比)。

请求说明

  • 请求方式:POST
  • 请求地址:http://open.volcengineapi.com/?Action=UpdateRelease&Version=2024-06-06 HTTP/1.1

调试

请求参数

参数类型是否必选示例值描述
ActionStringUpdateRelease接口名称。当前 API 的名称为 UpdateRelease
VersionString2024-06-06接口版本。当前 API 的版本为 2024-06-06
FunctionIdStringnwwzoaq1函数 ID。
TargetTrafficWeightInteger50目标发布流量百分比。合法取值 0-100, 代表希望发布的版本所占的流量比例。

请求示例

POST http://open.volcengineapi.com/?Action=UpdateRelease&Version=2024-06-06 HTTP/1.1
Content-Type: application/json
{
    "FunctionId": "nwwzoaq1",
    "TargetTrafficWeight": 50
}

返回参数

参数类型示例值描述
FunctionIdStringnwwzoaq1函数 ID。

Status

String

done

函数发布状态:

  • pending:从未发布
  • inprogress:正在发布
  • done:发布成功
  • failed:发布失败
StatusMessageStringFunction release finished successfully函数发布状态详细信息。作为发布状态的补充。
StableRevisionNumberInteger1当前线上稳定运行的版本号码。初次发布成功后生成, 初次发布前 (status==pending) StableRevisionNumber 为 -1。
NewRevisionNumberInteger1正在发布的新版本的版本号。在 status 为 pending 时不返回, 为 inprogress/failed/done 时均返回。
OldRevisionNumberInteger1旧版本的版本号。在 status 为 pending 时不返回, 为 inprogress/failed/done 时均返回。
StartTimeString2024-06-27 07:05:12当前发布开始时间。status 为 pending 时不返回,为 inprogress/failed/done 时均返回。
TargetTrafficWeightInteger100目标发布流量百分比。合法取值 0-100, 代表希望发布的版本所占的流量比例, 全量发布为 100。

CurrentTrafficWeight

Integer

50

当前发布流量当前百分比。合法取值 1-100, 代表当前正在发布的版本所占的流量比例, 只有 status 为 inprogress/failed
时返回。

ErrorCode

String

function_start_failed

发布失败时的错误码:

  • function_start_failed:函数启动失败
  • function_start_timeout:函数启动超时
  • function_health_check_failed:函数健康检查失败
  • system_internal_error:系统内部错误
FailedInstanceLogsStringhttps://vefaas-sit.tos-s3-cn-boe.volces.com/release_failed_instance_logs/r8ts3chz/xozoeiqdo91anhi9_coldstart发布失败的实例日志下载链接。
ReleaseRecordIdStringxozoeiqdo91anhi9发布记录 ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateRelease",
        "Version": "2024-06-06",
        "Service": "vefaas",
        "Region": "cn-beijing"
    },
    "Result": {
        "FunctionId": "nwwzoaq1",
        "Status": "done",
        "StatusMessage": "Function release finished successfully",
        "StableRevisionNumber": 1,
        "NewRevisionNumber": 1,
        "OldRevisionNumber": 1,
        "StartTime": "2024-06-27 07:05:12",
        "TargetTrafficWeight": 100,
        "CurrentTrafficWeight": 50,
        "ErrorCode": "function_start_failed",
        "FailedInstanceLogs": "https://vefaas-sit.tos-s3-cn-boe.volces.com/release_failed_instance_logs/r8ts3chz/xozoeiqdo91anhi9_coldstart",
        "ReleaseRecordId": "xozoeiqdo91anhi9"
    }
}

错误码

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