DescribeRouterInterfaces - Express Connect - Centro de documentación de Alibaba Cloud

Consulta las interfaces de enrutador en una región especificada.

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

list

*RouterInterface

acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la interfaz de enrutador. Puede llamar a la operación DescribeRegions para consultar el ID de la región.	cn-hangzhou
IncludeReservationData	boolean	No	Especifica si se deben incluir los datos de renovación. Valores válidos: true false (valor predeterminado)	false
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página cuando se realiza la paginación. Valor máximo: 50. Valor predeterminado: 10.	10
Filter	array<object>	No	La información del filtro.
	object	No	La información del filtro.
Key	string	No	La condición de filtrado. Puede especificar hasta 5 condiciones de filtrado. Se admiten las siguientes condiciones de filtrado: RouterInterfaceId: el ID de la interfaz de enrutador. RouterId: el ID del enrutador. RouterType: el tipo de enrutador. Valores válidos: VRouter y VBR. RouterInterfaceOwnerId: el ID de la cuenta a la que pertenece la interfaz de enrutador. OppositeInterfaceId: el ID de la interfaz de enrutador par. OppositeRouterType: el tipo de la interfaz de enrutador par. Valores válidos: VRouter y VBR. OppositeRouterId: el ID de la interfaz de enrutador par. OppositeInterfaceOwnerId: el ID de la cuenta a la que pertenece la interfaz de enrutador par. Status: el estado de la interfaz de enrutador. Name: el nombre de la interfaz de enrutador. Nota Los múltiples valores de cada condición de filtrado tienen una relación OR. Se devuelve una interfaz de enrutador siempre que coincida con uno de los valores. Las condiciones de filtrado tienen una relación AND. Una interfaz de enrutador se devuelve solo cuando coincide con todas las condiciones de filtrado especificadas.	Filter.1.Status
Value	array	No	El valor de filtrado basado en la Key especificada. Puede especificar varios valores de filtrado para una Key. Los valores de filtrado tienen una relación OR. Se devuelve una interfaz de enrutador siempre que coincida con uno de los valores de filtrado.	Filter.1.Active 1
	string	No	El valor de filtrado basado en la Key especificada. Puede especificar varios valores de filtrado para una Key. Los valores de filtrado tienen una relación OR. Se devuelve una interfaz de enrutador siempre que coincida con uno de los valores de filtrado.	test
ResourceGroupId	string	No	El ID del grupo de recursos. Para obtener más información sobre los grupos de recursos, consulte ¿Qué es un grupo de recursos?.	rg-acfmxazb4ph6aiy****
Tags	array<object>	No	Las etiquetas del recurso.
	object	No	La etiqueta.
Key	string	No	La clave de etiqueta del recurso. Debe especificar al menos 1 clave de etiqueta y puede especificar hasta 20 claves de etiqueta. La clave de etiqueta no puede ser una cadena vacía. Una clave de etiqueta puede tener una longitud máxima de 128 caracteres. No puede comenzar con `aliyun` o `acs:`, y 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 una longitud máxima de 128 caracteres. No puede comenzar con `aliyun` o `acs:`, y no puede contener `http://` o `https://`.	FinanceJoshua

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
RequestId	string	El ID de la solicitud.	C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45
PageNumber	integer	El número de página. Valor predeterminado: 1.	1
PageSize	integer	El número de entradas por página cuando se realiza la paginación. Valor máximo: 50. Valor predeterminado: 10.	10
TotalCount	integer	El número total de entradas devueltas.	1
RouterInterfaceSet	object
RouterInterfaceType	array<object>	Los detalles de las interfaces de enrutador.
	array<object>	Los detalles de las interfaces de enrutador.
