全部产品
Search
文档中心

ApsaraDB for MongoDB:DescribeDBInstanceAttribute

更新时间:Dec 16, 2025

Mengambil detail instans ApsaraDB for MongoDB.

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

get

*dbinstance

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

None None

Parameter permintaan

Parameter

Type

Required

Description

Example

Engine

string

No

Mesin database. Tetapkan nilainya ke MongoDB.

MongoDB

DBInstanceId

string

Yes

ID instans.

dds-bp11483712c1****

ResourceGroupId

string

No

ID kelompok sumber daya. Untuk informasi selengkapnya, lihat Lihat informasi dasar kelompok sumber daya.

Catatan

Parameter ini hanya dapat dikonfigurasi di website Alibaba Cloud China (www.aliyun.com).

rg-acfmyiu4ekp****

IsDelete

boolean

No

Menentukan apakah akan menanyakan instans yang telah dihapus. Nilai yang valid:

  • false: Instans sedang berjalan.

  • true: Instans telah dihapus.

false

Elemen respons

Element

Type

Description

Example

object

Detail instans.

RequestId

string

ID permintaan.

A935A8EE-A6CC-53DE-98BA-20ABAA7E632B

DBInstances

object

DBInstance

array<object>

Detail instans.

array<object>

Detail instans.

CreationTime

string

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

2022-01-02T07:43:59Z

ReplicaSets

object

ReplicaSet

array<object>

Detail instans set replika.

Catatan

Parameter ini dikembalikan jika instans merupakan instans set replika.

object

Detail instans set replika.

Catatan

Parameter ini dikembalikan jika instans merupakan instans set replika.

VSwitchId

string

ID vSwitch.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

vpc-bp1jk5vwkcri27qme****

ConnectionPort

string

Port koneksi node.

3717

ReplicaSetRole

string

Peran node. Nilai yang valid:

  • Primary: node primer.

  • Secondary: node sekunder.

Primary

ConnectionDomain

string

Titik akhir node.

dds-bp11483712c1****.mongodb.rds.aliyuncs.com

VPCCloudInstanceId

string

ID instans VPC dari node set replika.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

dds-bp11483712c1****

NetworkType

string

Jenis jaringan. Nilai yang valid:

  • Classic: jaringan klasik.

  • VPC: VPC.

VPC

VPCId

string

ID VPC.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

vpc-bp1jk5vwkcri27qme****

ReplacateId

string

ID logis instans Cache Terdistribusi Global.

Catatan

Anda tidak dapat lagi membeli instans jenis ini. Parameter ini hanya dikembalikan untuk instans Cache Terdistribusi Global yang sudah ada.

bls-m****

Tags

object

Tag

array<object>

Daftar tag yang dilampirkan pada instans.

object

Daftar tag yang dilampirkan pada instans.

Key

string

Kunci tag.

test

Value

string

Nilai tag.

api

VpcAuthMode

string

Mode akses tanpa password melalui jaringan pribadi. Nilai yang valid:

  • Open: Akses tanpa password diaktifkan.

  • Close: Akses tanpa password dinonaktifkan. Anda harus menggunakan password untuk mengakses instans.

  • NotSupport: Instans tidak mendukung fitur ini.

Open

NetworkType

string

Jenis jaringan instans. Nilai yang valid:

  • Classic: jaringan klasik.

  • VPC: VPC.

VPC

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 ruang disk habis.

Unlock

EngineVersion

string

Versi utama mesin database.

4.4

MaxIOPS

integer

Jumlah maksimum operasi input/output per detik (IOPS) instans.

1000

MaxMBPS

integer

Throughput maksimum disk, dalam MB/s.

350

VPCCloudInstanceIds

string

ID instans VPC.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

Penting Parameter ini sudah tidak digunakan lagi.

dds-bp11483712c1****

MongosList

object

MongosAttribute

array<object>

Daftar informasi node Mongos.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

object

Daftar informasi node Mongos.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

VpcCloudInstanceId

string

ID instans VPC dari node Mongos.

s-bp1d8c262a158****

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 ruang disk habis.

Unlock

MaxIOPS

integer

IOPS maksimum node Mongos.

800

VSwitchId

string

ID vSwitch.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

vsw-bp1vj604nj5a9zz74****

NodeClass

string

Tipe instans node Mongos.

dds.mongos.mid

MaxConnections

integer

Jumlah maksimum koneksi ke node Mongos.

1000

Port

integer

Port koneksi node Mongos.

3717

VPCId

string

ID VPC.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

vpc-bp1n3i15v90el48nx****

ConnectSting

string

Titik akhir node Mongos.

Peringatan Parameter ini sedang ditinggalkan. Gunakan parameter ConnectString sebagai gantinya.

