1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
部署虚拟机部署组应用
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DeployGroup。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GroupId | 是 | String | 部署组ID |
| PkgId | 是 | String | 程序包ID |
| StartupParameters | 否 | String | 部署组启动参数 |
| DeployDesc | 否 | String | 部署应用描述信息 |
| ForceStart | 否 | Boolean | 是否允许强制启动 |
| EnableHealthCheck | 否 | Boolean | 是否开启健康检查 |
| HealthCheckSettings | 否 | HealthCheckSettings | 开启健康检查时，配置健康检查 |
| UpdateType | 否 | Integer | 部署方式，0表示快速更新，1表示滚动更新 |
| DeployBetaEnable | 否 | Boolean | 是否启用beta批次 |
| DeployBatch.N | 否 | Array of Float | 滚动发布每个批次参与的实例比率 |
| DeployExeMode | 否 | String | 滚动发布的执行方式，auto表示自动， manual表示手动 |
| DeployWaitTime | 否 | Integer | 滚动发布每个批次的时间间隔 |
| StartScript | 否 | String | 启动脚本 base64编码 |
| StopScript | 否 | String | 停止脚本 base64编码 |
| IncrementalDeployment | 否 | Boolean | 是否进行增量部署，默认为false，全量更新 |
| JdkName | 否 | String | JDK名称: konaJDK或openJDK |
| JdkVersion | 否 | String | konaJDK版本：8、11和17 openJDK版本：8、17 |
| AgentProfileList.N | 否 | Array of AgentProfile | 部署agent的类型、版本 |
| WarmupSetting | 否 | WarmupSetting | 预热参数配置 |
| EnableBatchHealthCheck | 否 | Boolean | 开启分批健康检查 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TaskId | 任务ID 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 test
test
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployGroup
<公共请求参数>
{
"GroupId": "",
"PkgId": ""
}输出示例
{
"Response": {
"RequestId": "95953982-9aa0-4f16-9bec-ffe7d8691d66",
"Result": null
}
}示例2 部署虚拟机部署组应用
部署虚拟机部署组应用
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployGroup
<公共请求参数>
{
"PkgId": "pkg-xxxxxxx",
"GroupId": "group-xxxxxxx",
"StartupParameters": "-Xms128m-Xmx512m-XX:MetaspaceSize=128m-XX:MaxMetaspaceSize=512m"
}输出示例
{
"Response": {
"RequestId": "48994bff-70ed-43b9-ae0e-8d3b4d6e72cd",
"Result": {
"TaskId": "task-xxxxxxx"
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.UnhandledException | 模块未处理异常。 |
| InternalError.CvmCaeMasterInternalError | TSF MASTER 内部执行错误。 |
| InternalError.GroupCommonError | 部署组通用异常。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameter.RepoPackageParamError | 请求参数有误。 |
| InvalidParameterValue.CvmCaeMasterAgentBusy | TSF MASTER 正在执行任务，请等待任务执行完成再下发新任务。 |
| InvalidParameterValue.CvmCaeMasterAgentNotFound | 无可用实例。 |
| InvalidParameterValue.GroupBatchParameterInvalid | 部署相关请求参数校验失败。 |
| ResourceNotFound.GroupApplicationNotExist | 无法获取分组所属应用。 |
| ResourceNotFound.GroupNotExist | 此部署组不存在，无法执行该操作。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |