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

Consulta as VPCs criadas.

Descrição da operação

A operação DescribeVpcs pode retornar o código de erro Throttling.DeepPageSkip durante paginação profunda e saltos de página frequentes. Reduza a frequência de consulta ou use paginação sequencial.

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

vpc:DescribeVpcs

list

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/*

VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VPCId}

vpc:tag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VpcId	string	Não	O ID da VPC. Você pode especificar até 20 IDs de VPC. Separe vários IDs de VPC com vírgulas (,).	vpc-bp1b1xjllp3ve5yze****
RegionId	string	Sim	O ID da região da VPC. Você pode chamar a operação DescribeRegions para consultar os IDs de região.	cn-hangzhou
VpcName	string	Não	O nome da VPC.	Vpc-1
IsDefault	boolean	Não	Especifica se deve ser consultada a VPC padrão na região especificada. Valores válidos: true (padrão): Consulta a VPC padrão na região especificada. false: Não consulta a VPC padrão.	false
DryRun	boolean	Não	Especifica se deve ser realizado um dry run para a solicitação. Valores válidos: true: Envia uma solicitação de verificação e não consulta o status do recurso. O sistema verifica se o seu par de AccessKey é válido, se o usuário do Resource Access Management (RAM) tem autorização e se os parâmetros obrigatórios foram especificados. Se a verificação falhar, o sistema retornará um erro. Se a verificação for bem-sucedida, o sistema retornará o código de erro `DryRunOperation`. false (padrão): Envia uma solicitação normal e consulta o status do recurso após a verificação ser bem-sucedida e um código de status HTTP 2xx ser retornado.	false
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a VPC pertence.	rg-acfmxvfvazb4p****
PageNumber	integer	Não	O número da página da lista. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para paginação. Valor máximo: 50. Valor padrão: 10.	10
VpcOwnerId	integer	Não	O ID da conta Alibaba Cloud da VPC.	253460731706911258
DhcpOptionsSetId	string	Não	O ID do conjunto de opções DHCP.	dopt-o6w0df4epg9zo8isy****
EnableIpv6	boolean	Não	Especifica se devem ser consultadas as VPCs para as quais os blocos CIDR IPv6 estão ativados na região especificada. Por padrão, este parâmetro está vazio, o que significa que as VPCs não são filtradas com base na ativação de blocos CIDR IPv6. Valores válidos: false: Os blocos CIDR IPv6 não estão ativados. true: Os blocos CIDR IPv6 estão ativados.	false
Tag	array<object>	Não	As tags do recurso.
	object	Não	A tag.
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. Se você especificar este parâmetro, não poderá especificar uma string vazia. Uma chave de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. Se você especificar este parâmetro, poderá especificar uma string vazia. Um valor de tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações retornadas.
PageSize	integer	O número de entradas por página para paginação.	10
RequestId	string	O ID da solicitação.	C6532AA8-D0F7-497F-A8EE-094126D441F5
PageNumber	integer	O número da página da lista.	1
TotalCount	integer	O número total de entradas.	2
Vpcs	object
Vpc	array<object>	Os detalhes da VPC.
	array<object>	Os detalhes da VPC.
CreationTime	string	A hora em que a VPC foi criada. A hora é exibida em UTC e segue o padrão ISO 8601 no formato YYYY-MM-DDThh:mm:ssZ.	2021-04-18T15:02:37Z
Status	string	O status da VPC. Valores válidos: Pending: A VPC está sendo configurada. Available: A VPC está disponível.	Available
VpcId	string	O ID da VPC.	vpc-bp1qpo0kug3a20qqe****
IsDefault	boolean	Indica se a VPC é a VPC padrão na região. Valores válidos: true: A VPC é a VPC padrão na região. false: A VPC não é a VPC padrão na região.	false
OwnerId	integer	O ID da conta Alibaba Cloud da VPC.	253460731706911258
RegionId	string	O ID da região da VPC.	cn-hangzhou
VpcName	string	O nome da VPC.	vpc1
VRouterId	string	O ID do vRouter.	vrt-bp1jcg5cmxjbl9xgc****
DhcpOptionsSetStatus	string	O status do conjunto de opções DHCP. Valores válidos: Available: O conjunto de opções DHCP está disponível. InUse: O conjunto de opções DHCP está em uso. Deleted: O conjunto de opções DHCP foi excluído. Pending: O conjunto de opções DHCP está sendo configurado.	Available
CidrBlock	string	O bloco CIDR IPv4 da VPC.	192.168.0.0/16
Description	string	A descrição da VPC.	This is my VPC.
ResourceGroupId	string	O ID do grupo de recursos ao qual a VPC pertence.	rg-acfmxazb4ph****
DhcpOptionsSetId	string	O ID do conjunto de opções DHCP.	dopt-o6w0df4epg9zo8isy****
Ipv6CidrBlock	string	O bloco CIDR IPv6 da VPC.	2408:XXXX:0:a600::/56
CenStatus	string	O status da VPC anexada à Cloud Enterprise Network (CEN). Este parâmetro retorna Attached apenas quando a VPC está anexada a uma instância CEN.	Attached
Tags	object
Tag	array<object>	As informações de tag da VPC.
	object	As informações de tag da VPC.
Key	string	A chave da tag anexada à VPC.	FinanceDept
Value	string	O valor da tag anexada à VPC.	FinanceJoshua
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>	As informações do bloco CIDR IPv6 da VPC.
	object	As informações do bloco CIDR IPv6 da VPC.
Ipv6Isp	string	O tipo do bloco CIDR IPv6 da VPC. Valores válidos: BGP: Alibaba Cloud BGP IPv6. ChinaMobile: China Mobile (linha única). ChinaUnicom: China Unicom (linha única). ChinaTelecom: China Telecom (linha única). Nota Se você for adicionado à lista de permissões de largura de banda de linha única, poderá definir este parâmetro como ChinaTelecom, ChinaUnicom ou ChinaMobile.	BGP
Ipv6CidrBlock	string	O bloco CIDR IPv6 da VPC.	2408:XXXX:0:a600::/56
VSwitchIds	object
VSwitchId	array	A lista de vSwitches na VPC consultada. Você pode consultar até 300 vSwitches criados mais recentemente na VPC. Para consultar todos os vSwitches na VPC, chame a operação DescribeVSwitches.
	string	A lista de vSwitches na VPC consultada. Você pode consultar até 300 vSwitches criados mais recentemente na VPC. Para consultar todos os vSwitches na VPC, chame a operação DescribeVSwitches.	vsw-bp1nhbnpv2blyz8dl****
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	As informações do bloco CIDR secundário.
	string	O bloco CIDR secundário da VPC.	192.168.20.0/24
UserCidrs	object
UserCidr	array	A lista de blocos CIDR do usuário.
	string	A lista de blocos CIDR do usuário.	10.0.0.0/8
NatGatewayIds	object
NatGatewayIds	array	O ID do NAT gateway.
	string	O ID do NAT gateway.	nat-245xxxftwt45bg****
RouterTableIds	object
RouterTableIds	array	As informações da tabela de rotas.
	string	O ID da tabela de rotas.	vtb-bp1krxxzp0c29fmon****
EnabledIpv6	boolean	Indica se o IPv6 está ativado. Valores válidos: false: O IPv6 está desativado. true: O IPv6 está ativado.	false
DnsHostnameStatus	string	Indica se o nome de host DNS está ativado.	DISABLED

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "C6532AA8-D0F7-497F-A8EE-094126D441F5",
  "PageNumber": 1,
  "TotalCount": 2,
  "Vpcs": {
    "Vpc": [
      {
        "CreationTime": "2021-04-18T15:02:37Z",
        "Status": "Available",
        "VpcId": "vpc-bp1qpo0kug3a20qqe****",
        "IsDefault": false,
        "OwnerId": 253460731706911260,
        "RegionId": "cn-hangzhou",
        "VpcName": "vpc1",
        "VRouterId": "vrt-bp1jcg5cmxjbl9xgc****",
        "DhcpOptionsSetStatus": "Available",
        "CidrBlock": "192.168.0.0/16",
        "Description": "This is my VPC.",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "DhcpOptionsSetId": "dopt-o6w0df4epg9zo8isy****",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/56",
        "CenStatus": "Attached",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "Ipv6CidrBlocks": {
          "Ipv6CidrBlock": [
            {
              "Ipv6Isp": "BGP",
              "Ipv6CidrBlock": "2408:XXXX:0:a600::/56"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "SecondaryCidrBlocks": {
          "SecondaryCidrBlock": [
            "192.168.20.0/24"
          ]
        },
        "UserCidrs": {
          "UserCidr": [
            "10.0.0.0/8"
          ]
        },
        "NatGatewayIds": {
          "NatGatewayIds": [
            "nat-245xxxftwt45bg****"
          ]
        },
        "RouterTableIds": {
          "RouterTableIds": [
            "vtb-bp1krxxzp0c29fmon****"
          ]
        },
        "EnabledIpv6": false,
        "DnsHostnameStatus": "DISABLED"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	O número de IDs de VPC excede o limite.
400	InvalidAliuid	User Id is not valid.
400	InvalidResourceGroupId	The specified ResourceGroupId does not exist.	O ID do grupo de recursos não existe.
400	InvalidTagKey	The tag keys are not valid.	O índice da tag é inválido.
400	InvalidTagValue	The tag values are not valid.	O valor da tag é inválido.
400	InvalidResourceGroupId.NotFound	The Specified ResourceGroupId not exists.
400	OperationUnsupported.ResourceGroupId	%s
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	O parâmetro OwnerAccount especificado é inválido.
400	IllegalParam.OwnerId	The specified parameter VpcOwnerId is not valid.
400	InvalidAccount.NotFound	The account is invalid.	A operação falhou porque a conta chamadora é inválida.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	O throttling é acionado porque o número de saltos de página na paginação profunda atingiu o limite. Reduza a frequência de saltos de página na paginação profunda ou use a paginação sequencial.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	O parâmetro TagKey especificado está duplicado.
500	InternalError	The request processing has failed due to some unknown error.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.