重启虚机部署组
最近更新时间: 2026-10-11 00:12:05
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.com。
重启虚机部署组
默认接口请求频率限制:20次/秒。
接口更新时间:2026-02-05 00:41:44。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:RestartGroup |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| DeployStrategy | 否 | 是 | Int64 | 0 立即 1分批 示例值: 1 |
| DeployBatch | 否 | 是 | Array of Float | 滚动发布每个批次参与的 示例值: [0.25,0.75] |
| DeployWaitTime | 否 | 是 | Int64 | 滚动发布每个批次的时间 示例值: 30 |
| EnableBatchHealthCheck | 否 | 是 | Bool | 开启分批健康检查 示例值: true |
| DeployExeMode | 否 | 是 | String | 滚动发布的执行方式,au 示例值: auto |
| GroupId | 否 | 是 | String | 部署组ID 示例值: group-6a790000 |
| InstanceIdList | 否 | 是 | Array of String | 实例列表,不传时为整个部署组 示例值: ["ins-0k020000"] |
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 | 模块未处理异常。 |
| MissingParameter.GroupIdNull | 分组ID不能为空。 |
5. 示例
示例1 重启虚拟机部署组
输入示例
POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: RestartGroup
<Common Parameters>
{
"GroupId": "group-qyqkr8ey"
}
输出示例
{
"Response": {
"Result": {
"TaskId": "task-5a55nrag"
},
"RequestId": "6a37b8ef-e106-4354-a5ce-601408fd18f0"
}
}