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

Consulta a lista de zonas suportadas por uma instância ApsaraDB for MongoDB.

Descrição da operação

Consulta as zonas nas quais uma instância ApsaraDB for MongoDB pode ser implantada sob condições de compra especificadas. O ID da região é obrigatório na condição de compra.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância. 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 da instância. Você pode chamar a operação DescribeRegions para consultar as zonas disponíveis.	cn-hangzhou-b
InstanceChargeType	string	Não	O método de cobrança do produto. Valores válidos: PrePaid: assinatura PostPaid: pay-as-you-go	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	normal
ResourceGroupId	string	Não	O ID do grupo de recursos. Para mais informações, consulte Exibir informações básicas de um grupo de recursos.	rg-acfmx2m4rqu7pry
AcceptLanguage	string	Não	O idioma dos valores retornados dos parâmetros RegionName e ZoneName. Valores válidos: zh (padrão): chinês en: inglês	zh
StorageSupport	string	Não	O tipo de armazenamento. Valores válidos: cloud: exibe apenas zonas disponíveis para instâncias que utilizam discos em nuvem. local: exibe apenas zonas disponíveis para instâncias que utilizam discos locais. default ou não especificado: exibe zonas disponíveis para instâncias que utilizam discos em nuvem e para instâncias que utilizam discos locais.	local
MongoType	string	Não	A edição da instância. As edições High-Available Edition e Preview Edition (dbfs) são suportadas.	dbfs
StorageType	string	Não	O tipo de armazenamento. Valores válidos: cloud_essd1: ESSDs (Enterprise SSDs) PL1 cloud_essd2: ESSDs PL2 cloud_essd3: ESSDs PL3 local_ssd: SSDs locais Nota Instâncias que executam MongoDB 4.4 ou posterior utilizam apenas discos em nuvem para armazenar dados. Se você não especificar este parâmetro, o valor cloud_essd1 será usado por padrão. Instâncias que executam MongoDB 4.2 e anterior utilizam apenas discos locais para armazenar dados. Se você não especificar este parâmetro, o valor local_ssd será usado por padrão.	local_ssd
ExcludeZoneId	string	Não	O ID da zona excluída dos resultados da consulta.	cn-shanghai-g
ExcludeSecondaryZoneId	string	Não	O ID da zona secundária excluída dos resultados da consulta. Você pode configurar os parâmetros ExcludeZoneId e ExcludeSecondaryZoneId para especificar os IDs de múltiplas zonas excluídas dos resultados da consulta.	cn-shanghai-b
DBInstanceClass	string	Não	O tipo de instância da instância.	dds.mongo.standard
EngineVersion	string	Não	A versão do mecanismo de banco de dados da instância.	5.0
ReplicationFactor	string	Não	O número de nós na instância. Nota Este parâmetro está disponível apenas para instâncias de conjunto de réplicas. Valores válidos: 1 3 5 7 Valores válidos: 1 : 1 3 : 3 5 : 5 7 : 7	3
InstanceType	string	Não	A arquitetura da instância. Valores válidos: sharding: instância de cluster fragmentado replicate: instância de conjunto de réplicas ou instância standalone	replicate

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	19A13A33-0FAD-5120-8AE1-B1636F74DD80
AvailableZones	array<object>	Os detalhes das zonas nas quais você pode criar instâncias ApsaraDB for MongoDB.
	object
ZoneId	string	O ID da zona.	cn-beijing-f
ZoneName	string	O nome da zona. O valor de retorno do parâmetro ZoneName está no idioma especificado pelo parâmetro AcceptLanguage. Por exemplo, se o valor do parâmetro ZoneId na resposta for cn-hangzhou-h, os seguintes valores serão retornados para o parâmetro ZoneName: Se o valor do parâmetro AcceptLanguage for zh, H será retornado para o parâmetro ZoneName. Se o valor do parâmetro AcceptLanguage for en, Hangzhou Zone H será retornado para o parâmetro ZoneName.	Hangzhou Zone H
RegionId	string	O ID da região. Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis mais recentes.	cn-beijing

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "19A13A33-0FAD-5120-8AE1-B1636F74DD80",
  "AvailableZones": [
    {
      "ZoneId": "cn-beijing-f",
      "ZoneName": "Hangzhou Zone H",
      "RegionId": "cn-beijing"
    }
  ]
}

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.