DescribeDBInstancesOverview - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Consulta la información general de una o más instancias de ApsaraDB for MongoDB.

Descripción de la operación

Si no especifica ninguna instancia, la operación devuelve la información general de todas las instancias en la región de destino asociada a su cuenta de Alibaba Cloud.
Los resultados de esta operación no están paginados.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dds:DescribeDBInstancesOverview

list

*Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Llame a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
InstanceIds	string	No	El ID de la instancia cuya información general desea consultar. Nota Si no especifica este parámetro, se devuelve la información general de todas las instancias en su cuenta de Alibaba Cloud. Puede especificar varios ID de instancia. Separe los ID con comas (,).	dds-bp12c5b040dc****
InstanceStatus	string	No	El estado de la instancia. Para obtener más información, consulte Estados de las instancias.	Running
ChargeType	string	No	El método de facturación de la instancia. Valores válidos: PrePaid: suscripción PostPaid: pago por uso	PostPaid
NetworkType	string	No	El tipo de red de la instancia. Valores válidos: Classic: red clásica VPC: nube privada virtual (VPC)	Classic
EngineVersion	string	No	La versión del motor de base de datos de la instancia. Valores válidos: 5.0, 4.4, 4.2, 4.0 y 3.4.	4.0
InstanceClass	string	No	El tipo de instancia. Para obtener más información sobre los tipos de instancia disponibles para las diferentes arquitecturas de instancia, consulte: Tipos de instancia independiente Tipos de instancia de conjunto de réplicas Tipos de instancia de clúster fragmentado	dds.mongo.2xlarge
VpcId	string	No	El ID de la VPC.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	El ID del vSwitch.	vsw-bp1e7clcw529l773d****
InstanceType	string	No	La arquitectura de la instancia. Valores válidos: sharding: instancia de clúster fragmentado replicate: instancia de conjunto de réplicas o independiente Nota Configure este parámetro según sea necesario. Por ejemplo, para consultar la información general de una instancia de clúster fragmentado, configure este parámetro como sharding. Si no especifica este parámetro, se devuelve la información general de todas las instancias.	replicate
ZoneId	string	No	El ID de la zona.	cn-hangzhou-b
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.	rg-acfmyiu4ekp****
ShowTags	boolean	No	Especifica si se deben devolver las etiquetas de la instancia. El valor predeterminado es false.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalCount	string	El número de instancias devueltas.	1
RequestId	string	El ID de la solicitud.	52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA
DBInstances	array<object>	Una lista de detalles de instancias.
	array<object>	Una lista de detalles de instancias.
CreationTime	string	La hora en que se creó la instancia. La hora está en formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2022-01-05T03:18:53Z
ExpireTime	string	La hora de vencimiento de la instancia de suscripción. La hora está en formato yyyy-MM-ddTHH:mmZ. La hora se muestra en UTC.	2022-02-05T16:00Z
Tags	array<object>	Las etiquetas de la instancia.
	object	Las etiquetas de la instancia.
Key	string	La clave de la etiqueta. La clave no puede comenzar con `aliyun`, `acs:`, `http://` ni `https://`. La clave puede tener hasta 64 caracteres de longitud. La clave no puede ser una cadena vacía.	testdatabase
Value	string	El valor de la etiqueta. El valor no puede comenzar con `aliyun`, `acs`: , `http://` ni `https://`. El valor puede tener hasta 128 caracteres de longitud. El valor puede ser una cadena vacía.	apitest
LastDowngradeTime	string	La hora en que se degradó la instancia por última vez.	2021-05-08
ShardList	array<object>	Los detalles de los nodos de fragmento. Nota Este parámetro solo se devuelve para instancias de clúster fragmentado.
	object	Los detalles de los nodos de fragmento. Nota Este parámetro solo se devuelve para instancias de clúster fragmentado.