s-bp1d8c262a15****.mongodb.rds.aliyuncs.com

NodeDescription

string

Nama node Mongos.

mongos1

NodeId

string

ID node Mongos.

s-bp1d8c262a15****

Status

string

Status node Mongos. Untuk informasi selengkapnya, lihat Status instans.

Running

CurrentKernelVersion

string

Versi mesin minor node MongoDB.

mongodb_20220518_4.0.21

ConnectString

string

Titik akhir node Mongos.

s-bp1d8c262a15****.mongodb.rds.aliyuncs.com

ProtocolType

string

Jenis protokol instans. Nilai yang valid:

  • mongodb: Protokol MongoDB.

  • dynamodb: Protokol DynamoDB.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

mongodb

DBInstanceDescription

string

Nama instans.

测试数据库

CurrentKernelVersion

string

Versi mesin minor instans.

5.0.5-20220721143518_0

DBInstanceReleaseProtection

boolean

Menunjukkan apakah perlindungan pelepasan diaktifkan untuk instans. Nilai yang valid:

  • true: Perlindungan pelepasan diaktifkan.

  • false: Perlindungan pelepasan dinonaktifkan.

false

ExpireTime

string

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

Catatan

Parameter ini dikembalikan jika instans merupakan instans langganan.

2022-02-05T16:00Z

MaintainStartTime

string

Waktu mulai jendela pemeliharaan. Waktu dalam format HH:mmZ. Waktu ditampilkan dalam UTC.

18:00Z

DBInstanceType

string

Tipe instans. Nilai yang valid:

  • replicate: instans set replika.

  • sharding: instans kluster sharded.

replicate

LastDowngradeTime

string

Waktu terakhir instans diturunkan spesifikasinya.

2022-01-08

ShardList

object

ShardAttribute

array<object>

Daftar informasi node shard.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

object

Daftar informasi node shard.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

LockMode

string

Mode penguncian kluster. Nilai yang valid:

  • Unlock: Kluster tidak terkunci.

  • ManualLock: Kluster dikunci secara manual.

  • LockByExpiration: Kluster dikunci otomatis karena kedaluwarsa.

  • LockByRestoration: Kluster dikunci otomatis sebelum rollback.

  • LockByDiskQuota: Kluster dikunci otomatis karena ruang disk habis.

Unlock

MaxIOPS

integer

IOPS maksimum node shard.

8000

ConnectString

string

Titik akhir node shard.

d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****

NodeClass

string

Tipe instans node shard.

dds.shard.mid

MaxConnections

integer

Jumlah maksimum koneksi ke node shard.

8000

Port

integer

Port node shard.

3717

NodeDescription

string

Nama node shard.

testshard

NodeId

string

ID node shard.

d-bp16e09d9c5d****

NodeStorage

integer

Ruang penyimpanan node shard. Satuan: GB.

10

ReadonlyReplicas

integer

Jumlah node read-only dalam node shard. Nilai yang valid: bilangan bulat dari 0 hingga 5.

0

Status

string

Status node shard. Untuk informasi selengkapnya, lihat Status instans.

Running

MaxDiskMbps

string

Throughput disk maksimum node shard.

350

CurrentKernelVersion

string

Versi mesin minor node MongoDB.

mongodb_20220518_4.0.21

ReplicaSetName

string

Nama node shard.

mgset-xxxx

MaintainEndTime

string

Waktu akhir jendela pemeliharaan. Waktu dalam format HH:mmZ. Waktu ditampilkan dalam UTC.

03:00Z

DBInstanceStatus

string

Status instans. Untuk informasi selengkapnya, lihat Status instans.

Running

VPCId

string

ID VPC.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

vpc-bp1n3i15v90el48nx****

RegionId

string

ID wilayah instans.

cn-hangzhou

DBInstanceStorage

integer

Ruang penyimpanan instans.

10

ReplicaSetName

string

Nama instans set replika.

Catatan

Parameter ini dikembalikan jika instans merupakan instans set replika.

mgset-10ace****

VSwitchId

string

ID vSwitch.

Catatan

Parameter ini dikembalikan jika jenis jaringan instans adalah VPC.

vsw-bp1oo2a7isyrb8igf****

StorageEngine

string

Mesin penyimpanan instans.

WiredTiger

ConfigserverList

object

ConfigserverAttribute

array<object>

Daftar informasi node Configserver.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

object

Daftar informasi node Configserver.

Catatan

Parameter ini dikembalikan jika instans merupakan instans kluster sharded.

MaxIOPS

integer

IOPS maksimum node Configserver.

1000

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 ruang disk habis.

Unlock

ConnectString

string

Titik akhir node Configserver.

dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com

NodeClass

string

Tipe instans node Configserver.

