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

Consulta um ou mais vSwitches.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região do vSwitch.	cn-hangzhou
VpcId	string	Não	O ID da nuvem privada virtual (VPC) à qual o vSwitch pertence. Nota Especifique pelo menos um dos parâmetros VpcId e DedicatedHostGroupId.	vpc-25cdvfeq58pl****
ZoneId	string	Não	O ID da zona do vSwitch.	cn-hangzhou-d
DedicatedHostGroupId	string	Não	O ID do cluster dedicado. Nota Especifique pelo menos um dos parâmetros VpcId e DedicatedHostGroupId.	dhg-4n****
PageNumber	integer	Não	O número da página da lista. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página para uma consulta paginada. O valor máximo é 50. O valor padrão é 50.	50
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o vSwitch pertence.	rg-bp67acfmxazb4ph****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	9A572171-4E27-40D1-BD36-D26C9E71E29E
TotalCount	integer	O número de entradas na lista.	1
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas na página atual.	10
VSwitchs	array<object>	A lista de vSwitches.
	object
CidrBlock	string	O bloco CIDR IPv4 do vSwitch.	172.16.0.0/24
Description	string	A descrição do vSwitch.	vSwitchDescription
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.	true
IzNo	string	A zona onde o NAT Gateway está localizado.	cn-hangzhou-b
Status	string	O status do vSwitch. Valores válidos: Pending: O vSwitch está sendo configurado. Available: O vSwitch está ativo.	Available
VSwitchId	string	O ID do vSwitch.	vsw-25bcdxs7pv1****
VSwitchName	string	O nome do vSwitch.	vSwitch
AvailableIpAddressCount	integer	O número de endereços IP disponíveis no vSwitch.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10,
  "VSwitchs": [
    {
      "CidrBlock": "172.16.0.0/24",
      "Description": "vSwitchDescription\t\n",
      "IsDefault": true,
      "IzNo": "cn-hangzhou-b\t\n",
      "Status": "Available",
      "VSwitchId": "vsw-25bcdxs7pv1****\t\n",
      "VSwitchName": "vSwitch",
      "AvailableIpAddressCount": 1
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidVSwitchId.NotFound	Specified virtual switch is not found in specified VPC.
400	IncorrecttVpcId	The specified parameter VPCId is not valid.
400	InvalidIzNo.NotSupported	Specified VPC zone is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.