Bir ApsaraDB for MongoDB örneğinin bilgilerini sorgular.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dds:DescribeDBInstanceAttribute |
get |
*dbinstance.
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Engine |
string |
No |
Veritabanı motoru. Değeri MongoDB olarak ayarlayın. Valid values:
|
MongoDB |
| DBInstanceId |
string |
Yes |
Örnek kimliği. |
dds-bp11483712c1**** |
| ResourceGroupId |
string |
No |
Kaynak grubu kimliği. Kaynak grupları hakkında daha fazla bilgi için bkz. Kaynak grubunun temel bilgilerini görüntüleme.\n>Bu parametre yalnızca Çin sitesinde desteklenir. |
rg-acfmyiu4ekp**** |
| IsDelete |
boolean |
No |
Örneğin silinip silinmediğini belirtir. Geçerli değerler:\n- false: Örnek çalışıyor durumdadır. Çalışan bir örneğin bilgilerini sorgular.\n- true: Örnek silinmiş durumdadır. Silinmiş bir örneğin bilgilerini sorgular. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Örnek ayrıntıları. |
||
| RequestId |
string |
İstek kimliği. |
A935A8EE-A6CC-53DE-98BA-20ABAA7E632B |
| DBInstances |
object |
||
| DBInstance |
array<object> |
Örnek ayrıntıları. |
|
|
array<object> |
Örnek ayrıntıları. |
||
| CreationTime |
string |
Örneğin oluşturulduğu zaman. Saat, yyyy-MM-ddTHH:mm:ssZ biçimindedir (UTC saati). |
2022-01-02T07:43:59Z |
| ReplicaSets |
object |
||
| ReplicaSet |
array<object> |
Replika kümesi örnek bilgileri. Not
Bu parametre, örnek türü replika kümesi olduğunda döndürülür. |
|
|
object |
Replika kümesi örnek bilgileri. Not
Bu parametre, örnek türü replika kümesi olduğunda döndürülür. |
||
| VSwitchId |
string |
vSwitch kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
vpc-bp1jk5vwkcri27qme**** |
| ConnectionPort |
string |
Düğümün bağlantı noktası. |
3717 |
| ReplicaSetRole |
string |
Düğümün rolü. Geçerli değerler:
|
Primary |
| ConnectionDomain |
string |
Düğümün uç noktası. |
dds-bp11483712c1****.mongodb.rds.aliyuncs.com |
| VPCCloudInstanceId |
string |
Replika kümesi düğümünün VPC örnek kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
dds-bp11483712c1**** |
| NetworkType |
string |
Ağ türü. Geçerli değerler:
|
VPC |
| VPCId |
string |
VPC kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
vpc-bp1jk5vwkcri27qme**** |
| ReplacateId |
string |
Küresel çoklu etkin örneğin mantıksal kimliği. Not
MongoDB artık bu örnek türünün satın alınmasını desteklememektedir. Bu parametre yalnızca eski küresel çoklu etkin örnekler için geçerlidir. |
bls-m**** |
| Tags |
object |
||
| Tag |
array<object> |
Örneğin etiket listesi. |
|
|
object |
Örneğin etiket listesi. |
||
| Key |
string |
Örneğin etiket anahtarı. |
test |
| Value |
string |
Örneğin etiket değeri. |
api |
| VpcAuthMode |
string |
Özel ağ üzerinden şifresiz erişim modu. Geçerli değerler:
|
Open |
| NetworkType |
string |
Örneğin ağ türü. Geçerli değerler:
|
VPC |
| LockMode |
string |
Örneğin kilit durumu. Geçerli değerler:
|
Unlock |
| EngineVersion |
string |
Ana veritabanı motoru sürümü. |
4.4 |
| MaxIOPS |
integer |
Örneğin maksimum IOPS değeri. |
1000 |
| MaxMBPS |
integer |
Örneğin maksimum bulut diski aktarım hızı. Birim: MB/s. |
350 |
| VPCCloudInstanceIds |
string |
VPC örneğinin kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. Önemli Bu parametre kullanımdan kaldırılmıştır. |
dds-bp11483712c1**** |
| MongosList |
object |
||
| MongosAttribute |
array<object> |
Mongos düğümü bilgilerinin listesi. Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
|
|
object |
Mongos düğümü bilgilerinin listesi. Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
||
| VpcCloudInstanceId |
string |
Mongos düğümünün VPC örnek kimliği. |
s-bp1d8c262a158**** |
| LockMode |
string |
Örneğin kilit durumu. Geçerli değerler:
|
Unlock |
| MaxIOPS |
integer |
Mongos düğümünün maksimum IOPS değeri. |
800 |
| VSwitchId |
string |
vSwitch kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
vsw-bp1vj604nj5a9zz74**** |
| NodeClass |
string |
Mongos düğümünün örnek türü. |
dds.mongos.mid |
| MaxConnections |
integer |
Mongos düğümü için maksimum bağlantı sayısı. |
1000 |
| Port |
integer |
Mongos düğümünün bağlantı noktası. |
3717 |
| VPCId |
string |
VPC kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
vpc-bp1n3i15v90el48nx**** |
| ConnectSting |
string |
Mongos düğümünün uç noktası. Uyarı Bu parametre kullanımdan kaldırılacaktır. Yerine ConnectString parametresini kullanın. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| NodeDescription |
string |
Mongos düğümünün adı. |
mongos1 |
| NodeId |
string |
Mongos düğümünün kimliği. |
s-bp1d8c262a15**** |
| Status |
string |
Mongos düğümünün durumu. Daha fazla bilgi için Örnek durum tablosu sayfasına bakın. |
Running |
| CurrentKernelVersion |
string |
MongoDB düğümünün mevcut alt motor sürümü. |
mongodb_20220518_4.0.21 |
| ConnectString |
string |
Mongos düğümünün uç noktası. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| ProtocolType |
string |
Örneğin erişim protokolü türü. Geçerli değerler:
Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
mongodb |
| DBInstanceDescription |
string |
Örnek adı. |
Test database |
| CurrentKernelVersion |
string |
Örnek veritabanının mevcut alt motor sürümü. |
5.0.5-20220721143518_0 |
| DBInstanceReleaseProtection |
boolean |
Örnek için silme korumasının etkinleştirilip etkinleştirilmediğini gösterir. Geçerli değerler:
|
false |
| ExpireTime |
string |
Abonelik örneğinin sona erme zamanı. Saat, yyyy-MM-ddTHH:mmZ biçimindedir (UTC saati). Not
Bu parametre, örneğin faturalandırma yöntemi abonelik olduğunda döndürülür. |
2022-02-05T16:00Z |
| MaintainStartTime |
string |
Bakım penceresinin başlangıç saati. Saat, HH:mmZ biçimindedir (UTC saati). |
18:00Z |
| DBInstanceType |
string |
Örnek türü. Geçerli değerler:
|
replicate |
| LastDowngradeTime |
string |
Örneğin en son düşürüldüğü zaman. Saat, YYYY-MM-DD biçimindedir. |
2022-01-08 |
| ShardList |
object |
||
| ShardAttribute |
array<object> |
Shard düğümü bilgilerinin listesi. Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
|
|
object |
Shard düğümü bilgilerinin listesi. Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
||
| LockMode |
string |
Kümenin kilit modu. Geçerli değerler:
|
Unlock |
| MaxIOPS |
integer |
Shard düğümünün maksimum IOPS değeri. |
8000 |
| ConnectString |
string |
Shard düğümünün uç noktası. |
d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:**** |
| NodeClass |
string |
Shard düğümünün örnek türü. |
dds.shard.mid |
| MaxConnections |
integer |
Shard düğümü için maksimum bağlantı sayısı. |
8000 |
| Port |
integer |
Shard düğümünün bağlantı noktası. |
3717 |
| NodeDescription |
string |
Shard düğümünün adı. |
testshard |
| NodeId |
string |
Shard düğümünün kimliği. |
d-bp16e09d9c5d**** |
| NodeStorage |
integer |
Shard düğümünün depolama kapasitesi. Birim: GB. |
10 |
| ReadonlyReplicas |
integer |
Shard düğümündeki salt okunur düğüm sayısı. Geçerli değerler: 0 ile 5 arası (tam sayılar). |
0 |
| Status |
string |
Shard düğümünün durumu. Daha fazla bilgi için Örnek durum tablosu sayfasına bakın. |
Running |
| MaxDiskMbps |
string |
Shard düğümünün maksimum bulut diski aktarım hızı. |
350 |
| CurrentKernelVersion |
string |
MongoDB düğümünün mevcut alt motor sürümü. |
mongodb_20220518_4.0.21 |
| ReplicaSetName |
string |
Shard düğümünün adı. |
mgset-xxxx |
| EcsIOPS |
integer |
Ana makine IOPS değeri. |
0 |
| EbsIOPS |
integer |
Disk IOPS değeri. |
0 |
| EcsBandwidth |
integer |
MB/s cinsinden ana makine aktarım hızı. |
0 |
| EbsBandwidth |
integer |
MB/s cinsinden ana makine aktarım hızı. |
0 |
| MaintainEndTime |
string |
Bakım penceresinin bitiş saati. Saat, HH:mmZ biçimindedir (UTC saati). |
03:00Z |
| DBInstanceStatus |
string |
Örnek durumu. Daha fazla bilgi için Örnek durum tablosu sayfasına bakın. |
Running |
| VPCId |
string |
VPC kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
vpc-bp1n3i15v90el48nx**** |
| RegionId |
string |
Örneğin bölge kimliği. |
cn-hangzhou |
| DBInstanceStorage |
integer |
Örnek depolama alanı. |
10 |
| ReplicaSetName |
string |
Replika kümesi örneğinin adı. Not
Bu parametre, örnek türü replika kümesi olduğunda döndürülür. |
mgset-10ace**** |
| VSwitchId |
string |
vSwitch kimliği. Not
Bu parametre, örneğin ağ türü VPC olduğunda döndürülür. |
vsw-bp1oo2a7isyrb8igf**** |
| StorageEngine |
string |
Örneğin depolama motoru türü. |
WiredTiger |
| ConfigserverList |
object |
||
| ConfigserverAttribute |
array<object> |
Configserver düğüm bilgilerinin listesi. Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
|
|
object |
Configserver düğümlerinin bilgi listesi. Not
Bu parametre, örnek türü parçalı küme olduğunda döndürülür. |
||
| MaxIOPS |
integer |
Configserver düğümünün maksimum IOPS değeri. |
1000 |
| LockMode |
string |
Örneğin kilit durumu. Geçerli değerler:
|
Unlock |
| ConnectString |
string |
Configserver düğümünün uç noktası. |
dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com |
| NodeClass |
string |
Configserver düğümünün teknik özellikleri. |
dds.cs.mid |
| MaxConnections |
integer |
Configserver düğümü için maksimum bağlantı sayısı. |
1000 |
| Port |
integer |
Configserver düğümünün bağlantı noktası. |
3717 |
| NodeDescription |
string |
Configserver düğümünün adı. |
testConfigserver |
| NodeId |
string |
Configserver düğümünün kimliği. |
dds-bp11483712c1****-cs |
| NodeStorage |
integer |
Configserver düğümünün depolama kapasitesi. Birim: GB. |
20 |
| Status |
string |
ConfigServer düğümünün durumu. Daha fazla bilgi için Örnek durum tablosu sayfasına bakın. |
Running |
| CurrentKernelVersion |
string |
MongoDB düğümünün mevcut alt motor sürümü. |
mongodb_20220518_4.0.21 |
| ResourceGroupId |
string |
Örneğin ait olduğu kaynak grubunun kimliği. Not
Bu parametre şu anda yalnızca Çin sitesinde döndürülmektedir. |
rg-acfmyiu4ekp**** |
| ZoneId |
string |
Örneğin ait olduğu bölgenin kimliği. |
cn-hangzhou-b |
| MaxConnections |
integer |
Örnek için maksimum bağlantı sayısı. |
500 |
| DBInstanceId |
string |
Örnek kimliği. |
dds-bp11483712c1**** |
| DBInstanceClass |
string |
Örnek türü. |
dds.mongo.mid |
| Engine |
string |
Veritabanı motoru. |
MongoDB |
| ReadonlyReplicas |
string |
Örnekteki salt okunur düğüm sayısı. |
1 |
| ReplicationFactor |
string |
Örnekteki düğüm sayısı. Not
Bu parametre, örnek türü replika kümesi olduğunda döndürülür. |
3 |
| KindCode |
string |
Örneğin türü. Geçerli değerler:
|
18 |
| CapacityUnit |
string |
Örnek tarafından tüketilen okuma ve yazma aktarım hızı. |
100 |
| ChargeType |
string |
Örneğin faturalandırma yöntemi. Geçerli değerler:
|
PostPaid |
| StorageType |
string |
Depolama türü. Geçerli değerler: cloud_essd1: PL1 ESSD. cloud_essd2: PL2 ESSD. cloud_essd3: PL3 ESSD. local_ssd: Yerel SSD. cloud_essd_dbfs_s: DBFS paylaşımlı depolama bulut diski. |
cloud_essd1 |
| DestroyTime |
string |
Örnek verilerinin silinme zamanı, yyyy-MM-ddTHH:mm:ssZ biçiminde (UTC). |
2021-12-10T16:00:00Z |
| DBInstanceOrderStatus |
string |
Örnek için oluşturulan siparişlerin durumu. Geçerli değerler:
Not
Sipariş işleme iş akışı şu şekilde ilerler: sipariş verme, sipariş ödeme, siparişi işleme gönderme, siparişi işleme ve siparişi tamamlama.
|
all_completed |
| Encrypted |
boolean |
Bulut diski şifrelemesinin etkinleştirilip etkinleştirilmediğini belirtir. |
true |
| EncryptionKey |
string |
Bulut diski şifrelemesi için kullanılan KMS anahtarı. |
07609cc3-3109-408f-a35e-c548e776da0b |
| SyncPercent |
string |
Yüzde olarak veri senkronizasyon ilerlemesi. Örnek değiştirilirken veri senkronizasyonu gibi işlemler gereklidir. Senkronizasyon ilerlemesini kontrol etmek için bu alanı kullanın. |
0.8 |
| UseClusterBackup |
boolean |
Küme yedekleme modunun etkinleştirilip etkinleştirilmediğini belirtir. Geçerli değerler:
|
true |
| BurstingEnabled |
boolean |
G/Ç burst özelliğinin etkinleştirilip etkinleştirilmediğini belirtir. |
true |
| ProvisionedIops |
integer |
Sağlanan performans. |
1960 |
| DisasterRecoveryInfo |
string |
Küresel aktif coğrafi yedeklilik için kaynak örnek ve hedef örnek bilgileri. |
{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]} |
| SearchNodeClass |
string |
Teknik özellik değişikliğinden sonraki Search düğümünün teknik özellikleri. |
mdb.shard.2x.xlarge.d |
| SearchNodeStorage |
integer |
Teknik özellik değişikliğinden sonraki Search düğümünün depolama kapasitesi. |
20 |
| SearchNodeCount |
integer |
Teknik özellik değişikliğinden sonraki Search düğümü sayısı. |
2 |
| ColdDataEnabled |
boolean |
Soğuk veri arşivleme özelliğinin etkinleştirilip etkinleştirilmediğini belirtir. |
|
| AIGatewayEnabled |
boolean |
Örnek için AI ağ geçidinin etkinleştirilip etkinleştirilmediğini belirtir. |
|
| ShardSearchNodes |
object |
||
| ShardSearchNodes |
array<object> |
Parçalı küme örneğindeki her Shard düğümüyle ilişkili Search düğümü bilgilerinin listesi. |
|
|
object |
|||
| NodeId |
string |
Shard düğümünün kimliği. |
|
| SearchNodeId |
string |
Search düğümünün kimliği. |
|
| SearchNodeClass |
string |
Search düğümünün teknik özellikleri. |
|
| SearchNodeStorage |
string |
Search düğümünün depolama kapasitesi. |
|
| SearchNodeCount |
string |
Search düğümü sayısı. |
|
| EcsIOPS |
integer |
Ana makine IOPS değeri. |
0 |
| EbsIOPS |
integer |
Disk IOPS değeri. |
0 |
| EcsBandwidth |
integer |
MB/s cinsinden ana makine aktarım hızı. |
0 |
| EbsBandwidth |
integer |
MB/s cinsinden disk aktarım hızı. |
0 |
Examples
Success response
JSON format
{
"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
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | VpcCloudInstanceIdNumError | Get vpcCloudInstanceId number error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.