Query Smart Access Gateway instances by access point using ListSmartAGByAccessPoint - Smart Access Gateway

Queries Smart Access Gateway (SAG) instances associated with specific access points in a region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:ListSmartAGByAccessPoint

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG instance is deployed. A region contains one or more access points. You can call the ListAccessPoints operation to query access points in a specific region.	cn-shanghai
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Maximum value: 50 .	5
AccessPointId	integer	Yes	The ID of the access point.	238
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
SmartAGStatus	string	No	The status of the SAG instance. Valid values: Active: The SAG device is connected to Alibaba Cloud. offline: The SAG device is disconnected from Alibaba Cloud.	Active

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The number of SAG instances within the access point.	16
RequestId	string	The ID of the request.	AE203140-5D0C-4B4D-88D1-D008206B3A01
SmartAccessGateways	array<object>	The information about the SAG instance.
	object
RoutingStrategy	string	The method that the SAG instance uses to synchronize Alibaba Cloud-facing routes. Valid values: static: static routing. dynamic: dynamic routing.	static
SmartAGName	string	The name of the SAG instance.	test
SmartAGId	string	The ID of the SAG instance.	sag-p86e06z4geaji1****
SmartAGStatus	string	The status of the SAG instance. Valid values: Active: The SAG device is connected to Alibaba Cloud. offline: The SAG device is disconnected from Alibaba Cloud.	Active
SmartAGDescription	string	The description of the SAG instance.	test
AssociatedCcnId	string	The ID of the Cloud Connect Network (CCN) instance with which the SAG instance is associated.	ccn-l42qf3vpvb****
HardwareVersion	string	The model of the SAG device with which the SAG instance is associated. Valid values: sag-1000. sag-100WM.	sag-1000

Examples

Success response

JSON format

{
  "TotalCount": 16,
  "RequestId": "AE203140-5D0C-4B4D-88D1-D008206B3A01",
  "SmartAccessGateways": [
    {
      "RoutingStrategy": "static",
      "SmartAGName": "test",
      "SmartAGId": "sag-p86e06z4geaji1****",
      "SmartAGStatus": "Active",
      "SmartAGDescription": "test",
      "AssociatedCcnId": "ccn-l42qf3vpvb****",
      "HardwareVersion": "sag-1000"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.