Consulte les informations relatives à une instance ApsaraDB for MongoDB.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
|
dds:DescribeDBInstanceAttribute |
get |
*dbinstance.
|
Aucune | Aucune |
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| Engine |
string |
Non |
Le moteur de base de données. Définissez la valeur sur MongoDB. |
MongoDB |
| DBInstanceId |
string |
Oui |
L'identifiant de l'instance. |
dds-bp11483712c1**** |
| ResourceGroupId |
string |
Non |
L'identifiant du groupe de ressources. Pour plus d'informations sur les groupes de ressources, consultez Afficher les informations de base d'un groupe de ressources. Remarque
Actuellement, seul le site China prend en charge ce paramètre. |
rg-acfmyiu4ekp**** |
| IsDelete |
boolean |
Non |
Indique si l'instance est supprimée. Valeurs valides :
|
false |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
Les détails de l'instance. |
||
| RequestId |
string |
L'identifiant de la requête. |
A935A8EE-A6CC-53DE-98BA-20ABAA7E632B |
| DBInstances |
object |
||
| DBInstance |
array<object> |
Les détails de l'instance. |
|
|
array<object> |
Les détails de l'instance. |
||
| CreationTime |
string |
L'heure de création de l'instance. L'heure suit le format yyyy-MM-ddTHH:mm:ssZ en UTC. |
2022-01-02T07:43:59Z |
| ReplicaSets |
object |
||
| ReplicaSet |
array<object> |
Informations sur les instances de jeu de réplicas. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un jeu de réplicas. |
|
|
object |
Informations sur les instances de jeu de réplicas. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un jeu de réplicas. |
||
| VSwitchId |
string |
L'identifiant du vSwitch. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ConnectionPort |
string |
Le port de connexion du nœud. |
3717 |
| ReplicaSetRole |
string |
Le rôle du nœud. Valeurs valides :
|
Primary |
| ConnectionDomain |
string |
L'adresse de connexion du nœud. |
dds-bp11483712c1****.mongodb.rds.aliyuncs.com |
| VPCCloudInstanceId |
string |
L'identifiant de l'instance VPC du nœud de l'ensemble de réplicas. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
dds-bp11483712c1**** |
| NetworkType |
string |
Le type de réseau. Valeurs valides :
|
VPC |
| VPCId |
string |
L'identifiant du VPC. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ReplacateId |
string |
L'identifiant logique de l'instance de cache distribué global. Remarque
MongoDB ne prend plus en charge l'achat de ce type d'instance. Ce paramètre s'applique uniquement aux anciennes instances de cache distribué global. |
bls-m**** |
| Tags |
object |
||
| Tag |
array<object> |
La liste des balises de l'instance. |
|
|
object |
La liste des balises de l'instance. |
||
| Key |
string |
La clé de balise de l'instance. |
test |
| Value |
string |
La valeur de balise de l'instance. |
api |
| VpcAuthMode |
string |
Le mode d'accès sans mot de passe sur le réseau interne. Valeurs valides :
|
Open |
| NetworkType |
string |
Le type de réseau de l'instance. Valeurs valides :
|
VPC |
| LockMode |
string |
L'état de verrouillage de l'instance. Valeurs valides :
|
Unlock |
| EngineVersion |
string |
La version majeure de la base de données. |
4.4 |
| MaxIOPS |
integer |
Le nombre maximal d'IOPS de l'instance. |
1000 |
| MaxMBPS |
integer |
Le débit maximal de disque de l'instance. Unité : Mo/s. |
350 |
| VPCCloudInstanceIds |
string |
L'identifiant de l'instance VPC. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. Important Ce paramètre est obsolète. |
dds-bp11483712c1**** |
| MongosList |
object |
||
| MongosAttribute |
array<object> |
La liste des informations sur les nœuds Mongos. Remarque
Ce paramètre n'est renvoyé que lorsque le type d'instance est un cluster fragmenté. |
|
|
object |
La liste des informations sur les nœuds Mongos. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un cluster fragmenté. |
||
| VpcCloudInstanceId |
string |
L'identifiant de l'instance VPC du nœud Mongos. |
s-bp1d8c262a158**** |
| LockMode |
string |
L'état de verrouillage de l'instance. Valeurs valides :
|
Unlock |
| MaxIOPS |
integer |
Le nombre maximal d'IOPS du nœud Mongos. |
800 |
| VSwitchId |
string |
L'identifiant du vSwitch. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
vsw-bp1vj604nj5a9zz74**** |
| NodeClass |
string |
Les spécifications du nœud Mongos. |
dds.mongos.mid |
| MaxConnections |
integer |
Le nombre maximal de connexions pour le nœud Mongos. |
1000 |
| Port |
integer |
Le port de connexion du nœud Mongos. |
3717 |
| VPCId |
string |
L'identifiant du VPC. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
vpc-bp1n3i15v90el48nx**** |
| ConnectSting |
string |
L'adresse de connexion du nœud Mongos. Avertissement Ce paramètre sera prochainement obsolète. Utilisez plutôt le paramètre ConnectString. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| NodeDescription |
string |
Le nom du nœud Mongos. |
mongos1 |
| NodeId |
string |
L'identifiant du nœud Mongos. |
s-bp1d8c262a15**** |
| Status |
string |
L'état du nœud Mongos. Pour plus d'informations, consultez le Tableau des états d'instance. |
Running |
| CurrentKernelVersion |
string |
La version mineure actuelle du noyau du nœud MongoDB. |
mongodb_20220518_4.0.21 |
| ConnectString |
string |
L'adresse de connexion du nœud Mongos. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| ProtocolType |
string |
Le type de protocole utilisé pour accéder à l'instance. Valeurs valides :
Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un cluster fragmenté. |
mongodb |
| DBInstanceDescription |
string |
Le nom de l'instance. |
Base de données de test |
| CurrentKernelVersion |
string |
La version mineure actuelle de la base de données. |
5.0.5-20220721143518_0 |
| DBInstanceReleaseProtection |
boolean |
Indique si la protection contre la libération est activée pour l'instance. Valeurs valides :
|
false |
| ExpireTime |
string |
L'heure d'expiration d'une instance par abonnement. L'heure suit le format yyyy-MM-ddTHH:mmZ en UTC. Remarque
Ce paramètre est renvoyé uniquement lorsque le mode de facturation est par abonnement. |
2022-02-05T16:00Z |
| MaintainStartTime |
string |
L'heure de début de la fenêtre de maintenance pour l'instance. L'heure suit le format HH:mmZ en UTC. |
18:00Z |
| DBInstanceType |
string |
Le type de l'instance. Valeurs valides :
|
replicate |
| LastDowngradeTime |
string |
La dernière fois que les spécifications de l'instance ont été réduites. |
2022-01-08 |
| ShardList |
object |
||
| ShardAttribute |
array<object> |
La liste des informations sur les nœuds de fragment. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un cluster fragmenté. |
|
|
object |
La liste des informations sur les nœuds de fragment. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un cluster fragmenté. |
||
| LockMode |
string |
Le mode de verrouillage du cluster. Valeurs valides :
|
Unlock |
| MaxIOPS |
integer |
Le nombre maximal d'IOPS du nœud de fragment. |
8000 |
| ConnectString |
string |
L'adresse de connexion du nœud de fragment. |
d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:**** |
| NodeClass |
string |
Les spécifications du nœud de fragment. |
dds.shard.mid |
| MaxConnections |
integer |
Le nombre maximal de connexions pour le nœud de fragment. |
8000 |
| Port |
integer |
Le port du nœud de fragment. |
3717 |
| NodeDescription |
string |
Le nom du nœud de fragment. |
testshard |
| NodeId |
string |
L'identifiant du nœud de fragment. |
d-bp16e09d9c5d**** |
| NodeStorage |
integer |
La capacité de stockage du nœud de fragment. Unité : Go. |
10 |
| ReadonlyReplicas |
integer |
Le nombre de nœuds en lecture seule dans le nœud de fragment. Valeurs valides : 0 à 5. |
0 |
| Status |
string |
L'état du nœud de fragment. Pour plus d'informations, consultez le Tableau des états d'instance. |
Running |
| MaxDiskMbps |
string |
Le débit maximal de disque du nœud de fragment. |
350 |
| CurrentKernelVersion |
string |
La version mineure actuelle du noyau du nœud MongoDB. |
mongodb_20220518_4.0.21 |
| ReplicaSetName |
string |
Le nom du nœud de fragment. |
mgset-xxxx |
| EcsIOPS |
integer |
||
| EbsIOPS |
integer |
||
| EcsBandwidth |
integer |
||
| EbsBandwidth |
integer |
||
| MaintainEndTime |
string |
L'heure de fin de la fenêtre de maintenance pour l'instance. L'heure suit le format HH:mmZ en UTC. |
03:00Z |
| DBInstanceStatus |
string |
L'état de l'instance. Pour plus d'informations, consultez le Tableau des états d'instance. |
Running |
| VPCId |
string |
L'identifiant du VPC. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
vpc-bp1n3i15v90el48nx**** |
| RegionId |
string |
L'identifiant de la région de l'instance. |
cn-hangzhou |
| DBInstanceStorage |
integer |
La capacité de stockage de l'instance. |
10 |
| ReplicaSetName |
string |
Le nom de l'instance d'ensemble de réplicas. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un ensemble de réplicas. |
mgset-10ace**** |
| VSwitchId |
string |
L'identifiant du vSwitch. Remarque
Ce paramètre est renvoyé uniquement lorsque le type de réseau de l'instance est VPC. |
vsw-bp1oo2a7isyrb8igf**** |
| StorageEngine |
string |
Le type de moteur de stockage de l'instance. |
WiredTiger |
| ConfigserverList |
object |
||
| ConfigserverAttribute |
array<object> |
La liste des informations des nœuds Configserver. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un cluster fragmenté. |
|
|
object |
La liste des informations sur les nœuds Configserver. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un cluster fragmenté. |
||
| MaxIOPS |
integer |
Le nombre maximal d'IOPS du nœud Configserver. |
1000 |
| LockMode |
string |
L'état de verrouillage de l'instance. Valeurs valides :
|
Unlock |
| ConnectString |
string |
L'adresse de connexion du nœud Configserver. |
dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com |
| NodeClass |
string |
Les spécifications du nœud Configserver. |
dds.cs.mid |
| MaxConnections |
integer |
Le nombre maximal de connexions pour le nœud Configserver. |
1000 |
| Port |
integer |
Le port du nœud Configserver. |
3717 |
| NodeDescription |
string |
Le nom du nœud Configserver. |
testConfigserver |
| NodeId |
string |
L'identifiant du nœud Configserver. |
dds-bp11483712c1****-cs |
| NodeStorage |
integer |
La capacité de stockage du nœud Configserver. Unité : Go. |
20 |
| Status |
string |
L'état du nœud ConfigServer. Pour plus d'informations, consultez le Tableau des états des instances. |
Running |
| CurrentKernelVersion |
string |
La version mineure actuelle du noyau du nœud MongoDB. |
mongodb_20220518_4.0.21 |
| ResourceGroupId |
string |
L'identifiant du groupe de ressources auquel l'instance appartient. Remarque
Ce paramètre est renvoyé uniquement sur le site Web d'Alibaba Cloud en Chine (www.aliyun.com). |
rg-acfmyiu4ekp**** |
| ZoneId |
string |
L'identifiant de la zone de l'instance. |
cn-hangzhou-b |
| MaxConnections |
integer |
Le nombre maximal de connexions pour l'instance. |
500 |
| DBInstanceId |
string |
L'identifiant de l'instance. |
dds-bp11483712c1**** |
| DBInstanceClass |
string |
Le type d'instance. |
dds.mongo.mid |
| Engine |
string |
Le moteur de base de données. |
MongoDB |
| ReadonlyReplicas |
string |
Le nombre de nœuds en lecture seule pour l'instance. |
1 |
| ReplicationFactor |
string |
Le nombre de nœuds dans l'instance. Remarque
Ce paramètre est renvoyé uniquement lorsque le type d'instance est un ensemble de réplicas. |
3 |
| KindCode |
string |
Le type de l'instance. Valeurs valides :
|
18 |
| CapacityUnit |
string |
Le débit de lecture et d'écriture consommé par l'instance. |
100 |
| ChargeType |
string |
Le mode de facturation de l'instance. Valeurs valides :
|
PostPaid |
| StorageType |
string |
La classe de stockage. Valeurs valides : cloud_essd1 : disque cloud ESSD PL1. cloud_essd2 : disque cloud ESSD PL2. cloud_essd3 : disque cloud ESSD PL3. local_ssd : disque local SSD. cloud_essd_dbfs_s : disque cloud de stockage partagé DBFS. |
cloud_essd1 |
| DestroyTime |
string |
L'heure à laquelle les données de l'instance sont détruites. L'heure suit le format yyyy-MM-ddTHH:mm:ssZ en UTC. |
2021-12-10T16:00:00Z |
| DBInstanceOrderStatus |
string |
L'état des commandes générées pour l'instance. Valeurs valides :
Remarque
Le flux de traitement des commandes comprend la passation de la commande, le paiement de celle-ci, son émission pour production, sa production et l'achèvement de la production.
|
all_completed |
| Encrypted |
boolean |
Indique si le chiffrement des disques est activé. |
true |
| EncryptionKey |
string |
La clé KMS utilisée pour le chiffrement des disques. |
07609cc3-3109-408f-a35e-c548e776da0b |
| SyncPercent |
string |
Le pourcentage de progression de la synchronisation des données. Lorsque l'instance subit des changements de spécifications, des opérations telles que la synchronisation des données se produisent. Vous pouvez utiliser ce champ pour surveiller la progression de la synchronisation. |
0.8 |
| UseClusterBackup |
boolean |
Indique si le mode de sauvegarde de cluster est activé. Valeurs valides :
|
true |
| BurstingEnabled |
boolean |
Indique si les performances en rafale sont activées. |
true |
| ProvisionedIops |
integer |
Les performances provisionnées. |
1960 |
| DisasterRecoveryInfo |
string |
Informations sur les instances source et de destination pour le Global Distributed Cache. |
{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]} |
| SearchNodeClass |
string |
Les spécifications du nœud Search pour les changements de spécifications. |
mdb.shard.2x.xlarge.d |
| SearchNodeStorage |
integer |
La capacité du nœud Search pour les changements de spécifications. |
20 |
| SearchNodeCount |
integer |
Le nombre de nœuds Search pour les changements de spécifications. |
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 |
Exemples
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": "Base de données de test",
"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
}
]
}
}
Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
Description |
|---|---|---|---|
| 400 | VpcCloudInstanceIdNumError | Get vpcCloudInstanceId number error. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.