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。 示例值:ap-guangzhou |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。 示例值:100 |
Filters.N | 否 | Array of Filter | 过滤参数,支持:access-point-id、isp 示例值:["Name": "access-point-id", "Values": ["ap-beijing-a-kc"]] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AccessPointSet | Array of AccessPoint | 接入点信息。 |
TotalCount | Integer | 接入点总数量。 示例值:100 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取全量接入点信息
获取全量接入点信息。
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeAccessPoints
&<公共请求参数>
输出示例
{
"Response": {
"AccessPointSet": [
{
"AccessPointName": "新加坡-C-泰戈尔",
"AccessPointId": "ap-singapore-c-tagore",
"City": "新加坡",
"Area": "其它",
"RegionId": "ap-singapore",
"Location": "新加坡Dodid泰戈尔AC",
"Coordinate": {
"Lat": 1.3885116,
"Lng": 103.8277551
},
"AccessPointType": "VXLAN",
"LineOperator": [
"InternationalOperator"
],
"AvailablePortType": [
"1000BASE-LX",
"1000BASE-ZX",
"10GBASE-LR",
"10GBASE-ZR",
"100GBASE-LR4L",
"100GBASE-LR4",
"100GBASE-40KM",
"QSFPDD-400G-FR4",
"QSFPDD-400G-LR4"
],
"AvailablePortInfo": [
{
"InternationalName": "1000BASE-LX",
"Specification": 1000,
"PortType": "X"
},
{
"InternationalName": "1000BASE-ZX",
"Specification": 1000,
"PortType": "X"
},
{
"InternationalName": "10GBASE-LR",
"Specification": 10000,
"PortType": "X"
},
{
"InternationalName": "10GBASE-ZR",
"Specification": 10000,
"PortType": "X"
},
{
"InternationalName": "100GBASE-LR4L",
"Specification": 100000,
"PortType": "X"
},
{
"InternationalName": "100GBASE-LR4",
"Specification": 100000,
"PortType": "X"
},
{
"InternationalName": "100GBASE-40KM",
"Specification": 100000,
"PortType": "X"
},
{
"InternationalName": "QSFPDD-400G-FR4",
"Specification": 400000,
"PortType": "X"
},
{
"InternationalName": "QSFPDD-400G-LR4",
"Specification": 400000,
"PortType": "X"
}
],
"State": "AVAILABLE"
}
],
"RequestId": "b6aa097b-3cd9-4c79-bf41-bb0d2427ffa2",
"TotalCount": 98
}
}
示例2 获取指定地域接入点信息
获取指定地域接入点信息。
输入示例
https://dc.tencentcloudapi.com/?Action=DescribeAccessPoints
&RegionId=ap-chongqing
&<公共请求参数>
输出示例
{
"Response": {
"AccessPointSet": [
{
"AccessPointName": "重庆-A-泰和",
"AccessPointId": "ap-chongqing-a-th",
"City": "重庆",
"Area": "西南",
"RegionId": "ap-chongqing",
"Location": "重庆腾讯泰和DC",
"Coordinate": {
"Lat": 29.790833,
"Lng": 106.523072
},
"AccessPointType": "VXLAN",
"LineOperator": [
"ChinaTelecom",
"ChinaMobile",
"ChinaUnicom",
"In-houseWiring",
"ChinaOther"
],
"AvailablePortType": [
"1000BASE-LX",
"1000BASE-T",
"1000BASE-ZX",
"10GBASE-LR",
"10GBASE-ZR",
"100GBASE-LR4L",
"100GBASE-LR4",
"100GBASE-40KM",
"QSFPDD-400G-FR4",
"QSFPDD-400G-LR4"
],
"AvailablePortInfo": [
{
"InternationalName": "1000BASE-LX",
"Specification": 1000,
"PortType": "X"
},
{
"InternationalName": "1000BASE-T",
"Specification": 1000,
"PortType": "T"
},
{
"InternationalName": "1000BASE-ZX",
"Specification": 1000,
"PortType": "X"
},
{
"InternationalName": "10GBASE-LR",
"Specification": 10000,
"PortType": "X"
},
{
"InternationalName": "10GBASE-ZR",
"Specification": 10000,
"PortType": "X"
},
{
"InternationalName": "100GBASE-LR4L",
"Specification": 100000,
"PortType": "X"
},
{
"InternationalName": "100GBASE-LR4",
"Specification": 100000,
"PortType": "X"
},
{
"InternationalName": "100GBASE-40KM",
"Specification": 100000,
"PortType": "X"
},
{
"InternationalName": "QSFPDD-400G-FR4",
"Specification": 400000,
"PortType": "X"
},
{
"InternationalName": "QSFPDD-400G-LR4",
"Specification": 400000,
"PortType": "X"
}
],
"State": "AVAILABLE"
}
],
"RequestId": "b6aa097b-3cd9-4c79-bf41-bb0d2427ffa3",
"TotalCount": 3
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |