Consulta la información de una instancia de ApsaraDB for MongoDB.
Pruébelo ahora
Test
Autorización de RAM
|
Action |
Nivel de acceso |
Tipo de recurso |
Clave de condición |
Acción dependiente |
|
dds:DescribeDBInstanceAttribute |
get |
*dbinstance
|
Ninguna | Ninguna |
Parámetros de la solicitud
|
Parámetro |
Tipo |
Obligatorio |
Descripción |
Ejemplo |
| Engine |
string |
No |
El motor de base de datos. Establezca el valor en MongoDB. Valores válidos:
|
MongoDB |
| DBInstanceId |
string |
Sí |
El ID de la instancia. |
dds-bp11483712c1**** |
| ResourceGroupId |
string |
No |
El ID del grupo de recursos. Para obtener más información sobre los grupos de recursos, consulte Ver información básica de un grupo de recursos. Nota
Este parámetro solo se admite en el sitio de China. |
rg-acfmyiu4ekp**** |
| IsDelete |
boolean |
No |
Especifica si la instancia está eliminada. Valores válidos:
|
false |
Elementos de la respuesta
|
Elemento |
Tipo |
Descripción |
Ejemplo |
|
object |
Los detalles de la instancia. |
||
| RequestId |
string |
El ID de la solicitud. |
A935A8EE-A6CC-53DE-98BA-20ABAA7E632B |
| DBInstances |
object |
||
| DBInstance |
array<object> |
Los detalles de la instancia. |
|
|
array<object> |
Los detalles de la instancia. |
||
| CreationTime |
string |
La hora en que se creó la instancia. La hora está en el formato yyyy-MM-ddTHH:mm:ssZ (hora UTC). |
2022-01-02T07:43:59Z |
| ReplicaSets |
object |
||
| ReplicaSet |
array<object> |
La información de la instancia de conjunto de réplicas. Nota
Este parámetro se devuelve cuando el tipo de instancia es conjunto de réplicas. |
|
|
object |
La información de la instancia de conjunto de réplicas. Nota
Este parámetro se devuelve cuando el tipo de instancia es conjunto de réplicas. |
||
| VSwitchId |
string |
El ID del vSwitch. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ConnectionPort |
string |
El puerto de conexión del nodo. |
3717 |
| ReplicaSetRole |
string |
El rol del nodo. Valores válidos:
|
Primary |
| ConnectionDomain |
string |
El endpoint del nodo. |
dds-bp11483712c1****.mongodb.rds.aliyuncs.com |
| VPCCloudInstanceId |
string |
El ID de la instancia de VPC del nodo del conjunto de réplicas. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
dds-bp11483712c1**** |
| NetworkType |
string |
El tipo de red. Valores válidos:
|
VPC |
| VPCId |
string |
El ID de la VPC. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
vpc-bp1jk5vwkcri27qme**** |
| ReplacateId |
string |
El ID lógico de la instancia global multiactiva. Nota
MongoDB ya no admite la compra de este tipo de instancia. Este parámetro solo se aplica a las instancias globales multiactivas heredadas. |
bls-m**** |
| Tags |
object |
||
| Tag |
array<object> |
La lista de etiquetas de la instancia. |
|
|
object |
La lista de etiquetas de la instancia. |
||
| Key |
string |
La clave de etiqueta de la instancia. |
test |
| Value |
string |
El valor de etiqueta de la instancia. |
api |
| VpcAuthMode |
string |
El modo de acceso sin contraseña a través de una red privada. Valores válidos:
|
Open |
| NetworkType |
string |
El tipo de red de la instancia. Valores válidos:
|
VPC |
| LockMode |
string |
El estado de bloqueo de la instancia. Valores válidos:
|
Unlock |
| EngineVersion |
string |
La versión principal del motor de base de datos. |
4.4 |
| MaxIOPS |
integer |
Las IOPS máximas de la instancia. |
1000 |
| MaxMBPS |
integer |
El rendimiento máximo del disco en la nube de la instancia. Unidad: MB/s. |
350 |
| VPCCloudInstanceIds |
string |
El ID de la instancia de VPC. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. Importante Este parámetro está obsoleto. |
dds-bp11483712c1**** |
| MongosList |
object |
||
| MongosAttribute |
array<object> |
La lista de información de los nodos Mongos. Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
|
|
object |
La lista de información de los nodos Mongos. Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
||
| VpcCloudInstanceId |
string |
El ID de la instancia de VPC del nodo Mongos. |
s-bp1d8c262a158**** |
| LockMode |
string |
El estado de bloqueo de la instancia. Valores válidos:
|
Unlock |
| MaxIOPS |
integer |
Las IOPS máximas del nodo Mongos. |
800 |
| VSwitchId |
string |
El ID del vSwitch. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
vsw-bp1vj604nj5a9zz74**** |
| NodeClass |
string |
El tipo de instancia del nodo Mongos. |
dds.mongos.mid |
| MaxConnections |
integer |
El número máximo de conexiones para el nodo Mongos. |
1000 |
| Port |
integer |
El puerto de conexión del nodo Mongos. |
3717 |
| VPCId |
string |
El ID de la VPC. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
vpc-bp1n3i15v90el48nx**** |
| ConnectSting |
string |
El endpoint del nodo Mongos. Aviso Este parámetro se retirará. Reemplácelo con el parámetro ConnectString. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| NodeDescription |
string |
El nombre del nodo Mongos. |
mongos1 |
| NodeId |
string |
El ID del nodo Mongos. |
s-bp1d8c262a15**** |
| Status |
string |
El estado del nodo Mongos. Para obtener más información, consulte la tabla de estados de la instancia. |
Running |
| CurrentKernelVersion |
string |
La versión secundaria actual del motor del nodo MongoDB. |
mongodb_20220518_4.0.21 |
| ConnectString |
string |
El endpoint del nodo Mongos. |
s-bp1d8c262a15****.mongodb.rds.aliyuncs.com |
| ProtocolType |
string |
El tipo de protocolo de acceso de la instancia. Valores válidos:
Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
mongodb |
| DBInstanceDescription |
string |
El nombre de la instancia. |
Test database |
| CurrentKernelVersion |
string |
La versión secundaria actual del motor de la base de datos de la instancia. |
5.0.5-20220721143518_0 |
| DBInstanceReleaseProtection |
boolean |
Indica si la protección contra eliminación está habilitada para la instancia. Valores válidos:
|
false |
| ExpireTime |
string |
La hora de vencimiento de la instancia de suscripción. La hora está en el formato yyyy-MM-ddTHH:mmZ (hora UTC). Nota
Este parámetro se devuelve cuando el método de facturación de la instancia es de suscripción. |
2022-02-05T16:00Z |
| MaintainStartTime |
string |
La hora de inicio de la ventana de mantenimiento. La hora está en el formato HH:mmZ (hora UTC). |
18:00Z |
| DBInstanceType |
string |
El tipo de instancia. Valores válidos:
|
replicate |
| LastDowngradeTime |
string |
La hora más reciente en que se degradó la instancia. La hora está en el formato YYYY-MM-DD. |
2022-01-08 |
| ShardList |
object |
||
| ShardAttribute |
array<object> |
La lista de información de los nodos Shard. Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
|
|
object |
La lista de información de los nodos Shard. Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
||
| LockMode |
string |
El modo de bloqueo del clúster. Valores válidos:
|
Unlock |
| MaxIOPS |
integer |
Las IOPS máximas del nodo Shard. |
8000 |
| ConnectString |
string |
El endpoint del nodo Shard. |
d-bp1af0680a9c6d3****.mongodb.rds.aliyuncs.com:**** |
| NodeClass |
string |
El tipo de instancia del nodo Shard. |
dds.shard.mid |
| MaxConnections |
integer |
El número máximo de conexiones para el nodo Shard. |
8000 |
| Port |
integer |
El puerto del nodo Shard. |
3717 |
| NodeDescription |
string |
El nombre del nodo Shard. |
testshard |
| NodeId |
string |
El ID del nodo Shard. |
d-bp16e09d9c5d**** |
| NodeStorage |
integer |
La capacidad de almacenamiento del nodo Shard. Unidad: GB. |
10 |
| ReadonlyReplicas |
integer |
El número de nodos de solo lectura en el nodo Shard. Valores válidos: 0 a 5 (números enteros). |
0 |
| Status |
string |
El estado del nodo Shard. Para obtener más información, consulte la tabla de estados de la instancia. |
Running |
| MaxDiskMbps |
string |
El rendimiento máximo del disco en la nube del nodo Shard. |
350 |
| CurrentKernelVersion |
string |
La versión secundaria actual del motor del nodo MongoDB. |
mongodb_20220518_4.0.21 |
| ReplicaSetName |
string |
El nombre del nodo Shard. |
mgset-xxxx |
| EcsIOPS |
integer |
Las IOPS del host. |
0 |
| EbsIOPS |
integer |
Las IOPS del disco. |
0 |
| EcsBandwidth |
integer |
El rendimiento del host en MB/s. |
0 |
| EbsBandwidth |
integer |
El rendimiento del host en MB/s. |
0 |
| MaintainEndTime |
string |
La hora de finalización de la ventana de mantenimiento. La hora está en el formato HH:mmZ (hora UTC). |
03:00Z |
| DBInstanceStatus |
string |
El estado de la instancia. Para obtener más información, consulte la tabla de estados de la instancia. |
Running |
| VPCId |
string |
El ID de la VPC. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
vpc-bp1n3i15v90el48nx**** |
| RegionId |
string |
El ID de la región de la instancia. |
cn-hangzhou |
| DBInstanceStorage |
integer |
El almacenamiento de la instancia. |
10 |
| ReplicaSetName |
string |
El nombre de la instancia de conjunto de réplicas. Nota
Este parámetro se devuelve cuando el tipo de instancia es conjunto de réplicas. |
mgset-10ace**** |
| VSwitchId |
string |
El ID del vSwitch. Nota
Este parámetro se devuelve cuando el tipo de red de la instancia es VPC. |
vsw-bp1oo2a7isyrb8igf**** |
| StorageEngine |
string |
El tipo de motor de almacenamiento de la instancia. |
WiredTiger |
| ConfigserverList |
object |
||
| ConfigserverAttribute |
array<object> |
La lista de información de los nodos Configserver. Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
|
|
object |
La lista de información de los nodos Configserver. Nota
Este parámetro se devuelve cuando el tipo de instancia es clúster fragmentado. |
||
| MaxIOPS |
integer |
Las IOPS máximas del nodo Configserver. |
1000 |
| LockMode |
string |
El estado de bloqueo de la instancia. Valores válidos:
|
Unlock |
| ConnectString |
string |
El endpoint del nodo Configserver. |
dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com |
| NodeClass |
string |
Las especificaciones del nodo Configserver. |
dds.cs.mid |
| MaxConnections |
integer |
El número máximo de conexiones para el nodo Configserver. |
1000 |
| Port |
integer |
El puerto del nodo Configserver. |
3717 |
| NodeDescription |
string |
El nombre del nodo Configserver. |
testConfigserver |
| NodeId |
string |
El ID del nodo Configserver. |
dds-bp11483712c1****-cs |
| NodeStorage |
integer |
La capacidad de almacenamiento del nodo Configserver. Unidad: GB. |
20 |
| Status |
string |
El estado del nodo ConfigServer. Para obtener más información, consulte la Tabla de estados de la instancia. |
Running |
| CurrentKernelVersion |
string |
La versión secundaria actual del motor del nodo MongoDB. |
mongodb_20220518_4.0.21 |
| ResourceGroupId |
string |
El ID del grupo de recursos al que pertenece la instancia. Nota
Actualmente, este parámetro solo se devuelve en el sitio de China. |
rg-acfmyiu4ekp**** |
| ZoneId |
string |
El ID de la zona a la que pertenece la instancia. |
cn-hangzhou-b |
| MaxConnections |
integer |
El número máximo de conexiones para la instancia. |
500 |
| DBInstanceId |
string |
El ID de la instancia. |
dds-bp11483712c1**** |
| DBInstanceClass |
string |
El tipo de instancia. |
dds.mongo.mid |
| Engine |
string |
El motor de base de datos. |
MongoDB |
| ReadonlyReplicas |
string |
El número de nodos de solo lectura en la instancia. |
1 |
| ReplicationFactor |
string |
El número de nodos en la instancia. Nota
Este parámetro se devuelve cuando el tipo de instancia es conjunto de réplicas. |
3 |
| KindCode |
string |
El tipo de instancia. Valores válidos:
|
18 |
| CapacityUnit |
string |
El rendimiento de lectura y escritura consumido por la instancia. |
100 |
| ChargeType |
string |
El método de facturación de la instancia. Valores válidos:
|
PostPaid |
| StorageType |
string |
El tipo de almacenamiento. Valores válidos: cloud_essd1: ESSD PL1. cloud_essd2: ESSD PL2. cloud_essd3: ESSD PL3. local_ssd: SSD local. cloud_essd_dbfs_s: disco en la nube de almacenamiento compartido DBFS. |
cloud_essd1 |
| DestroyTime |
string |
La hora de destrucción de los datos de la instancia, en formato yyyy-MM-ddTHH:mm:ssZ (UTC). |
2021-12-10T16:00:00Z |
| DBInstanceOrderStatus |
string |
El estado de los pedidos generados para la instancia. Valores válidos:
Nota
El flujo de trabajo de procesamiento de pedidos avanza de la siguiente manera: realizar el pedido, pagar el pedido, enviar el pedido para su procesamiento, procesar el pedido y completar el pedido.
|
all_completed |
| Encrypted |
boolean |
Especifica si el cifrado de disco en la nube está habilitado. |
true |
| EncryptionKey |
string |
La clave de KMS utilizada para el cifrado de disco en la nube. |
07609cc3-3109-408f-a35e-c548e776da0b |
| SyncPercent |
string |
El progreso de sincronización de datos como porcentaje. Cuando la instancia se está modificando, se requieren operaciones como la sincronización de datos. Utilice este campo para comprobar el progreso de la sincronización. |
0.8 |
| UseClusterBackup |
boolean |
Especifica si el modo de respaldo de clúster está habilitado. Valores válidos:
|
true |
| BurstingEnabled |
boolean |
Especifica si la ráfaga de E/S está habilitada. |
true |
| ProvisionedIops |
integer |
El rendimiento aprovisionado. |
1960 |
| DisasterRecoveryInfo |
string |
La información de la instancia de origen y la instancia de destino para la georredundancia activa global. |
{"relations":[{"destInsName":"dds-bp11483712c1****","destRegionId":"cn-hangzhou","srcInsName":"dds-7xv054b9c43c****","srcRegionId":"cn-guangzhou"}]} |
| SearchNodeClass |
string |
Las especificaciones del nodo Search después de un cambio de especificaciones. |
mdb.shard.2x.xlarge.d |
| SearchNodeStorage |
integer |
La capacidad de almacenamiento del nodo Search después de un cambio de especificaciones. |
20 |
| SearchNodeCount |
integer |
El número de nodos Search después de un cambio de especificaciones. |
2 |
| ColdDataEnabled |
boolean |
Especifica si la función de archivado de datos fríos está habilitada. |
|
| AIGatewayEnabled |
boolean |
Especifica si la puerta de enlace de IA está habilitada para la instancia. |
|
| ShardSearchNodes |
object |
||
| ShardSearchNodes |
array<object> |
La lista de información de los nodos Search asociados con cada nodo Shard en la instancia de clúster fragmentado. |
|
|
object |
|||
| NodeId |
string |
El ID del nodo Shard. |
|
| SearchNodeId |
string |
El ID del nodo Search. |
|
| SearchNodeClass |
string |
Las especificaciones del nodo Search. |
|
| SearchNodeStorage |
string |
La capacidad de almacenamiento del nodo Search. |
|
| SearchNodeCount |
string |
El número de nodos Search. |
|
| EcsIOPS |
integer |
Las IOPS del host. |
0 |
| EbsIOPS |
integer |
Las IOPS del disco. |
0 |
| EcsBandwidth |
integer |
El rendimiento del host en MB/s. |
0 |
| EbsBandwidth |
integer |
El rendimiento del disco en MB/s. |
0 |
Ejemplos
Respuesta exitosa
JSON Formato
{
"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 datos de prueba",
"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
}
]
}
}
Códigos de error
|
Código de estado HTTP |
Código de error |
Mensaje de error |
Descripción |
|---|---|---|---|
| 400 | VpcCloudInstanceIdNumError | Get vpcCloudInstanceId number error. |
Consulte Códigos de error para ver la lista completa.
Notas de la versión
Consulte Notas de la versión para ver la lista completa.