DescribeDBInstances--文档数据库 MongoDB 版-火山引擎

文档中心

文档数据库 MongoDB 版

实例管理

DescribeDBInstances

调用 DescribeDBInstances 接口查询 MongoDB 实例的基本信息。

请求类型

同步请求。

注意事项

说明

若您不传入任何参数，默认返回当前账号下所有 MongoDB 实例的列表信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
ZoneId	String	否	cn-beijing-a	可用区 ID。说明您可以调用 DescribeAvailabilityZones 接口查询 MongoDB 实例的所有可用区信息，包括可用区 ID。
InstanceId	String	否	mongo-replica-e405f8e2****	实例 ID。
InstanceName	String	否	test_mongo	实例名称。
InstanceType	String	否	ReplicaSet	MongoDB 的实例类型，取值范围如下： `ReplicaSet`：副本集。 `ShardedCluster`：分片集群。说明若该参数留空，默认返回当前账号下所有类型的 MongoDB 实例列表。
InstanceStatus	String	否	Running	实例状态。关于实例状态的更多详情，请参见实例状态说明。
DBEngine	String	否	MongoDB	数据库引擎。取值固定为 `MongoDB`。
DBEngineVersion	String	否	MongoDB_5_0	数据库引擎版本，取值范围如下： `MongoDB_4_0`：MongoDB 4.0 版本。 `MongoDB_4_2`：MongoDB 4.2 版本。 `MongoDB_4_4`：MongoDB 4.4 版本。 `MongoDB_5_0`：MongoDB 5.0 版本。 `MongoDB_6_0`：MongoDB 6.0 版本。 `MongoDB_7_0`：MongoDB 7.0 版本。说明若该参数留空，默认返回当前账号下所有版本的 MongoDB 实例列表。关于 MongoDB 版本的更多详情，请参见版本介绍。
CreateStartTime	String	否	2022-03-15T03:50:00Z	实例创建的开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
CreateEndTime	String	否	2022-03-15T04:00:00Z	实例创建的结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
UpdateStartTime	String	否	2022-03-19T03:45:00Z	实例更新的开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
UpdateEndTime	String	否	2022-03-19T04:00:00Z	实例更新的结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
VpcId	String	否	vpc-2743n1ihbxla87fap8tap****	实例所属的私有网络（VPC）ID。说明您可以调用 DescribeVpcs 接口查询当前账号下的所有私有网络列表信息，包括私有网络 ID。
PageNumber	Integer	否	1	实例信息列表的页码，默认值为 1。取值为不超过 Integer 数据类型的最大值，起始值为 1。
PageSize	Integer	否	10	每页记录数，取值范围为 1~1000，默认值为 10。
ProjectName	String	否	default	指定实例所属的项目名称。说明若该参数留空，表示不使用实例的项目名称条件进行筛选。
FilterByTags	Object[]	否		用于查询筛选的标签键值对数组。说明若该参数留空，表示不使用标签条件进行筛选。若同时传入多个标签进行筛选时，多个标签筛选条件之间为或关系。
TagFilters	Object[]	否		该字段已废弃不再使用。建议通过 `FilterByTags` 字段进行标签筛选。

返回参数

参数	类型	示例值	描述
Total	Integer	1	所有实例的数量。
DBInstances	Object[]		实例基本信息列表。

示例

请求示例 1

通过 FilterByTags 字段筛选出按量计费分片集群实例。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "ZoneId": "cn-beijing-a",
    "PageSize": 20,
    "PageNumber": 1,
    "FilterByTags": [
        {
            "Key": "instancetype",
            "Value": [
                "shard"
            ]
        },
        {
            "Key": "chargetype",
            "Value": [
                "postpaid"
            ]
        }
    ]
}

返回示例 1

按量计费分片集群实例的正常返回示例。

