Querying Connectivity Detection Tasks of a Virtual Interface Peer

Function

This API is used to query information about multiple connectivity detection tasks for 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

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 0 Maximum: 36
limit	No	Integer	Specifies the number of records returned on each page. Value range: 1 to 2000 Minimum: 1 Maximum: 2000 Default: 2000
sort_key	No	String	Specifies the sorting field. Default: id Minimum: 0 Maximum: 36
sort_dir	No	Array of strings	Specifies the sorting order of returned results. There are two options: asc (default) and desc.
offset	No	Integer	Specifies the pagination offset. Minimum: 1 Maximum: 1000
page_reverse	No	Boolean	Specifies the pagination parameter.

Request Parameters

**Table 3** 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

None

Example Requests

Querying connectivity detection tasks of a virtual interface peer

GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/vif-peer-detections

Example Responses

Status code: 200

Specifies the response body for querying connectivity detection tasks for a virtual interface peer.

{
  "request_id" : "ecf6442668da7d4adf0dfaf4bded8840",
  "vif_peer_detections" : [ {
    "id" : "a3b2dbbc-b0d0-4197-b133-b446dcf4c9af",
    "vif_peer_id" : "1158951c-a6f1-40a0-af88-632817fd24ac",
    "project_id" : "b197c48159d44a66b32c538c3f8da89a",
    "domain_id" : "16f5abbe1f624ce3a7f4b19751a8af72",
    "start_time" : "2025-07-05T15:12:14Z",
    "end_time" : "2025-07-05T15:14:14Z",
    "status" : "complete",
    "loss_ratio" : 0
  } ],
  "page_info" : {
    "previous_marker" : "a3b2dbbc-b0d0-4197-b133-b446dcf4c9af",
    "current_count" : 1
  }
}