有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: tem.tencentcloudapi.com 。

更新应用部署版本

默认接口请求频率限制:20次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RollingUpdateApplicationByVersion。
Version String 公共参数,本接口取值:2021-07-01。
Region String 公共参数,详见产品支持的 地域列表
ApplicationId String 应用ID
示例值:1
EnvironmentId String 环境ID
示例值:1
DeployVersion String 更新版本,IMAGE 部署为 tag 值;JAR/WAR 部署 为 Version
示例值:v1
PackageName String JAR/WAR 包名,仅 JAR/WAR 部署时必填
示例值:xxx
From String 请求来源平台,含 IntelliJ,Coding
示例值:IntelliJ
DeployStrategyType String 部署策略,AUTO 为全自动;BETA 为小批量验证后自动;MANUAL 为全手动;
示例值:AUTO
TotalBatchCount Integer 发布批次数
示例值:2
BatchInterval Integer 批次间隔时间
示例值:60
BetaBatchNum Integer 小批量验证批次的实例数
示例值:1
MinAvailable Integer 发布过程中保障的最小可用实例数
示例值:1
Force Boolean 是否强制发布
示例值:force

3. 输出参数

参数名称 类型 描述
Result String 版本ID
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 应用部署

应用部署

输入示例

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

{
    "ApplicationId": "abc",
    "EnvironmentId": "abc",
    "DeployVersion": "abc",
    "PackageName": "abc",
    "From": "abc",
    "DeployStrategyType": "abc",
    "TotalBatchCount": 0,
    "BatchInterval": 0,
    "BetaBatchNum": 0,
    "MinAvailable": 0,
    "Force": true
}

输出示例

{
    "Response": {
        "RequestId": "81f74023-563c-437d-abf7-8139449ef178",
        "Result": "version-xxx"
    }
}

示例2 部署成功

部署成功

输入示例

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

{
    "EnvironmentId": "env-qgnzgy8r",
    "TotalBatchCount": "2",
    "PackageName": "tem/pkg/1300555551/service-gn54vdy6/1641528220867/hello-world-0.0.1-SNAPSHOT.jar",
    "DeployStrategyType": "AUTO",
    "DeployVersion": "20220107122452",
    "BatchInterval": "60",
    "ApplicationId": "service-gn54vdy6",
    "BetaBatchNum": "1"
}

输出示例

{
    "Response": {
        "RequestId": "28fe46b2-dbd9-4ee6-b388-603acb6c9263",
        "Result": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.DefaultInternalError 服务器繁忙,请稍后再试。
InternalError.DeployVersionError 版本部署调用失败。
InvalidParameterValue.ApmNotBind APM 没有与当前环境绑定。
InvalidParameterValue.InvalidDeployVersion 版本号格式非法。
InvalidParameterValue.InvalidEnvName 环境变量名非法,要求有由字母、数字,".","_" 和 "-" 组成,不能由数字开头。
InvalidParameterValue.InvalidMountPath 挂载路径不合法,不能为 /app。
InvalidParameterValue.JdkVersionRequired JDK 版本不能为空。
InvalidParameterValue.NamespaceNotBelongToAppid 命名空间不属于用户。
InvalidParameterValue.OsNotSupport 操作系统不支持。
InvalidParameterValue.RegistryNotBind 注册中心没有与当前环境绑定。
InvalidParameterValue.ServiceNotBelongToAppid 应用不属于此账户。
InvalidParameterValue.ServicePodReachMaximum 实例创建失败,达到上限。
InvalidParameterValue.TemIdInvalid 不是合法的TEM ID。
InvalidParameterValue.VersionLengthLimit version 不能超过128位。
InvalidParameterValue.VersionLowerCase 版本必须小写。
MissingParameter.DeployModeNull 部署方式不能为空。
MissingParameter.DeployVersionNull 部署版本不能为空。
MissingParameter.LogsetOrTopicNull logset 和 topic 不能为空。
MissingParameter.NamespaceIdNull 环境ID不能为空。
MissingParameter.SvcRepoNotReady 镜像仓库还未就绪。
ResourceInUse.ServiceDeploying 服务部署中。
ResourceNotFound.ServiceNotFound 找不到应用。
ResourceNotFound.VersionNamespaceNotFound 找不到版本对应的环境。
ResourceUnavailable.WaitForKruise 等待组件安装。
UnauthorizedOperation.MissingEksLogRole 缺少容器服务的 CLS 日志角色,请打开控制台授权。
UnauthorizedOperation.UnauthorizedOperation 未授权。