Help Center/ Direct Connect/ API Reference/ API/ Connections/ Querying the Connection List

Updated on 2024-11-14 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Connection List

Function

This API is used to query the connection list.

Debugging

For details, see Calling APIs.

URI

GET /v3/{project_id}/dcaas/direct-connects

**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–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_key	No	String	Specifies the field for sorting. Default: id Minimum: 0 Maximum: 36
sort_dir	No	Array	Specifies the sorting order of returned results. The value can be asc (default) or desc.
hosting_id	No	Array	Specifies operations connection ID by which hosted connections are queried. Array length: 0–5
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 queried. Array length: 1–5
name	No	Array	Specifies the resource name by which instances are queried. You can specify multiple names. 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.
direct_connects	Array of DirectConnect objects	Specifies the connection list.
page_info	PageInfo object	Specifies the pagination query information.

**Table 5** DirectConnect
Parameter	Type	Description
id	String	Specifies the connection ID.
tenant_id	String	Specifies the project ID.
name	String	Specifies the connection name. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the connection. Minimum: 0 Maximum: 128
port_type	String	Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G. Enumeration values: 1G 10G 40G 100G
bandwidth	Integer	Specifies the connection bandwidth, in Mbit/s. Minimum: 2 Maximum: 100000
location	String	Specifies information about the Direct Connect location. Minimum: 0 Maximum: 255
peer_location	String	Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Minimum: 0 Maximum: 255
device_id	String	Specifies the ID of the device connected to the connection. Minimum: 0 Maximum: 36
type	String	Specifies the type of a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection). Default: standard Enumeration values: standard hosting hosted
hosting_id	String	Specifies the ID of the operations connection on which the hosted connection is created.
charge_mode	String	Specifies the billing mode. The value can be prepayment, bandwidth, or traffic. Enumeration values: prepayment bandwidth traffic
provider	String	Specifies the line carrier of a connection. It can be China Telecom, China Unicom, China Mobile, and other carriers that provide the lines.
admin_state_up	Boolean	Specifies the administrative status. The value can be true or false. Default: true
vlan	Integer	Specifies the VLAN allocated to the hosted connection. Minimum: 0 Maximum: 3999
status	String	Specifies the connection status. ACTIVE: The connection is in the normal state. DOWN: The port for the connection is in the down state, which may cause line faults. BUILD: Operations related to the connection are being performed. ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault. PENDING_DELETE: The connection is being deleted. DELETED: The connection has been deleted. APPLY: A request for a connection is submitted. DENY: A site survey is rejected because the customer fails to meet the requirements. PENDING_PAY: The order for the connection is to be paid. PAID: The order for the connection has been paid. PENDING_SURVEY: A site survey is required for the connection. LEASED_LINE_DELIVERY: The carrier is deploying the line. Enumeration values: BUILD PAID APPLY PENDING_SURVEY ACTIVE DOWN ERROR PENDING_DELETE DELETED DENY PENDING_PAY LEASED_LINE_DELIVERY
apply_time	String	Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
create_time	String	Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
provider_status	String	Specifies the carrier status. The status can be ACTIVE or DOWN. Enumeration values: ACTIVE DOWN
peer_port_type	String	Specifies the peer port type.
peer_provider	String	Specifies the carrier of the leased line.
order_id	String	Specifies the connection order ID, which is used to support duration-based billing and identify user orders.
product_id	String	Specifies the product ID corresponding to the connection's order. The product ID is used to specify billing policies such as duration-based packages.
spec_code	String	Specifies the product specifications corresponding to the connection's order. The specifications are used to specify billing policies such as duration-based packages.
period_type	Integer	Specifies whether a connection in a specified order is billed by year or month.
period_num	Integer	Specifies the required service duration of a yearly/monthly connection.
vgw_type	String	Specifies the gateway type required by a connection. Default: default Enumeration values: default
lag_id	String	Specifies the ID of the LAG that the connection belongs to.
signed_agreement_status	String	Specifies the signing status of the Direct Connect Disclaimers. Enumeration values: signed
signed_agreement_time	String	Specifies when the Direct Connect Disclaimers were signed.
enterprise_project_id	String	Specifies the ID of the enterprise project that the connection belongs to. Minimum: 36 Maximum: 36
tags	Array of Tag objects	Specifies the tags. Array length: 0–10
locales	LocalesBody object	Specifies the region of the connection.
support_feature	Array of strings	Lists the features supported by the connection.
ies_id	String	Specifies the edge site ID.
reason	String	Displays error information if the status of a line is Error.
email	String	Specifies the customer email information.
onestop_product_id	String	Specifies the product ID if the connection is a full-service connection. This parameter is used in line sales scenarios.
building_line_product_id	String	Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios.
last_onestop_product_id	String	Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed.
last_building_line_product_id	String	Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed.
modified_bandwidth	Integer	Specifies the new bandwidth after the line bandwidth is changed.
change_mode	Integer	Specifies the status of a renewal change.
onestopdc_status	String	Specifies the status of a full-service connection.
public_border_group	String	Specifies the public border group of the AZ, indicating whether the site is a HomeZones site.
auto_renew	Integer	Specifies whether to automatically renew a yearly/monthly subscription.
ratio_95peak	Integer	Specifies the percentage of the minimum bandwidth for 95th percentile billing. Minimum: 0 Maximum: 100

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

