文档

ListAccessPoints - 查询智能接入网关接入点信息

更新时间:

调用ListAccessPoints查询智能接入网关接入点信息。

接口说明

接入点是指智能接入网关接入云连接网时的连接点。云连接网在一些区域内包含多个接入点。智能接入网关实例绑定云连接网后,系统采取就近原则,自动帮您连接最近的接入点进入阿里云。您可以通过本 API 查询指定区域内的接入点信息。云连接网区域详情请参见云连接网介绍

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:ListAccessPointsList
  • 全部资源
    *

请求参数

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

要查询的接入点所属地域 ID。您可以通过 DescribeRegions 查询地域 ID。

cn-hangzhou
PageSizeinteger

分页查询时每页的条目数。 取值范围:1~50。 默认值:20

20
SmartAGIdstring

智能接入网关实例 ID。

sag-far8v6owtdxlua****
PageNumberinteger

分页查询时的页码,默认值为 1

1

返回参数

名称类型描述示例值
object
AccessPointsobject []

接入点信息。

Longitudestring

接入点经度。

1.35****
ActiveSmartAGCountinteger

当前接入点下可用的智能接入网关实例数量。

0
InactiveSmartAGCountinteger

当前接入点下离线的智能接入网关实例数量。

7
Latitudestring

接入点纬度。

103.81****
AccessPointIdinteger

接入点 ID。

401
TotalCountinteger

接入点总个数。

2
RequestIdstring

请求 ID。

E26DBAAE-A796-4A48-98B4-B45AFCD1F299

示例

正常返回示例

JSON格式

{
  "AccessPoints": [
    {
      "Longitude": "1.35****",
      "ActiveSmartAGCount": 0,
      "InactiveSmartAGCount": 7,
      "Latitude": "103.81****",
      "AccessPointId": 401
    }
  ],
  "TotalCount": 2,
  "RequestId": "E26DBAAE-A796-4A48-98B4-B45AFCD1F299"
}

错误码

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