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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeAccessPoints

要执行的操作。

取值:DescribeAccessPoints

RegionId String cn-hangzhou

接入点所在的地域ID。

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

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

返回数据

名称 类型 示例值 描述
AccessPointSet Array of AccessPointType

查询到的接入点信息。

AccessPointType
AccessPointFeatureModels Array of AccessPointFeatureModel

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

AccessPointFeatureModel
FeatureKey String AP_Support_VbrBandwidthLimit

接入点特性。

FeatureValue String true

接入点特性值。

AccessPointId String ap-cn-hangzhou-****

接入点ID。

AttachedRegionNo String cn-hangzhou

接入点所在的地域ID。

Description String 接入点描述信息

接入点描述信息。

HostOperator String 中国电信

接入点所属的运营商。

Location String 杭州

接入点的位置。

Name String 杭州-余杭-C

接入点名称。

Status String recommended

物理专线的接入点状态。

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

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

TotalCount Integer 5

列表条条目数。

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

RequestId String 3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAccessPoints
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotSupport The RegionId provided does not support in our records. 输入的地域ID不正确。

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