文档

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

更新时间:

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-ddoscoo:DescribeHealthCheckStatusRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
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
HealthCheckStatusobject []

源站健康检查状态信息。

Statusstring

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

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

转发端口。

8080
InstanceIdstring

DDoS 高防实例 ID。

ddoscoo-cn-mp91j1ao****
Protocolstring

转发协议。取值:

  • tcp
  • udp
tcp
RealServerStatusListobject []

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

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

错误码

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

  • 本页导读 (1)