DescribeVpcs - PolarDB: Central de Documentação do Alibaba Cloud

Consulta uma ou mais 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

polardb:DescribeVpcs

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ZoneId	string	Não	O ID da zona. Nota Você pode chamar a operação DescribeRegions para consultar zonas.	cn-hangzhou-i
Product	string	Não	O nome do produto de nuvem.	VPN
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30 50 100 Valor padrão: 30.	30
PageNumber	integer	Não	O número da página. O valor deve ser um número inteiro maior que 0 e não exceder o valor máximo do tipo de dados inteiro. Valor padrão: 1.	3
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a VPC pertence.	rg-acfmzh544n3j3bi
VpcId	string	Não	O ID da VPC. Nota Você pode chamar a operação DescribeVpcs para consultar os detalhes das VPCs.	vpc-*************

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNumber	integer	O número da página retornada. O valor padrão é 1.	2
PageSize	integer	O número de entradas retornadas por página. Valores válidos: 30 50 100 30	50
RequestId	string	O ID da solicitação.	11FDB5A0-84F5-5361-B729-5770B0AEB9D5
TotalCount	integer	O número total de entradas.	50
Vpcs	array<object>	Uma lista de VPCs.
	array<object>	Os detalhes da VPC.
AliUid	string	O ID da conta Alibaba Cloud.	1868512340232755
Bid	string	Indica se a conta é uma conta Alibaba Finance Cloud, uma conta Alibaba Gov Cloud ou uma conta de nuvem pública.	26842
CidrBlock	string	O bloco CIDR IPv4 da VPC.	57.100.6.59/32
GmtCreate	string	A hora em que a VPC foi criada.	2021-04-18T15:02:37Z
GmtModified	string	A hora em que a VPC foi modificada pela última vez.	2021-04-18T15:02:37Z
IsDefault	boolean	Indica se a VPC é a VPC padrão. Valores válidos: true: A VPC é a VPC padrão. false: A VPC não é a VPC padrão.	true
RegionNo	string	O ID da região à qual a VPC pertence.	cn-chengdu-wt97-a01
Status	string	O status da VPC. Valores válidos: `Pending`: A VPC está sendo configurada. `Available`: A VPC está ativa.	Pending
VSwitchs	array<object>	Uma lista de vSwitches.
	object	Os detalhes do vSwitch.
CidrBlock	string	The IPv4 CIDR block of the vSwitch.	47.118.126.0/25
GmtCreate	string	The time when the vSwitch was created.	2021-04-18T15:02:37Z
GmtModified	string	The time when the vSwitch was last modified.	2021-04-18T15:02:37Z
IsDefault	boolean	Indicates whether the vSwitch is the default vSwitch. Valid values: true: The vSwitch is the default vSwitch. false: The vSwitch is not the default vSwitch.	false
IzNo	string	The zone to which the vSwitch belongs.	cn-shenzhen-f
Status	string	The status of the vSwitch. Valid values: Pending: The vSwitch is being configured. Available: The vSwitch is active.	Pending
VSwitchId	string	The ID of the vSwitch.	vsw-uf6fus5py6hbvxqwzwnk8
VSwitchName	string	The name of the vSwitch.	default-sw
VpcId	string	O ID da VPC. Nota Você pode chamar a operação DescribeVpcs para consultar os detalhes das VPCs.	vpc-bp16efwqjzyumc23c647v
VpcName	string	O nome da VPC.	vpc-e2e-10341f3

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 2,
  "PageSize": 50,
  "RequestId": "11FDB5A0-84F5-5361-B729-5770B0AEB9D5",
  "TotalCount": 50,
  "Vpcs": [
    {
      "AliUid": "1868512340232755",
      "Bid": "26842",
      "CidrBlock": "57.100.6.59/32",
      "GmtCreate": "2021-04-18T15:02:37Z\n",
      "GmtModified": "2021-04-18T15:02:37Z\n",
      "IsDefault": true,
      "RegionNo": "cn-chengdu-wt97-a01",
      "Status": "Pending",
      "VSwitchs": [
        {
          "CidrBlock": "47.118.126.0/25",
          "GmtCreate": "2021-04-18T15:02:37Z",
          "GmtModified": "2021-04-18T15:02:37Z",
          "IsDefault": false,
          "IzNo": "cn-shenzhen-f",
          "Status": "Pending",
          "VSwitchId": "vsw-uf6fus5py6hbvxqwzwnk8",
          "VSwitchName": "default-sw"
        }
      ],
      "VpcId": "vpc-bp16efwqjzyumc23c647v",
      "VpcName": "vpc-e2e-10341f3"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	PARAMETER_MUST_NOT_NULL	Miss mandatory parameter.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.