云数据库 MongoDB 查询云数据库实例列表

1. 接口描述

接口请求域名： mongodb.tencentcloudapi.com 。

本接口（DescribeDBInstances）用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDBInstances。
Version	是	String	公共参数，本接口取值：2019-07-25。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceIds.N	否	Array of String	实例 ID 列表。例如：cmgo-p8vn****。请登录 MongoDB 控制台在实例列表复制实例 ID。示例值：cmgo-hcscymcl
InstanceType	否	Integer	指定查询的实例类型。取值范围如下： 0：所有实例。 1：正式实例。 3：只读实例。 4：灾备实例。示例值：0
ClusterType	否	Integer	指定所查询实例的集群类型，取值范围如下： 0：副本集实例。 1：分片实例。 -1：副本集与分片实例。示例值：0
Status.N	否	Array of Integer	指定所查询实例的当前状态，取值范围如下所示： 0：待初始化。 1：流程处理中，例如：变更规格、参数修改等。 2：实例正常运行中。 -2：实例已过期。示例值：2
VpcId	否	String	私有网络的 ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其 ID。示例值：1
SubnetId	否	String	私有网络的子网ID。 - 基础网络则无需配置该参数。 - 请登录 MongoDB 控制台在实例列表中，单击私有网络名称，在私有网络页面获取其子网 ID。示例值：1
PayMode	否	Integer	指定所查询实例的付费类型，取值范围如下： 0：查询按量计费实例。 1：查询包年包月实例。 -1：查询按量计费与包年包月实例。示例值：1
Limit	否	Integer	单次请求返回的数量。默认值为20，取值范围为[1,100]。示例值：10
Offset	否	Integer	偏移量，默认值为0。示例值：1
OrderBy	否	String	配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。示例值：ProjectId
OrderByType	否	String	配置返回结果的排序方式。 - ASC：升序。 - DESC：降序。示例值：ASC
ProjectIds.N	否	Array of Integer	项目 ID。请登录 MongoDB 控制台，在右上角的账户信息下拉菜单中，选择项目管理查询项目。示例值：[1,2]
SearchKey	否	String	指定查询搜索的关键词。支持设置为具体的实例ID、实例名称或者内网 IP 地址。示例值：cmgo-glh5****
Tags.N	否	Array of TagInfo	标签信息，包含标签键与标签值。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合查询条件的实例总数。示例值：19
InstanceDetails	Array of InstanceDetail	实例详细信息列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例列表

查询实例列表

输入示例

POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDBInstances
<公共请求参数>

{
    "Status": [
        0
    ],
    "OrderBy": "ProjectId",
    "InstanceIds": [
        "cmgo-3vgr****"
    ],
    "VpcId": "vpc-gfb3****",
    "Tags": [
        {
            "TagKey": "testTag",
            "TagValue": "testValue"
        }
    ],
    "ClusterType": 0,
    "PayMode": 0,
    "Limit": 1,
    "SearchKey": "",
    "Offset": 1,
    "SubnetId": "",
    "OrderByType": "",
    "InstanceType": 0,
    "ProjectIds": [
        1
    ]
}

输出示例

{
    "Response": {
        "InstanceDetails": [
            {
                "AutoRenewFlag": 0,
                "CloneInstances": [],
                "ClusterType": 0,
                "ClusterVer": 1,
                "ConfigServerCpuNum": 0,
                "ConfigServerMemory": 0,
                "ConfigServerNodeNum": 3,
                "ConfigServerVolume": 0,
                "CpuNum": 2,
                "CreateTime": "2023-03-30 07:44:21",
                "DeadLine": "2073-03-30 07:44:21",
                "InstanceId": "cmgo-3vgr****",
                "InstanceName": "测试实例",
                "InstanceStatusDesc": "运行中",
                "InstanceType": 1,
                "InstanceVer": 4,
                "MachineType": "HIO10G",
                "MaintenanceEnd": "05:00:00",
                "MaintenanceStart": "04:00:00",
                "Memory": 4096,
                "MongoVersion": "MONGO_42_WT",
                "MongosCpuNum": 0,
                "MongosMemory": 0,
                "MongosNodeNum": 0,
                "NetType": 1,
                "PayMode": 0,
                "ProjectId": 0,
                "Protocol": 0,
                "ReadonlyInstances": [],
                "ReadonlyNodeNum": 0,
                "RealInstanceId": "cmgo-3vgr****",
                "Region": "ap-guangzhou",
                "RelatedInstance": {
                    "InstanceId": "",
                    "Region": ""
                },
                "ReplicaSets": [
                    {
                        "Memory": 4096,
                        "OplogSize": 1024,
                        "RealReplicaSetId": "cmgo-3vgrapm5_*",
                        "ReplicaSetId": "cmgo-3vgrapm5_*",
                        "ReplicaSetName": "cmgo-3vgrapm5_*",
                        "SecondaryNum": 2,
                        "UsedVolume": 315,
                        "Volume": 10240
                    }
                ],
                "ReplicationSetNum": 1,
                "SecondaryNum": 2,
                "StandbyInstances": [],
                "Status": 2,
                "SubnetId": "subnet-7q7d****",
                "Tags": [],
                "UsedVolume": 315,
                "Vip": "10.5.2.12;10.5.2.14;10.5.2.10",
                "Volume": 10240,
                "VpcId": "vpc-gfb3****",
                "Vport": 27017,
                "Zone": "ap-guangzhou-2",
                "ZoneList": []
            }
        ],
        "RequestId": "230c9c0e-a56f-4639-81ee-3cb46905c087",
        "TotalCount": 1
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.PermissionDenied	当前子账号无权执行该操作。
InvalidParameterValue.IllegalInstanceStatus	非法的实例状态。
InvalidParameterValue.RegionError	无效的地域。
InvalidParameterValue.VpcIdOrSubnetIdNotFound	未找到虚拟网络（子网）。
InvalidParameterValue.ZoneError	无效的可用区。
LimitExceeded.TooManyRequests	请求太过频繁，触发接口频限。
UnsupportedOperation	操作不支持。

查询云数据库实例列表

本页目录：