ReservationActiveTime	string	La hora de activación de la renovación. La hora sigue el estándar ISO 8601 en formato UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-03-11T16:00:00Z
HealthCheckTargetIp	string	La dirección IP de destino de la comprobación de estado.	116.62.XX.XX
Status	string	El estado de la interfaz de enrutador.	active
CreationTime	string	La hora en que se creó la tabla de rutas. La hora sigue el estándar ISO 8601 en formato UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
ReservationOrderType	string	El tipo de pedido de renovación.	RENEWCHANGE
OppositeInterfaceId	string	El ID de la interfaz de enrutador par.	ri-bp1itx13bwe6f2wfh****
Spec	string	La especificación de la interfaz de enrutador.	Large
ChargeType	string	El método de facturación.	PayByTraffic
RouterInterfaceId	string	El ID de la interfaz de enrutador.	ri-2zenfgfpyu3v93koa****
HcThreshold	integer	El umbral de la comprobación de estado.	2
OppositeRouterType	string	El tipo de enrutador al que pertenece la interfaz de enrutador par.	VRouter
VpcInstanceId	string	El ID de la VPC local en la conexión de emparejamiento.	vpc-2ze3tq4uxhysg717x****
OppositeInterfaceOwnerId	string	El ID de la cuenta a la que pertenece la interfaz de enrutador par.	271598332402530847
OppositeVpcInstanceId	string	El ID de la VPC par.	vpc-bp1qpo0kug3a20qqe****
ReservationInternetChargeType	string	El tipo de facturación de la renovación.	PayByBandwidth
CrossBorder	boolean	Indica si la conexión es una conexión transfronteriza.	false
Bandwidth	integer	El ancho de banda de la interfaz de enrutador. Unidad: Mbit/s.	10
Description	string	La descripción de la interfaz de enrutador.	Descripción de la interfaz de enrutador
HcRate	integer	La tasa de comprobación de estado.	1
ReservationBandwidth	string	El ancho de banda de la renovación. Unidad: Mbit/s.	10
Name	string	El nombre personalizado.	test
OppositeRouterId	string	El ID del enrutador al que pertenece la interfaz de enrutador par.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceSpec	string	La especificación de la interfaz de enrutador par.	Large
RouterId	string	El ID del enrutador al que pertenece la entrada de ruta.	vrt-bp1d3bxtdv68tfd7g****
OppositeInterfaceBusinessStatus	string	El estado comercial de la interfaz de enrutador par.	Normal
ConnectedTime	string	La hora en que se estableció la conexión. La hora sigue el estándar ISO 8601 en formato UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
HealthCheckSourceIp	string	La dirección IP de origen de la comprobación de estado.	116.62.XX.XX
OppositeInterfaceStatus	string	El estado de la interfaz de enrutador par.	Normal
EndTime	string	La hora de finalización de los datos recuperados. La hora sigue el estándar ISO 8601 en formato UTC. Formato: `YYYY-MM-DDThh:mmZ`.	2021-06-08T12:20:55
OppositeRegionId	string	El ID de la región de la interfaz de enrutador par.	cn-shanghai
OppositeAccessPointId	string	El ID del punto de acceso par.	ap-cn-shanghaiSZ-****
BusinessStatus	string	El estado comercial de la interfaz de enrutador. Valores válidos: Normal: Normal. FinancialLocked: bloqueo financiero. SecurityLocked: bloqueado debido al control de riesgos de seguridad.	Normal
OppositeBandwidth	integer	El ancho de banda par. Unidad: Mbit/s.	12
RouterType	string	El tipo de enrutador al que pertenece la tabla de rutas. Valores válidos: VRouter: vRouter de VPC. VBR: Virtual Border Router.	VRouter
Role	string	El rol en la conexión de emparejamiento.	InitiatingSide
HasReservationData	string	Indica si existen datos de renovación.	false
AccessPointId	string	El ID del punto de acceso.	ap-cn-shanghaiSZ-****
Ipv6Status	string	Indica si la protección de seguridad IPv6 está habilitada. Valores válidos: on: habilitado. off: deshabilitado. unsupport: no compatible.	on
FastLinkMode	boolean	Indica si la interfaz de enrutador en el VBR se creó en modo de enlace rápido. El modo de enlace rápido permite que las interfaces de enrutador en el VBR y la VPC se conecten automáticamente después de su creación. Valores válidos: true false (valor predeterminado)	false
ResourceGroupId	string	El ID del grupo de recursos. Para obtener más información sobre los grupos de recursos, consulte ¿Qué es un grupo de recursos?.	rg-acfmxazb4ph6aiy****
Tags	object
Tags	array<object>	Las etiquetas del recurso.
	object	La etiqueta.
Key	string	La clave de etiqueta del recurso.	FinanceDept
Value	string	El valor de etiqueta del recurso.	FinanceJoshua

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "C7F6FCBD-F9CC-4501-8EF3-CDC9577CAE45",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RouterInterfaceSet": {
    "RouterInterfaceType": [
      {
        "ReservationActiveTime": "2021-03-11T16:00:00Z",
        "HealthCheckTargetIp": "116.62.XX.XX",
        "Status": "active",
        "CreationTime": "2021-06-08T12:20:55",
        "ReservationOrderType": "RENEWCHANGE",
        "OppositeInterfaceId": "ri-bp1itx13bwe6f2wfh****",
        "Spec": "Large",
        "ChargeType": "PayByTraffic",
        "RouterInterfaceId": "ri-2zenfgfpyu3v93koa****",
        "HcThreshold": 2,
        "OppositeRouterType": "VRouter",
        "VpcInstanceId": "vpc-2ze3tq4uxhysg717x****",
        "OppositeInterfaceOwnerId": "271598332402530847",
        "OppositeVpcInstanceId": "vpc-bp1qpo0kug3a20qqe****",
        "ReservationInternetChargeType": "PayByBandwidth",
        "CrossBorder": false,
        "Bandwidth": 10,
        "Description": "Descripción de la interfaz de enrutador",
        "HcRate": 1,
        "ReservationBandwidth": "10",
        "Name": "test",
        "OppositeRouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceSpec": "Large",
        "RouterId": "vrt-bp1d3bxtdv68tfd7g****",
        "OppositeInterfaceBusinessStatus": "Normal",
        "ConnectedTime": "2021-06-08T12:20:55",
        "HealthCheckSourceIp": "116.62.XX.XX",
        "OppositeInterfaceStatus": "Normal",
        "EndTime": "2021-06-08T12:20:55",
        "OppositeRegionId": "cn-shanghai",
        "OppositeAccessPointId": "ap-cn-shanghaiSZ-****",
        "BusinessStatus": "Normal",
        "OppositeBandwidth": 12,
        "RouterType": "VRouter",
        "Role": "InitiatingSide",
        "HasReservationData": "false",
        "AccessPointId": "ap-cn-shanghaiSZ-****",
        "Ipv6Status": "on",
        "FastLinkMode": false,
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "Tags": {
          "Tags": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidParam.NotNull	The parameter must not be null.
400	EndPoint.Empty	the rc endpoint is empty.
400	InvalidConnectionType.MalFormed	Connection type must be vpc2vpc or vbr2vpc.
400	InvalidProductForm.MalFormed	Product form must be routerinterface or expressconnect.
400	InvalidRole.Malformed	role must be InitiatingSide or AcceptingSide.
400	IllegalParam.AliUid	Specified value of aliuid invalid.
400	Parameter.Illegal	The parameter is illegal.
400	InvalidRegionId.NotFound	The specified RegionId does not exist.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
404	InvalidFilterKey.ValueNotSupported	Specified filter key is not supported: Filter.X.key

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.