DescribeHealthCheckList - Anti-DDoS - Alibaba Cloud Documentation Center

Queries the Layer 4 or Layer 7 health check configurations of a port forwarding rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeHealthCheckList	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
NetworkRules	string	Yes	The information about the port forwarding rule. This parameter is a JSON string. The string contains the following fields: InstanceId: the ID of the instance. This field is required and must be of the STRING type. Protocol: the forwarding protocol. This field is required and must be of the STRING type. Valid values: tcp and udp. FrontendPort: the forwarding port. This field is required and must be of the INTEGER type.	[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	string	The total number of returned health check configurations.	1
RequestId	string	The ID of the request.	83B4AF42-E8EE-4DC9-BD73-87B7733A36F9
HealthCheckList	object []	An array that consists of information about the health check configuration.
FrontendPort	integer	The forwarding port.	8080
InstanceId	string	The ID of the instance.	ddoscoo-cn-mp91j1ao****
Protocol	string	The forwarding protocol. Valid values: tcp udp	tcp
HealthCheck	object	The health check configuration.
Timeout	integer	The response timeout period. Valid values: 1 to 30. Unit: seconds.	5
Type	string	The type of the protocol. Valid values: tcp: The Layer 4 health check configuration was queried. http: The Layer 7 health check configuration was queried.	tcp
Domain	string	The domain name. Note This parameter is returned only when the Layer 7 health check configuration is queried.	www.aliyun.com
Interval	integer	The interval at which checks are performed. Valid values: 1 to 30. Unit: seconds.	15
Up	integer	The number of consecutive successful health checks that must occur before a port is declared healthy. Valid values: 1 to 10.	3
Down	integer	The number of consecutive failed health checks that must occur before a port is declared unhealthy. Valid values: 1 to 10.	3
Port	integer	The port that was checked.	8080
Uri	string	The check path. Note This parameter is returned only when the Layer 7 health check configuration is queried.	/abc

Examples

Sample success responses

JSONformat

{
  "TotalCount": "1",
  "RequestId": "83B4AF42-E8EE-4DC9-BD73-87B7733A36F9",
  "HealthCheckList": [
    {
      "FrontendPort": 8080,
      "InstanceId": "ddoscoo-cn-mp91j1ao****",
      "Protocol": "tcp",
      "HealthCheck": {
        "Timeout": 5,
        "Type": "tcp",
        "Domain": "www.aliyun.com",
        "Interval": 15,
        "Up": 3,
        "Down": 3,
        "Port": 8080,
        "Uri": "/abc"
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history