Docs

Direct Connect

DC Connection

DescribeDirectConnectAccessPoints - Querying information about DC access points.

Call DescribeDirectConnectAccessPoints to query information about Direct Connect (DC) access points.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The following only details request parameters specific to this API and key common parameters. For more information, see Common parameters.

Action String required Example: DescribeDirectConnectAccessPoints

The interface name. The current API name is DescribeDirectConnectAccessPoints.

Version String required Example: 2020-04-01

The interface version. The current API version is 2020-04-01.

DirectConnectAccessPointIds.N String optional Example: ap-cn-shanghai-***-A

The ID of the DC access point to be queried.

N represents the sequence number of a DC access point ID. You can call a maximum of 100 IDs per request.

Separate multiple IDs with ampersands (&).

If not provided, the information about all access points is queried by default.

PageSize Integer optional Example: 20

The number of entries per page in a pagination query. Maximum: 100. Default: 20.

PageNumber Integer optional Example: 1

Page number for pagination query.

Set this parameter to a non-negative integer.

If left blank or set to 0, it defaults to 1.

Response parameters

The following only details response parameters specific to this API. For more information, see Response structure.

PageSize Integer Example: 20

Number of entries per page in the current pagination.

PageNumber Integer Example: 1

The current page number.

TotalCount Integer Example: 1

Total number of the qualified DC access points.

DirectConnectAccessPoints Object[] Example: -

The details of the DC access point.

Status String Example: Available

The status of the DC access point.

Available

Unavailable

Location String Example: Wanguo, Langfang City, Hebei Province

The physical location of the DC access point.

Description String Example: China Mobile access point

The description of the DC access point.

LineOperators String[] Example: ChinaTelecom

The line operator who supports the DC access point.

ChinaTelecom: China Telecom

ChinaMobile: China Mobile

ChinaUnicom: China Unicom

ChinaOther: Other line operators in China with the corresponding telecommunications business operating license.

DirectConnectAccessPointId String Example: ap-cn-shanghai-***-A

The ID of the DC access point.

DirectConnectAccessPointName String Example: LFWG

The name of the DC access point.

DirectConnectAccessPointAlias String Example: AP-LangFangWanGuo

The English name of the DC access point location.

Request examples

GET /?Action=DescribeDirectConnectAccessPoints&Version=2020-04-01&PageNumber=1&PageSize=20&DirectConnectAccessPointIds=ap-cn-beijing-*** HTTP/1.1​
Host: directconnect.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/directconnect/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​

Response examples

{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "DescribeDirectConnectAccessPoints",​
        "Version": "2020-04-01",​
        "Service": "directconnect",​
        "Region": "cn-north-1"​
    },​
    "Result": {​
        "DirectConnectAccessPoints": [​
            {​
                "Status": "Available",​
                "Location": "Wanguo, Langfang City, Hebei Province",​
                "Description": "China Mobile access point",​
                "LineOperators": [​
                    "ChinaTelecom"​
                ],​
                "DirectConnectAccessPointId": "ap-cn-shanghai-***-A",​
                "DirectConnectAccessPointName": "LFWG",​
                "DirectConnectAccessPointAlias": "AP-LangFangWanGuo"​
            }​
        ],​
        "PageNumber": 1,​
        "PageSize": 20,​
        "TotalCount": 1​
    }​
}​

Error codes

The table below describes the error codes for this API that are associated with business logic. For details, see Common error codes.

Status code	Error codes	Error message	Description
400	InvalidPage.Malformed	The specified page is malformed.	The specified pagination parameter is invalid.
400	LimitExceeded.DirectConnectAccessPointId	You've reached the limit on the number of direct connect access point IDs that you can describe.	You have reached the maximum number of DC access points that can be queried.

Last updated: 2026.02.26 11:13:16