All Products
Search

This Product

    ApsaraDB for MongoDB:DescribeDBInstances

    Document Center

    ApsaraDB for MongoDB:DescribeDBInstances

    Last Updated:Mar 26, 2026

    Mengkueri daftar instans MongoDB.

    Deskripsi operasi

    Secara default, operasi ini mengkueri daftar instans set replika, termasuk instans mandiri. Jika parameter permintaan DBInstanceType tidak ditentukan, nilai default-nya adalah replicate. Untuk mengkueri daftar instans kluster sharded, atur DBInstanceType ke sharding.

    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:DescribeDBInstances

    get

    *Instance

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

    *Instance

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

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID wilayah.

    cn-hangzhou
    PageNumber

    integer

    No

    Nomor halaman. Nilainya harus lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data integer. Nilai default: 1.

    1
    PageSize

    integer

    No

    Jumlah entri yang ditampilkan per halaman. Nilai yang valid:

    • 30 (default)

    • 50

    • 100

    30
    DBInstanceId

    string

    No

    ID instans.

    dds-bp199659b178****
    ReplicationFactor

    string

    No

    Jumlah node dalam instans set replika. Nilai yang valid:

    • 3

    • 5

    • 7

    3
    DBInstanceDescription

    string

    No

    Nama instans. Nama tersebut harus memenuhi persyaratan berikut:

    • Harus diawali dengan karakter Tionghoa atau huruf.

    • Dapat berisi angka, karakter Tionghoa, huruf, garis bawah (_), dan tanda hubung (-).

    • Panjangnya harus antara 2 hingga 256 karakter.

    Test database
    ExpireTime

    string

    No

    Waktu kedaluwarsa instans. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC. Parameter ini digunakan untuk memfilter instans yang kedaluwarsa pada atau sebelum waktu yang ditentukan.

    2019-12-26T16:00:00Z
    DBInstanceStatus

    string

    No

    Status instans. Untuk informasi selengkapnya, lihat Instance states.

    Running
    DBInstanceType

    string

    No

    Arsitektur instans. Nilai yang valid:

    • sharding: instans kluster sharded.

    • replicate: instans set replika atau mandiri. Ini adalah nilai default.

    sharding
    DBInstanceClass

    string

    No

    Tipe instans. Untuk informasi selengkapnya, lihat Instance types.

    dds.mongo.mid
    Engine

    string

    No

    Engine database. Atur nilainya ke MongoDB.

    MongoDB
    EngineVersion

    string

    No

    Versi engine database. Nilai yang valid:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.0
    NetworkType

    string

    No

    Jenis jaringan instans. Nilai yang valid:

    • Classic: jaringan klasik.

    • VPC: virtual private cloud (VPC).

    VPC
    VpcId

    string

    No

    ID VPC.

    vpc-bp1n3i15v90el48nx****
    VSwitchId

    string

    No

    ID vSwitch VPC.

    vsw-bp1vj604nj5a9zz74****
    ChargeType

    string

    No

    Metode penagihan instans. Nilai yang valid:

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    PrePaid
    ZoneId

    string

    No

    ID zona. Anda dapat memanggil operasi DescribeRegions untuk mengkueri ID zona.

    cn-hangzhou-b
    Expired

    string

    No

    Status kedaluwarsa instans. Nilai yang valid:

    • true: Instans telah kedaluwarsa.

    • false: Instans belum kedaluwarsa.

    true
    ConnectionDomain

    string

    No

    Titik akhir node. Anda dapat memanggil operasi DescribeDBInstanceAttribute untuk mengkueri titik akhir.

    dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-acfmyiu4ekp****
    Tag

    array<object>

    No

    Tag instans.

    object

    No

    Key

    string

    No

    Kunci tag N. Nilai N harus berada dalam rentang 1 hingga 20.

    • Kunci tag tidak boleh diawali dengan aliyun, acs:, http://, atau https://.

    • Panjang kunci tag maksimal 64 karakter.

    • Kunci tag tidak boleh berupa string kosong.

    testdatabase
    Value

    string

    No

    Nilai tag N. Nilai N harus berada dalam rentang 1 hingga 20.

    • Nilai tag tidak boleh diawali dengan aliyun, acs:, http://, atau https://.

    • Panjang nilai tag maksimal 128 karakter.

    • Nilai tag boleh berupa string kosong.

    apitest
    DBNodeType

    string

    No

    Memfilter instans berdasarkan tipe. Nilai yang valid:

    1. customized: instans mandiri dan instans DBFS.

    2. standard: instans standar, yang mencakup instans set replika dan instans kluster sharded.

    3. default: semua instans.

    default

    Elemen respons

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    Jumlah instans yang dikembalikan.

    5
    RequestId

    string

    ID permintaan.

    0E4FE33F-5510-5758-8FA7-A6672CDE****
    PageSize

    integer

    Jumlah entri yang dikembalikan per halaman.

    30
    PageNumber

    integer

    Nomor halaman.

    1
    DBInstances

    object

    DBInstance

    array<object>

    Detail instans.

    array<object>

    CreationTime

    string

    Waktu pembuatan instans. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    2021-03-25T02:18:00Z
    ChargeType

    string

    Metode penagihan instans. Nilai yang valid:

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    PrePaid
    Tags

    object

    Tag

    array<object>

    Detail tag sumber daya.

    object

    Detail tag sumber daya.

    Key

    string

    Kunci tag.

    test
    Value

    string

    Nilai tag.

    api
    VpcAuthMode

    string

    Menunjukkan apakah akses tanpa password melalui VPC diaktifkan. Nilai yang valid:

    • Open: diaktifkan.

    • Close: dinonaktifkan.

    Close
    NetworkType

    string

    Jenis jaringan instans. Nilai yang valid:

    • Classic: jaringan klasik.

    • VPC: VPC.

    Classic
    LockMode

    string

    Status penguncian instans. Nilai yang valid:

    • Unlock: Instans tidak terkunci.

    • ManualLock: Instans dikunci secara manual.

    • LockByExpiration: Instans dikunci otomatis karena kedaluwarsa.

    • LockByRestoration: Instans dikunci otomatis sebelum rollback.

    • LockByDiskQuota: Instans dikunci otomatis karena storage space penuh.

    • Released: Instans telah dihapus. Dalam status ini, instans tidak dapat dibuka kuncinya. Anda hanya dapat membuat instans baru dari file backup. Proses pemulihan mungkin memakan waktu lama.

    Unlock
    EngineVersion

    string

    Versi engine database. Nilai yang valid:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    MongosList

    object

    MongosAttribute

    array<object>

    Detail node Mongos.

    Catatan

    Parameter ini hanya dikembalikan untuk instans kluster sharded.

    object

    Detail node Mongos.

    Catatan

    Parameter ini hanya dikembalikan untuk instans kluster sharded.

    NodeClass

    string

    Tipe instans node Mongos.

    dds.mongos.standard
    NodeDescription

    string

    Deskripsi node Mongos.

    Test mongos node
    NodeId

    string

    ID node Mongos.

    s-bp10e3b0d02f****
    DBInstanceDescription

    string

    Deskripsi instans.

    Test database
    ExpireTime

    string

    Waktu kedaluwarsa instans. Waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu ditampilkan dalam UTC.

    2021-11-25T16:00Z
    DBInstanceType

    string

    Arsitektur instans. Nilai yang valid:

    • sharding: instans kluster sharded.

    • replicate: instans set replika atau mandiri.

    sharding
    LastDowngradeTime

    string

    Waktu terakhir instans diturunkan spesifikasinya.

    2021-05-08
    ShardList

    object

    ShardAttribute

    array<object>

    Detail node shard.

    Catatan

    Parameter ini hanya dikembalikan untuk instans kluster sharded.

    object

    Detail node shard.

    Catatan

    Parameter ini hanya dikembalikan untuk instans kluster sharded.

    NodeClass

    string

    Tipe instans node shard.

    dds.shard.mid
    NodeDescription

    string

    Deskripsi node shard.

    Test shard node
    NodeStorage

    integer

    Storage space node shard. Satuan: GB.

    10
    NodeId

    string

    ID node shard.

    d-bp1cac6f2083****
    ReadonlyReplicas

    integer

    Jumlah node read-only dalam node shard. Nilainya dapat berupa bilangan bulat dari 0 hingga 5.

    2
    DestroyTime

    string

    Waktu penghapusan data instans. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.

    Catatan

    • Untuk instans subscription, resource komputasinya dilepas pada hari ke-16 setelah instans kedaluwarsa. Data disimpan selama 7 hari lagi. Pada hari ke-23, data dihapus dan tidak dapat dipulihkan.

    • Untuk instans pay-as-you-go, resource komputasinya dilepas pada hari ke-16 setelah pembayaran tertunggak. Data disimpan selama 7 hari lagi. Pada hari ke-23, data dihapus dan tidak dapat dipulihkan.

    2021-12-10T16:00:00Z
    DBInstanceStatus

    string

    Status instans. Untuk informasi selengkapnya, lihat Instance states.

    Running
    RegionId

    string

    ID wilayah instans.

    cn-hangzhou
    DBInstanceStorage

    integer

    Storage space instans.

    20
    ResourceGroupId

    string

    ID kelompok sumber daya.

    rg-acfmyiu4ekp****
    ZoneId

    string

    ID zona instans.

    cn-hangzhou-g
    DBInstanceId

    string

    ID instans.

    dds-bp18b0934e70****
    DBInstanceClass

    string

    Tipe instans.

    dds.mongo.mid
    Engine

    string

    Engine database.

    MongoDB
    ReplicationFactor

    string

    Jumlah node dalam instans.

    Catatan

    Parameter ini hanya dikembalikan untuk instans set replika.

    3
    KindCode

    string

    Tipe instans. Nilai yang valid:

    • 0: server fisik.

    • 1: ECS.

    • 2: Docker.

    • 18: instans pada arsitektur berbasis Kubernetes yang baru.

    1
    CapacityUnit

    string

    Throughput baca-tulis yang dikonsumsi oleh instans.

    Catatan

    Parameter ini hanya dikembalikan untuk instans serverless.

    100
    StorageType

    string

    Jenis penyimpanan. Nilai yang valid:

    • cloud_essd: disk cloud ESSD.

    • local_ssd: SSD lokal.

    local_ssd
    BackupRetentionPolicy

    integer

    Kebijakan retensi backup. Nilai yang valid:

    • 0: Semua set cadangan langsung dihapus saat instans dilepas.

    • 1: Backup otomatis dilakukan saat instans dilepas, dan set cadangan ini disimpan dalam jangka panjang.

    • 2: Backup otomatis dilakukan saat instans dilepas, dan semua set cadangan kluster disimpan dalam jangka panjang.

    1
    ReleaseTime

    string

    Waktu pelepasan instans.

    2024-06-17T07:01Z

    Contoh

    Respons sukses

    JSONformat

    {
  "TotalCount": 5,
  "RequestId": "0E4FE33F-5510-5758-8FA7-A6672CDE****",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2021-03-25T02:18:00Z",
        "ChargeType": "PrePaid",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Close",
        "NetworkType": "Classic",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "MongosList": {
          "MongosAttribute": [
            {
              "NodeClass": "dds.mongos.standard",
              "NodeDescription": "Test mongos node",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "Test database",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "Test shard node",
              "NodeStorage": 10,
              "NodeId": "d-bp1cac6f2083****",
              "ReadonlyReplicas": 2
            }
          ]
        },
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 20,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp18b0934e70****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReplicationFactor": "3",
        "KindCode": "1",
        "CapacityUnit": "100",
        "StorageType": "local_ssd",
        "BackupRetentionPolicy": 1,
        "ReleaseTime": "2024-06-17T07:01Z"
      }
    ]
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.