**Table 7** LocalesBody
Parameter	Type	Description
en_us	String	Specifies the region name in English. Minimum: 0 Maximum: 255
zh_cn	String	Specifies the region name in Chinese. Minimum: 0 Maximum: 255

**Table 8** 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 this parameter is left empty, the resource is on the last page. Minimum: 0 Maximum: 36

Example Requests

Querying the connection list

GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects

Example Responses

Status code: 200

The connection list is queried.

{
  "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535",
  "direct_connects" : [ {
    "bandwidth" : 100,
    "create_time" : "2018-10-19T09:53:26.000Z",
    "port_type" : "10G",
    "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
    "apply_time" : "2018-10-19T09:53:26.000Z",
    "peer_location" : "",
    "peer_port_type" : null,
    "peer_provider" : null,
    "location" : "ExampleLocation",
    "provider" : "ExampleProvider",
    "type" : "standard",
    "status" : "BUILD",
    "description" : "",
    "provider_status" : "ACTIVE",
    "order_id" : "",
    "vlan" : null,
    "device_id" : "172.16.40.2",
    "name" : "direct connect1",
    "admin_state_up" : true,
    "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
    "hosting_id" : null,
    "product_id" : "",
    "vgw_type" : "default",
    "spec_code" : "100ge",
    "charge_mode" : null,
    "support_feature" : [ ],
    "ies_id" : null,
    "reason" : null,
    "email" : "cloud@example.com",
    "onestop_product_id" : null,
    "building_line_product_id" : null,
    "last_building_line_product_id" : null,
    "last_onestop_product_id" : null,
    "modified_bandwidth" : null,
    "change_mode" : null,
    "onestopdc_status" : null,
    "public_border_group" : "center",
    "auto_renew" : 0,
    "ratio_95peak" : null
  } ]
}

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

    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("<YOUR REGION>"))
                .build();
        ListDirectConnectsRequest request = new ListDirectConnectsRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withFields();
        request.withSortKey("<sort_key>");
        request.withSortDir();
        request.withHostingId();
        request.withEnterpriseProjectId();
        request.withId();
        request.withName();
        try {
            ListDirectConnectsResponse response = client.listDirectConnects(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("<YOUR REGION>")) \
        .build()

    try:
        request = ListDirectConnectsRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.fields = 
        request.sort_key = "<sort_key>"
        request.sort_dir = 
        request.hosting_id = 
        request.enterprise_project_id = 
        request.id = 
        request.name = 
        response = client.list_direct_connects(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("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

          

        

      
     