1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(RestartInstance)用于重启实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RestartInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。 |
InstanceId | 是 | String | 实例id 示例值:cynosdbmysql-ins-a45df3g |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | Integer | 异步任务id 示例值:123 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 重启实例
重启实例
输入示例
https://cynosdb.tencentcloudapi.com/?Action=RestartInstance
&InstanceId="cynosdbmysql-ins-qwerasd"
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "128046",
"FlowId": "123"
}
}
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.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InternalError.DbOperationFailed | 查询数据库失败。 |
InternalError.GetSecurityGroupDetailFailed | 获取安全组信息失败。 |
InternalError.GetSubnetFailed | 获取子网失败。 |
InternalError.GetVpcFailed | 获取VPC失败。 |
InternalError.ListInstanceFailed | 安全组查询实例失败。 |
InternalError.OperateWanFail | 操作外网失败。 |
InternalError.OperationNotSupport | 操作不支持。 |
InternalError.QueryDatabaseFailed | 查询数据库失败。 |
InternalError.SystemError | 系统内部错误。 |
InvalidParameter.IsolateNotAllowed | 当前实例不可隔离。 |
InvalidParameterValue.AccountExist | 账号已存在。 |
InvalidParameterValue.DBTypeNotFound | 不支持的实例类型。 |
InvalidParameterValue.FlowNotFound | 任务流ID不存在。 |
InvalidParameterValue.IllegalInstanceName | 实例名称字符非法。 |
InvalidParameterValue.IllegalOrderBy | 无效的排序字段。 |
InvalidParameterValue.IllegalPassword | 密码不符合要求。 |
InvalidParameterValue.InstanceNotFound | 实例不存在。 |
InvalidParameterValue.InternalAccount | 内置账号不允许操作。 |
InvalidParameterValue.InvalidDBVersion | 实例版本非法。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
InvalidParameterValue.InvalidSpec | 实例规格非法。 |
InvalidParameterValue.ParamError | 参数错误。 |
InvalidParameterValue.RegionZoneUnavailable | 所选地域和可用区不可用。 |
InvalidParameterValue.StoragePoolNotFound | 未找到相关存储pool。 |
InvalidParameterValue.SubnetNotFound | 找不到所选子网。 |
InvalidParameterValue.VpcNotFound | 找不到所选VPC网络。 |
LimitExceeded.ClusterInstanceLimit | 集群中节点数超过最大限制。 |
LimitExceeded.UserInstanceLimit | 用户实例个数超出限制。 |
OperationDenied.ServerlessInstanceStatusDenied | serverless实例当前状态不允许该操作。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
ResourceUnavailable.InstanceLockFail | 锁定实例失败,暂时不可操作。 |
ResourceUnavailable.InstanceStatusAbnormal | 实例状态异常,暂时不可操作。 |
UnauthorizedOperation.NotRealNameAccount | 非实名用户禁止购买。 |
UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |