查询实例列表
最近更新时间: 2024-09-03 18:49:56
1. 接口描述
接口请求域名： dcdb.api3.cloud.sunhongs.com。
查询云数据库实例列表，支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。 如果不指定任何筛选条件，则默认返回10条实例记录，单次请求最多支持返回100条实例记录。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-07-24 16:00:37。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDCDBInstances |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceIds | 否 | 否 | Array of String | 按照一个或者多个实例 ID 查询。实例 ID 形如：dcdbt-2t4cf98d |
| SearchName | 否 | 否 | String | 搜索的字段名，当前支持的值有：instancename、vip、all。传 instancename 表示按实例名进行搜索；传 vip 表示按内网IP进行搜索；传 all 将会按实例ID、实例名和内网IP进行搜索。 |
| SearchKey | 否 | 否 | String | 搜索的关键字，支持模糊搜索。多个关键字使用换行符（'\n'）分割。 |
| ProjectIds | 否 | 否 | Array of Int64 | 此参数对外不可见。 按项目 ID 查询 |
| IsFilterVpc | 否 | 否 | Bool | 是否根据 VPC 网络来搜索 |
| VpcId | 否 | 否 | String | 私有网络 ID， IsFilterVpc 为 1 时有效 |
| SubnetId | 否 | 否 | String | 私有网络的子网 ID， IsFilterVpc 为 1 时有效 |
| OrderBy | 否 | 否 | String | 排序字段， projectId， createtime， instancename 三者之一 |
| OrderByType | 否 | 否 | String | 排序类型， desc 或者 asc |
| Offset | 否 | 否 | Int64 | 偏移量，默认为 0 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为 10，最大值为 100。 |
| ExclusterType | 否 | 否 | Int64 | 1非独享集群，2独享集群， 0全部 |
| IsFilterExcluster | 否 | 否 | Bool | 标识是否使用ExclusterType字段, false不使用，true使用 |
| ExclusterIds | 否 | 否 | Array of String | 独享集群ID |
| TagKeys | 否 | 否 | Array of String | 按标签key查询 |
| FilterInstanceType | 否 | 否 | String | 实例类型过滤，1-独享实例，2-主实例，3-灾备实例，多个按逗号分隔 |
| Status | 否 | 否 | Array of Int64 | 筛选的实例状态 |
| ExcludeStatus | 否 | 否 | Array of Int64 | 过滤的实例状态 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 此参数对外不可见。 符合条件的实例数量 |
| Instances | DCDBInstanceInfo | 此参数对外不可见。 实例详细信息列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CamAuthFailed | |
| InternalError.DbOperationFailed | |
| InternalError.FenceError | |
| InternalError.GetSubnetFailed | |
| InternalError.GetVpcFailed | |
| InvalidParameter.GenericParameterError | |
| InvalidParameter.SubnetNotFound | |
| InvalidParameterValue.IllegalExclusterID | |
| InvalidParameterValue.SpecIdIllegal | |
| UnauthorizedOperation.PermissionDenied |