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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeVSwitches	Operação a ser executada. Defina o valor como DescribeVSwitches.
VpcId	String	Não	vpc-25cdvfeq58pl****	ID da VPC à qual o vSwitch pertence. Nota Especifique pelo menos um dos parâmetros RegionId ou VpcId.
VSwitchId	String	Não	vsw-23dscddcffvf3****	ID do vSwitch a ser consultado.
ZoneId	String	Não	cn-hangzhou-d	ID da zona à qual o vSwitch pertence. Chame a operação DescribeZones para obter a lista mais recente de zonas.
RegionId	String	Não	cn-hangzhou	ID da região à qual o vSwitch pertence. Chame a operação DescribeRegions para obter a lista mais recente de regiões. Nota Especifique pelo menos um dos parâmetros RegionId ou VpcId.
VSwitchName	String	Não	vSwitch	Nome do vSwitch. Deve ter de 1 a 128 caracteres. Não pode começar com `http://` ou `https://`.
DryRun	Boolean	Não	true	Define se apenas uma simulação será executada, sem realizar a solicitação real. Valores válidos: true: executa apenas a simulação. O sistema verifica a solicitação em busca de problemas potenciais, incluindo valores de parâmetros ausentes, sintaxe incorreta e limites de serviço. Se a solicitação falhar na simulação, uma mensagem de erro é retornada. Caso seja aprovada, o código de erro `DryRunOperation` é retornado. false (padrão): executa a simulação e realiza a solicitação real. Se a solicitação passar na simulação, um código de status HTTP 2xx é retornado e a operação é executada.
IsDefault	Boolean	Não	true	Indica se o vSwitch padrão na região especificada deve ser consultado. Valores válidos: true false Se este parâmetro não for especificado, o sistema consulta todos os vSwitches na região indicada por padrão.
RouteTableId	String	Não	vtb-bp145q7glnuzdvzu2****	ID da tabela de rotas.
ResourceGroupId	String	Não	rg-bp67acfmxazb4ph****	ID do grupo de recursos ao qual o vSwitch pertence.
PageNumber	Integer	Não	1	Número da página a ser retornada. Valor padrão: 1.
PageSize	Integer	Não	10	Número de entradas por página. Valor máximo: 50. Valor padrão: 10.
VSwitchOwnerId	Long	Não	2546073170691****	ID da conta Alibaba Cloud à qual o vSwitch pertence.
Tag.N.Key	String	Não	FinanceDept	Chave da tag N a ser adicionada ao recurso. É possível especificar até 20 chaves de tag. A chave não pode ser uma string vazia. A chave da tag pode ter até 128 caracteres. Não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`.
Tag.N.Value	String	Não	FinanceJoshua	Valor da tag N a ser adicionado ao recurso. É possível especificar até 20 valores de tag. O valor pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter `http://` ou `https://`. Também não pode começar com `aliyun` ou `acs:`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Integer	10	Número de entradas por página.
RequestId	String	9A572171-4E27-40D1-BD36-D26C9E71E29E	ID da solicitação.
PageNumber	Integer	1	Número da página retornada.
TotalCount	Integer	1	Número total de entradas retornadas.
VSwitches	Array of VSwitch		Detalhes do vSwitch.
VSwitch
VpcId	String	vpc-257gcdcdq64****	ID da VPC à qual o vSwitch pertence.
Status	String	Available	Status do vSwitch. Valores válidos: Pending Available
CreationTime	String	2022-01-18T12:43:57Z	Data e hora de criação do vSwitch.
IsDefault	Boolean	true	Indica se o vSwitch padrão na região onde a pilha está implantada foi consultado. Valores válidos: true false
AvailableIpAddressCount	Long	1	Quantidade de endereços IP disponíveis no vSwitch.
NetworkAclId	String	nacl-a2do9e413e0spzasx****	ID da ACL de rede.
OwnerId	Long	253460731706911258	ID da conta Alibaba Cloud à qual o vSwitch pertence.
VSwitchId	String	vsw-25bcdxs7pv1****	ID do vSwitch.
CidrBlock	String	172.16.0.0/24	Bloco CIDR IPv4 do vSwitch.
Description	String	VSwitchDescription	Descrição do vSwitch.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	ID do grupo de recursos ao qual o vSwitch pertence.
ZoneId	String	cn-hangzhou-d	ID da zona à qual o vSwitch pertence.
Ipv6CidrBlock	String	2408:4002:10c4:4e03::/64	Bloco CIDR IPv6 do vSwitch.
VSwitchName	String	vSwitch	Nome do vSwitch.
ShareType	String	Shared	Indica se o vSwitch é compartilhado. Se nenhum valor for retornado, trata-se de um vSwitch comum. Se Shared for retornado, o vSwitch é compartilhado. Se Sharing for retornado, o vSwitch está em processo de compartilhamento.
EnabledIpv6	Boolean	true	Indica se o IPv6 está ativado para o vSwitch. Ao ativar o IPv6, configure também o bloco CIDR IPv6 correspondente. Valores válidos: true false
Tags	Array of Tag		Informações de tag do vSwitch.
Tag
Key	String	department	Chave da tag N.
Value	String	dev	Valor da tag N.
RouteTable	Object		Informações da tabela de rotas.
RouteTableId	String	vrt-bp145q7glnuzdv****	ID da tabela de rotas associada ao vSwitch.
RouteTableType	String	System	Tipo da tabela de rotas associada ao vSwitch. Valores válidos: System Custom

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=DescribeVSwitches
&VpcId=vpc-25cdvfeq58pl****
&VSwitchId=vsw-23dscddcffvf3****
&ZoneId=cn-hangzhou-d
&RegionId=cn-hangzhou
&VSwitchName=vSwitch
&DryRun=true
&IsDefault=true
&RouteTableId=vtb-bp145q7glnuzdvzu2****
&ResourceGroupId=rg-bp67acfmxazb4ph****
&PageNumber=1
&PageSize=10
&Tag=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&Common request parameters

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "VSwitches" : [ {
    "VpcId" : "vpc-257gcdcdq64****",
    "Status" : "Available",
    "CreationTime" : "2022-01-18T12:43:57Z",
    "IsDefault" : true,
    "AvailableIpAddressCount" : 1,
    "NetworkAclId" : "nacl-a2do9e413e0spzasx****",
    "OwnerId" : 253460731706911260,
    "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" : [ {
      "Key" : "department",
      "Value" : "dev"
    } ],
    "RouteTable" : {
      "RouteTableId" : "vrt-bp145q7glnuzdv****",
      "RouteTableType" : "System"
    }
  } ]
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	Forbidden.VpcNotFound	Specified VPC can not found.	A VPC especificada 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.
404	InvalidVSwitchId.NotFound	VSwitch not exist.	O vSwitch especificado não existe. Verifique se o ID do vSwitch informado é válido.
404	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	A quantidade de IDs de VPC excede o limite permitido.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.