dds.cs.mid

MaxConnections

integer

Jumlah maksimum koneksi ke node Configserver.

1000

Port

integer

Port node Configserver.

3717

NodeDescription

string

Nama node Configserver.

testConfigserver

NodeId

string

ID node Configserver.

dds-bp11483712c1****-cs

NodeStorage

integer

Ruang penyimpanan node Configserver. Satuan: GB.

20

Status

string

Status node ConfigServer. Untuk informasi selengkapnya, lihat Status instans.

Running

CurrentKernelVersion

string

Versi mesin minor node MongoDB.

mongodb_20220518_4.0.21

ResourceGroupId

string

ID kelompok sumber daya tempat instans berada.

Catatan

Parameter ini hanya dikembalikan di website Alibaba Cloud China (www.aliyun.com).

rg-acfmyiu4ekp****

ZoneId

string

ID zona instans.

cn-hangzhou-b

MaxConnections

integer

Jumlah maksimum koneksi ke instans.

500

DBInstanceId

string

ID instans.

dds-bp11483712c1****

DBInstanceClass

string

Tipe instans.

dds.mongo.mid

Engine

string

Mesin database.

MongoDB

ReadonlyReplicas

string

Jumlah node read-only dalam instans.

1

ReplicationFactor

string

Jumlah node dalam instans.

Catatan

Parameter ini dikembalikan jika instans merupakan instans set replika.

3

KindCode

string

Jenis instans. Nilai yang valid:

  • 0: Instans yang menggunakan disk lokal.

  • 3: Instans mandiri.

  • 18: Instans yang menggunakan disk cloud.

18

CapacityUnit

string

Throughput baca dan tulis yang dikonsumsi oleh instans.

100

ChargeType

string

Metode penagihan instans. Nilai yang valid:

  • PrePaid: langganan.

  • PostPaid: bayar sesuai penggunaan.

PostPaid

StorageType

string

Kelas penyimpanan. Nilai yang valid:

cloud_essd1: Disk ESSD (enhanced SSD) PL1. cloud_essd2: Disk ESSD PL2. cloud_essd3: Disk ESSD PL3. local_ssd: SSD lokal. cloud_essd_dbfs_s: Disk penyimpanan bersama berbasis DBFS.

cloud_essd1

DestroyTime

string

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

2021-12-10T16:00:00Z

DBInstanceOrderStatus

string

Status pesanan yang dibuat untuk instans. Nilai yang valid:

  • all_completed: Semua pesanan sedang diproses atau telah selesai.

  • order_unpaid: Instans memiliki pesanan yang belum dibayar.

  • order_wait_for_produce: Pesanan menunggu pemrosesan.

Catatan

Proses pemenuhan pesanan adalah sebagai berikut: Pesanan ditempatkan dan dibayar, diajukan untuk pemrosesan, lalu instans diproses.

  • Jika status pesanan tetap order_wait_for_produce dalam waktu lama, terjadi masalah selama pengajuan. Sistem akan mencoba ulang secara otomatis.

  • Status instans hanya berubah saat instans sedang diproses atau telah selesai. Misalnya, status berubah menjadi Upgrading atau Running.

all_completed

Encrypted

boolean

Menunjukkan apakah enkripsi disk diaktifkan.

true

EncryptionKey

string

ID kunci KMS yang digunakan untuk enkripsi disk.

07609cc3-3109-408f-a35e-c548e776da0b

SyncPercent

string

Progres sinkronisasi data dalam persentase. Saat instans menjalani perubahan konfigurasi, diperlukan sinkronisasi data. Anda dapat memeriksa parameter ini untuk melihat progres sinkronisasi.

0.8

UseClusterBackup

boolean

Menunjukkan apakah mode backup kluster diaktifkan. Nilai yang valid:

  • true: Mode backup kluster diaktifkan.

  • false: Mode backup kluster dinonaktifkan.

true

BurstingEnabled

boolean

Menunjukkan apakah fitur bursting diaktifkan.

true

ProvisionedIops

integer

Performa yang disediakan.

1960

DisasterRecoveryInfo

string

Informasi tentang instans sumber dan tujuan instans Cache Terdistribusi Global.

{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]}

SearchNodeClass

string

Spesifikasi node Search untuk perubahan konfigurasi.

mdb.shard.2x.xlarge.d

SearchNodeStorage

integer

Kapasitas penyimpanan node Search untuk perubahan konfigurasi.

20

SearchNodeCount

integer

Jumlah node Search untuk perubahan konfigurasi.

2

Contoh

Respons sukses

JSONformat

