文档

DescribeAccessPoints - 查询指定地域中的物理专线接入点

更新时间:

调用DescribeAccessPoints接口查询指定地域中的物理专线接入点。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

接入点所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10
AcceptLanguagestring

返回值语言,取值:

  • zh-CN:中文。
  • en-US(默认值):英文。
zh-CN

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10
TotalCountinteger

列表条条目数。

5
AccessPointSetobject []

查询到的接入点信息。

Statusstring

物理专线的接入点状态。

  • recommended :表示接入点状态良好,推荐接入。
  • hot :表示接入的物理专线较多,状态正常。
  • full :表示接入物理专线已满,不允许新增接入。
  • disabled :表示接入点不可用。
recommended
Typestring

物理专线的网络类型。默认值:VPC

VPC
HostOperatorstring

接入点所属的运营商。

中国电信
Descriptionstring

接入点描述信息。

接入点描述信息
AttachedRegionNostring

接入点所在的地域 ID。

cn-hangzhou
Namestring

接入点名称。

杭州-余杭-C
AccessPointIdstring

接入点 ID。

ap-cn-hangzhou-****
Locationstring

接入点的位置。

杭州
AccessPointFeatureModelsobject []

查询到的接入点特征模型。

FeatureValuestring

接入点特性值。

true
FeatureKeystring

接入点特性。

AP_Support_VbrBandwidthLimit

示例

正常返回示例

JSON格式

{
  "RequestId": "3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 5,
  "AccessPointSet": {
    "AccessPointType": [
      {
        "Status": "recommended",
        "Type": "VPC",
        "HostOperator": "中国电信",
        "Description": "接入点描述信息",
        "AttachedRegionNo": "cn-hangzhou",
        "Name": "杭州-余杭-C",
        "AccessPointId": "ap-cn-hangzhou-****",
        "Location": "杭州",
        "AccessPointFeatureModels": {
          "AccessPointFeatureModel": [
            {
              "FeatureValue": "true",
              "FeatureKey": "AP_Support_VbrBandwidthLimit"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidAccessPointType.NotSupportInvalid access point type.-
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404InvalidRegionId.NotSupportThe RegionId provided does not support in our records.输入的地域ID不正确。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-09-20OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2023-05-18OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:AcceptLanguage
  • 本页导读 (1)
文档反馈