Help Center/ Direct Connect/ API Reference/ API/ Virtual Interface Peer Connectivity Detection Task/ Querying the Details About a Connectivity Detection Task of a Virtual Interface Peer
Updated on 2026-11-11 GMT+08:00

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 permissions are 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

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

vif_peer_id

Yes

String

Definition

Specifies the virtual interface peer ID.

Constraints

N/A

Range

The value can contain up to 36 characters in UUID format and is connected by hyphens (-).

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

request_id

String

Definition

Specifies the request ID.

Range

The value can contain a maximum of 36 characters.

vif_peer_detection

VifPeerDetection object

Definition

Specifies the connectivity detection task for the virtual interface peer.

Table 4 VifPeerDetection

Parameter

Type

Description

id

String

Definition

Specifies the ID of the connectivity detection task for the virtual interface peer.

Range

The value can contain a maximum of 36 characters.

vif_peer_id

String

Definition

Specifies the ID of the virtual interface peer.

Range

The value can contain a maximum of 36 characters.

project_id

String

Definition

Specifies the tenant ID.

Range

N/A

domain_id

String

Definition

Specifies the account ID.

Range

N/A

start_time

String

Definition

Specifies when the detection was started.

Range

N/A

end_time

String

Definition

Specifies when the detection was ended.

Range

N/A

status

String

Definition

Specifies the detection status.

Range

  • processing: The detection is in progress.

  • complete: The detection is complete.

  • error: The detection exits unexpectedly.

loss_ratio

Integer

Definition

Specifies the packet loss rate.

Range

0–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
  }
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;


public class ShowVifPeerDetectionSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowVifPeerDetectionRequest request = new ShowVifPeerDetectionRequest();
        request.withVifPeerId("{vif_peer_id}");
        try {
            ShowVifPeerDetectionResponse response = client.showVifPeerDetection(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowVifPeerDetectionRequest()
        request.vif_peer_id = "{vif_peer_id}"
        response = client.show_vif_peer_detection(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.ShowVifPeerDetectionRequest{}
	request.VifPeerId = "{vif_peer_id}"
	response, err := client.ShowVifPeerDetection(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.