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

Consulta los recursos disponibles en la zona especificada.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Puede llamar a la operación DescribeRegions para consultar las regiones disponibles más recientes.	cn-hangzhou
ZoneId	string	No	El ID de la zona. Puede llamar a la operación DescribeRegions para consultar las zonas disponibles.	cn-hangzhou-h
InstanceChargeType	string	No	El método de facturación de la instancia. Valores válidos: PrePaid (predeterminado): suscripción PostPaid: pago por uso	PrePaid
DbType	string	No	La arquitectura de la instancia. Valores válidos: normal: instancia de conjunto de réplicas sharding: instancia de clúster fragmentado	sharding
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-acfmyiu4ekp****
StorageType	string	No	El tipo de almacenamiento de la instancia. Valores válidos: local_ssd: SSD local cloud_essd1: SSD mejorado (ESSD) PL1 cloud_essd2: ESSD PL2 cloud_essd3: ESSD PL3 cloud_auto: disco ESSD AutoPL Este parámetro está vacío de forma predeterminada, lo que indica que se consultan todos los tipos de recursos de almacenamiento.	local_ssd
DBInstanceClass	string	No	El tipo de la instancia.	dds.mongo.standard
EngineVersion	string	No	La versión principal del motor de la instancia.	5.0
ReplicationFactor	string	No	El número de nodos, aplicable solo a conjuntos de réplicas. Valores válidos: 1 : 1 3 : 3 5 : 5 7 : 7	3

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypes	object
SupportedDBType	array<object>	Los tipos de base de datos admitidos.
	array<object>
AvailableZones	object
AvailableZone	array<object>	Las zonas disponibles.
	array<object>
SupportedEngineVersions	object
SupportedEngineVersion	array<object>	Las versiones del motor de almacenamiento admitidas.
	array<object>
SupportedEngines	object
SupportedEngine	array<object>	The supported storage engines.
	array<object>
SupportedNodeTypes	object
SupportedNodeType	array<object>	The supported instance types.
	array<object>
NodeType	string	The number of nodes in the instance.	3
NetworkTypes	string	The network type of the instance.	VPC
AvailableResources	object
AvailableResource	array<object>	The details of the available resources.
	array<object>
InstanceClassRemark	string	The type of the instance.	4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））
InstanceClass	string	The instance family.	mdb.shard.2x.xlarge.d
DBInstanceStorageRange	object	The storage capacity range of the instance.
Min	integer	The minimum storage capacity. Unit: GB.	20
Max	integer	The maximum storage capacity. Unit: GB.	16000
Step	integer	The step size for adjusting the storage capacity. Unit: GB.	10
Engine	string	The storage engine of the instance.	WiredTiger
Version	string	La versión del motor de base de datos de la instancia.	4.0
ZoneId	string	El ID de la zona.	cn-hangzhou-h
RegionId	string	El ID de la región.	cn-hangzhou
DbType	string	La arquitectura de la instancia. Valores válidos: normal: instancia de conjunto de réplicas sharding: instancia de clúster fragmentado	sharding

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "344EE51D-8850-4935-B68B-58A8F4DCE3BD",
  "SupportedDBTypes": {
    "SupportedDBType": [
      {
        "AvailableZones": {
          "AvailableZone": [
            {
              "SupportedEngineVersions": {
                "SupportedEngineVersion": [
                  {
                    "SupportedEngines": {
                      "SupportedEngine": [
                        {
                          "SupportedNodeTypes": {
                            "SupportedNodeType": [
                              {
                                "NodeType": "3",
                                "NetworkTypes": "VPC",
                                "AvailableResources": {
                                  "AvailableResource": [
                                    {
                                      "InstanceClassRemark": "4核8GB（独享型）（当前选择规格：mdb.shard.2x.xlarge.d（4核8G（独享型云盘版），最大连接数：3000，最大IOPS：min{1800+50*存储空间, 21000}））",
                                      "InstanceClass": "mdb.shard.2x.xlarge.d",
                                      "DBInstanceStorageRange": {
                                        "Min": 20,
                                        "Max": 16000,
                                        "Step": 10
                                      }
                                    }
                                  ]
                                }
                              }
                            ]
                          },
                          "Engine": "WiredTiger"
                        }
                      ]
                    },
                    "Version": "4.0"
                  }
                ]
              },
              "ZoneId": "cn-hangzhou-h",
              "RegionId": "cn-hangzhou"
            }
          ]
        },
        "DbType": "sharding"
      }
    ]
  }
}

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.