tencent cloud

Direct Connect

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Application Scenarios
Use Limits
Connection Access Point
Relevant Products
Network Planning
Purchase Guide
Billing Overview
Purchasing in the Console
Renewing Connections
Getting Started
Operation Guide
Connections
Direct Connect Gateways
Dedicated Tunnels
Monitoring and Alarming
MACsec Encryption
Cloud Exchange
Cloud Access Management
Overview
Access Policy Types
Access Policy Syntax
Practical Tutorial
Connecting a Local IDC to CVM by Using a VPC NAT Gateway and Direct Connect
Hybrid Cloud Primary/Secondary Communication (DC and VPN)
Best Practices on Direct Connect High Availability and Hybrid Cloud Network
Migrating Cross-Region Dedicated Tunnel to CCN
Migrating IDC to the Cloud Through CCN
Accelerating Routing Convergence Through BGP+BFD (Layer 3)
IDC Local Configuration
Establishing Direct Connect Between Tencent Cloud and Various Cloud Vendors Through Equinix
API Documentation
History
Introduction
API Category
Making API Requests
Direct Connect APIs
Data Types
Error Codes
FAQ
Basic FAQs
Billing Issues
Function Issues
Troubleshooting
General Troubleshooting Solutions
Access Failure and Packet Loss
Agreements
Tencent Cloud Direct Connect Service Level Agreement
Tencent Cloud Direct Connect Service Agreement
Tencent Cloud Direct Connect Review Standards
Contact Us
Glossary
DocumentationDirect ConnectAPI DocumentationDirect Connect APIsDescribeAccessPoints

DescribeAccessPoints

PDF
Focus Mode
Font Size
Last updated: 2025-10-30 21:39:45

1. API Description

Domain name for API request: dc.intl.tencentcloudapi.com.

This API is used to query connection access points.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeAccessPoints.
Version Yes String Common Params. The value used for this API: 2018-04-10.
Region No String Common Params. This parameter is not required.
RegionId No String Access point region, which can be queried through DescribeRegions.

You can call DescribeRegions to get the region ID.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of results to be returned. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name Type Description
AccessPointSet Array of AccessPoint Access point information.
TotalCount Integer Number of eligible access points.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting the information of all access points

This example shows you how to get the information of all access points, where AVAILABLE indicates available access points and UNAVAILABLE indicates the unavailable ones.

Input Example

https://dc.intl.tencentcloudapi.com/?Action=DescribeAccessPoints
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 6,
        "AccessPointSet": [
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-hx",
                "State": "AVAILABLE",
                "Location": "TravelSky High-Tech Industrial Park, Houshayu Town, Shunyi District, Beijing",
                "AccessPointName": "TravelSky"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-jxq",
                "State": "AVAILABLE",
                "Location": "BEZ IT Park, Chaoyang District, Beijing",
                "AccessPointName": "Beijing Wanhong Road"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-yz",
                "State": "UNAVAILABLE",
                "Location": "No. 15, Middle Tongji Road, Beijing Economic-Technological Development Area, Daxing District, Beijing",
                "AccessPointName": "Beijing 21Vianet 1"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-zj",
                "State": "AVAILABLE",
                "Location": "No. 1, Bo’xing 8th Road, Beijing Economic-Technological Development Area, Beijing"
                "AccessPointName": "Beijing CICC"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-yf",
                "State": "UNAVAILABLE",
                "Location": "Building B4, Zone C, AT&M Park, No. 11, Middle Fenghui Road, Haidian District, Beijing",
                "AccessPointName": "Beijing Yongfeng"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-kc",
                "State": "AVAILABLE",
                "Location": "No. 15, Kechuang 9th Street, Beijing Economic-Technological Development Area, Beijing",
                "AccessPointName": "Beijing Kechuang"
            }
        ],
        "RequestId": "d591e41a-f3a5-4990-abf0-acdd88f238d9"
    }
}

Example2 Getting the information of access points in a specific region

This example shows you how to get the information of access points in a specific region, where AVAILABLE indicates available access points and UNAVAILABLE indicates the unavailable ones.

Input Example

https://dc.intl.tencentcloudapi.com/?Action=DescribeAccessPoints
&RegionId=ap-chongqing
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 2,
        "AccessPointSet": [
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-chongqing",
                "AccessPointId": "ap-cn-chongqing-yf",
                "State": "AVAILABLE",
                "Location": "Chongqing China Telecom Yunfu Data Center",
                "AccessPointName": "Chongqing Yunfu"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-chongqing",
                "AccessPointId": "ap-cn-chongqing-yx",
                "State": "AVAILABLE",
                "Location": "Chongqing China Unicom Yunxiang Data Center",
                "AccessPointName": "Chongqing Yunxiang"
            }
        ],
        "RequestId": "b6aa097b-3cd9-4c79-bf41-bb0d2427ffa1"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError An internal error occurred.
InvalidParameter Invalid parameter.
InvalidParameterValue The parameter value is invalid.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation The operation is unauthorized.
UnsupportedOperation Unsupported operation.
Previous Topic: ResponsesNext Topic: RejectDirectConnectTunnel

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback