Mengkueri informasi tentang instans Database Apsara for MongoDB.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dds:DescribeDBInstanceAttribute |
get |
*dbinstance
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| Engine |
string |
No |
Mesin database. Atur nilai menjadi MongoDB. |
MongoDB |
| DBInstanceId |
string |
Yes |
ID instans. |
dds-bp11483712c1**** |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya. Untuk informasi lebih lanjut tentang kelompok sumber daya, lihat Melihat informasi dasar kelompok sumber daya. Catatan
Saat ini, hanya situs China yang mendukung parameter ini. |
rg-acfmyiu4ekp**** |
| IsDelete |
boolean |
No |
Apakah instans dihapus. Nilai valid:
|
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 saat instance dibuat. Waktu mengikuti format yyyy-MM-ddTHH:mm:ssZ dalam UTC. |
2022-01-02T07:43:59Z |
| ReplicaSets |
object |
||
| ReplicaSet |
array<object> |
Informasi tentang instance replica set. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah replica set. |
|
|
object |
Informasi tentang instance replica set. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah replica set. |
||
| VSwitchId |
string |
ID vSwitch. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ConnectionPort |
string |
Port koneksi node. |
3717 |
| ReplicaSetRole |
string |
Peran node. Nilai yang valid:
|
Primary |
| ConnectionDomain |
string |
Alamat koneksi node. |
dds-bp11483712c1****.mongodb.rds.aliyuncs.com |
| VPCCloudInstanceId |
string |
ID instance VPC dari node replica set. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
dds-bp11483712c1**** |
| NetworkType |
string |
Tipe jaringan. Nilai yang valid:
|
VPC |
| VPCId |
string |
ID VPC. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ReplacateId |
string |
ID logis dari instance Global Distributed Cache. Catatan
MongoDB tidak lagi mendukung pembelian tipe instance ini. Parameter ini hanya berlaku untuk instance Global Distributed Cache lawas. |
bls-m**** |
| Tags |
object |
||
| Tag |
array<object> |
Daftar tag untuk instance. |
|
|
object |
Daftar tag untuk instance. |
||
| Key |
string |
Kunci tag dari instance. |
test |
| Value |
string |
Nilai tag dari instance. |
api |
| VpcAuthMode |
string |
Mode akses tanpa kata sandi melalui jaringan internal. Nilai yang valid:
|
Open |
| NetworkType |
string |
Tipe jaringan instance. Nilai yang valid:
|
VPC |
| LockMode |
string |
Status kunci instance. Nilai yang valid:
|
Unlock |
| EngineVersion |
string |
Versi mayor dari database. |
4.4 |
| MaxIOPS |
integer |
IOPS maksimum dari instance. |
1000 |
| MaxMBPS |
integer |
Throughput disk maksimum dari instance. Satuan: MB/d. |
350 |
| VPCCloudInstanceIds |
string |
ID instance VPC. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. Penting Parameter ini sudah usang. |
dds-bp11483712c1**** |
| MongosList |
object |
||
| MongosAttribute |
array<object> |
Daftar informasi node Mongos. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
|
|
object |
Daftar informasi node Mongos. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
||
| VpcCloudInstanceId |
string |
ID instance VPC dari node Mongos. |
s-bp1d8c262a158**** |
| LockMode |
string |
Status kunci instance. Nilai yang valid:
|
Unlock |
| MaxIOPS |
integer |
IOPS maksimum dari node Mongos. |
800 |
| VSwitchId |
string |
ID vSwitch. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
vsw-bp1vj604nj5a9zz74**** |
| NodeClass |
string |
Spesifikasi node Mongos. |
dds.mongos.mid |
| MaxConnections |
integer |
Jumlah maksimum koneksi untuk node Mongos. |
1000 |
| Port |
integer |
Port koneksi node Mongos. |
3717 |
| VPCId |
string |
ID VPC. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
vpc-bp1n3i15v90el48nx**** |
| ConnectSting |
string |
Alamat koneksi node Mongos. Peringatan Parameter ini akan segera usang. 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 Tabel status instance. |
Running |
| CurrentKernelVersion |
string |
Versi minor kernel saat ini dari node MongoDB. |
mongodb_20220518_4.0.21 |
| ConnectString |
string |
Alamat koneksi node Mongos. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| ProtocolType |
string |
Tipe protokol yang digunakan untuk mengakses instance. Nilai yang valid:
Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
mongodb |
| DBInstanceDescription |
string |
Nama instance. |
Test database |
| CurrentKernelVersion |
string |
Versi minor saat ini dari database. |
5.0.5-20220721143518_0 |
| DBInstanceReleaseProtection |
boolean |
Menunjukkan apakah proteksi rilis diaktifkan untuk instance. Nilai yang valid:
|
false |
| ExpireTime |
string |
Waktu kedaluwarsa dari instance langganan. Waktu mengikuti format yyyy-MM-ddTHH:mmZ dalam UTC. Catatan
Parameter ini hanya dikembalikan ketika metode penagihan adalah langganan. |
2022-02-05T16:00Z |
| MaintainStartTime |
string |
Waktu mulai jendela pemeliharaan untuk instance. Waktu mengikuti format HH:mmZ dalam UTC. |
18:00Z |
| DBInstanceType |
string |
Tipe instance. Nilai yang valid:
|
replicate |
| LastDowngradeTime |
string |
Waktu terakhir kali spesifikasi instance diturunkan. |
2022-01-08 |
| ShardList |
object |
||
| ShardAttribute |
array<object> |
Daftar informasi node shard. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
|
|
object |
Daftar informasi node shard. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
||
| LockMode |
string |
Mode kunci cluster. Nilai yang valid:
|
Unlock |
| MaxIOPS |
integer |
IOPS maksimum dari node shard. |
8000 |
| ConnectString |
string |
Alamat koneksi node shard. |
d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:**** |
| NodeClass |
string |
Spesifikasi node shard. |
dds.shard.mid |
| MaxConnections |
integer |
Jumlah maksimum koneksi untuk node shard. |
8000 |
| Port |
integer |
Port node shard. |
3717 |
| NodeDescription |
string |
Nama node shard. |
testshard |
| NodeId |
string |
ID node shard. |
d-bp16e09d9c5d**** |
| NodeStorage |
integer |
Kapasitas penyimpanan node shard. Satuan: GB. |
10 |
| ReadonlyReplicas |
integer |
Jumlah node read-only di node shard. Nilai yang valid: 0 sampai 5. |
0 |
| Status |
string |
Status node shard. Untuk informasi selengkapnya, lihat Tabel status instance. |
Running |
| MaxDiskMbps |
string |
Throughput disk maksimum dari node shard. |
350 |
| CurrentKernelVersion |
string |
Versi minor kernel saat ini dari node MongoDB. |
mongodb_20220518_4.0.21 |
| ReplicaSetName |
string |
Nama node shard. |
mgset-xxxx |
| EcsIOPS |
integer |
||
| EbsIOPS |
integer |
||
| EcsBandwidth |
integer |
||
| EbsBandwidth |
integer |
||
| MaintainEndTime |
string |
Waktu akhir jendela pemeliharaan untuk instance. Waktu mengikuti format HH:mmZ dalam UTC. |
03:00Z |
| DBInstanceStatus |
string |
Status instance. Untuk informasi selengkapnya, lihat Tabel status instance. |
Running |
| VPCId |
string |
ID VPC. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
vpc-bp1n3i15v90el48nx**** |
| RegionId |
string |
ID region dari instance. |
cn-hangzhou |
| DBInstanceStorage |
integer |
Kapasitas penyimpanan instance. |
10 |
| ReplicaSetName |
string |
Nama instance replica set. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah replica set. |
mgset-10ace**** |
| VSwitchId |
string |
ID vSwitch. Catatan
Parameter ini hanya dikembalikan ketika tipe jaringan instance adalah VPC. |
vsw-bp1oo2a7isyrb8igf**** |
| StorageEngine |
string |
Tipe mesin penyimpanan dari instance. |
WiredTiger |
| ConfigserverList |
object |
||
| ConfigserverAttribute |
array<object> |
Daftar informasi node Configserver. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
|
|
object |
Daftar informasi node Configserver. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah sharded cluster. |
||
| MaxIOPS |
integer |
IOPS maksimum dari node Configserver. |
1000 |
| LockMode |
string |
Status kunci instance. Nilai yang valid:
|
Unlock |
| ConnectString |
string |
Alamat koneksi node Configserver. |
dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com |
| NodeClass |
string |
Spesifikasi node Configserver. |
dds.cs.mid |
| MaxConnections |
integer |
Jumlah maksimum koneksi untuk 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 |
Kapasitas penyimpanan node Configserver. Satuan: GB. |
20 |
| Status |
string |
Status node ConfigServer. Untuk informasi selengkapnya, lihat Tabel status instance. |
Running |
| CurrentKernelVersion |
string |
Versi minor kernel saat ini dari node MongoDB. |
mongodb_20220518_4.0.21 |
| ResourceGroupId |
string |
ID grup sumber daya tempat instance berada. Catatan
Parameter ini hanya dikembalikan di Situs Web Alibaba Cloud China (www.aliyun.com). |
rg-acfmyiu4ekp**** |
| ZoneId |
string |
ID zona dari instance. |
cn-hangzhou-b |
| MaxConnections |
integer |
Jumlah maksimum koneksi untuk instance. |
500 |
| DBInstanceId |
string |
ID instance. |
dds-bp11483712c1**** |
| DBInstanceClass |
string |
Tipe instance. |
dds.mongo.mid |
| Engine |
string |
Mesin database. |
MongoDB |
| ReadonlyReplicas |
string |
Jumlah node read-only untuk instance. |
1 |
| ReplicationFactor |
string |
Jumlah node dalam instance. Catatan
Parameter ini hanya dikembalikan ketika tipe instance adalah replica set. |
3 |
| KindCode |
string |
Tipe instance. Nilai yang valid:
|
18 |
| CapacityUnit |
string |
Throughput baca dan tulis yang dikonsumsi oleh instance. |
100 |
| ChargeType |
string |
Metode penagihan instance. Nilai yang valid:
|
PostPaid |
| StorageType |
string |
Kelas penyimpanan. Nilai yang valid: cloud_essd1: ESSD PL1 cloud disk. cloud_essd2: ESSD PL2 cloud disk. cloud_essd3: ESSD PL3 cloud disk. local_ssd: SSD local disk. cloud_essd_dbfs_s: DBFS shared storage cloud disk. |
cloud_essd1 |
| DestroyTime |
string |
Waktu saat data instance dihancurkan. Waktu mengikuti format yyyy-MM-ddTHH:mm:ssZ dalam UTC. |
2021-12-10T16:00:00Z |
| DBInstanceOrderStatus |
string |
Status pesanan yang dihasilkan untuk instance. Nilai yang valid:
Catatan
Alur pemrosesan pesanan meliputi penempatan pesanan, pembayaran pesanan, penerbitan pesanan untuk produksi, produksi pesanan, dan penyelesaian produksi.
|
all_completed |
| Encrypted |
boolean |
Menunjukkan apakah enkripsi disk diaktifkan. |
true |
| EncryptionKey |
string |
Kunci KMS yang digunakan untuk enkripsi disk. |
07609cc3-3109-408f-a35e-c548e776da0b |
| SyncPercent |
string |
Persentase progres sinkronisasi data. Ketika instance sedang mengalami perubahan spesifikasi, operasi seperti sinkronisasi data terjadi. Anda dapat menggunakan kolom ini untuk memantau progres sinkronisasi. |
0.8 |
| UseClusterBackup |
boolean |
Menunjukkan apakah mode pencadangan cluster diaktifkan. Nilai yang valid:
|
true |
| BurstingEnabled |
boolean |
Menunjukkan apakah performa burst diaktifkan. |
true |
| ProvisionedIops |
integer |
Performa yang disediakan. |
1960 |
| DisasterRecoveryInfo |
string |
Informasi tentang instance sumber dan tujuan untuk Global Distributed Cache. |
{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]} |
| SearchNodeClass |
string |
Spesifikasi node Search untuk perubahan spesifikasi. |
mdb.shard.2x.xlarge.d |
| SearchNodeStorage |
integer |
Kapasitas node Search untuk perubahan spesifikasi. |
20 |
| SearchNodeCount |
integer |
Jumlah node Search untuk perubahan spesifikasi. |
2 |
| ColdDataEnabled |
boolean |
||
| AIGatewayEnabled |
boolean |
||
| ShardSearchNodes |
object |
||
| ShardSearchNodes |
array<object> |
||
|
object |
|||
| NodeId |
string |
||
| SearchNodeId |
string |
||
| SearchNodeClass |
string |
||
| SearchNodeStorage |
string |
||
| SearchNodeCount |
string |
||
| EcsIOPS |
integer |
||
| EbsIOPS |
integer |
||
| EcsBandwidth |
integer |
||
| EbsBandwidth |
integer |
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": "Test database",
"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",
"EcsIOPS": 0,
"EbsIOPS": 0,
"EcsBandwidth": 0,
"EbsBandwidth": 0
}
]
},
"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,
"ColdDataEnabled": false,
"AIGatewayEnabled": false,
"ShardSearchNodes": {
"ShardSearchNodes": [
{
"NodeId": "",
"SearchNodeId": "",
"SearchNodeClass": "",
"SearchNodeStorage": "",
"SearchNodeCount": ""
}
]
},
"EcsIOPS": 0,
"EbsIOPS": 0,
"EcsBandwidth": 0,
"EbsBandwidth": 0
}
]
}
}
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.