All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeDBInstancesOverview

    Document Center

    ApsaraDB for MongoDB:DescribeDBInstancesOverview

    Last Updated:Jun 10, 2026

    Mengkueri Tampilan satu atau beberapa instans Database Apsara untuk MongoDB.

    Deskripsi operasi

    • If you do not specify any instances, the operation returns overview information for all instances in the destination region associated with your Alibaba Cloud account.

    • The results of this operation are not paginated.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dds:DescribeDBInstancesOverview

    list

    *Instance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    ID Wilayah. Panggil DescribeRegions untuk mengkueri daftar wilayah terbaru.

    cn-hangzhou
    InstanceIds

    string

    No

    ID Instans yang Tampilannya ingin Anda kueri.

    Catatan

    • Jika Anda tidak menentukan parameter ini, Tampilan semua instans di akun Alibaba Cloud Anda akan dikembalikan.

    • Anda dapat menentukan beberapa ID Instans. Pisahkan ID dengan koma (,).

    dds-bp12c5b040dc****
    InstanceStatus

    string

    No

    Status Instans. Untuk informasi lebih lanjut, lihat Instance states.

    Running
    ChargeType

    string

    No

    Metode penagihan Instans. Nilai valid:

    • PrePaid: langganan

    • PostPaid: pay-as-you-go.

    PostPaid
    NetworkType

    string

    No

    Jenis jaringan Instans. Nilai valid:

    • Classic: jaringan klasik

    • VPC: virtual private cloud (VPC).

    Classic
    EngineVersion

    string

    No

    Versi mesin database Instans. Nilai valid: 5.0, 4.4, 4.2, 4.0, dan 3.4.

    4.0
    InstanceClass

    string

    No

    Tipe instans. Untuk informasi lebih lanjut tentang tipe instans yang tersedia untuk format arsitektur instans yang berbeda, lihat:

    dds.mongo.2xlarge
    VpcId

    string

    No

    ID VPC.

    vpc-bp1nme44gek34slfc****
    VSwitchId

    string

    No

    ID vSwitch.

    vsw-bp1e7clcw529l773d****
    InstanceType

    string

    No

    Arsitektur Instans. Nilai valid:

    • sharding: instans kluster sharded

    • replicate: instans replica set atau Instans mandiri

    Catatan

    • Atur parameter ini sesuai kebutuhan. Misalnya, untuk mengkueri Tampilan instans kluster sharded, atur parameter ini ke sharding.

    • Jika Anda tidak menentukan parameter ini, Tampilan semua instans akan dikembalikan.

    replicate
    ZoneId

    string

    No

    ID zona.

    cn-hangzhou-b
    ResourceGroupId

    string

    No

    ID kelompok sumber daya. Untuk informasi lebih lanjut tentang kelompok sumber daya, lihat View basic information about a resource group.

    rg-acfmyiu4ekp****
    ShowTags

    boolean

    No

    Apakah akan mengembalikan tag Instans. Nilai default adalah false.

    false

    Elemen respons

    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.

    Catatan

    This parameter is returned only for sharded cluster instances.

    object

    The details of the shard nodes.

    Catatan

    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.

    测试shard节点
    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.

    Catatan

    • 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.

    Catatan

    This parameter is returned only for sharded cluster instances.

    object

    The details of the mongos nodes.

    Catatan

    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.

    测试mongos节点
    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.

    Catatan

    This parameter is returned only for replica set instances.

    3
    DBInstanceDescription

    string

    The description of the instance.

    测试数据库
    KindCode

    string

    The instance edition. Valid values:

    • 0: physical server

    • 1: ECS

    • 2: DOCKER

    • 18: instance on the new Kubernetes-based architecture

    0

    Contoh

    Respons sukses

    JSONformat

    {
  "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": "测试shard节点",
          "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": "测试mongos节点",
          "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": "测试数据库",
      "KindCode": "0"
    }
  ]
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.