Queries access points in a specific region.

Background information

An access point connects Smart Access Gateway (SAG) instances to Cloud Connect Network (CCN). In some regions, more than one access point is deployed. After an SAG instance is associated with a CCN instance, the system selects the nearest access point to establish connections to Alibaba Cloud. This topic describes how to query access points in a specific region. For more information about CCN areas, see Introduction to CCN.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates a sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No ListAccessPoints

The operation that you want to perform.

Set the value to ListAccessPoints.

RegionId String Yes cn-hangzhou

The ID of the region where the access points are queried. You can call the DescribeRegions operation to query region IDs.

PageSize Integer No 20

The number of entries to return on each page.

SmartAGId String No sag-far8v6owtdxlua****

The ID of the SAG instance.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

Response parameters

Parameter Type Example Description
AccessPoints Array of AccessPoint

A list of access points.

AccessPointId Integer 401

The ID of the access point.

ActiveSmartAGCount Integer 0

The number of available SAG instances in the access point.

InactiveSmartAGCount Integer 7

The number of offline SAG instances in the access point.

Latitude String 103.81****

The latitude of the access point.

Longitude String 1.35****

The longitude of the access point.

RequestId String E26DBAAE-A796-4A48-98B4-B45AFCD1F299

The ID of the request.

TotalCount Integer 2

The total number of access points.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListAccessPoints
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<ListAccessPointsResponse>
  <AccessPoints>
        <AccessPointId>401</AccessPointId>
        <ActiveSmartAGCount>0</ActiveSmartAGCount>
        <Latitude>103.81****</Latitude>
        <InactiveSmartAGCount>7</InactiveSmartAGCount>
        <Longitude>1.35****</Longitude>
  </AccessPoints>
  <AccessPoints>
        <AccessPointId>402</AccessPointId>
        <ActiveSmartAGCount>0</ActiveSmartAGCount>
        <Latitude>24.6****</Latitude>
        <InactiveSmartAGCount>13</InactiveSmartAGCount>
        <Longitude>-28.4****</Longitude>
  </AccessPoints>
  <TotalCount>2</TotalCount>
  <RequestId>E26DBAAE-A796-4A48-98B4-B45AFCD1F299</RequestId>
</ListAccessPointsResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.