部署虚拟机部署组应用
最近更新时间: 2026-10-11 00:12:05
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.com。
部署虚拟机部署组应用
默认接口请求频率限制：10000次/秒。
接口更新时间：2026-02-04 20:52:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DeployGroup |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| StopScript | 否 | 否 | String | 停止脚本 base64编码 示例值： mock-script-base64 |
| JdkName | 否 | 否 | String | JDK名称: openJDK 示例值： konaJDK |
| JdkVersion | 否 | 否 | String | JDK版本：8、11和17 openJDK版本：8、17 示例值： 8 |
| GatewayConfig | 否 | 否 | GatewayConfig | Envoy网关服务配置 示例值：查看 |
| HealthCheckSettings | 否 | 否 | HealthCheckSettings | 开启健康检查时，配置健康检查 示例值：查看 |
| UpdateType | 否 | 否 | Uint64 | 部署方式，0表示快速更新，1表示滚动更新 示例值： 1 |
| DeployBetaEnable | 否 | 否 | Bool | 是否启用beta批次 示例值： true |
| EnableBatchHealthCheck | 否 | 否 | Bool | 开启分批健康检查 示例值： true |
| PkgId | 是 | 否 | String | 程序包ID 示例值： pkg-6a79x94v |
| EnableHealthCheck | 否 | 否 | Bool | 是否开启健康检查 示例值： true |
| DeployBatch | 否 | 否 | Array of Float | 滚动发布每个批次参与的实例比率 示例值： [0.25,0.75] |
| DeployExeMode | 否 | 否 | String | 滚动发布的执行方式，auto表示自动， manual表示手动 示例值： auto |
| StartScript | 否 | 否 | String | 启动脚本 base64编码 示例值： mock-script-base64 |
| IncrementalDeployment | 否 | 否 | Bool | 是否进行增量部署，默认为false，全量更新 示例值： false |
| AgentProfileList | 否 | 否 | Array of AgentProfile | 部署agent的类型、版本 示例值：查看 |
| StartupParameters | 否 | 否 | String | 部署组启动参数 示例值： -Xms512m -Xmx1024m |
| DeployDesc | 否 | 否 | String | 部署应用描述信息 示例值： 这是应用描述信息 |
| ForceStart | 否 | 否 | Bool | 是否允许强制启动 示例值： false |
| DeployWaitTime | 否 | 否 | Uint64 | 滚动发布每个批次的时间间隔 示例值： 30 |
| WarmupSetting | 否 | 否 | WarmupSetting | 预热参数配置 示例值：查看 |
| GroupId | 是 | 否 | String | 部署组ID 示例值： group-6a79x94v |
3. 输出参数
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| ResourceNotFound.GroupNotExist | 此部署组不存在，无法执行该操作。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| InvalidParameterValue.CvmCaeMasterAgentNotFound | 无可用实例。 |
| InvalidParameterValue.CvmCaeMasterAgentBusy | TSF MASTER 正在执行任务，请等待任务执行完成再下发新任务。 |
| InternalError.CvmCaeMasterInternalError | TSF MASTER 内部执行错误。 |
| InternalError.GroupCommonError | 部署组通用异常。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| ResourceNotFound.GroupApplicationNotExist | 无法获取分组所属应用。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
| InvalidParameterValue.GroupBatchParameterInvalid | 部署相关请求参数校验失败。 |
| InvalidParameter.RepoPackageParamError | 请求参数有误。 |
| FailedOperation.UnhandledException | 模块未处理异常。 |
| FailedOperation.TapmBindRequired | |
| FailedOperation.TapmExpiredOtel | |
| FailedOperation.ActionReadTimeout | 模块请求未响应。 |
5. 示例
示例1 部署虚拟机部署组应用
部署虚拟机部署组应用
输入示例
POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DeployGroup
<Common Parameters>
{
"PkgId": "pkg-6a79x94v",
"GroupId": "group-6a79x94v",
"StartupParameters": "-Xms128m-Xmx512m-XX:MetaspaceSize=128m-XX:MaxMetaspaceSize=512m"
}
输出示例
{
"Response": {
"RequestId": "48994bff-70ed-43b9-ae0e-8d3b4d6e72cd",
"Result": {
"TaskId": "task-6a79x94v"
}
}
}