ListListeners - Global Accelerator - Centro de documentación de Alibaba Cloud

Consulta una lista de listeners.

Descripción de la operación

Consulta la lista de listeners en una instancia de Alibaba Cloud Global Accelerator (GA), incluido el tipo de enrutamiento, el estado, la marca de tiempo UNIX de creación y la información de puertos de cada listener.

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

ga:ListListeners

list

*Listener.

acs:ga:{#regionId}:{#accountId}:listener/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia de Alibaba Cloud Global Accelerator (GA). Establezca el valor en cn-hangzhou.	cn-hangzhou
PageNumber	integer	No	El número de página de la lista. Valor predeterminado: 1.	1
PageSize	integer	No	El número de entradas por página para una consulta paginada. Valor máximo: 50. Valor predeterminado: 10.	10
AcceleratorId	string	Sí	El ID de la instancia de Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
Protocol	string	No	El tipo de protocolo de transporte de red del listener.	HTTP

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La lista de información de respuesta.
TotalCount	integer	El número total de entradas en la lista.	1
Listeners	array<object>	La información del listener.
	array<object>	La información del listener.
Certificates	array<object>	La información del certificado SSL.
	object	La información del certificado SSL.
Type	string	El tipo de certificado. Actualmente, solo se admite Server (certificado de servidor).	Server
Id	string	El ID del certificado SSL.	44983xxxx-cn-hangzhou
BackendPorts	array<object>	La información del puerto del servidor backend.
	object	La información del puerto del servidor backend.
FromPort	string	El puerto inicial del servidor backend.	80
ToPort	string	El puerto final del servidor backend.	80
ListenerId	string	El ID del listener.	lsr-bp1bpn0kn908w4nbw****
Description	string	La descripción del listener.	Listener
State	string	El estado del listener. active: Normal. init: Inicializando. updating: En configuración. deleting: En eliminación.	active
ClientAffinity	string	La afinidad de cliente. Si se devuelve NONE, no se mantiene la afinidad de cliente. Las conexiones del mismo cliente no siempre se dirigen al mismo endpoint. Si se devuelve SOURCE_IP, se mantiene la afinidad de cliente. Cuando un cliente accede a una aplicación con estado, todas las solicitudes del mismo cliente se dirigen al mismo endpoint, independientemente del puerto y protocolo de origen.	SOURCE_IP
Protocol	string	El tipo de protocolo de transporte del listener. TCP: Protocolo TCP. UDP: Protocolo UDP. HTTP: Protocolo HTTP. HTTPS: Protocolo HTTPS.	TCP
CreateTime	integer	La marca de tiempo en la que se creó el listener. Unidad: milisegundos.	1577786252000
PortRanges	array<object>	La información de puertos del listener.
	object	La información de puertos del listener.
FromPort	integer	El puerto de escucha inicial que se utiliza para recibir solicitudes y reenviarlas a los endpoints.	20
ToPort	integer	El puerto de escucha final que se utiliza para recibir solicitudes y reenviarlas a los endpoints.	20
Name	string	El nombre del listener.	Listener
ProxyProtocol `deprecated`	boolean	Indica si la función de conservación de la dirección IP de origen del cliente está habilitada. true: La función de conservación de la dirección IP de origen del cliente está habilitada. Después de habilitar esta función, el servicio backend puede ver la dirección IP original del cliente. false: La función de conservación de la dirección IP de origen del cliente no está habilitada.	true
AcceleratorId	string	El ID de la instancia de Alibaba Cloud Global Accelerator (GA).	ga-bp1odcab8tmno0hdq****
XForwardedForConfig	object	La información de configuración del campo `XForward`.
XForwardedForGaIdEnabled	boolean	Indica si el campo de encabezado `GA-ID` se utiliza para obtener el ID de la instancia de Alibaba Cloud Global Accelerator (GA). true: sí. false: no. Nota Solo los listeners HTTP y HTTPS admiten este parámetro.	false
XRealIpEnabled	boolean	Indica si el campo `X-Real-IP` se utiliza para obtener la dirección IP real del cliente. true: sí. false: no. Nota Solo los listeners HTTP y HTTPS admiten este parámetro.	false
XForwardedForGaApEnabled	boolean	Indica si el campo `GA-AP` se utiliza para obtener la información del área de aceleración. true: sí. false: no. Nota Solo los listeners HTTP y HTTPS admiten este parámetro.	false
XForwardedForProtoEnabled	boolean	Indica si el campo `GA-X-Forward-Proto` se utiliza para obtener el protocolo del listener de la instancia de Alibaba Cloud Global Accelerator (GA). true: sí. false: no. Nota Solo los listeners HTTP y HTTPS admiten este parámetro.	false
XForwardedForPortEnabled	boolean	Indica si el campo `GA-X-Forward-Port` se utiliza para obtener el puerto del listener de la instancia de Alibaba Cloud Global Accelerator (GA). true: sí. false: no. Nota Solo los listeners HTTP y HTTPS admiten este parámetro.	false
SecurityPolicyId	string	El ID de instancia de la política de seguridad. tls_cipher_policy_1_0 Versiones TLS admitidas: TLSv1.0, TLSv1.1 y TLSv1.2. Suites de algoritmos de cifrado admitidas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA y DES-CBC3-SHA. tls_cipher_policy_1_1 Versiones TLS admitidas: TLSv1.1 y TLSv1.2. Suites de algoritmos de cifrado admitidas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA y DES-CBC3-SHA. tls_cipher_policy_1_2 Versiones TLS admitidas: TLSv1.2. Suites de algoritmos de cifrado admitidas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA y DES-CBC3-SHA. tls_cipher_policy_1_2_strict Versiones TLS admitidas: TLSv1.2. Suites de algoritmos de cifrado admitidas: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA y ECDHE-RSA-AES256-SHA. tls_cipher_policy_1_2_strict_with_1_3 Versiones TLS admitidas: TLSv1.2 y TLSv1.3. Suites de algoritmos de cifrado admitidas: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA y ECDHE-RSA-AES256-SHA. Nota Solo los listeners HTTPS admiten este parámetro.	tls_cipher_policy_1_0
Type	string	El tipo de enrutamiento del listener. Standard: tipo de enrutamiento inteligente. CustomRouting: tipo de enrutamiento personalizado.	Standard
ServiceId	string	El ID del servicio al que pertenece la instancia administrada. Nota Este parámetro solo es válido cuando ServiceManaged se establece en True.	ALB
ServiceManaged	boolean	Indica si la instancia está administrada. Valores válidos: true: La instancia está administrada. false: La instancia no está administrada.	true
ServiceManagedInfos	array<object>	La lista de políticas de acciones que el usuario puede ejecutar en la instancia administrada. Nota Este parámetro solo es válido cuando ServiceManaged se establece en True. Cuando la instancia está en estado administrado, las operaciones del usuario en la instancia están restringidas y ciertas acciones están prohibidas.
	object	La lista de políticas de acciones que el usuario puede ejecutar en la instancia administrada.
Action	string	El nombre de la acción de la política administrada. Valores válidos: Create: Crear una instancia. Update: Actualizar la instancia actual. Delete: Eliminar la instancia actual. Associate: Hacer referencia a la instancia actual o que esta sea referenciada. UserUnmanaged: Dejar de administrar la instancia por parte del usuario. CreateChild: Crear un recurso secundario bajo la instancia actual.	Update
ChildType	string	El tipo de recurso secundario. Valores válidos: Listener: recurso de listener. IpSet: recurso de región de aceleración. EndpointGroup: recurso de grupo de endpoints. ForwardingRule: recurso de regla de reenvío. Endpoint: recurso de endpoint. EndpointGroupDestination: recurso de asignación de protocolos del grupo de endpoints bajo un listener de enrutamiento personalizado. EndpointPolicy: recurso de política de tráfico de endpoints bajo un listener de enrutamiento personalizado. Nota Este parámetro solo es válido cuando Action se establece en CreateChild.	Listener
IsManaged	boolean	Indica si la acción de la política administrada está administrada. Valores válidos: true: La acción de la política administrada está administrada. El usuario no puede realizar la acción especificada por Action en la instancia administrada. false: La acción de la política administrada no está administrada. El usuario puede realizar la acción especificada por Action en la instancia administrada.	false
IdleTimeout	integer	El tiempo de espera de conexión inactiva. Unidad: segundos.	900
RequestTimeout	integer	El tiempo de espera de solicitud de conexión HTTP/HTTPS. Unidad: segundos. Nota Este parámetro solo es válido para listeners cuyo Protocol (tipo de protocolo de transporte) es HTTP o HTTPS. Si el servidor backend no devuelve una respuesta dentro del tiempo de espera, Global Accelerator deja de esperar y devuelve un código de error HTTP 504 al cliente.	60
HttpVersion	string	La versión máxima del protocolo HTTP. Valores válidos: http3: HTTP/3. http2: HTTP/2. http1.1: HTTP/1.1. Nota Solo los listeners HTTPS admiten este parámetro.	http2
PageSize	integer	El número de entradas por página para una consulta paginada.	10
RequestId	string	El ID de la solicitud.	6FEA0CF3-D3B9-43E5-A304-D217037876A8
PageNumber	integer	El número de página de la lista.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "Listeners": [
    {
      "Certificates": [
        {
          "Type": "Server",
          "Id": "44983xxxx-cn-hangzhou"
        }
      ],
      "BackendPorts": [
        {
          "FromPort": "80",
          "ToPort": "80"
        }
      ],
      "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
      "Description": "Listener",
      "State": "active",
      "ClientAffinity": "SOURCE_IP",
      "Protocol": "TCP",
      "CreateTime": 1577786252000,
      "PortRanges": [
        {
          "FromPort": 20,
          "ToPort": 20
        }
      ],
      "Name": "Listener",
      "ProxyProtocol": true,
      "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
      "XForwardedForConfig": {
        "XForwardedForGaIdEnabled": false,
        "XRealIpEnabled": false,
        "XForwardedForGaApEnabled": false,
        "XForwardedForProtoEnabled": false,
        "XForwardedForPortEnabled": false
      },
      "SecurityPolicyId": "tls_cipher_policy_1_0",
      "Type": "Standard",
      "ServiceId": "ALB",
      "ServiceManaged": true,
      "ServiceManagedInfos": [
        {
          "Action": "Update",
          "ChildType": "Listener",
          "IsManaged": false
        }
      ],
      "IdleTimeout": 900,
      "RequestTimeout": 60,
      "HttpVersion": "http2"
    }
  ],
  "PageSize": 10,
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
  "PageNumber": 1
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.

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.