- 文档首页
专线连接
API参考
专线健康检查
DescribeDirectConnectHealthCheckProbes - 查询健康检查探针
专线健康检查
DescribeDirectConnectHealthCheckProbes - 查询健康检查探针
DescribeDirectConnectHealthCheckProbes - 查询健康检查探针
调用 DescribeDirectConnectHealthCheckProbes 接口,查询符合要求的健康检查探针的详细信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
请求参数
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。 Action String 必选 示例值:DescribeDirectConnectHealthCheckProbes
接口名称。当前 API 的名称为 DescribeDirectConnectHealthCheckProbes。
Version String 必选 示例值:2020-04-01
接口版本。当前 API 的版本为 2020-04-01。
DirectConnectHealthCheckProbeIds.N String 可选 示例值:dhp-2752hz4****
健康检查探针的ID。
- 参数 - N:表示健康检查实例ID的序号,单次调用数量上限100个。
DirectConnectHealthCheckProbeName String 可选 示例值:CheckProbes-01
健康检查探针的名称。
PageNumber Integer 可选 示例值:1
列表的页码。
PageSize Integer 可选 示例值:20
分页查询时每页的行数。最大值为100,默认值为20。
DirectConnectHealthCheckId String 可选 示例值:dhc-2752hz4tek****
健康检查探针所在的健康检查实例ID。
返回参数
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。 TotalCount Integer 示例值:1
满足指定条件的健康检查探针总数。
PageNumber Integer 示例值:1
当前页码。
PageSize Integer 示例值:20
当前分页的行数。
DirectConnectHealthCheckProbes Object[] 示例值:-
健康检查实例的详细信息。
AccountId String 示例值:20******57
资源归属账号ID。
DirectConnectHealthCheckProbeId String 示例值:dhp-2752hz4****
健康检查探针的ID。
DirectConnectHealthCheckProbeName String 示例值:CheckProbes-01
健康检查探针的名称。
DirectConnectHealthCheckId String 示例值:dhc-2752hz4tek****
健康检查实例的ID。
Description String 示例值:This is a checkprobes
健康检查探针描述。
ProbeTargetIp String 示例值:10.XX.XX.1
健康检查的目标 IP 地址。
ProbeInterval Integer 示例值:2
健康检查发送连续探测报文的时间间隔,单位:秒。
ProbeThreshold Integer 示例值:5
指定健康检查发送探测报文的个数。
ProbePacketProtocol String 示例值:ICMP
健康检查探测报文的协议。
ProbePort Integer 示例值:10000
健康检查探测报文的端口。
ProbePacketSize Integer 示例值:100
健康检查探测报文的大小,单位:Byte。
Status String 示例值:Available
健康检查探针状态。
CreationTime String 示例值:2021-12-07T15:57:22+08:00
健康检查探针的创建时间。
UpdateTime String 示例值:2021-12-07T15:57:22+08:00
健康检查探针的更新时间。
请求示例
返回示例
错误码
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
最近更新时间:2026.01.23 17:00:43