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 示例值:env-sdfsd |
VersionName | 是 | String | 要替换的版本名称,可以为latest 示例值:version |
UploadType | 否 | String | 枚举(package/repository/image) 示例值:apckage |
RepositoryType | 否 | String | repository的类型(coding/gitlab/github) 示例值:coding |
FlowRatio | 否 | Integer | 流量占比 示例值:90 |
DockerfilePath | 否 | String | dockerfile地址 示例值:. |
BuildDir | 否 | String | 构建目录 示例值:. |
Cpu | 否 | String | Cpu的大小,单位:核 示例值:2 |
Mem | 否 | String | Mem的大小,单位:G 示例值:3 |
MinNum | 否 | String | 最小副本数,最小值:0 示例值:11 |
MaxNum | 否 | String | 最大副本数 示例值:12 |
PolicyType | 否 | String | 策略类型 cpu/mem 示例值:cpu |
PolicyThreshold | 否 | String | 策略阈值 示例值:40 |
EnvParams | 否 | String | 环境变量 示例值:key=value |
ContainerPort | 否 | Integer | 容器端口 示例值:80 |
ServerName | 否 | String | 服务名称 示例值:server |
Repository | 否 | String | repository地址 示例值:address |
Branch | 否 | String | 分支 示例值:master |
VersionRemark | 否 | String | 版本备注 示例值:remark |
PackageName | 否 | String | 代码包名字 示例值:zip |
PackageVersion | 否 | String | 代码包版本 示例值:234343 |
ImageInfo | 否 | CloudBaseRunImageInfo | Image的详情 |
CodeDetail | 否 | CloudBaseCodeRepoDetail | Github等拉取代码的详情 |
IsRebuild | 否 | Boolean | 是否回放流量 示例值:false |
InitialDelaySeconds | 否 | Integer | 延迟多长时间开始健康检查(单位s) 示例值:80 |
MountVolumeInfo.N | 否 | Array of CloudBaseRunVolumeMount | cfs挂载信息 |
Rollback | 否 | Boolean | 是否回滚 示例值:false |
SnapshotName | 否 | String | 版本历史名 示例值:name |
CustomLogs | 否 | String | 自定义采集路径 示例值:stdout |
EnableUnion | 否 | Boolean | 是否启用统一域名 示例值:false |
OperatorRemark | 否 | String | 操作备注 示例值:remark |
ServerPath | 否 | String | 服务路径(只会第一次生效) 示例值:path |
IsUpdateCls | 否 | Boolean | 是否更新Cls 示例值:false |
PolicyDetail.N | 否 | Array of HpaPolicy | 自动扩缩容策略组 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | String | succ为成功 示例值:succ |
VersionName | String | 滚动更新的VersionName 注意:此字段可能返回 null,表示取不到有效值。 示例值:version |
RunId | String | 操作记录id 注意:此字段可能返回 null,表示取不到有效值。 示例值:aa123 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
滚动更新
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RollUpdateCloudBaseRunServerVersion
<公共请求参数>
{
"EnvId": "",
"VersionName": "",
"UploadType": "",
"RepositoryType": "",
"FlowRatio": 0,
"DockerfilePath": "",
"BuildDir": "",
"Cpu": "",
"Mem": "",
"MinNum": "",
"MaxNum": "",
"PolicyType": "",
"PolicyThreshold": "",
"EnvParams": "",
"ContainerPort": 0,
"ServerName": "",
"Repository": "",
"Branch": "",
"VersionRemark": "",
"PackageName": "",
"PackageVersion": "",
"ImageInfo": {
"RepositoryName": "",
"IsPublic": true,
"TagName": "",
"ServerAddr": "",
"ImageUrl": ""
},
"CodeDetail": {
"Name": {
"Name": "",
"FullName": ""
},
"Url": ""
},
"IsRebuild": true,
"InitialDelaySeconds": 0,
"MountVolumeInfo": [
{
"Name": "",
"MountPath": "",
"ReadOnly": true,
"NfsVolumes": [
{
"Server": "",
"Path": "",
"ReadOnly": true,
"SecretName": "",
"EnableEmptyDirVolume": true
}
]
}
],
"Rollback": true,
"SnapshotName": "",
"CustomLogs": "",
"EnableUnion": true,
"OperatorRemark": "",
"ServerPath": "",
"IsUpdateCls": true,
"PolicyDetail": [
{
"PolicyType": "",
"PolicyThreshold": 0
}
]
}
输出示例
{
"Response": {
"Result": "succ",
"VersionName": "version",
"RunId": "",
"RequestId": "sdfasfaf"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ServiceNotExist | 服务不存在。 |