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

Consulta informações de rede. A rede interna é realizada por vSwitch.

Descrição da operação

A operação DescribeVSwitches pode retornar o código de erro Throttling.DeepPageSkip durante paginação profunda ou salto de páginas 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:DescribeVSwitches

list

*VSwitch.

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

vpc:VPC

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VpcId	string	Não	O ID da VPC à qual pertencem os vSwitches que você deseja consultar.	vpc-25cdvfeq58pl****
VSwitchId	string	Não	O ID do vSwitch que você deseja consultar.	vsw-23dscddcffvf3****
ZoneId	string	Não	O ID da zona à qual o vSwitch pertence. Você pode chamar a operação DescribeZones para consultar o ID da zona.	cn-hangzhou-d
RegionId	string	Não	O ID da região à qual o vSwitch pertence. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
VSwitchName	string	Não	O nome do vSwitch.	vSwitch
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos:	true
IsDefault	boolean	Não	Especifica se deve consultar o vSwitch padrão na região especificada. Valores válidos:	true
RouteTableId	string	Não	O ID da tabela de rotas.	vtb-bp145q7glnuzdvzu2****
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o vSwitch pertence.	rg-bp67acfmxazb4ph****
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página para consultas paginadas. Valor máximo: 50. Valor padrão: 10.	10
VSwitchOwnerId	integer	Não	O ID da conta Alibaba Cloud proprietária do recurso.	2546073170691****
EnableIpv6	boolean	Não	Especifica se deve consultar vSwitches que têm blocos CIDR IPv6 ativados na região especificada. Valores válidos:	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. A chave da tag não pode ser uma string vazia.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. O valor da tag pode ser uma string vazia.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
PageSize	integer	O número de entradas por página.	10
RequestId	string	O ID da solicitação.	9A572171-4E27-40D1-BD36-D26C9E71E29E
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas retornadas.	1
VSwitches	object
VSwitch	array<object>	Os detalhes dos vSwitches.
	array<object>	A estrutura do vSwitch.
VpcId	string	O ID da VPC à qual o vSwitch pertence.	vpc-257gcdcdq64****
Status	string	O status do vSwitch. Valores válidos:	Available
CreationTime	string	A hora em que o vSwitch foi criado.	2022-01-18T12:43:57Z
IsDefault	boolean	Indica se o vSwitch é o vSwitch padrão. Valores válidos:	true
AvailableIpAddressCount	integer	O número de endereços IP disponíveis no vSwitch.	1
NetworkAclId	string	O ID da ACL de rede.	nacl-a2do9e413e0spzasx****
OwnerId	integer	O ID da conta Alibaba Cloud proprietária do recurso.	25346073170691****
VSwitchId	string	O ID do vSwitch.	vsw-25bcdxs7pv1****
CidrBlock	string	O bloco CIDR IPv4 do vSwitch.	172.16.0.0/24
Description	string	A descrição do vSwitch.	VSwitchDescription
ResourceGroupId	string	O ID do grupo de recursos ao qual o vSwitch pertence.	rg-acfmxazb4ph6aiy****
ZoneId	string	A zona à qual o vSwitch pertence.	cn-hangzhou-d
Ipv6CidrBlock	string	O bloco CIDR IPv6 do vSwitch.	2408:4002:10c4:4e03::/64
VSwitchName	string	O nome do vSwitch.	vSwitch
ShareType	string	O tipo de compartilhamento do vSwitch.	Shared
EnabledIpv6	boolean	Indica se o bloco CIDR IPv6 está ativado para o vSwitch. Valores válidos:	true
Tags	object
Tag	array<object>	As informações de tag do vSwitch.
	object	A estrutura de informações da tag.
Key	string	A chave da tag do vSwitch.	department
Value	string	O valor da tag do vSwitch.	dev
RouteTable	object	As informações da tabela de rotas.
RouteTableId	string	O ID da tabela de rotas associada ao vSwitch.	vrt-bp145q7glnuzdv****
RouteTableType	string	O tipo da tabela de rotas associada ao vSwitch. Valores válidos:	System

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber": 1,
  "TotalCount": 1,
  "VSwitches": {
    "VSwitch": [
      {
        "VpcId": "vpc-257gcdcdq64****",
        "Status": "Available",
        "CreationTime": "2022-01-18T12:43:57Z",
        "IsDefault": true,
        "AvailableIpAddressCount": 1,
        "NetworkAclId": "nacl-a2do9e413e0spzasx****",
        "OwnerId": 0,
        "VSwitchId": "vsw-25bcdxs7pv1****",
        "CidrBlock": "172.16.0.0/24",
        "Description": "VSwitchDescription",
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "ZoneId": "cn-hangzhou-d",
        "Ipv6CidrBlock": "2408:4002:10c4:4e03::/64",
        "VSwitchName": "vSwitch",
        "ShareType": "Shared",
        "EnabledIpv6": true,
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "dev"
            }
          ]
        },
        "RouteTable": {
          "RouteTableId": "vrt-bp145q7glnuzdv****",
          "RouteTableType": "System"
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	Forbidden.VpcNotFound	Specified VPC can not found.	A VPC especificada não existe. Verifique se a VPC está correta.
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	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	O parâmetro OwnerAccount especificado é inválido.
400	IllegalParam.OwnerId	The specified parameter VSwitchOwnerId is not valid.
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	O número de IDs de VPC excede o limite.
400	InvalidVSwitchIdNumber.NotSupported	The number of vSwitchIds exceeds the limit.
400	Throttling.DeepPageSkip	Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination.	A frequência de saltos de página na paginação profunda acionou o limitador. Reduza a frequência de saltos de página na paginação profunda ou use a paginação sequencial.
404	InvalidVSwitchId.NotFound	VSwitch not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.