文档首页/ 云专线 DC/ API参考/ API/ 虚拟接口对等体连通性探测/ 查询虚拟接口对等体连通性探测实例 - ShowVifPeerDetection
更新时间:2025-12-05 GMT+08:00
分享

查询虚拟接口对等体连通性探测实例 - ShowVifPeerDetection

功能介绍

当您的对虚拟接口对等体发起连通性探测后,您可以通过此接口查询单次探测的信息,包括ID、探测开始时间、探测结束时间、探测状态、丢包率等。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v3/{project_id}/dcaas/vif-peer-detections/{vif_peer_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

vif_peer_id

String

虚拟接口对等体ID

最小长度:36

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求id

最小长度:0

最大长度:36

vif_peer_detection

VifPeerDetection object

虚拟接口对等体连通性探测实例

表4 VifPeerDetection

参数

参数类型

描述

id

String

虚拟接口对等体连通性探测实例uuid

最小长度:0

最大长度:36

vif_peer_id

String

虚拟接口对等体实例uuid

最小长度:0

最大长度:36

project_id

String

租户id

最小长度:0

最大长度:36

domain_id

String

账号id

最小长度:0

最大长度:36

start_time

String

探测开始时间

end_time

String

探测结束时间

status

String

探测状态,取值范围:

  • processing: 探测处理中

  • complete: 探测完成

  • error: 探测异常退出

loss_ratio

Integer

丢包率

最小值:0

最大值:100

请求示例

查询虚拟接口对等体连通性探测实例

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/vif-peer-detections/3284c6e2-a803-4108-8496-ed3f150697d6

响应示例

状态码:200

OK

查询虚拟接口对等体连通性探测实例返回体

{
  "request_id" : "ecf6442668da7d4adf0dfaf4bded8840",
  "vif_peer_detection" : {
    "id" : "3284c6e2-a803-4108-8496-ed3f150697d6",
    "vif_peer_id" : "747c8f2b-3dd9-43b4-a7b4-7533ec6cb6c1",
    "project_id" : "b197c48159d44a66b32c538c3f8da89a",
    "domain_id" : "221d3417d0a74b2dbac5611818e23456",
    "start_time" : "2025-07-05 15:11:14",
    "end_time" : "2025-07-05 15:15:14",
    "status" : "complete",
    "loss_ratio" : 0
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档