1. 接口描述
接口请求域名： dbbrain.api3.fincloud.tencent.com。
获取实例信息列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2025-05-16 10:46:48。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDiagDBInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2021-05-27 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceNames | 否 | 是 | Array of String | 根据实例名称条件查询。 示例值： ["share-测试"] |
| InstanceIds | 否 | 是 | Array of String | 根据实例ID条件查询。 示例值： ["share-test"] |
| IsSupported | 是 | 否 | Bool | 是否是DBbrain支持的实例，固定传 true。 示例值： true |
| Product | 是 | 否 | String | 服务产品类型，支持值包括： "mariadb" - 数据库 MariaDB， "dcdb" - 数据库 TDSQL MySQL，默认为"mariadb"。 示例值： mariadb |
| Offset | 否 | 是 | Int64 | 分页参数，偏移量。 示例值： 0 |
| Limit | 否 | 是 | Int64 | 分页参数，分页值，最大值为100。 示例值： 50 |
| ClusterIds | 否 | 是 | Array of String | 根集群ID条件查询。 示例值： ["tdsql-test"] |
| ClusterNames | 否 | 是 | Array of String | 根据集群名称条件查询。 示例值： ["tdsql-测试"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 实例总数。 示例值： 100 |
| DbScanStatus | Int64 | 全实例巡检状态：0：开启全实例巡检；1：未开启全实例巡检。 示例值： 1 |
| Items | Array of InstanceInfo | 实例相关信息。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| RequestLimitExceeded | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |