调用DescribeHealthCheckStatus查询源站健康检查状态信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeHealthCheckStatus

要执行的操作。取值:DescribeHealthCheckStatus

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

要查询的端口转发规则,使用JSON格式的字符串表述,具体结构如下。

  • InstanceId:String类型,必选,DDoS高防实例ID。
  • Protocol:String类型,必选,转发协议类型。取值:tcpudp
  • FrontendPort:Integer类型,必选,转发端口。

返回数据

名称 类型 示例值 描述
RequestId String DE9FF9E1-569C-4B6C-AB6A-0F6D927BB27C

本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

HealthCheckStatus Array of Status

源站健康检查状态信息。

Status String normal

源站健康检查状态。取值:

  • normal:健康
  • abnormal:不健康
FrontendPort Integer 8080

转发端口。

InstanceId String ddoscoo-cn-mp91j1ao****

DDoS高防实例ID。

Protocol String tcp

转发协议。取值:

  • tcp
  • udp
RealServerStatusList Array of RealServerStatus

源站IP地址健康检查状态列表。

Status String abnormal

当前IP地址健康检查状态。取值:

  • normal:健康
  • abnormal:不健康
Address String 192.0.XX.XX

源站IP地址。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeHealthCheckStatus
&NetworkRules=[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

访问错误中心查看更多错误码。