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

Evalúa la disponibilidad de recursos antes de comprar una nueva instancia o cambiar la configuración de una instancia existente.

Descripción de la operación

Evalúa la disponibilidad de recursos para instancias de conjunto de réplicas y instancias de clúster fragmentado de MongoDB. Los escenarios admitidos incluyen la compra de una nueva instancia, el cambio de configuración de una instancia y la adición de nodos a un clúster fragmentado.

Nota

Puede llamar a esta operación hasta 200 veces por minuto. Las llamadas que superen este límite están sujetas a limitación de tráfico.

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:EvaluateResource

none

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Para obtener más información, consulte DescribeRegions.	cn-hangzhou
ZoneId	string	Sí	El ID de la zona. Para obtener más información, consulte DescribeRegions.	cn-hangzhou-h
Engine	string	No	El motor de base de datos. Establezca el valor en MongoDB.	MongoDB
EngineVersion	string	Sí	La versión del motor de base de datos.	4.2
DBInstanceClass	string	No	El tipo de instancia. Nota Este parámetro es obligatorio cuando evalúa recursos para una instancia de conjunto de réplicas. Para obtener detalles sobre los tipos de instancia, consulte Tipos de instancia.	dds.mongo.mid
ShardsInfo	string	No	La información de fragmentos del clúster fragmentado. Este parámetro es obligatorio cuando evalúa recursos para una instancia de clúster fragmentado. Para evaluar recursos para una nueva instancia de clúster fragmentado, especifique el tipo de instancia para cada fragmento en una cadena JSON. Ejemplo: `{ "ConfigSvrs": [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}], "Mongos": [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}], "Shards": [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"}, {"Storage":50,"DBInstanceClass":"dds.shard.standard"}] }` Los parámetros del ejemplo se describen a continuación: ConfigSvrs: Los nodos ConfigServer. Mongos: Los nodos Mongos. Shards: Los nodos de fragmento. Storage: El espacio de almacenamiento del fragmento destino. DBInstanceClass: El tipo de instancia del fragmento destino. Para obtener detalles sobre los tipos de instancia, consulte Tipos de instancia de clúster fragmentado. Para evaluar recursos para actualizar o degradar una instancia de clúster fragmentado, especifique solo la información del nodo en una cadena JSON. Ejemplo: `{ "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard" }` Los parámetros del ejemplo se describen a continuación: NodeId: El ID del nodo destino. NodeClass: El tipo de instancia del nodo destino. Para obtener detalles sobre los tipos de instancia, consulte Tipos de instancia de clúster fragmentado.	{"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}
DBInstanceId	string	No	El ID de la instancia. Este parámetro es obligatorio cuando evalúa recursos para una actualización o degradación de instancia.	dds-bp14bf67a76d****
ReplicationFactor	string	No	El número de nodos en la instancia. Establezca el valor en 1 para una instancia independiente. Establezca el valor en 2 para una instancia que utiliza almacenamiento compartido. Para una instancia de conjunto de réplicas, los valores válidos son 3, 5 y 7.	3
ReadonlyReplicas	string	No	El número de nodos de solo lectura en la instancia. Valores válidos: 1 a 5. Nota Este parámetro no es obligatorio para instancias independientes.	1
Storage	string	No	El espacio de almacenamiento del conjunto de réplicas. Unidad: GB. Nota Este parámetro es obligatorio si la instancia utiliza discos en la nube.	10

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
DBInstanceAvailable	string	Indica si hay recursos disponibles en la región actual. Valores válidos: 1: Los recursos son suficientes. 0: Los recursos son insuficientes.	1
EngineVersion	string	La versión del motor de base de datos.	4.0
RequestId	string	El ID de la solicitud.	AE2DE465-E45F-481F-ABD8-37D64173****
Engine	string	El motor de base de datos. El valor está fijado en MongoDB.	MongoDB

Ejemplos

Respuesta exitosa

JSON Formato

{
  "DBInstanceAvailable": "1",
  "EngineVersion": "4.0",
  "RequestId": "AE2DE465-E45F-481F-ABD8-37D64173****",
  "Engine": "MongoDB"
}

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.