# 滚动更新服务版本

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：updateCloudbaseServiceVersion

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

# 1. 调用方式

# HTTPS 调用

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

# 云调用

本接口不支持云调用

# 第三方调用

本接口仅支持第三方平台使用 component_access_token 自己调用。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 component_access_token

# 请求体 `Request Payload`

参数名	类型	必填	说明
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	object	否	Image的详情
code_detail	object	否	Github等拉取代码的详情
is_rebuild	boolean	否	是否回放流量
initial_delay_seconds	number	否	延迟多长时间开始健康检查（单位s）
mount_volume_info	objarray	否	cfs挂载信息
rollback	boolean	否	是否回滚
snapshot_name	string	否	版本历史名
custom_logs	string	否	自定义采集路径
enable_union	boolean	否	是否启用统一域名
server_path	string	否	服务路径（只会第一次生效）
is_update_cls	boolean	否	是否更新Cls
policy_detail	objarray	否	自动扩缩容策略组

# Body.image_info `Object Payload`

Image的详情

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

# Body.code_detail `Object Payload`

Github等拉取代码的详情

参数名	类型	必填	说明
name	object	否	repo的名字
url	string	否	repo的url

# Body.mount_volume_info(Array) `Object Payload`

cfs挂载信息

参数名	类型	必填	说明
name	string	否	资源名
mount_path	string	否	挂载路径
read_only	boolean	否	是否只读
nfs_volumes	objarray	否	Nfs挂载信息

# Body.policy_detail(Array) `Object Payload`

自动扩缩容策略组

参数名	类型	必填	说明
policy_type	string	否	策略类型
policy_threshold	number	否	策略阈值

# Body.code_detail.name `Object Payload`

repo的名字

参数名	类型	必填	说明
name	string	否	repo的名字
full_name	string	否	repo的完整全名

# Body.mount_volume_info(Array).nfs_volumes`Object Payload`

Nfs挂载信息

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

# 3. 返回参数

# 返回体 `Response Payload`

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

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
  "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"
}

# 6. 错误码

以下是本接口的错误码列表，其他错误码可参考通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具辅助定位和分析问题。

错误码	错误描述	解决方案
-1000	system error	系统错误
-1	system error	系统繁忙，此时请开发者稍候再试
0	ok	ok
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未开通云开发

# 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。

# 滚动更新服务版本

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# Body.image_info Object Payload

# Body.code_detail Object Payload

# Body.mount_volume_info(Array) Object Payload

# Body.policy_detail(Array) Object Payload

# Body.code_detail.name Object Payload

# Body.mount_volume_info(Array).nfs_volumesObject Payload