查询云数据库实例列表
最近更新时间: 2024-10-18 10:38:27
1. 接口描述
接口请求域名： mongodb.api3.fincloud.tencent.cn。
本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-01-05 22:49:17。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDBInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-07-25 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceIds | 否 | 否 | Array of String | 实例ID列表，格式如：cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同 |
| InstanceType | 否 | 否 | Int64 | 实例类型，取值范围：0-所有实例,1-正式实例，2-临时实例, 3-只读实例，-1-正式实例+只读+灾备实例 |
| ClusterType | 否 | 否 | Int64 | 集群类型，取值范围：0-副本集实例，1-分片实例，-1-所有实例 |
| Status | 否 | 否 | Array of Int64 | 实例状态，取值范围：0-待初始化，1-流程执行中，2-实例有效，-2-实例已过期 |
| VpcId | 否 | 否 | String | 私有网络的ID，基础网络则不传该参数 |
| SubnetId | 否 | 否 | String | 私有网络的子网ID，基础网络则不传该参数。入参设置该参数的同时，必须设置相应的VpcId |
| PayMode | 否 | 否 | Int64 | 付费类型，取值范围：0-按量计费，1-包年包月，-1-按量计费+包年包月 |
| Limit | 否 | 否 | Uint64 | 单次请求返回的数量，最小值为1，最大值为100，默认值为20 |
| Offset | 否 | 否 | Uint64 | 偏移量，默认值为0 |
| OrderBy | 否 | 否 | String | 返回结果集排序的字段，目前支持："ProjectId", "InstanceName", "CreateTime"，默认为升序排序 |
| OrderByType | 否 | 否 | String | 返回结果集排序方式，目前支持："ASC"或者"DESC" |
| ProjectIds | 否 | 否 | Array of Uint64 | 项目 ID |
| SearchKey | 否 | 否 | String | 搜索关键词，支持实例Id、实例名称、完整IP |
| Tags | 否 | 否 | Array of TagInfo | Tag信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 符合查询条件的实例总数 |
| InstanceDetails | InstanceDetail | 实例详细信息列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.RegionError | |
| InvalidParameterValue.IllegalInstanceStatus | |
| InvalidParameterValue.VpcIdOrSubnetIdNotFound | |
| InvalidParameterValue.ZoneError | |
| InvalidParameter.PermissionDenied |