Gunakan DescribeDBInstances untuk menanyakan instans MongoDB - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri daftar instans MongoDB.

Deskripsi operasi

Secara default, operasi ini mengkueri daftar instans replica set (termasuk instans node tunggal). Jika parameter permintaan DBInstanceType tidak ditentukan, nilai default parameter ini adalah replicate. Untuk mengkueri daftar instans kluster sharded, atur DBInstanceType menjadi 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

*Instans.

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

*Instans.

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

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. Nilai harus berupa bilangan bulat positif yang tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 30 (default) 50 100 Valid values: 30 : 30 entri per halaman. 50 : 50 entri per halaman. 100 : 100 entri per halaman.	30
DBInstanceId	string	No	ID instans.	dds-bp199659b178****
ReplicationFactor	string	No	Jumlah node dalam instans replica set. Nilai valid: 3 5 7	3
DBInstanceDescription	string	No	Nama instans. Nama harus memenuhi persyaratan berikut: Harus diawali dengan karakter Mandarin atau huruf. Dapat berisi angka, karakter Mandarin, huruf, garis bawah (_), dan tanda hubung (-). Panjangnya harus 2 hingga 256 karakter.	TestDatabase
ExpireTime	string	No	Waktu kedaluwarsa instans dalam format yyyy-MM-ddTHH:mm:ssZ (UTC). Parameter ini digunakan untuk memfilter instans yang waktu kedaluwarsanya lebih awal dari atau sama dengan waktu yang ditentukan.	2019-12-26T16:00:00Z
DBInstanceStatus	string	No	Status instans. Untuk detail lebih lanjut mengenai nilai valid, lihat Tabel status instans.	Running
DBInstanceType	string	No	Tipe instans. Nilai valid: sharding: instans kluster sharded. replicate: nilai default. Instans replica set atau instans node tunggal.	sharding
DBInstanceClass	string	No	Spesifikasi instans. Untuk informasi lebih lanjut mengenai nilai valid, lihat Spesifikasi instans.	dds.mongo.mid
Engine	string	No	Mesin database. Atur nilainya menjadi MongoDB. Valid values: MongoDB : Mesin database MongoDB.	MongoDB
EngineVersion	string	No	Versi mesin database. Nilai valid: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.0
NetworkType	string	No	Jenis jaringan instans. Nilai valid: Classic: jaringan klasik. VPC: VPC.	VPC
VpcId	string	No	ID VPC.	vpc-bp1n3i15v90el48nx****
VSwitchId	string	No	ID vSwitch VPC.	vsw-bp1vj604nj5a9zz74****
ChargeType	string	No	Metode penagihan instans. Nilai valid: PrePaid: langganan. PostPaid: bayar sesuai pemakaian.	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 valid: true: kedaluwarsa. false: 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.
	object	No
Key	string	No	Kunci tag instans. Nilai valid untuk N: 1 hingga 20. Kunci tag tidak dapat diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`. Panjang kunci tag dapat mencapai 64 karakter. Kunci tag tidak boleh berupa string kosong.	testdatabase
Value	string	No	Nilai tag instans. Nilai valid untuk N: 1 hingga 20. Nilai tag tidak dapat diawali dengan `aliyun`, `acs:`, `http://`, atau `https://`. Panjang nilai tag dapat mencapai 128 karakter. Nilai tag dapat berupa string kosong.	apitest
DBNodeType	string	No	Apakah akan memfilter instans standar atau uji coba. Instans node tunggal dan instans DBFS: customized Instans standar (replica set dan kluster sharded): standard Default (menampilkan semua instans): default	default

Elemen respons

Element	Type	Description	Example
	object
TotalCount	integer	Jumlah instans dalam hasil kueri.	5
RequestId	string	ID permintaan.	0E4FE33F-5510-5758-8FA7-A6672CDE****
PageSize	integer	Jumlah rekaman per halaman.	30
PageNumber	integer	Nomor halaman.	1
DBInstances	object
DBInstance	array<object>	Daftar informasi instans.
	array<object>
CreationTime	string	Waktu pembuatan instans. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC).	2021-03-25T02:18:00Z
ChargeType	string	Metode penagihan instans. Nilai valid: PrePaid: langganan. PostPaid: bayar sesuai pemakaian.	PrePaid
Tags	object
Tag	array<object>	Daftar tag sumber daya.
	object	Daftar tag sumber daya.
Key	string	Kunci tag sumber daya.	test
Value	string	Nilai tag sumber daya.	api
VpcAuthMode	string	Apakah akses tanpa kata sandi melalui VPC diaktifkan. Nilai valid: Open: diaktifkan. Close: dinonaktifkan.	Close
NetworkType	string	Jenis jaringan instans. Nilai valid: Classic: jaringan klasik. VPC: VPC.	Classic
LockMode	string	Status kunci instans. Nilai valid: Unlock: Instans tidak terkunci. ManualLock: Instans dikunci secara manual. LockByExpiration: Instans dikunci secara otomatis karena telah kedaluwarsa. LockByRestoration: Instans dikunci secara otomatis sebelum rollback. LockByDiskQuota: Instans dikunci secara otomatis karena penyimpanan penuh. Released: Instans telah dilepas. Dalam hal ini, instans tidak dapat dibuka kuncinya. Anda hanya dapat menggunakan data cadangan untuk membuat instans baru. Proses pembangunan ulang memakan waktu lama.	Unlock
EngineVersion	string	Versi mesin database. Nilai valid: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
MongosList	object
MongosAttribute	array<object>	Daftar informasi node Mongos (Proxy Layanan). Catatan Parameter ini dikembalikan ketika tipe instans adalah instans kluster sharded.
	object	Daftar informasi node Mongos (Proxy Layanan). Catatan Parameter ini dikembalikan ketika tipe instans adalah instans kluster sharded.
