调用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

AcceptLanguage String zh-CN

返回值语言,取值:

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

返回数据

名称 类型 示例值 描述
RequestId String 3E85D803-C7CF-4BCD-9CFE-6DBA1DFFA027

请求ID。

PageNumber Integer 1

列表的页码,默认值为1

PageSize Integer 10

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

TotalCount Integer 5

列表条条目数。

AccessPointSet Array of AccessPointType

查询到的接入点信息。

AccessPointType
Status String recommended

物理专线的接入点状态。

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

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

HostOperator String 中国电信

接入点所属的运营商。

Description String 接入点描述信息

接入点描述信息。

AttachedRegionNo String cn-hangzhou

接入点所在的地域ID。

Name String 杭州-余杭-C

接入点名称。

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

接入点ID。

Location String 杭州

接入点的位置。

AccessPointFeatureModels Array of AccessPointFeatureModel

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

AccessPointFeatureModel
FeatureValue String true

接入点特性值。

FeatureKey String AP_Support_VbrBandwidthLimit

接入点特性。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeAccessPoints
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceptLanguage=zh-CN
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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