调用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类型,必选,转发端口。
RegionId String cn-hangzhou

DDoS高防服务地域ID。取值:

  • cn-hangzhou:表示DDoS高防(新BGP)服务
  • ap-southeast-1:表示DDoS高防(国际)服务

返回数据

名称 类型 示例值 描述
HealthCheckStatus Array

源站健康检查状态信息。

FrontendPort Integer 8080

转发端口。

InstanceId String ddoscoo-cn-mp91j1ao****

DDoS高防实例ID。

Protocol String tcp

转发协议。取值:

  • tcp
  • udp
RealServerStatusList Array

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

Address String 1.1.1.1

源站IP地址。

Status String abnormal

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

  • normal:健康
  • abnormal:不健康
Status String normal

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

  • normal:健康
  • abnormal:不健康
RequestId String DE9FF9E1-569C-4B6C-AB6A-0F6D927BB27C

本次请求的ID。

示例

请求示例

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

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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