NodeClass	string	Spesifikasi node Mongos (Proxy Layanan).	dds.mongos.standard
NodeDescription	string	Deskripsi node Mongos (Proxy Layanan).	Uji node Mongos (Proxy Layanan)
NodeId	string	ID node Mongos (Proxy Layanan).	s-bp10e3b0d02f****
DBInstanceDescription	string	Deskripsi atau catatan instans.	TestDatabase
ExpireTime	string	Waktu ketika instans kedaluwarsa. Waktu dalam format yyyy-MM-ddTHH:mmZ (UTC).	2021-11-25T16:00Z
DBInstanceType	string	Tipe instans. Nilai valid: sharding: instans kluster sharded. replicate: instans replica set atau instans mandiri.	sharding
LastDowngradeTime	string	Waktu terakhir instans diturunkan spesifikasinya. Waktu dalam format YYYY-MM-DD.	2021-05-08
ShardList	object
ShardAttribute	array<object>	Daftar informasi node shard. Catatan Parameter ini dikembalikan ketika tipe instans adalah instans kluster sharded.
	object	Daftar informasi node shard. Catatan Parameter ini dikembalikan ketika tipe instans adalah instans kluster sharded.
NodeClass	string	Tipe instans node shard.	dds.shard.mid
NodeDescription	string	Deskripsi node shard.	Uji node shard
NodeStorage	integer	Kapasitas penyimpanan node shard. Unit: GB.	10
NodeId	string	ID node shard.	d-bp1cac6f2083****
ReadonlyReplicas	integer	Jumlah node baca-saja dalam node shard. Nilai valid: 0 hingga 5.	2
DestroyTime	string	Waktu penghancuran data instans. Waktu dalam format yyyy-MM-ddTHH:mm:ssZ (UTC). Catatan Untuk instans langganan, sumber daya komputasi dilepas pada hari ke-16 setelah instans kedaluwarsa, dan data dipertahankan selama 7 hari lagi. Pada hari ke-23 setelah instans kedaluwarsa, data dihapus dan tidak dapat dipulihkan. Untuk instans bayar sesuai pemakaian, sumber daya komputasi dilepas pada hari ke-16 setelah instans mengalami pembayaran tertunda, dan data dipertahankan selama 7 hari lagi. Pada hari ke-23 setelah pembayaran tertunda, data dihapus dan tidak dapat dipulihkan.	2021-12-10T16:00:00Z
DBInstanceStatus	string	Status instans. Untuk detail, lihat Tabel status instans.	Running
RegionId	string	ID wilayah instans.	cn-hangzhou
DBInstanceStorage	integer	Kapasitas penyimpanan 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	Mesin database.	MongoDB
ReplicationFactor	string	Jumlah node dalam instans. Catatan Parameter ini dikembalikan ketika tipe instans adalah instans replica set.	3
KindCode	string	Tipe instans. Nilai valid: 0: mesin fisik. 1: ECS. 2: DOCKER. 18: instans arsitektur baru berbasis Kubernetes.	1
CapacityUnit	string	Throughput baca/tulis yang dikonsumsi oleh instans. Catatan Parameter ini dikembalikan ketika tipe instans adalah instans arsitektur tanpa server.	100
StorageType	string	Tipe penyimpanan. Nilai valid: cloud_essd: cloud disk ESSD. local_ssd: SSD standar lokal.	local_ssd
BackupRetentionPolicy	integer	Kebijakan retensi data cadangan. Nilai valid: 0: Semua set cadangan segera dihapus saat instans dilepas. 1: Cadangan otomatis dilakukan saat instans dilepas, dan set cadangan dipertahankan untuk retensi jangka panjang (LTR). 2: Cadangan otomatis dilakukan saat instans dilepas, dan semua set cadangan kluster dipertahankan untuk retensi jangka panjang (LTR).	1
ReleaseTime	string	Waktu instans dilepas. Waktu dalam format YYYY-MM-DDTHH:mmZ (UTC).	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": "测试mongos节点",
              "NodeId": "s-bp10e3b0d02f****"
            }
          ]
        },
        "DBInstanceDescription": "测试数据库",
        "ExpireTime": "2021-11-25T16:00Z",
        "DBInstanceType": "sharding",
        "LastDowngradeTime": "2021-05-08",
        "ShardList": {
          "ShardAttribute": [
            {
              "NodeClass": "dds.shard.mid",
              "NodeDescription": "测试shard节点",
              "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.