有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstances。
Version String 公共参数,本接口取值:2018-04-08。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
示例值:cmgo-7pjedvz7
InstanceType Integer 实例类型,取值范围:
  • 0: 所有实例
  • 1: 正式实例
  • 2: 临时实例
  • 3: 只读实例
  • -1: 正式实例+只读+灾备实例

示例值:0
ClusterType Integer 集群类型,取值范围:
  • 0: 副本集实例
  • 1: 正式实例
  • -1: 所有实例

示例值:0
Status.N Array of Integer 实例状态,取值范围:
  • 0: 待初始化
  • 1: 流程执行中
  • 2: 有效实例
  • -2: 已过期实例

示例值:2
VpcId String 私有网络的ID,基础网络则不传该参数。
示例值:1
SubnetId String 私有网络的子网ID,基础网络则不传该参数。入参设置该参数的同时,必须设置相应的VpcId。
示例值:1
PayMode Integer 付费类型,取值范围:
  • 0: 按量计费
  • 1:包年包月
  • -1: 按量计费+包年包月

示例值:1
Limit Integer 单次请求返回的数量,最小值为1,最大值为100,默认值为20。
示例值:10
Offset Integer 偏移量,默认值为0。
示例值:1
OrderBy String 返回结果集排序的字段,目前支持:
  • ProjectId: 按照项目ID排序
  • InstanceName:按照实例名称排序
  • CreateTime: 根据创建时间排序
OrderByType String 返回结果集排序方式,目前支持:"ASC"或者"DESC"。
  • ASC: 顺序取值
  • DESC:倒序取值

3. 输出参数

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

4. 示例

示例1 查询实例列表

输入示例

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

{
    "Limit": "1"
}

输出示例

{
    "Response": {
        "InstanceDetails": [
            {
                "AutoRenewFlag": 0,
                "CloneInstances": [],
                "ClusterType": 0,
                "ClusterVer": 1,
                "CpuNum": 2,
                "CreateTime": "2019-04-02 19:29:16",
                "DeadLine": "2019-04-04 19:29:16",
                "InstanceId": "cmgo-rw2v134z",
                "InstanceName": "cmgo-rw2v134z",
                "InstanceStatusDesc": "回档中",
                "InstanceType": 2,
                "InstanceVer": 4,
                "MachineType": "HIO10G",
                "MaintenanceEnd": "05:00:00",
                "MaintenanceStart": "04:00:00",
                "Memory": 4096,
                "MongoVersion": "MONGO_3_WT",
                "NetType": 1,
                "PayMode": 0,
                "ProjectId": 0,
                "Protocol": 0,
                "ReadonlyInstances": [],
                "RealInstanceId": "cmgo-da0pc0dr",
                "Region": "ap-guangzhou",
                "RelatedInstance": {
                    "InstanceId": "",
                    "Region": ""
                },
                "ReplicaSets": [
                    {
                        "Memory": 4096,
                        "OplogSize": 10240,
                        "RealReplicaSetId": "cmgo-rw2v134z_0",
                        "ReplicaSetId": "cmgo-rw2v134z_0",
                        "ReplicaSetName": "cmgo-rw2v134z_0",
                        "SecondaryNum": 2,
                        "UsedVolume": 0,
                        "Volume": 102400
                    }
                ],
                "ReplicationSetNum": 1,
                "SecondaryNum": 2,
                "StandbyInstances": [],
                "Status": 1,
                "SubnetId": "subnet-b0lagkxi",
                "Tags": [],
                "UsedVolume": 0,
                "Vip": "",
                "Volume": 102400,
                "VpcId": "vpc-orgohlut",
                "Vport": 27017,
                "Zone": "ap-guangzhou-3"
            }
        ],
        "RequestId": "302530d2-ee57-495e-89d0-51e03b11815e",
        "TotalCount": 19
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.PermissionDenied 当前子账号无权执行该操作。
InvalidParameterValue.IllegalInstanceStatus 非法的实例状态。
InvalidParameterValue.RegionError 无效的地域。
InvalidParameterValue.VpcIdOrSubnetIdNotFound 未找到虚拟网络(子网)。
InvalidParameterValue.ZoneError 无效的可用区。