# 滚动更新服务版本

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

updateCloudbaseServiceVersion

# 功能描述

通过本接口可以滚动更新服务版本，使用过程中如遇到问题，可在开放平台服务商专区发帖交流。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/componenttcb/rollupdatecloudbaserunserverversion?access_token=ACCESS_TOKEN

# 请求参数

属性	类型	必填	说明
access_token	string	是	第三方接口调用令牌component_access_token
env_id	string	是	环境ID
version_name	string	是	要替换的版本名称，可以为latest
upload_type	string	否	枚举（package/repository/image)
repository_type	string	否	repository的类型(coding/gitlab/github)
flow_ratio	number	否	流量占比
dockerfile_path	string	否	dockerfile地址
build_dir	string	否	构建目录
cpu	string	否	Cpu的大小，单位：核
mem	string	否	Mem的大小，单位：G
min_num	string	否	最小副本数，最小值：0
max_num	string	否	最大副本数
policy_type	string	否	策略类型
policy_threshold	string	否	策略阈值
env_params	string	否	环境变量
container_port	number	否	容器端口
server_name	string	否	服务名称
repository	string	否	repository地址
branch	string	否	分支
version_remark	string	否	版本备注
package_name	string	否	代码包名字
package_version	string	否	代码包版本
image_info	CloudBaseRunImageInfo	否	Image的详情
code_detail	CloudBaseCodeRepoDetail	否	Github等拉取代码的详情
is_rebuild	bool	否	是否回放流量
initial_delay_seconds	number	否	延迟多长时间开始健康检查（单位s）
mount_volume_info	Array.<CloudBaseRunVolumeMount>	否	cfs挂载信息
rollback	bool	否	是否回滚
snapshot_name	string	否	版本历史名
custom_logs	string	否	自定义采集路径
enable_union	bool	否	是否启用统一域名
server_path	string	否	服务路径（只会第一次生效）
is_update_cls	bool	否	是否更新Cls
policy_detail	Array.<HpaPolicy>	否	自动扩缩容策略组

CloudBaseRunImageInfo 的结构

属性	类型	必填	说明
repository_name	string	否	镜像仓库名称
is_public	bool	否	是否公有
tag_name	string	否	镜像tag名称
server_addr	string	否	镜像server
image_url	string	否	镜像拉取地址

CloudBaseCodeRepoDetail 的结构

属性	类型	默认值	必填	说明
name	CloudBaseCodeRepoName		否	repo的名字
url	string		否	repo的url

CloudBaseCodeRepoName 的结构

属性	类型	默认值	必填	说明
name	string		否	repo的名字
full_name	string		否	repo的完整全名

CloudBaseRunVolumeMount 的结构

属性	类型	必填	说明
name	string	否	资源名
mount_path	string	否	挂载路径
read_only	bool	否	是否只读
nfs_volumes	Array.<CloudBaseRunNfsVolumeSource>	否	Nfs挂载信息

CloudBaseRunNfsVolumeSource 的结构

属性	类型	必填	说明
server	string	否	NFS挂载Server
path	string	否	Server路径
read_only	bool	否	是否只读
secret_name	string	否	secret名称
enable_empty_dir_volume	bool	否	临时目录

HpaPolicy 的结构

属性	类型	默认值	必填	说明
policy_type	string		否	策略类型
policy_threshold	number		否	策略阈值

# 返回值

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
result	string	succ为成功
run_id	string	操作记录id

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
    "env_id": "test-6gxk23no5605e14f",
    "version_name": "ss-003",
    "upload_type": "image",
    "flow_ratio": 100,
    "dockerfile_path": "Dockerfile",
    "cpu": "0.25",
    "mem": "0.5",
    "min_num": "0",
    "max_num": "1",
    "policy_type": "cpu",
    "policy_threshold": "50",
    "env_params": "{}",
    "container_port": 80,
    "server_name": "ss",
    "image_info": {
        "repository_name": "tcb-100001320084-hvbz/web-container-6gnyxqnl696f40ce_pressure-python",
        "is_public": true,
        "tag_name": "pressure-python-006-20211219230528",
        "server_addr": "ccr.ccs.tencentyun.com",
        "image_url": "ccr.ccs.tencentyun.com/tcb-100001320084-hvbz/web-container-6gnyxqnl696f40ce_pressure-python:pressure-python-006-20211219230528"
    },
    "custom_logs": "stdout"
}

# 返回数据示例


{
    "errcode": 0,
    "errmsg": "ok",
    "result": "succ",
    "run_id": "1mz9GjJgyY53bh"
}

# 错误码

错误码	错误码取值	解决方案
0	ok	ok
-1	system error	系统繁忙，此时请开发者稍候再试
-1000	system error	系统错误
40014	invalid access_token	不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
40097	invalid args	参数错误
40101	missing parameter	缺少必填参数
41001	access_token missing	缺少 access_token 参数
42001	access_token expired	access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明
43002	require POST method	需要 POST 请求
44002	empty post data	POST 的数据包为空
47001	data format error	解析 JSON/XML 内容错误;post 数据中参数缺失;检查修正后重试。
85088	no qbase privilege	该APP未开通云开发