1. 接口描述
接口请求域名: cynosdb.tencentcloudapi.com 。
本接口(DescribeLibraDBInstanceDetail)用于查询只读分析引擎详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeLibraDBInstanceDetail。 |
| Version | 是 | String | 公共参数,本接口取值:2019-01-07。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。 |
| ClusterId | 是 | String | 集群ID 示例值:cynosdbmysql-csmr78sn |
| InstanceId | 是 | String | 只读分析引擎实例 ID 示例值:"cynosdbmysql-libradb-ins-mhrc48ym"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Uin | String | 主账号 注意:此字段可能返回 null,表示取不到有效值。 示例值:10003***252 |
| AppId | Integer | 账号唯一ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:134431132 |
| ClusterId | String | 集群ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:cynosdbmysql-bdcl1n11 |
| ClusterName | String | 集群名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:andy |
| InstanceId | String | 实例ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:cynosdbmysql-ins-ifq10f11 |
| InstanceName | String | 实例名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:cynosdbmysql-ins-ifq10f11 |
| ProjectId | Integer | 项目ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1303453 |
| Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou |
| Zone | String | 可用区 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-guangzhou-3 |
| Status | String | 实例状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:running |
| StatusDesc | String | 状态描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:运行中 |
| LibraDBVersion | String | Libra分析引擎版本 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.2404.15.1 |
| Cpu | Integer | cpu核数 注意:此字段可能返回 null,表示取不到有效值。 示例值:4 |
| Memory | Integer | 内存大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:16 |
| Storage | Integer | 存储大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| StorageType | String | 存储类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOUD_TCS |
| InstanceType | String | 实例类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:Common |
| InstanceRole | String | 实例角色 注意:此字段可能返回 null,表示取不到有效值。 示例值:libradbRo |
| UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-11-07 15:01:21 |
| CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-11-06 15:01:21 |
| PayMode | Integer | 售卖方式 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| PeriodStartTime | String | 售卖开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-10-07 15:01:21 |
| PeriodEndTime | String | 售卖结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-11-07 15:01:21 |
| RenewFlag | Integer | 续费标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| NetType | Integer | 网络类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| VpcId | String | 私有网络ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-5l7l5q11 |
| SubnetId | String | 子网ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-b5v6i111 |
| Vip | String | 虚拟IP 注意:此字段可能返回 null,表示取不到有效值。 示例值:172.1.1.1 |
| Vport | Integer | 端口 注意:此字段可能返回 null,表示取不到有效值。 示例值:2000 |
| InstanceNetInfo | InstanceNetInfo | 实例网络信息 注意:此字段可能返回 null,表示取不到有效值。 |
| ResourceTags | Array of Tag | 实例标签信息 注意:此字段可能返回 null,表示取不到有效值。 |
| NodeInfo | Array of LibraDBNodeInfo | 实例节点信息 |
| NodeCount | Integer | 实例节点个数 示例值:2 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询只读分析引擎实例详情
本接口(DescribeLibraDBInstanceDetail)用于查询只读分析引擎实例详情
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLibraDBInstanceDetail
<公共请求参数>
{
"ClusterId": "cynosdbmysql-9xl6z5m1",
"InstanceId": "libradb-ins-3v7ejwba"
}
输出示例
{
"Response": {
"AppId": 1300274166,
"ClusterId": "cynosdbmysql-xxx",
"ClusterName": "test_cluster",
"Cpu": 8,
"CreateTime": "2025-04-07 16:26:29",
"InstanceId": "libradb-ins-3v7ejwba",
"InstanceName": "test_1",
"InstanceNetInfo": {
"InstanceGroupId": "cynosdbmysql-grp-xxx",
"InstanceGroupType": "libradbRo",
"NetType": 1,
"SubnetId": "subnet-xxxx",
"Vip": "10.0.0.34",
"VpcId": "vpc-dfa31dd1",
"Vport": 2000,
"WanDomain": "",
"WanIP": "",
"WanPort": 0,
"WanStatus": "init"
},
"InstanceRole": "libradbRo",
"InstanceType": "Common",
"LibraDBVersion": "1.2404.21.0",
"Memory": 32,
"NetType": 0,
"NodeCount": 1,
"NodeInfo": [
{
"Cpu": 8,
"DataStatus": "Running",
"Memory": 32,
"Message": "",
"NodeId": "libradbn-0",
"Status": "normal",
"Storage": 20
}
],
"PayMode": 0,
"PeriodEndTime": "0001-01-01 00:00:00",
"PeriodStartTime": "2025-04-07 16:26:28",
"ProjectId": 0,
"Region": "ap-guangzhou",
"RenewFlag": 1,
"RequestId": "e760a135-4e85-42a0-99e8-8496f1a5ed0c",
"ResourceTags": [],
"Status": "running",
"StatusDesc": "运行中",
"Storage": 20,
"StorageType": "CLOUD_TCS",
"SubnetId": "",
"Uin": "700001143625",
"UpdateTime": "2025-04-07 16:29:05",
"Vip": "",
"VpcId": "",
"Vport": 0,
"Zone": "ap-guangzhou-7"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DatabaseAccessError | 数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| FailedOperation.OperationFailedError | 操作失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InvalidParameterValue.InstanceNotFound | 实例不存在。 |
| InvalidParameterValue.PrePayPayModeError | 预付费类型不允许该操作。 |
| OperationDenied.ClusterOpNotAllowedError | 由于操作禁止,当前集群不允许该操作。 |
| ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
| ResourceNotFound.ResourceError | 参数对应资源不存在。 |
| ResourceUnavailable.InstanceLockFail | 锁定实例失败,暂时不可操作。 |
| ResourceUnavailable.InstanceStatusAbnormal | 实例状态异常,暂时不可操作。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |