Help Center> Direct Connect> API Reference> APIs> Virtual Interface> Querying the Virtual Interface List

Updated on 2023-12-07 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Virtual Interface List

Function

This API is used to query all virtual interfaces of a tenant.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/virtual-interfaces

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of records returned on each page. Value range: 1 to 2000 Minimum: 1 Maximum: 2000 Default: 2000
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
fields	No	Array	Specifies the list of fields to be displayed. Array Length: 1 - 5
sort_dir	No	Array	Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.
sort_key	No	String	Specifies the sorting field. Default: id Minimum: 0 Maximum: 36
enterprise_project_id	No	Array	Filters resource instances by enterprise project ID. Array Length: 1 - 10
id	No	Array	Specifies the resource ID by which instances are filtered. Array Length: 1 - 5
status	No	Array	Specifies the status by which instances are filtered. Array Length: 1 - 5
direct_connect_id	No	Array	Specifies the connection ID by which connections are filtered and queried. Array Length: 1 - 5
vgw_id	No	Array	Specifies the virtual gateway ID by which virtual gateways are filtered and queried. Array Length: 1 - 5

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

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
virtual_interfaces	Array of VirtualInterface objects	Specifies parameters for creating a virtual interface.
page_info	PageInfo object	Specifies the pagination query information.

**Table 5** VirtualInterface
Parameter	Type	Description
id	String	Specifies the virtual interface ID. Maximum: 36
name	String	Specifies the virtual interface name. Maximum: 64
admin_state_up	Boolean	Specifies the administrative status, which can be true or false.
bandwidth	Integer	Specifies the virtual interface bandwidth. Minimum: 2 Maximum: 2147483647
create_time	String	Specifies when the virtual interface was created. Maximum: 255
update_time	String	Specifies when the virtual interface was updated.
description	String	Provides supplementary information about the virtual interface. Maximum: 128
direct_connect_id	String	Specifies the connection ID. Maximum: 36
service_type	String	Specifies the gateway type, which can be VGW, GDGW, or LGW. Enumeration values: VGW GDGW LGW
status	String	Specifies the operating status, which can be ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, PENDING_DELETE, DELETED, AUTHORIZATION, or REJECTED.
tenant_id	String	Specifies the project ID. Minimum: 32 Maximum: 32
type	String	Specifies the type of the virtual interface. The value is private. Default: private Maximum: 255 Enumeration values: private public
vgw_id	String	Specifies the virtual gateway ID. Minimum: 36 Maximum: 36
vlan	Integer	Specifies the VLAN for connecting to the user gateway. The value ranges from 0 to 3999. Minimum: 0 Maximum: 3999
route_limit	Integer	Specifies the remote subnet route configurations of the virtual interface. Minimum: 1 Maximum: 200 Default: 50
enable_nqa	Boolean	Specifies whether to enable NQA. The value can be true or false.
enable_bfd	Boolean	Specifies whether to enable Bidirectional Forwarding Detection (BFD). The value can be true or false.
lag_id	String	Specifies the ID of the LAG associated with the virtual interface. Minimum: 36 Maximum: 36
device_id	String	Specifies the ID of the device that the virtual interface belongs to.
enterprise_project_id	String	Specifies the ID of the enterprise project that the virtual interface belongs to. Minimum: 36 Maximum: 36
tags	Array of Tag objects	Specifies the tags. Array Length: 0 - 10
local_gateway_v4_ip	String	Specifies the IPv4 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
remote_gateway_v4_ip	String	Specifies the IPv4 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
ies_id	String	Specifies the ID of an IES edge site.
reason	String	Displays error information if the status of a line is Error.
rate_limit	Boolean	Specifies whether rate limiting is enabled on a virtual interface.
address_family	String	Specifies the address family of the virtual interface, which can be IPv4 or IPv6. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
local_gateway_v6_ip	String	Specifies the IPv6 interface address of the gateway used on the cloud. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
remote_gateway_v6_ip	String	Specifies the IPv6 interface address of the gateway used on premises. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
lgw_id	String	Specifies the ID of the local gateway, which is used in IES scenarios.
gateway_id	String	Specifies the ID of the gateway associated with the virtual interface.
remote_ep_group	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
service_ep_group	Array of strings	Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections. This parameter has been migrated to the vifpeer parameter list and will be discarded later.
bgp_route_limit	Integer	Specifies the BGP route configuration.
priority	String	Specifies the priority of a virtual interface. The value can be normal or low. If the priorities are the same, the virtual interfaces work in load balancing mode. If the priorities are different, the virtual interfaces work in active/standby pairs. Outbound traffic is preferentially forwarded to the normal virtual interface with a higher priority. This option is only supported by virtual interfaces that use BGP routing. Default: normal Enumeration values: normal low
vif_peers	Array of VifPeer objects	Specifies the peer information of the virtual interface.
extend_attribute	VifExtendAttribute object	Specifies extended attributes when BFD or NQA is used for reliability detection.

**Table 6** Tag
Parameter	Type	Description
key	String	Specifies the tag key. The key can contain a maximum of 36 Unicode characters, including letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 36
value	String	Specifies the tag value. The value can contain a maximum of 43 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Minimum: 0 Maximum: 43

