DescribeAccessPoints

Last updated: 2020-07-17 11:09:02

1. API Description

Domain name for API request: dc.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 parameter. The value used for this API: DescribeAccessPoints.
Version Yes String Common parameter. The value used for this API: 2018-04-10.
Region No String Common parameter. This parameter is not required for this API.
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, which is returned for each request. 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 unavailable ones.

Input Example

https://dc.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 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 unavailable ones.

Input Example

https://dc.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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Internal error
InvalidParameter Invalid parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Unsupported operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help