You need to enable JavaScript to run this app.
文档中心
专线连接

专线连接

复制全文
下载 pdf
专线健康检查
DescribeDirectConnectHealthCheckProbes - 查询健康检查探针
复制全文
下载 pdf
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个。​
  • 多个健康检查实例ID之间用&分隔。​
​
DirectConnectHealthCheckProbeName String 可选 示例值:CheckProbes-01​
健康检查探针的名称。​
​
PageNumber Integer 可选 示例值:1​
列表的页码。​
  • 如需传入此参数,请传入非负整数。​
  • 不传或传入0,则均默认为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​
健康检查探针状态。​
  • Creating: 创建中​
  • Deleting: 删除中​
  • Pending:配置中​
  • Available:可用​
​
CreationTime String 示例值:2021-12-07T15:57:22+08:00​
健康检查探针的创建时间。​
​
UpdateTime String 示例值:2021-12-07T15:57:22+08:00​
健康检查探针的更新时间。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeDirectConnectHealthCheckProbes&Version=2020-04-01&DirectConnectHealthCheckIds=dhc-2752hz4tek****&DirectConnectHealthCheckProbeIds.1=dhp-2752hz4**** HTTP/1.1​
Host: directconnect.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeDirectConnectHealthCheckProbes",​
"Version": "2020-04-01",​
"Service": "directconnect",​
"Region": "cn-north-1"​
},​
"Result": {​
"DirectConnectHealthCheckProbes": [​
{​
"Status": "Available",​
"AccountId": "20******57",​
"ProbePort": 10000,​
"UpdateTime": "2021-12-07T15:57:22+08:00",​
"Description": "This is a checkprobes",​
"CreationTime": "2021-12-07T15:57:22+08:00",​
"ProbeInterval": 2,​
"ProbeTargetIp": "10.XX.XX.1",​
"ProbeThreshold": 5,​
"ProbePacketSize": 100,​
"ProbePacketProtocol": "ICMP",​
"DirectConnectHealthCheckId": "dhc-2752hz4tek****",​
"DirectConnectHealthCheckProbeId": "dhp-2752hz4****",​
"DirectConnectHealthCheckProbeName": "CheckProbes-01"​
}​
],​
"PageNumber": 1,​
"PageSize": 20,​
"TotalCount": 1​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
LimitExceeded.DirectConnectHealthCheckProbeId​
You've reached the limit on the number of direct connect health check IDs that you can describe.​
已达到可查询的健康检查探针ID数量上限。​
​
​
最近更新时间:2026.01.23 17:00:43
这个页面对您有帮助吗?
有用
有用
无用
无用