**Table 7** VifPeer
Parameter	Type	Description
id	String	Specifies the resource ID. Minimum: 36 Maximum: 36
tenant_id	String	Specifies the ID of the project that the virtual interface peer belongs to. Minimum: 36 Maximum: 36
name	String	Specifies the name of the virtual interface peer. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the virtual interface peer. Minimum: 0 Maximum: 128
address_family	String	Specifies the address family type of the virtual interface, which can be IPv4 or IPv6.
local_gateway_ip	String	Specifies the address of the virtual interface peer used on the cloud.
remote_gateway_ip	String	Specifies the address of the virtual interface peer used in the on-premises data center.
route_mode	String	Specifies the routing mode, which can be static or bgp. Maximum: 255 Enumeration values: bgp static
bgp_asn	Integer	Specifies the ASN of the BGP peer. Minimum: 1 Maximum: 4294967295
bgp_md5	String	Specifies the MD5 password of the BGP peer.
remote_ep_group	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.
service_ep_group	Array of strings	Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.
device_id	String	Specifies the ID of the device that the virtual interface peer belongs to.
bgp_route_limit	Integer	Specifies the BGP route configuration.
bgp_status	String	Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null. Maximum: 10
status	String	Specifies the status of the virtual interface peer.
vif_id	String	Specifies the ID of the virtual interface corresponding to the virtual interface peer. Minimum: 36 Maximum: 36
receive_route_num	Integer	Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. Note: If this parameter cannot be obtained, contact customer service to migrate your ports.
enable_nqa	Boolean	Specifies whether to enable NQA. The value can be true or false.
enable_bfd	Boolean	Specifies whether to enable BFD. The value can be true or false.

**Table 8** VifExtendAttribute
Parameter	Type	Description
ha_type	String	Specifies the availability detection type of the virtual interface. Enumeration values: nqa bfd
ha_mode	String	Specifies the availability detection mode. Enumeration values: auto_single auto_multi static_single static_multi enhance_nqa
detect_multiplier	Integer	Specifies the number of detection retries. Default: 5
min_rx_interval	Integer	Specifies the interval for receiving detection packets. Default: 1000
min_tx_interval	Integer	Specifies the interval for sending detection packets. Default: 1000
remote_disclaim	Integer	Specifies the remote identifier of the static BFD session.
local_disclaim	Integer	Specifies the local identifier of the static BFD session.

**Table 9** PageInfo
Parameter	Type	Description
previous_marker	String	Specifies the marker of the previous page. The value is the resource UUID. Minimum: 0 Maximum: 36
current_count	Integer	Specifies the number of resources in the current list. Minimum: 0 Maximum: 2000
next_marker	String	Specifies the marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page. Minimum: 0 Maximum: 36

Example Requests

Querying the virtual interface list

GET https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces

Example Responses

Status code: 200

{
  "virtual_interfaces" : [ {
    "id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
    "name" : "vif-0819",
    "description" : "mytest",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "direct_connect_id" : "4673e339-8412-4ee1-b73e-2ba9cdfa54c1",
    "vgw_id" : "8a47064a-f34c-4f94-b7fe-cac456c9b37b",
    "type" : "private",
    "service_type" : "VGW",
    "vlan" : 332,
    "bandwidth" : 2,
    "status" : "ACTIVE",
    "create_time" : "2022-08-19T11:28:06.000Z",
    "admin_state_up" : true,
    "enable_bfd" : false,
    "route_limit" : 50,
    "enable_nqa" : false,
    "local_gateway_v4_ip" : "1.1.1.1/30",
    "remote_gateway_v4_ip" : "1.1.1.2/30",
    "ies_id" : null,
    "reason" : null,
    "rate_limit" : false,
    "address_family" : "ipv4",
    "local_gateway_v6_ip" : null,
    "remote_gateway_v6_ip" : null,
    "lgw_id" : null,
    "gateway_id" : null,
    "remote_ep_group" : [ "1.1.2.0/30" ],
    "service_ep_group" : [ ],
    "bgp_route_limit" : 100,
    "priority" : "normal",
    "vif_peers" : [ {
      "id" : "c768eb52-12a8-4859-9b43-81194643040c",
      "tenant_id" : "0605768a3300d5762f82c01180692873",
      "name" : "vif-0819",
      "description" : "",
      "address_family" : "ipv4",
      "local_gateway_ip" : "1.1.1.1/30",
      "remote_gateway_ip" : "1.1.1.2/30",
      "route_mode" : "static",
      "bgp_asn" : null,
      "bgp_md5" : null,
      "device_id" : "18.9.215.131",
      "bgp_route_limit" : 100,
      "bgp_status" : null,
      "status" : "ACTIVE",
      "vif_id" : "0d0fdf63-f2c4-491c-8866-d504796189be",
      "receive_route_num" : -1,
      "remote_ep_group" : [ "1.1.2.0/30" ],
      "service_ep_group" : null,
      "enable_bfd" : false,
      "enable_nqa" : false
    } ],
    "enterprise_project_id" : "0"
  } ],
  "request_id" : "5633df7af874576d819a481c76673236"
}

SDK Sample Code

The SDK sample code is as follows.

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

import java.util.List;
import java.util.ArrayList;

public class ListVirtualInterfacesSolution {

    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");

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

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("cn-north-4"))
                .build();
        ListVirtualInterfacesRequest request = new ListVirtualInterfacesRequest();
        request.withDirectConnectId();
        request.withVgwId();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withFields();
        request.withSortDir();
        request.withSortKey("<sort_key>");
        request.withEnterpriseProjectId();
        request.withId();
        request.withStatus();
        try {
            ListVirtualInterfacesResponse response = client.listVirtualInterfaces(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());
        }
    }
}

# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListVirtualInterfacesRequest()
        request.direct_connect_id = 
        request.vgw_id = 
        request.limit = <limit>
        request.marker = "<marker>"
        request.fields = 
        request.sort_dir = 
        request.sort_key = "<sort_key>"
        request.enterprise_project_id = 
        request.id = 
        request.status = 
        response = client.list_virtual_interfaces(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListVirtualInterfacesRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	response, err := client.ListVirtualInterfaces(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}