Help Center/ Direct Connect/ API Reference/ API/ Direct Connect Locations/ Querying the Direct Connect Location List
Updated on 2026-11-11 GMT+08:00

Querying the Direct Connect Location List

Function

This API is used to query all the Direct Connect locations in a region. The marker and limit parameters are used for pagination query. The two parameters take effect only when they are used together.

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/direct-connect-locations

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Specifies the number of records returned on each page.

Constraints

N/A

Range

1 to 2000

Default Value

2000

marker

No

String

Definition

Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried.

Constraints

This parameter must be used together with limit.

Range

The value can contain a maximum of 36 characters.

Default Value

N/A

sort_key

No

String

Definition

Specifies the sorting key.

Constraints

N/A

Range

The value can contain a maximum of 36 characters.

Default Value

id

sort_dir

No

Array of strings

Definition

Specifies the sorting order of returned results, which can be asc (ascending order) or desc (descending order). The default value is asc.

Constraints

N/A

id

No

Array of strings

Definition

Specifies the resource ID by which instances are queried.

Constraints

The array length ranges from 1 to 5.

name

No

Array of strings

Definition

Specifies the resource name by which instances are filtered. You can specify multiple names.

Constraints

The array length ranges from 1 to 5.

status

No

Array of strings

Definition

Specifies the status by which instances are queried.

Constraints

The array length ranges from 1 to 5.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

direct_connect_locations

Array of DirectConnectLocationEntry objects

Definition

Specifies the Direct Connect locations.

page_info

PageInfo object

Definition

Specifies the pagination query information.

request_id

String

Definition

Specifies the request ID.

Range

The value can contain a maximum of 36 characters.

Table 5 DirectConnectLocationEntry

Parameter

Type

Description

id

String

Definition

Specifies the ID of the Direct Connect location.

Range

The value can contain a maximum of 36 characters.

name

String

Definition

Specifies the name of the Direct Connect location.

Range

The value can contain a maximum of 64 characters.

region_id

String

Definition

Specifies the region that the Direct Connect location belongs to.

Range

N/A

site_code

String

Definition

Specifies the site code of the Direct Connect location.

Range

The value can contain a maximum of 64 characters.

address

AddressBody object

Definition

Provides the address of the Direct Connect location.

locales

LocalesBody object

Definition

Specifies the locale.

provider_list

Array of ProviderResponseBody objects

Definition

Lists the supported carriers.

public_border_group

String

Definition

Specifies the public border group that the Direct Connect location belongs to.

Range

The value can contain a maximum of 64 characters.

latitude

String

Definition

Specifies the latitude of the Direct Connect location.

Range

The value can contain a maximum of 36 characters.

longitude

String

Definition

Specifies the longitude of the Direct Connect location.

Range

The value can contain a maximum of 36 characters.

description

String

Definition

Specifies the description.

Range

The value can contain a maximum of 255 characters.

created_time

String

Definition

Specifies the creation time.

updated_time

String

Definition

Specifies the update time.

available_port_speeds

Array of strings

Definition

Specifies available port types at the Direct Connect location.

location_type

String

Definition

Specifies the location type.

Range

The value can contain a maximum of 64 characters.

city

String

Definition

Specifies the city.

Range

The value can contain a maximum of 64 characters.

support_region_type

String

Definition

Specifies the supported region type.

Range

The value can contain a maximum of 64 characters.

Table 6 AddressBody

Parameter

Type

Description

en_us

String

Definition

Specifies the English name.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

zh_cn

String

Definition

Specifies the Chinese name.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

Table 7 LocalesBody

Parameter

Type

Description

en_us

String

Definition

Specifies the region name in English.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

zh_cn

String

Definition

Specifies the region name in Chinese.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

Table 8 ProviderResponseBody

Parameter

Type

Description

id

String

Definition

Specifies the carrier ID.

Range

The value can contain only up to 32 characters, including lowercase letters (a to z), uppercase letters (A to Z), digits (0 to 9), underscores (_), and hyphens (-).

short_name

String

Definition

Specifies the carrier name abbreviation.

Range

The value can contain 1 to 36 characters, including only letters (a–z or A–Z), digits (0 to 9), underscores (_), periods (.), and hyphens (-).

