All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeDBInstancesOverview

    Document Center

    ApsaraDB for MongoDB:DescribeDBInstancesOverview

    Last Updated:Mar 26, 2026

    Queries the overview of one or more ApsaraDB for MongoDB instances.

    Operation description

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:DescribeDBInstancesOverview

    list

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/*

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    The region ID. Call DescribeRegions to query the latest region list.

    cn-hangzhou

    InstanceIds

    string

    No

    The ID of the instance whose overview you want to query.

    Note

    • If you do not specify this parameter, an overview of all instances in your Alibaba Cloud account is returned.

    • You can specify multiple instance IDs. Separate the IDs with commas (,).

    dds-bp12c5b040dc****

    InstanceStatus

    string

    No

    The status of the instance. For more information, see Instance states.

    Running

    ChargeType

    string

    No

    The billing method of the instance. Valid values:

    • PrePaid: subscription

    • PostPaid: pay-as-you-go

    PostPaid

    NetworkType

    string

    No

    The network type of the instance. Valid values:

    • Classic: classic network

    • VPC: virtual private cloud (VPC)

    Classic

    EngineVersion

    string

    No

    The database engine version of the instance. Valid values: 5.0, 4.4, 4.2, 4.0, and 3.4.

    4.0

    InstanceClass

    string

    No

    The instance type. For more information about the instance types available for different instance architectures, see:

    dds.mongo.2xlarge

    VpcId

    string

    No

    The ID of the VPC.

    vpc-bp1nme44gek34slfc****

    VSwitchId

    string

    No

    The ID of the vSwitch.

    vsw-bp1e7clcw529l773d****

    InstanceType

    string

    No

    The instance architecture. Valid values:

    • sharding: sharded cluster instance

    • replicate: replica set or standalone instance

    Note

    • Set this parameter as needed. For example, to query the overview of a sharded cluster instance, set this parameter to sharding.

    • If you do not specify this parameter, an overview of all instances is returned.

    replicate

    ZoneId

    string

    No

    The ID of the zone.

    cn-hangzhou-b

    ResourceGroupId

    string

    No

    The ID of the resource group. For more information about resource groups, see View basic information about a resource group.

    rg-acfmyiu4ekp****

    ShowTags

    boolean

    No

    Specifies whether to return instance tags. The default value is false.

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    TotalCount

    string

    The number of instances returned.

    1

    RequestId

    string

    The request ID.

    52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
    DBInstances

    array<object>

    A list of instance details.

    array<object>

    A list of instance details.

    CreationTime

    string

    The time when the instance was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.

    2022-01-05T03:18:53Z

    ExpireTime

    string

    The expiration time of the subscription instance. The time is in the yyyy-MM-ddTHH:mmZ format. The time is in UTC.

    2022-02-05T16:00Z
    Tags

    array<object>

    The tags of the instance.

    object

    The tags of the instance.

    Key

    string

    The tag key.

    • The key cannot start with aliyun, acs:, http://, or https://.

    • The key can be up to 64 characters in length.

    • The key cannot be an empty string.

    testdatabase

    Value

    string

    The tag value.

    • The value cannot start with aliyun, acs:, http://, or https://.

    • The value can be up to 128 characters in length.

    • The value can be an empty string.

    apitest

    LastDowngradeTime

    string

    The time when the instance was last downgraded.

    2021-05-08
    ShardList

    array<object>

    The details of the shard nodes.

    Note

    This parameter is returned only for sharded cluster instances.

    object

    The details of the shard nodes.

    Note

    This parameter is returned only for sharded cluster instances.

    NodeClass

    string

    The instance type of the shard node.

    dds.shard.mid

    NodeDescription

    string

    The description of the shard node.

    test-shard-node

    NodeStorage

    integer

    The storage capacity of the shard node, in GB.

    10

    NodeId

    string

    The ID of the shard node.

    d-bp1cac6f2083****

    ReadonlyReplicas

    integer

    The number of read-only nodes in the shard. Valid values: 0 to 5.

    2

    DBInstanceType

    string

    The instance architecture. Valid values:

    • sharding: sharded cluster instance

    • replicate: replica set or standalone instance

    replicate

    DestroyTime

    string

    The time when the data of the instance was destroyed. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.

    2021-12-10T16:00:00Z

    ChargeType

    string

    The billing method of the instance. Valid values:

    • PrePaid: subscription

    • PostPaid: pay-as-you-go

    PrePaid

    CapacityUnit

    string

    The read/write throughput of the instance.

    Note

    • This parameter is returned only for Serverless instances.

    • Serverless instances are available only on the China site (aliyun.com).

    100

    VpcAuthMode

    string

    Indicates whether password-free access over a VPC is enabled. Valid values:

    • Open: enabled

    • Close: disabled

    Open

    DBInstanceStatus

    string

    The status of the instance. For more information, see Instance states.

    Running

    NetworkType

    string

    The network type of the instance. Valid values:

    • Classic: classic network

    • VPC: virtual private cloud (VPC)

    VPC

    LockMode

    string

    The lock mode of the instance.

    • Unlock: The instance is not locked.

    • ManualLock: The instance is manually locked.

    • LockByExpiration: The instance is automatically locked after it expires.

    • LockByRestoration: The instance is automatically locked before a rollback.

    • LockByDiskQuota: The instance is automatically locked after its storage space is exhausted.

    • Released: The instance is released. You cannot unlock a released instance. You can only restore the data of the instance to a new instance. The restoration may take a long time.

    Unlock

    EngineVersion

    string

    The database engine version of the instance.

    4.2
    MongosList

    array<object>

    The details of the mongos nodes.

    Note

    This parameter is returned only for sharded cluster instances.

    object

    The details of the mongos nodes.

    Note

    This parameter is returned only for sharded cluster instances.

    NodeClass

    string

    The instance type of the mongos node.

    dds.mongos.standard

    NodeDescription

    string

    The description of the mongos node.

    test-mongos-node

    NodeId

    string

    The ID of the mongos node.

    s-bp10e3b0d02f****

    RegionId

    string

    The region ID of the instance.

    cn-hangzhou

    DBInstanceStorage

    integer

    The storage capacity of the instance, in GB.

    20

    ResourceGroupId

    string

    The ID of the resource group to which the instance belongs.

    rg-acfm22cdcgc****

    ZoneId

    string

    The zone of the instance.

    cn-hangzhou-i

    DBInstanceId

    string

    The instance ID.

    dds-bp12c5b040dc****

    DBInstanceClass

    string

    The instance type. For more information about the instance types available for different instance architectures, see:

    dds.mongo.mid

    Engine

    string

    The database engine. The value is MongoDB.

    MongoDB

    ReplicationFactor

    string

    The number of nodes in the instance.

    Note

    This parameter is returned only for replica set instances.

    3

    DBInstanceDescription

    string

    The description of the instance.

    test-database

    KindCode

    string

    The instance edition. Valid values:

    • 0: physical server

    • 1: ECS

    • 2: DOCKER

    • 18: instance on the new Kubernetes-based architecture

    0

    Examples

    Success response

    JSON format

    {
  "TotalCount": "1",
  "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances": [
    {
      "CreationTime": "2022-01-05T03:18:53Z",
      "ExpireTime": "2022-02-05T16:00Z",
      "Tags": [
        {
          "Key": "testdatabase",
          "Value": "apitest"
        }
      ],
      "LastDowngradeTime": "2021-05-08",
      "ShardList": [
        {
          "NodeClass": "dds.shard.mid",
          "NodeDescription": "test-shard-node",
          "NodeStorage": 10,
          "NodeId": "d-bp1cac6f2083****",
          "ReadonlyReplicas": 2
        }
      ],
      "DBInstanceType": "replicate",
      "DestroyTime": "2021-12-10T16:00:00Z",
      "ChargeType": "PrePaid",
      "CapacityUnit": "100",
      "VpcAuthMode": "Open",
      "DBInstanceStatus": "Running",
      "NetworkType": "VPC",
      "LockMode": "Unlock",
      "EngineVersion": "4.2",
      "MongosList": [
        {
          "NodeClass": "dds.mongos.standard",
          "NodeDescription": "test-mongos-node",
          "NodeId": "s-bp10e3b0d02f****"
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBInstanceStorage": 20,
      "ResourceGroupId": "rg-acfm22cdcgc****",
      "ZoneId": "cn-hangzhou-i",
      "DBInstanceId": "dds-bp12c5b040dc****",
      "DBInstanceClass": "dds.mongo.mid",
      "Engine": "MongoDB",
      "ReplicationFactor": "3",
      "DBInstanceDescription": "test-database",
      "KindCode": "0"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.