DescribeVSwitches - - Centro de documentación de Alibaba Cloud

Consulta vSwitches.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeVSwitches	La operación que desea ejecutar. Establezca el valor en DescribeVSwitches.
VpcId	String	No	vpc-25cdvfeq58pl****	El ID de la VPC a la que pertenece el vSwitch. Nota Especifique como mínimo uno de los siguientes parámetros: RegionId o VpcId.
VSwitchId	String	No	vsw-23dscddcffvf3****	El ID del vSwitch que desea consultar.
ZoneId	String	No	cn-hangzhou-d	El ID de la zona a la que pertenece el vSwitch. Llame a la operación DescribeZones para obtener la lista más reciente de zonas.
RegionId	String	No	cn-hangzhou	El ID de la región a la que pertenece el vSwitch. Llame a la operación DescribeRegions para obtener la lista más reciente de regiones. Nota Especifique como mínimo uno de los siguientes parámetros: RegionId o VpcId.
VSwitchName	String	No	vSwitch	El nombre del vSwitch. El nombre debe tener entre 1 y 128 caracteres de longitud. No puede comenzar con `http://` ni con `https://`.
DryRun	Boolean	No	true	Indica si se ejecuta únicamente una prueba sin realizar la solicitud real. Valores válidos: true: solo se realiza la prueba. El sistema comprueba posibles problemas en la solicitud, como valores de parámetros faltantes, sintaxis incorrecta o límites del servicio. Si la prueba falla, se devuelve un mensaje de error. Si la prueba se supera correctamente, se devuelve el código de error `DryRunOperation`. false (predeterminado): se ejecuta la prueba y también la solicitud real. Si la prueba se supera correctamente, se devuelve un código de estado HTTP 2xx y se ejecuta la operación.
IsDefault	Boolean	No	true	Indica si se consulta el vSwitch predeterminado en la región especificada. Valores válidos: true false Si no especifica este parámetro, el sistema consulta todos los vSwitches de la región indicada de forma predeterminada.
RouteTableId	String	No	vtb-bp145q7glnuzdvzu2****	El ID de la tabla de rutas.
ResourceGroupId	String	No	rg-bp67acfmxazb4ph****	El ID del resource group al que pertenece el vSwitch.
PageNumber	Integer	No	1	El número de página que se va a devolver. Valor predeterminado: 1.
PageSize	Integer	No	10	El número de entradas por página. Valor máximo: 50. Valor predeterminado: 10.
VSwitchOwnerId	Long	No	2546073170691****	El ID de la cuenta de Alibaba Cloud a la que pertenece el vSwitch.
Tag.N.Key	String	No	FinanceDept	La clave de la etiqueta N que se agrega al recurso. Se pueden especificar hasta 20 claves de etiqueta. La clave no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 128 caracteres de longitud. No puede comenzar con `aliyun` ni con `acs:`, y no debe contener `http://` o `https://`.
Tag.N.Value	String	No	FinanceJoshua	El valor de la etiqueta N que se agrega al recurso. Se pueden especificar hasta 20 valores de etiqueta. El valor puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres de longitud y no debe contener `http://` ni `https://`. Tampoco puede comenzar con `aliyun` o `acs:`.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
PageSize	Integer	10	El número de entradas por página.
RequestId	String	9A572171-4E27-40D1-BD36-D26C9E71E29E	El ID de la solicitud.
PageNumber	Integer	1	El número de la página devuelta.
TotalCount	Integer	1	El número total de entradas devueltas.
VSwitches	Array of VSwitch		Los detalles del vSwitch.
VSwitch
VpcId	String	vpc-257gcdcdq64****	El ID de la VPC a la que pertenece el vSwitch.
Status	String	Available	El estado del vSwitch. Valores válidos: Pending Available
CreationTime	String	2022-01-18T12:43:57Z	La hora en que se creó el vSwitch.
IsDefault	Boolean	true	Indica si se consultó el vSwitch predeterminado en la región donde está desplegada la pila. Valores válidos: true false
AvailableIpAddressCount	Long	1	El número de direcciones IP disponibles en el vSwitch.
NetworkAclId	String	nacl-a2do9e413e0spzasx****	El ID de la ACL de red.
OwnerId	Long	253460731706911258	El ID de la cuenta de Alibaba Cloud a la que pertenece el vSwitch.
VSwitchId	String	vsw-25bcdxs7pv1****	El ID del vSwitch.
CidrBlock	String	172.16.0.0/24	El bloque CIDR IPv4 del vSwitch.
Description	String	VSwitchDescription	La descripción del vSwitch.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	El ID del resource group al que pertenece el vSwitch.
ZoneId	String	cn-hangzhou-d	El ID de la zona a la que pertenece el vSwitch.
Ipv6CidrBlock	String	2408:4002:10c4:4e03::/64	El bloque CIDR IPv6 del vSwitch.
VSwitchName	String	vSwitch	El nombre del vSwitch.
ShareType	String	Shared	Indica si el vSwitch es compartido. Si no se devuelve ningún valor, el vSwitch es un vSwitch estándar. Si se devuelve Shared, el vSwitch es un vSwitch compartido. Si se devuelve Sharing, el vSwitch se encuentra en proceso de compartición.
EnabledIpv6	Boolean	true	Indica si IPv6 está habilitado para el vSwitch. Si habilita IPv6, debe configurar el bloque CIDR IPv6 del vSwitch. Valores válidos: true false
Tags	Array of Tag		La información de etiquetas del vSwitch.
Tag
Key	String	department	La clave de la etiqueta N.
Value	String	dev	El valor de la etiqueta N.
RouteTable	Object		La información de la tabla de rutas.
RouteTableId	String	vrt-bp145q7glnuzdv****	El ID de la tabla de rutas asociada al vSwitch.
RouteTableType	String	System	El tipo de la tabla de rutas asociada al vSwitch. Valores válidos: System Custom

Ejemplos

Solicitudes de ejemplo

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

Respuestas correctas de ejemplo

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 error

HttpCode	Código de error	Mensaje de error	Descripción
400	Forbidden.VpcNotFound	Specified VPC can not found.	La VPC especificada no existe.
400	InvalidTagKey	The tag keys are not valid.	El índice de la etiqueta no es válido.
400	InvalidTagValue	The tag values are not valid.	El valor de la etiqueta no es válido.
404	InvalidVSwitchId.NotFound	VSwitch not exist.	El vSwitch especificado no existe. Compruebe si el ID del vSwitch indicado es válido.
404	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	El número de IDs de VPC supera el límite permitido.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.