调用DescribeHealthCheckList查询端口转发规则的健康检查配置(四层或七层)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeHealthCheckList |
要执行的操作。取值:DescribeHealthCheckList |
NetworkRules | String | 是 | [{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}] |
要查询的端口转发规则,使用JSON格式的字符串表述,具体结构如下。
|
RegionId | String | 否 | cn-hangzhou |
DDoS高防服务地域ID。取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HealthCheckList | Array |
健康检查配置列表。 |
|
FrontendPort | Integer | 8080 |
转发端口。 |
HealthCheck | Struct |
健康检查配置信息。 |
|
Domain | String | www.aliyun.com |
域名。 说明 仅适用于七层健康检查。
|
Down | Integer | 3 |
不健康阈值。取值范围:1~10。 |
Interval | Integer | 15 |
检查间隔。取值范围:1~30,单位:秒。 |
Port | Integer | 8080 |
检查端口。 |
Timeout | Integer | 5 |
响应超时时间。取值范围:1~30,单位:秒。 |
Type | String | tcp |
协议类型。取值:
|
Up | Integer | 3 |
健康阈值。取值范围:1~10。 |
Uri | String | /abc |
检查路径。 说明 仅适用于七层健康检查。
|
InstanceId | String | ddoscoo-cn-mp91j1ao**** |
DDoS高防实例ID。 |
Protocol | String | tcp |
转发协议。取值:
|
RequestId | String | 83B4AF42-E8EE-4DC9-BD73-87B7733A36F9 |
本次请求的ID。 |
TotalCount | String | 1 |
健康检查配置的总数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeHealthCheckList
&NetworkRules=[{"InstanceId":"ddoscoo-cn-mp91j1ao****","Protocol":"tcp","FrontendPort":8080}]
&<公共请求参数>
正常返回示例
XML
格式
<DescribeHealthCheckListResponse>
<RequestId>83B4AF42-E8EE-4DC9-BD73-87B7733A36F9</RequestId>
<HealthCheckList>
<InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
<FrontendPort>8080</FrontendPort>
<HealthCheck>
<Type>tcp</Type>
<Down>3</Down>
<Timeout>5</Timeout>
<Port>8080</Port>
<Up>3</Up>
<Interval>15</Interval>
</HealthCheck>
<Protocol>tcp</Protocol>
</HealthCheckList>
<TotalCount>1</TotalCount>
</DescribeHealthCheckListResponse>
JSON
格式
{
"RequestId": "83B4AF42-E8EE-4DC9-BD73-87B7733A36F9",
"HealthCheckList": [
{
"InstanceId": "ddoscoo-cn-mp91j1ao****",
"FrontendPort": 8080,
"HealthCheck": {
"Type": "tcp",
"Down": 3,
"Timeout": 5,
"Port": 8080,
"Up": 3,
"Interval": 15
},
"Protocol": "tcp"
}
],
"TotalCount": 1
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交