调用DescribeHealthCheckList查询端口转发规则的健康检查配置

查询端口转发规则的健康检查配置（四层或七层）。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
yundun-ddoscoo:DescribeHealthCheckList	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
NetworkRules	string	是	要查询的端口转发规则，使用 JSON 格式的字符串表述，具体结构如下。 InstanceId：String 类型，必选，DDoS 高防实例 ID。 Protocol：String 类型，必选，转发协议类型。取值：tcp、udp。 FrontendPort：Integer 类型，必选，转发端口。	[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	83B4AF42-E8EE-4DC9-BD73-87B7733A36F9
HealthCheckList	array<object>	健康检查配置列表。
HealthCheckItem	object
FrontendPort	integer	转发端口。	8080
InstanceId	string	DDoS 高防实例 ID。	ddoscoo-cn-mp91j1ao****
Protocol	string	转发协议。取值： tcp udp	tcp
HealthCheck	object	健康检查配置信息。
Timeout	integer	响应超时时间。取值范围：1~30，单位：秒。	5
Type	string	协议类型。取值： tcp：四层 http：七层	tcp
Domain	string	域名。说明仅适用于七层健康检查。	www.aliyun.com
Interval	integer	检查间隔。取值范围：1~30，单位：秒。	15
Up	integer	健康阈值。取值范围：1~10。	3
Down	integer	不健康阈值。取值范围：1~10。	3
Port	integer	检查端口。	8080
Uri	string	检查路径。说明仅适用于七层健康检查。	/abc

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史