调用DescribeHealthCheckAttribute查询健康检查实例详情_智能接入网关(SAG)-阿里云帮助中心

调用DescribeHealthCheckAttribute查询健康检查实例详情。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	智能接入网关实例的地域 ID。	cn-shanghai
HcInstanceId	string	是	健康检查实例 ID。	hc-1k4ucuq77b56x4****
SmartAGId	string	是	智能接入网关实例 ID。	sag-1um5x5nwhilymw****

返回参数

名称	类型	描述	示例值
	object
SrcPort	integer	健康检查的源端口。说明该功能目前不支持。	2334
Description	string	健康检查实例描述。	hc-123
RequestId	string	请求 ID。	DDA08B78-5634-4A83-94E4-5C58FD7EBA19
SrcIpAddr	string	健康检查的源地址。	10.XX.XX.1
CreateTime	long	健康检查实例创建时间戳。单位：毫秒。	1586759657000
FailCountThreshold	integer	连续探测失败次数阈值。取值范围：1~15。默认值：3。	3
DstPort	integer	健康检查的目的端口。说明该功能目前不支持。	1223
Name	string	健康检查实例名称。	bvt-test-03****
ProbeCount	integer	每次健康检查探测次数。取值范围：1~20。默认值：1。	3
Type	string	健康检查报文类型。目前仅支持ICMP_ECHO。	ICMP_ECHO
ProbeTimeout	integer	健康检查一次探测的超时时间。取值范围：10~30000。默认值：1000。单位：毫秒。	1000
HcInstanceId	string	健康检查实例 ID。	hc-1k4ucuq77b56x4****
RttThreshold	integer	双向时延阈值。取值：-1或 1~5000。默认值：-1，表示不配置双向时延阈值。	300
ProbeInterval	integer	健康检查配置探测间隔，一次探测未完成情况下，不会发起下一次探测。取值范围：1000~60000。默认值：2000。单位：毫秒。	2000
SmartAGId	string	智能接入网关实例 ID。	sag-1um5x5nwhilymw****
RttFailThreshold	integer	时延阈值触发次数。取值范围：1~15。默认值：3。	3
DstIpAddr	string	健康检查的目的地址。	192.XX.XX.1

示例

正常返回示例

JSON格式

{
  "SrcPort": 2334,
  "Description": "hc-123",
  "RequestId": "DDA08B78-5634-4A83-94E4-5C58FD7EBA19",
  "SrcIpAddr": "10.XX.XX.1",
  "CreateTime": 1586759657000,
  "FailCountThreshold": 3,
  "DstPort": 1223,
  "Name": "bvt-test-03****",
  "ProbeCount": 3,
  "Type": "ICMP_ECHO",
  "ProbeTimeout": 1000,
  "HcInstanceId": "hc-1k4ucuq77b56x4****",
  "RttThreshold": 300,
  "ProbeInterval": 2000,
  "SmartAGId": "sag-1um5x5nwhilymw****",
  "RttFailThreshold": 3,
  "DstIpAddr": "192.XX.XX.1"
}

错误码

HTTP status code	错误码	错误信息	描述
400	HC.InstanceNoFound	The specified network health check instance does not exist.	健康检查实例不存在。

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