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

Obtém uma lista paginada de VPCs.

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

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-hangzhou
ZoneId	string	Não	O ID da zona.	cn-hangzhou-h
PageNumber	integer	Não	O número da página. O valor deve ser maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. Valor padrão: 1.	1
PageSize	integer	Não	O número de registros por página. O valor deve ser maior que 0 e não pode exceder o valor máximo do tipo de dados Integer. Valor padrão: 50.	10
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfmyiu4ekp****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de registros.	4
Vpcs	array<object>	A lista de VPCs.
	array<object>
Status	string	O status da VPC. Available indica que a VPC está disponível.	Available
VpcName	string	O nome da VPC.	vpc-name
VpcId	string	O ID da VPC.	vpc-2zep2pepkthg5ueal****
IsDefault	boolean	Indica se a VPC é a VPC padrão. Valores válidos: true: Sim. false: Não. Valores válidos: true : true. false : false.	true
CidrBlock	string	O bloco CIDR da VPC.	10...**/24
RegionNo	string	O ID da região.	cn-hangzhou
GmtCreate	string	Este parâmetro foi descontinuado e nenhum valor é retornado.	null
AliUid	string	Este parâmetro foi descontinuado e nenhum valor é retornado.	null
VSwitchs	array<object>	A lista de vSwitches.
	object
Status	string	O status do vSwitch. Available indica que o vSwitch está disponível.	Available
VSwitchId	string	O ID do vSwitch.	vsw-bp*******************
IsDefault	boolean	Indica se o vSwitch é o vSwitch padrão. Valores válidos: true: O vSwitch é o vSwitch padrão. false: O vSwitch não é o vSwitch padrão. Valores válidos: true : true. false : false.	true
CidrBlock	string	O bloco CIDR do vSwitch.	10...**/28
GmtCreate	string	Este parâmetro foi descontinuado e nenhum valor é retornado.	null
GmtModified	string	Este parâmetro foi descontinuado e nenhum valor é retornado.	null
IzNo	string	A zona à qual o vSwitch pertence.	cn-hangzhou-i
VSwitchName	string	O nome do vSwitch.	vsw-name
GmtModified	string	Este parâmetro foi descontinuado e nenhum valor é retornado.	null
Bid	string	Este parâmetro foi descontinuado e nenhum valor é retornado.	null
RequestId	string	O ID da solicitação.	53924AF0-1628-5AA2-9C95-D4**********
PageSize	integer	O número de registros por página.	10
PageNumber	integer	O número da página.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 4,
  "Vpcs": [
    {
      "Status": "Available",
      "VpcName": "vpc-name",
      "VpcId": "vpc-2zep2pepkthg5ueal****",
      "IsDefault": true,
      "CidrBlock": "10.**.**.**/24",
      "RegionNo": "cn-hangzhou",
      "GmtCreate": "null",
      "AliUid": "null",
      "VSwitchs": [
        {
          "Status": "Available",
          "VSwitchId": "vsw-bp*******************",
          "IsDefault": true,
          "CidrBlock": "10.**.**.**/28",
          "GmtCreate": "null",
          "GmtModified": "null",
          "IzNo": "cn-hangzhou-i",
          "VSwitchName": "vsw-name"
        }
      ],
      "GmtModified": "null",
      "Bid": "null"
    }
  ],
  "RequestId": "53924AF0-1628-5AA2-9C95-D4**********",
  "PageSize": 10,
  "PageNumber": 1
}

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.