{
    "ResponseMetadata": {
        "RequestId": "2023080717063891CD986698CC4AB4****",
        "Action": "DescribeDBInstances",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBInstances": [
            {
                "ChargeStatus": "Normal",
                "ChargeType": "PostPaid",
                "ClosedTime": "",
                "ConfigServersId": "mongo-shard-3d714182****-config",
                "CreateTime": "2023-06-15T09:27:55Z",
                "DBEngineVersion": "MongoDB_5_0",
                "DBEngineVersionStr": "MongoDB 5.0",
                "ExpiredTime": "",
                "InstanceId": "mongo-shard-3d714182****",
                "InstanceName": "python_sdk_test_shard",
                "InstanceStatus": "Running",
                "InstanceType": "ShardedCluster",
                "MongosId": "mongo-shard-3d714182****",
                "PrivateEndpoint": "mongodb://<user>:<password>@mongoshard3d714182****0.mongodb.ivolces.com:3717,mongoshard3d714182****1.mongodb.ivolces.com:3717,mongoshard3d714182****2.mongodb.ivolces.com:3717/?authSource=admin&retryWrites=true",
                "ReadOnlyNodeNumber": 0,
                "ProjectName": "default",
                "ReclaimTime": "",
                "StorageType": "LocalSSD",
                "SubnetId": "subnet-rr96lovl7f28v0x58tv****",
                "Tags": [
                    {
                        "Key": "chargetype",
                        "Value": "postpaid"
                    },
                    {
                        "Key": "instancetype",
                        "Value": "shard"
                    }
                ],
                "UpdateTime": "2023-06-29T13:23:20Z",
                "VpcId": "vpc-13f24t16guqdc3n6nu4k5****",
                "ZoneId": "cn-beijing-a"
            }
        ],
        "Total": 1
    }
}

请求示例 2

通过 ChargeType 和 InstanceType 字段筛选出包年包月副本集实例。

POST https://mongodb.cn-beijing.volcengineapi.com/?Action=DescribeDBInstances&Version=2022-01-01 HTTP/1.1
Host: mongodb.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "ZoneId": "cn-beijing-a",
    "PageSize": 20,
    "PageNumber": 1,
    "ChargeType": "Prepaid",
    "InstanceType": "ReplicaSet"
}

返回示例 2

包年包月副本集实例的正常返回示例。

{
    "ResponseMetadata": {
        "RequestId": "2023080717041449288C0B997AD0B1****",
        "Action": "DescribeDBInstances",
        "Version": "2022-01-01",
        "Service": "mongodb",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBInstances": [
            {
                "AutoRenew": false,
                "ChargeStatus": "Normal",
                "ChargeType": "Prepaid",
                "ClosedTime": "2023-09-04T04:00:00Z",
                "CreateTime": "2023-08-02T09:22:58Z",
                "DBEngineVersion": "MongoDB_5_0",
                "DBEngineVersionStr": "MongoDB 5.0",
                "ExpiredTime": "2023-09-03T15:59:59Z",
                "InstanceId": "mongo-replica-c70a99ee****",
                "InstanceName": "api_test_replica",
                "InstanceStatus": "Running",
                "InstanceType": "ReplicaSet",
                "PrivateEndpoint": "mongodb://<user>:<password>@mongoreplicac70a99ee****0.mongodb.ivolces.com:3717,mongoreplicac70a99ee****1.mongodb.ivolces.com:3717/?authSource=admin&replicaSet=rs-mongo-replica-c70a99ee****&retryWrites=true",
                "ReadOnlyNodeNumber": 0,
                "ProjectName": "default",
                "ReclaimTime": "2023-09-10T15:59:59Z",
                "StorageType": "LocalSSD",
                "SubnetId": "subnet-rr96lovl7f28v0x58tv****",
                "UpdateTime": "2023-08-03T02:58:29Z",
                "VpcId": "vpc-13f24t16guqdc3n6nu4k5****",
                "ZoneId": "cn-beijing-a"
            }
        ],
        "Total": 1
    }
}

错误码

更多详情，请参见错误码。

最近更新时间：2026.04.15 14:16:32

这个页面对您有帮助吗？

有用

无用

文档数据库 MongoDB 版

请求类型 #

注意事项 #

调试 #

请求参数 #

返回参数 #

示例 #

请求示例 1 #

返回示例 1 #

请求示例 2 #

返回示例 2 #

错误码 #