NodeClass	string	El tipo de instancia del nodo de fragmento.	dds.shard.mid
NodeDescription	string	La descripción del nodo de fragmento.	测试shard节点
NodeStorage	integer	La capacidad de almacenamiento del nodo de fragmento, en GB.	10
NodeId	string	El ID del nodo de fragmento.	d-bp1cac6f2083****
ReadonlyReplicas	integer	El número de nodos de solo lectura en el fragmento. Valores válidos: de 0 a 5.	2
DBInstanceType	string	La arquitectura de la instancia. Valores válidos: sharding: instancia de clúster fragmentado replicate: instancia de conjunto de réplicas o independiente	replicate
DestroyTime	string	La hora en que se destruyeron los datos de la instancia. La hora está en formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2021-12-10T16:00:00Z
ChargeType	string	El método de facturación de la instancia. Valores válidos: PrePaid: suscripción PostPaid: pago por uso	PrePaid
CapacityUnit	string	El rendimiento de lectura/escritura de la instancia. Nota Este parámetro solo se devuelve para instancias Serverless. Las instancias Serverless solo están disponibles en el sitio de China (aliyun.com).	100
VpcAuthMode	string	Indica si el acceso sin contraseña a través de una VPC está habilitado. Valores válidos: Open: habilitado Close: deshabilitado	Open
DBInstanceStatus	string	El estado de la instancia. Para obtener más información, consulte Estados de las instancias.	Running
NetworkType	string	El tipo de red de la instancia. Valores válidos: Classic: red clásica VPC: nube privada virtual (VPC)	VPC
LockMode	string	El modo de bloqueo de la instancia. Unlock: La instancia no está bloqueada. ManualLock: La instancia está bloqueada manualmente. LockByExpiration: La instancia se bloquea automáticamente después de vencer. LockByRestoration: La instancia se bloquea automáticamente antes de una reversión. LockByDiskQuota: La instancia se bloquea automáticamente después de agotar su espacio de almacenamiento. Released: La instancia está liberada. No puede desbloquear una instancia liberada. Solo puede restaurar los datos de la instancia en una nueva instancia. La restauración puede tardar mucho tiempo.	Unlock
EngineVersion	string	La versión del motor de base de datos de la instancia.	4.2
MongosList	array<object>	Los detalles de los nodos mongos. Nota Este parámetro solo se devuelve para instancias de clúster fragmentado.
	object	Los detalles de los nodos mongos. Nota Este parámetro solo se devuelve para instancias de clúster fragmentado.
NodeClass	string	El tipo de instancia del nodo mongos.	dds.mongos.standard
NodeDescription	string	La descripción del nodo mongos.	测试mongos节点
NodeId	string	El ID del nodo mongos.	s-bp10e3b0d02f****
RegionId	string	El ID de la región de la instancia.	cn-hangzhou
DBInstanceStorage	integer	La capacidad de almacenamiento de la instancia, en GB.	20
ResourceGroupId	string	El ID del grupo de recursos al que pertenece la instancia.	rg-acfm22cdcgc****
ZoneId	string	La zona de la instancia.	cn-hangzhou-i
DBInstanceId	string	El ID de la instancia.	dds-bp12c5b040dc****
DBInstanceClass	string	El tipo de instancia. Para obtener más información sobre los tipos de instancia disponibles para las diferentes arquitecturas de instancia, consulte: Tipos de instancia independiente Tipos de instancia de conjunto de réplicas Tipos de instancia de clúster fragmentado	dds.mongo.mid
Engine	string	El motor de base de datos. El valor es MongoDB.	MongoDB
ReplicationFactor	string	El número de nodos en la instancia. Nota Este parámetro solo se devuelve para instancias de conjunto de réplicas.	3
DBInstanceDescription	string	La descripción de la instancia.	测试数据库
KindCode	string	La edición de la instancia. Valores válidos: 0: servidor físico 1: ECS 2: DOCKER 18: instancia en la nueva arquitectura basada en Kubernetes	0

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": "1",
  "RequestId": "52820D2B-B2DD-59F0-BDF2-83EC19C6F1CA",
  "DBInstances": [
    {
      "CreationTime": "2022-01-05T03:18:53Z",
      "ExpireTime": "2022-02-05T16:00Z",
      "Tags": [
        {
          "Key": "testdatabase",
          "Value": "apitest"
        }
      ],
      "LastDowngradeTime": "2021-05-08",
      "ShardList": [
        {
          "NodeClass": "dds.shard.mid",
          "NodeDescription": "Test shard node",
          "NodeStorage": 10,
          "NodeId": "d-bp1cac6f2083****",
          "ReadonlyReplicas": 2
        }
      ],
      "DBInstanceType": "replicate",
      "DestroyTime": "2021-12-10T16:00:00Z",
      "ChargeType": "PrePaid",
      "CapacityUnit": "100",
      "VpcAuthMode": "Open",
      "DBInstanceStatus": "Running",
      "NetworkType": "VPC",
      "LockMode": "Unlock",
      "EngineVersion": "4.2",
      "MongosList": [
        {
          "NodeClass": "dds.mongos.standard",
          "NodeDescription": "Test mongos node",
          "NodeId": "s-bp10e3b0d02f****"
        }
      ],
      "RegionId": "cn-hangzhou",
      "DBInstanceStorage": 20,
      "ResourceGroupId": "rg-acfm22cdcgc****",
      "ZoneId": "cn-hangzhou-i",
      "DBInstanceId": "dds-bp12c5b040dc****",
      "DBInstanceClass": "dds.mongo.mid",
      "Engine": "MongoDB",
      "ReplicationFactor": "3",
      "DBInstanceDescription": "Test database",
      "KindCode": "0"
    }
  ]
}

Códigos de 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.