| object | | |
Description | string | The description of the listener. | Listener |
RequestId | string | | 6FEA0CF3-D3B9-43E5-A304-D217037876A8 |
State | string | The status of the listener. Valid values:
- configuring: The listener is being configured.
- init: The listener is being initialized.
- updating: The listener is being updated.
- deleting: The listener is being deleted.
| active |
CreateTime | string | The time when the listener was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds. | 1577786252000 |
PortRanges | object [] | The information about the listener ports. | |
FromPort | integer | The first port in the range of listener ports that are used to receive and forward requests to endpoints. | 20 |
ToPort | integer | The last port in the range of listener ports that are used to receive and forward requests to endpoints. | 20 |
BackendPorts | object [] | The information about the backend ports. | |
FromPort | string | The first port in the range of ports that are used by the backend server to receive requests.
This parameter is returned only if an HTTPS listener is configured and the listener port is the same as the service port of the backend server. | 80 |
ToPort | string | The last port in the range of ports that are used by the backend server to receive requests. | 80 |
Certificates | object [] | | |
Type | string | The type of the SSL certificate.
Only Server may be returned, which indicates a server certificate. | Server |
Id | string | The ID of the SSL certificate. | 449****-cn-hangzhou |
Protocol | string | The network transmission protocol that is used by the listener. Valid values:
- tcp: TCP.
- udp: UDP.
- http: HTTP.
- https: HTTPS.
| tcp |
ListenerId | string | | lsr-bp1bpn0kn908w4nbw**** |
ClientAffinity | string | Indicates whether client affinity is enabled for the listener.
- If NONE is returned, client affinity is disabled. Requests from the same client may be forwarded to different endpoints.
- If SOURCE_IP is returned, client affinity is enabled. When a client accesses stateful applications, requests from the same client are forwarded to the same endpoint regardless of the source port or protocol.
| SOURCE_IP |
Name | string | The name of the listener. | Listener |
RelatedAcls | object [] | The information about the access control list (ACL) that is associated with the listener. | |
AclId | string | The ID of the ACL that is associated with the listener. | 123 |
Status | string | Indicates whether the access control feature is enabled. Valid values:
- on: enabled.
- off: disabled.
| off |
AclType | string | The type of the ACL. Valid values:
- white: a whitelist. Only requests from the IP addresses or CIDR blocks in the ACL are forwarded. Whitelists are suitable for scenarios in which you want to allow only specific IP addresses to access an application. If a whitelist is improperly configured, risks may arise. After a whitelist is configured for a listener, only requests from the IP addresses that are added to the whitelist are distributed by the listener. If the whitelist is enabled but no IP addresses are added to the ACL, the listener does not forward requests.
- black: a blacklist. All requests from the IP addresses or CIDR blocks in the ACL are blocked. Blacklists are suitable for scenarios in which you want to deny access from specific IP addresses to an application. If the blacklist is enabled but no IP addresses are added to the ACL, the listener forwards all requests.
This parameter is returned only if the value of Status is on. | white |
AcceleratorId | string | The ID of the GA instance. | ga-bp1odcab8tmno0hdq**** |
ProxyProtocol | boolean | Indicates whether the client IP address preservation feature is enabled. Valid values:
- true You can view the source IP addresses of clients over the backend service.
- false
| false |
XForwardedForConfig | object | The configurations of the XForward headers. | |
XForwardedForGaIdEnabled | boolean | Indicates whether the GA-ID header is used to retrieve the ID of the GA instance. Valid values:
Note
This parameter is returned only for HTTP and HTTPS listeners.
| false |
XForwardedForGaApEnabled | boolean | Indicates whether the GA-AP header is used to retrieve information about acceleration regions. Valid values:
Note
This parameter is returned only for HTTP and HTTPS listeners.
| false |
XForwardedForProtoEnabled | boolean | Indicates whether the GA-X-Forward-Proto header is used to retrieve the listener protocol of the GA instance. Valid values:
Note
This parameter is returned only for HTTP and HTTPS listeners.
| false |
XForwardedForPortEnabled | boolean | Indicates whether the GA-X-Forward-Port header is used to retrieve the listener ports of the GA instance. Valid values:
Note
This parameter is returned only for HTTP and HTTPS listeners.
| false |
XRealIpEnabled | boolean | Indicates whether the X-Real-IP header is used to retrieve client IP addresses. Valid values:
Note
This parameter is returned only for HTTP and HTTPS listeners.
| false |
SecurityPolicyId | string | The ID of the security policy.
Note
This parameter is returned only for HTTPS listeners.
| tls_cipher_policy_1_0 |
Type | string | The routing type of the listener. Valid values:
- Standard: intelligent routing.
- CustomRouting: custom routing.
| Standard |
ServiceId | string | The ID of the service that manages the instance.
Note
This parameter is returned only if the value of ServiceManaged is true.
| ALB |
ServiceManaged | boolean | Indicates whether the instance is managed. Valid values:
| true |
ServiceManagedInfos | object [] | The actions that users can perform on the managed instance.
Note
This parameter is returned only if the value of ServiceManaged is true.
Users can perform only specific actions on a managed instance.
| |
Action | string | The name of the action on the managed instance. Valid values:
- Create
- Update
- Delete
- Associate
- UserUnmanaged
- CreateChild
| Update |
ChildType | string | The type of the child resource. Valid values:
- Listener: a listener.
- IpSet: an acceleration region.
- EndpointGroup: an endpoint group.
- ForwardingRule: a forwarding rule.
- Endpoint: an endpoint.
- EndpointGroupDestination: a protocol mapping of an endpoint group associated with a custom routing listener.
- EndpointPolicy: a traffic policy of an endpoint associated with a custom routing listener.
Note
This parameter is returned only if the value of Action is CreateChild.
| Listener |
IsManaged | boolean | Indicates whether the specified actions are managed.
- true: The specified actions are managed, and users cannot perform the specified actions on the managed instance.
- false: The specified actions are not managed, and users can perform the specified actions on the managed instance.
| false |
IdleTimeout | integer | The timeout period of idle connections. Unit: seconds. | 900 |
RequestTimeout | integer | The timeout period of HTTP or HTTPS requests. Unit: seconds.
Note
This parameter is returned only for HTTP and HTTPS listeners. If no responses are received from the backend server within the specified timeout period, GA returns the HTTP 504 error code to the client.
| 60 |
HttpVersion | string | The maximum version of the HTTP protocol. Valid values:
Note
This parameter is returned only for HTTPS listeners.
| http2 |