type

String

Definition

Specifies the carrier type.

Range

The value can be LEVEL_ONE or LEVEL_TWO. It can contain a maximum of 36 characters.

provider_value

ProviderValueBody object

Definition

Specifies the carrier name.

description

String

Definition

Provides supplementary information about the carrier.

Range

The value can contain 1 to 36 characters, including only letters (a–z or A–Z), digits (0 to 9), underscores (_), periods (.), and hyphens (-).

Table 9 ProviderValueBody

Parameter

Type

Description

en_us

String

Definition

Specifies the English name.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

zh_cn

String

Definition

Specifies the Chinese name.

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

Table 10 PageInfo

Parameter

Type

Description

previous_marker

String

Definition

Specifies the marker of the previous page. The value is the resource UUID.

Range

The value can contain a maximum of 36 characters.

current_count

Integer

Definition

Specifies the number of resources in the current list.

Range

0 to 2000

next_marker

String

Definition

Specifies the marker of the next page. The value is the resource UUID. This parameter does not exist if the page is the last one.

Range

The value can contain a maximum of 36 characters.

Example Requests

Querying the Direct Connect location list

GET https://{dc_endpoint}/v3/92ea72fe26294aa180a2712c28e43c21/dcaas/direct-connect-locations

Example Responses

Status code: 200

Direct Connect location list that has been queried

{
  "request_id" : "cb4aaa7fe6b5d4d769e84935aed477a2",
  "direct_connect_locations" : [ {
    "name" : "xxx",
    "id" : "00825bc2-59e9-4e00-a7f9-e8164971bd93",
    "region_id" : "xxxxxx",
    "site_code" : "xxxxxx",
    "address" : {
      "en_us" : "xxx",
      "zh_cn" : "xxx"
    },
    "public_border_group" : null,
    "locales" : {
      "en_us" : "xxx",
      "zh_cn" : "xxx"
    },
    "provider_list" : [ {
      "id" : "773dd278-1cae-4a8c-ad53-f2d8e8a9b9f9",
      "short_name" : "others",
      "type" : "LEVEL_TWO",
      "provider_value" : {
        "en_us" : "Other",
        "zh_cn" : "Other"
      },
      "description" : "Carrier"
    }, {
      "id" : "b6fd0ad8-dac4-4e21-a987-bce2f28ee861",
      "short_name" : "example1",
      "type" : "LEVEL_ONE",
      "provider_value" : {
        "en_us" : "example1",
        "zh_cn" : "example1"
      },
      "description" : "Carrier"
    }, {
      "id" : "ea30d085-aa48-49b0-a519-8f3085e8137a",
      "short_name" : "example2",
      "type" : "LEVEL_ONE",
      "provider_value" : {
        "en_us" : "example2",
        "zh_cn" : "example2"
      },
      "description" : "Carrier"
    }, {
      "id" : "a237b909-e60d-4292-8afe-9600ddfef755",
      "short_name" : "example3",
      "type" : "LEVEL_ONE",
      "provider_value" : {
        "en_us" : "example3",
        "zh_cn" : "example3"
      },
      "description" : "Carrier"
    } ],
    "latitude" : "0.0",
    "longitude" : "0.0",
    "description" : "test",
    "created_time" : "2023-11-23T01:24:52.000Z",
    "updated_time" : "2024-08-24T01:26:18.911Z",
    "available_port_speeds" : [ "100G", "1G", "10G", "40G" ],
    "location_type" : "region",
    "city" : "Beijing4",
    "support_region_type" : "singleRegion"
  } ],
  "page_info" : {
    "previous_marker" : "00825bc2-59e9-4e00-a7f9-e8164971bd93",
    "current_count" : 1
  }
}

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

    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();
        ListDirectConnectLocationsRequest request = new ListDirectConnectLocationsRequest();
        try {
            ListDirectConnectLocationsResponse response = client.listDirectConnectLocations(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 = ListDirectConnectLocationsRequest()
        response = client.list_direct_connect_locations(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.ListDirectConnectLocationsRequest{}
	response, err := client.ListDirectConnectLocations(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.