DeployGroup
最近更新时间: 2025-10-20 17:06:15
1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.cn。
部署虚拟机部署组应用
默认接口请求频率限制：20次/秒。
接口更新时间：2021-01-27 10:42:28。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DeployGroup |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| GroupId | 是 | 否 | String | 部署组ID |
| PkgId | 是 | 否 | String | 程序包ID |
| StartupParameters | 否 | 否 | String | 部署组启动参数 |
| DeployDesc | 否 | 否 | String | 部署应用描述信息 |
| ForceStart | 否 | 否 | Bool | 是否允许强制启动 |
| EnableHealthCheck | 否 | 否 | Bool | 是否开启健康检查 |
| HealthCheckSettings | 否 | 否 | HealthCheckSettings | 开启健康检查时，配置健康检查 |
| UpdateType | 否 | 否 | Uint64 | 部署方式，0表示快速更新，1表示滚动更新 |
| DeployBetaEnable | 否 | 否 | Bool | 是否启用beta批次 |
| DeployBatch | 否 | 否 | Array of Float | 滚动发布每个批次参与的实例比率 |
| DeployExeMode | 否 | 否 | String | 滚动发布的执行方式 |
| DeployWaitTime | 否 | 否 | Uint64 | 滚动发布每个批次的时间间隔 |
| StartScript | 否 | 否 | String | 启动脚本 base64编码 |
| StopScript | 否 | 否 | String | 停止脚本 base64编码 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TaskId | 此参数对外不可见。 任务ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| ResourceNotFound.GroupNotExist | 此部署组不存在，无法执行该操作。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| InvalidParameterValue.CvmCaeMasterAgentNotFound | 无可用实例。 |
| InvalidParameterValue.CvmCaeMasterAgentBusy | TSF MASTER 正在执行任务，请等待任务执行完成再下发新任务。 |
| InvalidParameter.RepoPackageParamError | 请求参数有误。 |