文档

DescribeHealthCheckStatus - 查询源站健康检查状态信息

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
NetworkRulesstring

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

  • InstanceId:String 类型,必选,DDoS 高防实例 ID。
  • Protocol:String 类型,必选,转发协议类型。取值:tcpudp
  • FrontendPort:Integer 类型,必选,转发端口。
[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]

返回参数

名称类型描述示例值
object
RequestIdstring

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

DE9FF9E1-569C-4B6C-AB6A-0F6D927BB27C
HealthCheckStatusarray<object>

源站健康检查状态信息。

object
Statusstring

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

  • normal:健康
  • abnormal:不健康
normal
FrontendPortinteger

转发端口。

8080
InstanceIdstring

DDoS 高防实例 ID。

ddoscoo-cn-mp91j1ao****
Protocolstring

转发协议。取值:

  • tcp
  • udp
tcp
RealServerStatusListarray<object>

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

object
Statusstring

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

  • normal:健康
  • abnormal:不健康
abnormal
Addressstring

源站 IP 地址。

192.0.XX.XX

示例

正常返回示例

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"
        }
      ]
    }
  ]
}

错误码

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