有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: dc.tencentcloudapi.com 。

查询物理专线接入点

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAccessPoints。
Version String 公共参数,本接口取值:2018-04-10。
Region String 公共参数,此参数为可选参数。
RegionId String 接入点所在的地域。使用DescribeRegions查询

您可以通过调用 DescribeRegions接口获取地域ID。
Offset Integer 偏移量,默认为0。
Limit Integer 返回数量,默认为20,最大值为100。

3. 输出参数

参数名称 类型 描述
AccessPointSet Array of AccessPoint 接入点信息。
TotalCount Integer 符合接入点数量。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取全量接入点信息

获取全量接入点信息,其中AVAILABLE是可以使用的接入点,UNAVAILABLE是不可以使用的接入点。

输入示例

https://dc.tencentcloudapi.com/?Action=DescribeAccessPoints
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 6,
        "AccessPointSet": [
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-hx",
                "State": "AVAILABLE",
                "Location": "北京市顺义区后沙峪镇中国航信高科技产业园 ",
                "AccessPointName": "北京航信"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-jxq",
                "State": "AVAILABLE",
                "Location": "北京朝阳区电子城IT产业园 ",
                "AccessPointName": "北京万红路"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-yz",
                "State": "UNAVAILABLE",
                "Location": "北京市大兴区亦庄开发区同济中路15号",
                "AccessPointName": "北京世纪互联1"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-zj",
                "State": "AVAILABLE",
                "Location": "北京亦庄经济技术开发区博兴八路1号",
                "AccessPointName": "北京中金"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-yf",
                "State": "UNAVAILABLE",
                "Location": "北京市海淀区丰慧中路11号安泰科技园C区B4栋",
                "AccessPointName": "北京永丰"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-beijing",
                "AccessPointId": "ap-cn-beijing-kc",
                "State": "AVAILABLE",
                "Location": "北京市经济技术开发区科创九街十五号",
                "AccessPointName": "北京科创"
            }
        ],
        "RequestId": "d591e41a-f3a5-4990-abf0-acdd88f238d9"
    }
}

示例2 获取单地域接入点信息

获取单地域接入点信息,其中AVAILABLE是可以使用的接入点,UNAVAILABLE是不可以使用的接入点。

输入示例

https://dc.tencentcloudapi.com/?Action=DescribeAccessPoints
&RegionId=ap-chongqing
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "AccessPointSet": [
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-chongqing",
                "AccessPointId": "ap-cn-chongqing-yf",
                "State": "AVAILABLE",
                "Location": "重庆电信云福DC",
                "AccessPointName": "重庆云福"
            },
            {
                "LineOperator": [
                    "ChinaTelecom",
                    "ChinaMobile",
                    "ChinaUnicom",
                    "In-houseWiring",
                    "ChinaOther",
                    "InternationalOperator"
                ],
                "RegionId": "ap-chongqing",
                "AccessPointId": "ap-cn-chongqing-yx",
                "State": "AVAILABLE",
                "Location": "重庆联通云祥DC",
                "AccessPointName": "重庆云祥"
            }
        ],
        "RequestId": "b6aa097b-3cd9-4c79-bf41-bb0d2427ffa1"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。