1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.com。
重启组件服务
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-17 03:08:47。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：RestartService |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例ID 示例值： tbds-664nmwbe |
| ServiceGroup | 是 | 否 | Int64 | 服务组类型 通过DescribeServiceGroups接口 ServiceType字段获取 示例值： 36 |
| ServiceType | 是 | 否 | Int64 | 服务类型 通过DescribeServiceGroups接口 ServiceNodeList.NodeType字段获取 示例值： 76 |
| NodeList | 否 | 否 | Array of String | 需要操作的节点IP列表 示例值： ['10.4.2.120'] |
| RollingRestart | 否 | 否 | Int64 | 是否滚动重启，1表示滚动重启，0表示非滚动重启 示例值： 1 |
| DealOnFail | 否 | 否 | Int64 | 0表示失败时阻塞等待处理，1表示单节点失败继续处理，默认为0 示例值： 0 |
| RestartReason | 否 | 否 | String | 重启原因 示例值： None |
| RestartPolicy | 否 | 否 | String | 重启策略名default 示例值： default |
| TimeWait | 否 | 否 | Int64 | 使用滚动重启时，各批次重启的时间间隔秒 示例值： 5 |
| BatchSize | 否 | 否 | Int64 | 批量重启大小 示例值： 1 |
| RackAwarenessSwitch | 否 | 否 | Int64 | 是否启用机架感知 0关闭 1开启 示例值： 0 |
| Scope | 否 | 否 | OpScope | 操作范围 示例值：查看 |
| ExpiredRoles | 否 | 否 | Bool | 是否仅重启配置过期的角色 示例值： 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidJobFlow | 无效的流程任务。 |
| InvalidParameter.InvalidRestartReasonLength | 参数错误。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| UnauthorizedOperation.RestartServiceUnsupported | 该服务不支持重启。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation.RestartServiceUnsupported | 该服务不支持重启。 |
| InvalidParameter.InvalidServiceNodeInfo | 参数ServiceNodeInfo无效或错误。 |
| InternalError | 内部错误。 |
| UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |
| InvalidParameter.InvalidRestartPolicy | 无效的重启策略。 |
| UnsupportedOperation.OnlyRollingRestartSupport | 当前组件只支持滚动重启。 |
| FailedOperation | 操作失败。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| InvalidParameter.RestartServiceUnsupported | 该服务不支持重启。 |
| InvalidParameter.InvalidBatchSize | 无效的重启批量大小。 |
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| ResourceInUse.InstanceInProcess | 实例在流程中。 |