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

Consulta as informações detalhadas de um vSwitch.

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

get

*VSwitch

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VSwitchId	string	Sim	O ID do vSwitch.	vsw-25naue4g****
RegionId	string	Não	O ID da região da VPC à qual o vSwitch pertence. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run, sem executar a solicitação real. Valores válidos: true: Realiza apenas um dry run. O sistema verifica a solicitação quanto a possíveis problemas, incluindo valores de parâmetros ausentes, sintaxe de solicitação incorreta e limites de serviço. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro DryRunOperation será retornado. false (padrão): Envia uma solicitação e realiza um dry run. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e a operação será executada.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes do vSwitch.
VpcId	string	O ID da VPC à qual o vSwitch pertence.	vpc-257gq642n****
Status	string	O status do vSwitch. Valores válidos: Pending Available	Pending
CreationTime	string	A hora em que o vSwitch foi criado.	2021-08-22T10:40:25Z
IsDefault	boolean	Indica se o vSwitch é o vSwitch padrão. Valores válidos: true false	false
AvailableIpAddressCount	integer	O número de endereços IP disponíveis.	12
NetworkAclId	string	O ID da lista de controle de acesso (ACL) de rede.	1
OwnerId	integer	O ID da conta Alibaba Cloud à qual o recurso pertence.	28768383240243****
VSwitchId	string	O ID do vSwitch.	vsw-25b7pv15t****
RequestId	string	O ID da solicitação.	7B48B4B9-1EAD-469F-B488-594DAB4B6A1A
CidrBlock	string	O bloco CIDR do vSwitch.	192.168.0.1/24
Description	string	A descrição do vSwitch.	abc
ResourceGroupId	string	O ID do grupo de recursos ao qual o vSwitch pertence.	rg-acfmxazb4ph****
ZoneId	string	O ID da zona à qual o vSwitch pertence.	cn-beijing-a
Ipv6CidrBlock	string	O bloco CIDR IPv6 do vSwitch.	2408:XXXX:3c5:44e::/64
VSwitchName	string	O nome do vSwitch.	test
ShareType	string	Indica se o vSwitch é compartilhado. Se nenhum valor for retornado, o vSwitch é um vSwitch comum. Se Shared for retornado, o vSwitch é compartilhado. Se Sharing for retornado, o vSwitch está sendo compartilhado.	Shared
EnabledIpv6	boolean	Indica se o IPv6 está ativado para o vSwitch. Se você ativar o IPv6, deverá configurar o bloco CIDR IPv6 do vSwitch. Valores válidos: true false Este campo é retornado apenas quando o IPv6 está ativado para o vSwitch.	true
RouteTable	object	As informações sobre a tabela de rotas associada ao vSwitch.
RouteTableId	string	O ID da tabela de rotas associada ao vSwitch.	vtb-bp145q7glnuzdv****
RouteTableType	string	O tipo da tabela de rotas. Valores válidos: System Custom	System
Tags	object
Tag	array<object>	As informações sobre as tags.
	object
Key	string	The key of tag N added to the resource.	FinanceDept
Value	string	The value of tag N added to the resource.	FinanceJoshua

Exemplos

Resposta de sucesso

JSON formato

{
  "VpcId": "vpc-257gq642n****",
  "Status": "Pending",
  "CreationTime": "2021-08-22T10:40:25Z",
  "IsDefault": false,
  "AvailableIpAddressCount": 12,
  "NetworkAclId": "1",
  "OwnerId": 0,
  "VSwitchId": "vsw-25b7pv15t****",
  "RequestId": "7B48B4B9-1EAD-469F-B488-594DAB4B6A1A",
  "CidrBlock": "192.168.0.1/24",
  "Description": "abc",
  "ResourceGroupId": "rg-acfmxazb4ph****",
  "ZoneId": "cn-beijing-a",
  "Ipv6CidrBlock": "2408:XXXX:3c5:44e::/64",
  "VSwitchName": "test",
  "ShareType": "Shared",
  "EnabledIpv6": true,
  "RouteTable": {
    "RouteTableId": "vtb-bp145q7glnuzdv****",
    "RouteTableType": "System"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidVSwitchId.NotFound	Specified VSwitch can not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.