{
  "RequestId": "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "ReplicaSets": {
          "ReplicaSet": [
            {
              "VSwitchId": "vpc-bp1jk5vwkcri27qme****",
              "ConnectionPort": "3717",
              "ReplicaSetRole": "Primary",
              "ConnectionDomain": "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
              "VPCCloudInstanceId": "dds-bp11483712c1****",
              "NetworkType": "VPC",
              "VPCId": "vpc-bp1jk5vwkcri27qme****"
            }
          ]
        },
        "ReplacateId": "bls-m****",
        "Tags": {
          "Tag": [
            {
              "Key": "test",
              "Value": "api"
            }
          ]
        },
        "VpcAuthMode": "Open",
        "NetworkType": "VPC",
        "LockMode": "Unlock",
        "EngineVersion": "4.4",
        "MaxIOPS": 1000,
        "MaxMBPS": 350,
        "VPCCloudInstanceIds": "dds-bp11483712c1****",
        "MongosList": {
          "MongosAttribute": [
            {
              "VpcCloudInstanceId": "s-bp1d8c262a158****",
              "LockMode": "Unlock",
              "MaxIOPS": 800,
              "VSwitchId": "vsw-bp1vj604nj5a9zz74****",
              "NodeClass": "dds.mongos.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "VPCId": "vpc-bp1n3i15v90el48nx****",
              "ConnectSting": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com",
              "NodeDescription": "mongos1",
              "NodeId": "s-bp1d8c262a15****",
              "Status": "Running",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ConnectString": "s-bp1d8c262a15****.mongodb.rds.aliyuncs.com"
            }
          ]
        },
        "ProtocolType": "mongodb",
        "DBInstanceDescription": "测试数据库",
        "CurrentKernelVersion": "5.0.5-20220721143518_0",
        "DBInstanceReleaseProtection": false,
        "ExpireTime": "2022-02-05T16:00Z",
        "MaintainStartTime": "18:00Z",
        "DBInstanceType": "replicate",
        "LastDowngradeTime": "2022-01-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "LockMode": "Unlock",
              "MaxIOPS": 8000,
              "ConnectString": "d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:****",
              "NodeClass": "dds.shard.mid",
              "MaxConnections": 8000,
              "Port": 3717,
              "NodeDescription": "testshard",
              "NodeId": "d-bp16e09d9c5d****",
              "NodeStorage": 10,
              "ReadonlyReplicas": 0,
              "Status": "Running",
              "MaxDiskMbps": "350",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21",
              "ReplicaSetName": "mgset-xxxx"
            }
          ]
        },
        "MaintainEndTime": "03:00Z",
        "DBInstanceStatus": "Running",
        "VPCId": "vpc-bp1n3i15v90el48nx****",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 10,
        "ReplicaSetName": "mgset-10ace****",
        "VSwitchId": "vsw-bp1oo2a7isyrb8igf****",
        "StorageEngine": "WiredTiger",
        "ConfigserverList": {
          "ConfigserverAttribute": [
            {
              "MaxIOPS": 1000,
              "LockMode": "Unlock",
              "ConnectString": "dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com",
              "NodeClass": "dds.cs.mid",
              "MaxConnections": 1000,
              "Port": 3717,
              "NodeDescription": "testConfigserver",
              "NodeId": "dds-bp11483712c1****-cs",
              "NodeStorage": 20,
              "Status": "Running",
              "CurrentKernelVersion": "mongodb_20220518_4.0.21"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "MaxConnections": 500,
        "DBInstanceId": "dds-bp11483712c1****",
        "DBInstanceClass": "dds.mongo.mid",
        "Engine": "MongoDB",
        "ReadonlyReplicas": "1",
        "ReplicationFactor": "3",
        "KindCode": "18",
        "CapacityUnit": "100",
        "ChargeType": "PostPaid",
        "StorageType": "cloud_essd1",
        "DestroyTime": "2021-12-10T16:00:00Z",
        "DBInstanceOrderStatus": "all_completed",
        "Encrypted": true,
        "EncryptionKey": "07609cc3-3109-408f-a35e-c548e776da0b",
        "SyncPercent": "0.8",
        "UseClusterBackup": true,
        "BurstingEnabled": true,
        "ProvisionedIops": 1960,
        "DisasterRecoveryInfo": "{\"relations\":[{\"destInsName\":\"dds-bp11483712c1****\",\"destRegionId\":\"cn-hangzhou\",\"srcInsName\":\"dds-7xv054b9c43c****\",\"srcRegionId\":\"cn-guangzhou\"}]}",
        "SearchNodeClass": "mdb.shard.2x.xlarge.d",
        "SearchNodeStorage": 20,
        "SearchNodeCount": 2
      }
    ]
  }
}

Kode kesalahan

HTTP status code

Error code

Error message

Description

400 VpcCloudInstanceIdNumError Get vpcCloudInstanceId number error.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.