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

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

功能介绍

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

调用方法

请参见如何调用API

授权信息

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

上一页最后一条资源记录的ID,为空时为查询第一页。

使用说明:必须与limit一起使用。

最小长度:0

最大长度:36

limit

Integer

每页返回的个数。

取值范围:1~2000。

最小值:1

最大值:2000

缺省值:2000

sort_key

String

排序字段。

缺省值:id

最小长度:0

最大长度:36

sort_dir

Array of strings

返回结果按照升序(asc)或降序(desc)排列,默认为asc

offset

Integer

分页偏移量

最小值:1

最大值:1000

page_reverse

Boolean

分页参数

vif_peer_id

String

虚拟接口对等体ID

最小长度:36

最大长度:36

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:10240

响应参数

状态码:200

OK

请求示例

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

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

响应示例

状态码:200

OK

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

{
  "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",
    "status" : "complete",
    "loss_ratio" : 0
  } ],
  "page_info" : {
    "previous_marker" : "a3b2dbbc-b0d0-4197-b133-b446dcf4c9af",
    "current_count" : 1
  }
}

SDK代码示例

SDK代码示例如下。

 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
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 ListVifPeerDetectionsSolution {

    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();
        ListVifPeerDetectionsRequest request = new ListVifPeerDetectionsRequest();
        try {
            ListVifPeerDetectionsResponse response = client.listVifPeerDetections(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
# 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 = ListVifPeerDetectionsRequest()
        response = client.list_vif_peer_detections(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
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.ListVifPeerDetectionsRequest{}
	response, err := client.ListVifPeerDetections(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档