Querying the Details About a Connectivity Detection Task of a Virtual Interface Peer

Function

This API is used to query the details about a connectivity detection task of a virtual interface peer, including the task ID, start time, end time, status, and packet loss rate.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 0 Maximum: 36
vif_peer_id	Yes	String	Specifies the virtual interface peer ID. Minimum: 36 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID. Minimum: 0 Maximum: 36
vif_peer_detection	VifPeerDetection object	Specifies the connectivity detection task for the virtual interface peer.

**Table 4** VifPeerDetection
Parameter	Type	Description
id	String	Specifies the ID of the connectivity detection task for the virtual interface peer. Minimum: 0 Maximum: 36
vif_peer_id	String	Specifies the ID of the virtual interface peer. Minimum: 0 Maximum: 36
project_id	String	Specifies the tenant ID. Minimum: 0 Maximum: 36
domain_id	String	Specifies the account ID. Minimum: 0 Maximum: 36
start_time	String	Specifies when the detection was started.
end_time	String	Specifies when the detection was ended.
status	String	Specifies the detection status. The value can be: processing: The detection is in progress. complete: The detection is complete. error: The detection exits unexpectedly.
loss_ratio	Integer	Specifies the packet loss rate. Minimum: 0 Maximum: 100

Example Requests

Querying the details about a connectivity detection task of a virtual interface peer

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

Example Responses

Status code: 200

Specifies the response body for querying the details about a connectivity detection task of a virtual interface peer.

{
  "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
  }
}