DescribeVSwitches - Virtual Private Cloud - Centro de documentación de Alibaba Cloud

Consulta información de red. La conexión de red interna se realiza mediante vSwitch.

Descripción de la operación

La operación DescribeVSwitches puede devolver el código de error Throttling.DeepPageSkip durante la paginación profunda o el salto de páginas frecuentes. Reduzca la frecuencia de consulta o utilice la paginación secuencial.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

vpc:DescribeVSwitches

list

*VSwitch

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

vpc:VPC

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
VpcId	string	No	El ID de la VPC a la que pertenecen los vSwitch que desea consultar. Nota Especifique al menos uno de los parámetros RegionId y VpcId.	vpc-25cdvfeq58pl****
VSwitchId	string	No	El ID del vSwitch que desea consultar.	vsw-23dscddcffvf3****
ZoneId	string	No	El ID de la zona a la que pertenece el vSwitch. Puede llamar a la operación DescribeZones para consultar el ID de la zona.	cn-hangzhou-d
RegionId	string	No	El ID de la región a la que pertenece el vSwitch. Puede llamar a la operación DescribeRegions para consultar el ID de la región. Nota Especifique al menos uno de los parámetros RegionId y VpcId.	cn-hangzhou
VSwitchName	string	No	El nombre del vSwitch. El nombre debe tener entre 1 y 128 caracteres de longitud y no puede comenzar con `http://` o `https://`.	vSwitch
DryRun	boolean	No	Especifica si se debe realizar una ejecución de prueba (dry run). Valores válidos: true: realiza una ejecución de prueba. El sistema verifica los parámetros requeridos, la sintaxis de la solicitud y las restricciones comerciales. Si la verificación falla, se devuelve el error correspondiente. Si la verificación es exitosa, se devuelve el código de error `DryRunOperation`. false (valor predeterminado): realiza una ejecución de prueba y envía la solicitud. Si la verificación es exitosa, se devuelve un código de estado HTTP 2xx y se ejecuta la operación.	true
IsDefault	boolean	No	Especifica si se debe consultar el vSwitch predeterminado en la región especificada. Valores válidos: true: consulta el vSwitch predeterminado en la región especificada. false: no consulta el vSwitch predeterminado en la región especificada. Si no especifica este parámetro, el sistema consulta todos los vSwitch en la región especificada.	true
RouteTableId	string	No	El ID de la tabla de rutas.	vtb-bp145q7glnuzdvzu2****
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenece el vSwitch.	rg-bp67acfmxazb4ph****
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página para consultas de paginación. Valor máximo: 50. Valor predeterminado: 10.	10
VSwitchOwnerId	integer	No	El ID de la cuenta de Alibaba Cloud propietaria del recurso.	2546073170691****
EnableIpv6	boolean	No	Especifica si se deben consultar los vSwitch que tienen bloques CIDR IPv6 habilitados en la región especificada. Valores válidos: true: consulta los vSwitch que tienen bloques CIDR IPv6 habilitados en la región especificada. false: no consulta los vSwitch que tienen bloques CIDR IPv6 habilitados en la región especificada. Si no especifica este parámetro, el sistema consulta todos los vSwitch en la región especificada.	false
Tag	array<object>	No	Las etiquetas del recurso.
	object	No	La etiqueta.
Key	string	No	La clave de etiqueta del recurso. Puede especificar hasta 20 claves de etiqueta. La clave de etiqueta no puede ser una cadena vacía. La clave de etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`.	FinanceDept
Value	string	No	El valor de etiqueta del recurso. Puede especificar hasta 20 valores de etiqueta. El valor de etiqueta puede ser una cadena vacía. El valor de etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con `aliyun` o `acs:`. No puede contener `http://` o `https://`.	FinanceJoshua

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
PageSize	integer	El número de entradas por página.	10
RequestId	string	El ID de la solicitud.	9A572171-4E27-40D1-BD36-D26C9E71E29E
PageNumber	integer	El número de página.	1
TotalCount	integer	El número total de entradas devueltas.	1
VSwitches	object
VSwitch	array<object>	Los detalles de los vSwitch.
	array<object>	La estructura del vSwitch.
VpcId	string	El ID de la VPC a la que pertenece el vSwitch.	vpc-257gcdcdq64****
Status	string	El estado del vSwitch. Valores válidos: Pending: configurándose. Available: disponible.	Available
CreationTime	string	La hora en que se creó el vSwitch.	2022-01-18T12:43:57Z
IsDefault	boolean	Indica si el vSwitch es el vSwitch predeterminado. Valores válidos: true: es el vSwitch predeterminado. false: no es el vSwitch predeterminado.	true
AvailableIpAddressCount	integer	El número de direcciones IP disponibles en el vSwitch.	1
NetworkAclId	string	El ID de la ACL de red.	nacl-a2do9e413e0spzasx****
OwnerId	integer	El ID de la cuenta de Alibaba Cloud propietaria del recurso.	25346073170691****
VSwitchId	string	El ID del vSwitch.	vsw-25bcdxs7pv1****
CidrBlock	string	El bloque CIDR IPv4 del vSwitch.	172.16.0.0/24
Description	string	La descripción del vSwitch.	VSwitchDescription
ResourceGroupId	string	El ID del grupo de recursos al que pertenece el vSwitch.	rg-acfmxazb4ph6aiy****
ZoneId	string	La zona a la que pertenece el vSwitch.	cn-hangzhou-d
Ipv6CidrBlock	string	El bloque CIDR IPv6 del vSwitch.	2408:4002:10c4:4e03::/64
VSwitchName	string	El nombre del vSwitch.	vSwitch
ShareType	string	El tipo de uso compartido del vSwitch. Si el valor está vacío, el vSwitch es un vSwitch normal. Si el valor es Shared, el vSwitch es un vSwitch compartido. Si el valor es Sharing, el vSwitch se está compartiendo con otros.	Shared
EnabledIpv6	boolean	Indica si el bloque CIDR IPv6 está habilitado para el vSwitch. Valores válidos: true: habilitado. false: no habilitado.	true
Tags	object
Tag	array<object>	La información de etiquetas del vSwitch.
	object	La estructura de información de etiquetas.
Key	string	La clave de etiqueta vinculada al vSwitch.	department
Value	string	El valor de etiqueta vinculado al vSwitch.	dev
RouteTable	object	La información de la tabla de rutas.
RouteTableId	string	El ID de la tabla de rutas asociada al vSwitch.	vrt-bp145q7glnuzdv****
RouteTableType	string	El tipo de la tabla de rutas asociada al vSwitch. Valores válidos: System: tabla de rutas del sistema. Custom: tabla de rutas personalizada.	System

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	Forbidden.VpcNotFound	Specified VPC can not found.	The specified VPC does not exist.
400	InvalidTagKey	The tag keys are not valid.	The tag index is invalid.
400	InvalidTagValue	The tag values are not valid.	The tag value is invalid.
400	IellgalParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	The specified parameter OwnerAccount is illegal.
400	IllegalParam.OwnerId	The specified parameter VSwitchOwnerId is not valid.
400	InvalidVpcIdNumber.NotSupported	The number of vpcIds exceeds the limit.	The value of the vpcId parameter has reached the upper limit.
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.	The number of deep pagination skip operations has triggered rate limiting. Reduce the frequency of deep page jumps, or use sequential paging.
404	InvalidVSwitchId.NotFound	VSwitch not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.