1. 接口描述
接口请求域名： cynosdb.tencentcloudapi.com 。
本接口（DescribeClusterInstanceGrps）用于查询实例组信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterInstanceGroups。 |
| 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 。 |
| ClusterId | 是 | String | 集群ID 示例值：cynosdbmysql-oib3wx0i |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 实例组个数 示例值：2 |
| InstanceGroupInfoList | Array of CynosdbInstanceGroup | 实例组列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群实例组信息
输入示例
POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterInstanceGroups
<公共请求参数>
{
"ClusterId": "cynosdbmysql-sgvwu2is"
}输出示例
{
"Response": {
"TotalCount": 0,
"InstanceGroupInfoList": [
{
"AppId": 0,
"ClusterId": "cynosdbmysql-sgvwu2is",
"CreatedTime": "2023-03-14 11:25:36",
"DeletedTime": "2024-04-19 14:33:28",
"InstanceGroupId": "cynosdbmysql-grp-xb3e8nxd",
"Status": "deleted",
"Type": "ha",
"UpdatedTime": "2024-04-19 14:33:27",
"Vip": "1.23.4.1",
"Vport": 3306,
"WanDomain": "cynosdbmysql-sgvwu2is.wan.domain.com",
"WanIP": "3.19.7.1",
"WanPort": 3306,
"WanStatus": "closed",
"InstanceSet": [
{
"Uin": "372386743",
"AppId": 2378462378,
"ClusterId": "cynosdbmysql-sgvwu2is",
"ClusterName": "MyClusterName",
"InstanceId": "cynosdbmysql-ins-cbgs2msn",
"InstanceName": "MyInstanceName",
"ProjectId": 298,
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-5",
"Status": "deleted",
"StatusDesc": "已删除",
"DbMode": "NORMAL",
"DbType": "MYSQL",
"DbVersion": "5.7",
"Cpu": 1,
"Memory": 2,
"Storage": 30,
"InstanceType": "rw",
"InstanceRole": "master",
"UpdateTime": "2020-09-22 00:00:00",
"CreateTime": "2020-09-22 00:00:00",
"VpcId": "vpc-bxgsh3nx",
"SubnetId": "subnet-a4sjf8us",
"Vip": "172.1.23.4",
"Vport": 3306,
"PayMode": 1,
"PeriodEndTime": "2020-09-22 00:00:00",
"DestroyDeadlineText": "<4 天",
"IsolateTime": "2020-09-22 00:00:00",
"NetType": 1,
"WanDomain": "cynosdbmysql-sgvwu2is.wan.domain.com",
"WanIP": "34.1.25.122",
"WanPort": 3306,
"WanStatus": "isolated",
"DestroyTime": "2020-06-12 00:00:00",
"CynosVersion": "3.1.10",
"ProcessingTask": "taskClosePasswordComplexity",
"RenewFlag": 1,
"MinCpu": 1,
"MaxCpu": 4,
"ServerlessStatus": "paused",
"StorageId": "cynosdbmysql-sgvwu2is",
"StoragePayMode": 1,
"PhysicalZone": "ap-guangzhou-5",
"BusinessType": "bus_a",
"Tasks": [
{
"TaskId": 34234,
"TaskType": "taskCreateCluster",
"TaskStatus": "success",
"ObjectId": "cynosdbmysql-sgvwu2is",
"ObjectType": "taskObjTypeCluster"
}
],
"IsFreeze": "yes",
"ResourceTags": [
{
"TagKey": "tag_key_1",
"TagValue": "tag_value_1"
}
],
"MasterZone": "ap-guangzhou-5",
"SlaveZones": [
"ap-guangzhou-7"
],
"InstanceNetInfo": [
{
"InstanceGroupType": "ha",
"InstanceGroupId": "cynosdbmysql-grp-sb2u8exh",
"VpcId": "vpc-2ysb7hsg",
"SubnetId": "subnet-t62sji8s",
"NetType": 1,
"Vip": "172.3.41.33",
"Vport": 3306,
"WanDomain": "cynosdbmysql-sgvwu2is.wan.domain.com",
"WanIP": "3.1.5.6",
"WanPort": 3306,
"WanStatus": "isolated"
}
],
"ResourcePackages": [
{
"PackageId": "package-xb8sh2js",
"PackageType": "CCU",
"DeductionPriority": 2
}
],
"InstanceIndexMode": "mixedRowColumn"
}
],
"UniqVpcId": "vpc-2ysb7hsg",
"UniqSubnetId": "subnet-t62sji8s",
"OldAddrInfo": {
"Vip": "12.4.23.44",
"Vport": 3306,
"ReturnTime": "2024-01-23 11:23:00"
},
"ProcessingTasks": [
"taskCloseAudit"
],
"Tasks": [
{
"TaskId": 234234,
"TaskType": "taskCloseAudit",
"TaskStatus": "processing",
"ObjectId": "cynosdbmysql-sgvwu2is",
"ObjectType": "taskObjTypeCluster"
}
],
"NetServiceId": 112496
}
],
"RequestId": "097ecbc0-a5e8-4c30-a4da-5a0faf312d8b"
}
}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.DatabaseAccessError | 数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| FailedOperation.OperationFailedError | 操作失败，请稍后重试。如果持续不成功，请联系客服进行处理。 |
| InternalError.DbOperationFailed | 查询数据库失败。 |
| InternalError.InternalHttpServerError | http请求执行异常。 |
| InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
| ResourceNotFound.ClusterNotFoundError | 集群不存在。 |
| UnauthorizedOperation.PermissionDenied | CAM鉴权不通过。 |
