Queries the health status of an origin server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeHealthCheckStatus

The operation that you want to perform. Set the value to DescribeHealthCheckStatus.

NetworkRules String Yes [{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]

Details about the port forwarding rule. This parameter is a JSON string. The fields in the value are described as follows:

  • 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.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance

Response parameters

Parameter Type Example Description
HealthCheckStatus Array

Details about the health status of the origin server.

FrontendPort Integer 8080

The forwarding port.

InstanceId String ddoscoo-cn-mp91j1ao****

The ID of the instance.

Protocol String tcp

The forwarding protocol. Valid values:

  • tcp
  • udp
RealServerStatusList Array

The health status of the IP addresses of the origin server.

Address String 1.1.1.1

The IP address of the origin server.

Status String abnormal

The health state of the IP address. Valid values:

  • normal: healthy
  • abnormal: unhealthy
Status String normal

The health status of the origin server. Valid values:

  • normal: healthy
  • abnormal: unhealthy
RequestId String DE9FF9E1-569C-4B6C-AB6A-0F6D927BB27C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeHealthCheckStatus
&NetworkRules=[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]
&<Common request parameters>

Sample success responses

XML format

<DescribeHealthCheckStatusResponse>
      <RequestId>DE9FF9E1-569C-4B6C-AB6A-0F6D927BB27C</RequestId>
      <HealthCheckStatus>
            <Status>abnormal</Status>
            <InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
            <FrontendPort>8080</FrontendPort>
            <RealServerStatusList>
                  <Status>abnormal</Status>
                  <Address>1.1.1.1</Address>
            </RealServerStatusList>
            <RealServerStatusList>
                  <Status>abnormal</Status>
                  <Address>2.2.2.2</Address>
            </RealServerStatusList>
            <RealServerStatusList>
                  <Status>abnormal</Status>
                  <Address>3.3.3.3</Address>
            </RealServerStatusList>
            <Protocol>tcp</Protocol>
      </HealthCheckStatus>
</DescribeHealthCheckStatusResponse>

JSON format

{
    "RequestId": "DE9FF9E1-569C-4B6C-AB6A-0F6D927BB27C",
    "HealthCheckStatus": [
        {
            "Status": "abnormal",
            "InstanceId": "ddoscoo-cn-mp91j1ao****",
            "FrontendPort": 8080,
            "RealServerStatusList": [
                {
                    "Status": "abnormal",
                    "Address": "1.1.1.1"
                },
                {
                    "Status": "abnormal",
                    "Address": "2.2.2.2"
                },
                {
                    "Status": "abnormal",
                    "Address": "3.3.3.3"
                }
            ],
            "Protocol": "tcp"
        }
    ]
}

Error codes

For a list of error codes, visit the API Error Center.