All Products
Search
Document Center

Smart Access Gateway:ListAccessPoints

Last Updated:Mar 03, 2024

Queries access points in a region.

Operation description

An access point connects Smart Access Gateway (SAG) instances to Cloud Connect Network (CCN). Some regions may contain more than one access point. 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 the areas that support CCN, 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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:ListAccessPointsList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the queried access points reside. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PageSizeintegerNo

The number of entries returned on each page.

Valid values: 1 to 50.

Default value: 20.

20
SmartAGIdstringNo

The ID of the SAG instance.

sag-far8v6owtdxlua****
PageNumberintegerNo

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

1

Response parameters

ParameterTypeDescriptionExample
object
AccessPointsobject []

The information about the access point.

Longitudestring

The longitude of the access point.

1.35****
ActiveSmartAGCountinteger

The number of available SAG instances in the access point.

0
InactiveSmartAGCountinteger

The number of offline SAG instances in the access point.

7
Latitudestring

The latitude of the access point.

103.81****
AccessPointIdinteger

The ID of the access point.

401
TotalCountinteger

The total number of access points.

2
RequestIdstring

The ID of the request.

E26DBAAE-A796-4A48-98B4-B45AFCD1F299

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.