DescribeAvailableResource - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta os recursos disponíveis na zona especificada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dds:DescribeAvailableResource

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis mais recentes.	cn-hangzhou
ZoneId	string	Não	O ID da zona. Você pode chamar a operação DescribeRegions para consultar as zonas disponíveis.	cn-hangzhou-h
InstanceChargeType	string	Não	O método de cobrança da instância. Valores válidos: PrePaid (padrão): assinatura PostPaid: pós-pago	PrePaid
DbType	string	Não	A arquitetura da instância. Valores válidos: normal: instância de conjunto de réplicas sharding: instância de cluster fragmentado	sharding
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmyiu4ekp****
StorageType	string	Não	O tipo de armazenamento da instância. Valores válidos: local_ssd: SSD local cloud_essd1: ESSD (Enhanced SSD) PL1 cloud_essd2: ESSD PL2 cloud_essd3: ESSD PL3 cloud_auto: disco ESSD AutoPL Este parâmetro é vazio por padrão, o que indica que todos os tipos de recursos de armazenamento são consultados.	local_ssd
DBInstanceClass	string	Não	O tipo de instância da instância.	dds.mongo.standard
EngineVersion	string	Não	A versão principal do mecanismo da instância.	5.0
ReplicationFactor	string	Não	O número de nós, aplicável apenas a conjuntos de réplicas. Valores válidos: 1 : 1 3 : 3 5 : 5 7 : 7	3

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	344EE51D-8850-4935-B68B-58A8F4DCE3BD
SupportedDBTypes	object
SupportedDBType	array<object>	Os tipos de banco de dados suportados.
	array<object>
AvailableZones	object
AvailableZone	array<object>	The available zones.
	array<object>
SupportedEngineVersions	object
SupportedEngineVersion	array<object>	The supported storage engine versions.
	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	The database engine version of the instance.	4.0
ZoneId	string	The ID of the zone.	cn-hangzhou-h
RegionId	string	The ID of the region.	cn-hangzhou
DbType	string	The architecture of the instance. Valid values: normal: replica set instance sharding: sharded cluster instance	sharding

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.