1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
本接口(DescribeInstanceDetail)用于查询实例详情。
默认接口请求频率限制：1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstanceDetail。 |
| 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-bzkxxrmt |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Detail | CynosdbInstanceDetail | 实例详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例详情
输入示例
https://cynosdb.tencentcloudapi.com/?Action=DescribeInstanceDetail
&InstanceId=cynosdbmysql-ins-bzkxxrmt
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "175707",
"Detail": {
"ServerlessStatus": "resume",
"RenewFlag": 0,
"Zone": "ap-guangzhou-3",
"DbVersion": "10.0",
"Storage": 100,
"Memory": 4,
"MinCpu": 1.0,
"MaxCpu": 2.0,
"Charset": "utf8",
"Status": "running",
"UpdateTime": "2018-06-20 19:12:54",
"VpcId": "vpc-1ptuei0b",
"InstanceId": "cynosdbmysql-ins-bzkxxrmt",
"ClusterId": "cynosdbmysql-cluster-5ne6bjyx",
"CynosVersion": "2.0.12",
"NetType": 1,
"PeriodEndTime": "2018-07-20 19:17:16",
"InstanceType": "rw",
"ProjectId": 0,
"Region": "ap-guangzhou",
"PayMode": 0,
"SubnetId": "subnet-1tmw9t4o",
"StatusDesc": "运行中",
"InstanceName": "ahhahhhhh",
"Cpu": 2,
"WanDomain": "",
"ClusterName": "cynosdbmysql-cluster-5ne6bjyx",
"InstanceRole": "master",
"Uin": "3374998458",
"DbType": "MYSQL",
"Vip": "10.0.1.2",
"AppId": 1251006243,
"Vport": 5432,
"CreateTime": "2018-06-20 19:12:54"
}
}
}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.CamSigAndAuthError | 鉴权失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.InternalHttpServerError | http请求执行异常。 |
| InternalError.OperationNotSupport | 操作不支持。 |
| InternalError.SystemError | 系统内部错误。 |
| InvalidParameterValue.InstanceNotFound | 实例不存在。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| OperationDenied.CamDeniedError | 权限校验失败。 |
| ResourceNotFound.InstanceNotFoundError | 实例不存在。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
