云开发 CloudBase 滚动更新服务版本-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： tcb.tencentcloudapi.com 。

针对特定的版本，进行滚动更新

默认接口请求频率限制：1000次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：RollUpdateCloudBaseRunServerVersion。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境ID
VersionName	是	String	要替换的版本名称，可以为latest
UploadType	否	String	枚举（package/repository/image)
RepositoryType	否	String	repository的类型(coding/gitlab/github)
FlowRatio	否	Integer	流量占比
DockerfilePath	否	String	dockerfile地址
BuildDir	否	String	构建目录
Cpu	否	String	Cpu的大小，单位：核
Mem	否	String	Mem的大小，单位：G
MinNum	否	String	最小副本数，最小值：0
MaxNum	否	String	最大副本数
PolicyType	否	String	策略类型
PolicyThreshold	否	String	策略阈值
EnvParams	否	String	环境变量
ContainerPort	否	Integer	容器端口
ServerName	否	String	服务名称
Repository	否	String	repository地址
Branch	否	String	分支
VersionRemark	否	String	版本备注
PackageName	否	String	代码包名字
PackageVersion	否	String	代码包版本
ImageInfo	否	CloudBaseRunImageInfo	Image的详情
CodeDetail	否	CloudBaseCodeRepoDetail	Github等拉取代码的详情
IsRebuild	否	Boolean	是否回放流量
InitialDelaySeconds	否	Integer	延迟多长时间开始健康检查（单位s）
MountVolumeInfo.N	否	Array of CloudBaseRunVolumeMount	cfs挂载信息
Rollback	否	Boolean	是否回滚
SnapshotName	否	String	版本历史名
CustomLogs	否	String	自定义采集路径
EnableUnion	否	Boolean	是否启用统一域名
OperatorRemark	否	String	操作备注
ServerPath	否	String	服务路径（只会第一次生效）
IsUpdateCls	否	Boolean	是否更新Cls
PolicyDetail.N	否	Array of HpaPolicy	自动扩缩容策略组

3. 输出参数

参数名称	类型	描述
Result	String	succ为成功
VersionName	String	滚动更新的VersionName 注意：此字段可能返回 null，表示取不到有效值。
RunId	String	操作记录id 注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

滚动更新

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RollUpdateCloudBaseRunServerVersion
<公共请求参数>

{
    "EnvId": "abc",
    "VersionName": "abc",
    "UploadType": "abc",
    "RepositoryType": "abc",
    "FlowRatio": 0,
    "DockerfilePath": "abc",
    "BuildDir": "abc",
    "Cpu": "abc",
    "Mem": "abc",
    "MinNum": "abc",
    "MaxNum": "abc",
    "PolicyType": "abc",
    "PolicyThreshold": "abc",
    "EnvParams": "abc",
    "ContainerPort": 0,
    "ServerName": "abc",
    "Repository": "abc",
    "Branch": "abc",
    "VersionRemark": "abc",
    "PackageName": "abc",
    "PackageVersion": "abc",
    "ImageInfo": {
        "RepositoryName": "abc",
        "IsPublic": true,
        "TagName": "abc",
        "ServerAddr": "abc",
        "ImageUrl": "abc"
    },
    "CodeDetail": {
        "Name": {
            "Name": "abc",
            "FullName": "abc"
        },
        "Url": "abc"
    },
    "IsRebuild": true,
    "InitialDelaySeconds": 0,
    "MountVolumeInfo": [
        {
            "Name": "abc",
            "MountPath": "abc",
            "ReadOnly": true,
            "NfsVolumes": [
                {
                    "Server": "abc",
                    "Path": "abc",
                    "ReadOnly": true,
                    "SecretName": "abc",
                    "EnableEmptyDirVolume": true
                }
            ]
        }
    ],
    "Rollback": true,
    "SnapshotName": "abc",
    "CustomLogs": "abc",
    "EnableUnion": true,
    "OperatorRemark": "abc",
    "ServerPath": "abc",
    "IsUpdateCls": true,
    "PolicyDetail": [
        {
            "PolicyType": "abc",
            "PolicyThreshold": 0
        }
    ]
}

输出示例

{
    "Response": {
        "Result": "abc",
        "VersionName": "abc",
        "RunId": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.ServiceNotExist	服务不存在。

新手指引

动态与公告

产品简介

购买指南

快速入门

操作指南

开发指南

CLI 使用指南

SDK 文档

API 文档

示例教程

视频专区

常见问题

服务协议

联系我们

词汇表

滚动更新服务版本

本页目录：