DescribeHealthCheckList - Anti-DDoS - Alibaba Cloud Documentation Center

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-ddoscoo:DescribeHealthCheckList

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	83B4AF42-E8EE-4DC9-BD73-87B7733A36F9
HealthCheckList	array<object>	An array that consists of information about the health check configuration.
	array<object>
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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.