All Products
Search
Document Center

Smart Access Gateway:ListSmartAGByAccessPoint

Last Updated:Mar 29, 2024

Queries information about Smart Access Gateway (SAG) instances within specific access points in a specific region.

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:ListSmartAGByAccessPointList
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
PageSizeintegerNo

The number of entries to return on each page. Default value: 10. Maximum value: 50 .

5
AccessPointIdintegerYes

The ID of the access point.

238
PageNumberintegerNo

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

1
SmartAGStatusstringNo

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 parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The number of SAG instances within the access point.

16
RequestIdstring

The ID of the request.

AE203140-5D0C-4B4D-88D1-D008206B3A01
SmartAccessGatewaysobject []

The information about the SAG instance.

RoutingStrategystring

The method that the SAG instance uses to synchronize Alibaba Cloud-facing routes. Valid values:

  • static: static routing.
  • dynamic: dynamic routing.
static
SmartAGNamestring

The name of the SAG instance.

test
SmartAGIdstring

The ID of the SAG instance.

sag-p86e06z4geaji1****
SmartAGStatusstring

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
SmartAGDescriptionstring

The description of the SAG instance.

test
AssociatedCcnIdstring

The ID of the Cloud Connect Network (CCN) instance with which the SAG instance is associated.

ccn-l42qf3vpvb****
HardwareVersionstring

The model of the SAG device with which the SAG instance is associated. Valid values:

  • sag-1000.
  • sag-100WM.
sag-1000

Examples

Sample success responses

JSONformat

{
  "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

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