You can call this operation to perform queries on layer 4 or layer 7 health check settings.

Request parameters

Name Type Required Description
Listeners String Yes The array of listeners that you want to query represented as a JSON string. For more information, see Listener.
Table 1. Listener
Name Type Required Description
InstanceId String Yes The ID of the Anti-DDoS Pro instance.
Protocol String Yes The listener protocol.
FrontendPort Integer Yes The port for front-end (client to Anti-DDoS Pro) connections. Valid values: 0-65535.
BackendPort Integer No The port for back-end (Anti-DDoS Pro to origin server) connections. Valid values: 0-65535.
RealServers JSON array No The IP addresses of the origin servers.
IsAutoCreate Boolean No Indicates whether the listener is automatically created. If true, the listener cannot be deleted or modified.

Response parameters

Name Type Description
Total Integer The total number of result records.
HealthCheck HealthCheck The health check information. For more information, see HealthCheck.
RequestId String The GUID generated by Alibaba Cloud for the request.
Table 2. HealthCheck
Name Type Description
Type String The protocol type. Valid values:
  • TCP: Layer 4
  • HTTP: Layer 7
Domain String In layer 7 health check, the domain name.
Uri String In layer 7 health check, the URI path.
Timeout Integer In layer 4 health check, the response timeout.
Port Integer In layer 4 health check, the port that is used to connect with the origin server.
Interval Integer In layer 4 health check, the time interval between health checks.
Up Integer In layer 4 health check, the healthy threshold.
Down Integer In layer 4 health check, the unhealthy threshold.

Examples

Sample requests
{
  "Listeners": "[{\"InstanceId\":\"0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc\",\"Protocol\":\"tcp\",\"FrontendPort\":80}]"
}
Sample responses
{
  "Total": 1,
  "HealthCheck": [
    {
      "InstanceId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc",
      "Protocol": "tcp",
      "FrontendPort": 80,
      "HealthCheck": {
        "Type": "tcp",
        "Timeout": 10,
        "Port": 80,
        "Interval": 10,
        "Up": 10,
        "Down": 20
      }
    }
  ],
  "RequestId": "0bcf28g5-d57c-11e7-9bs0-d89d6717dxbc"
}