You can call this operation to query Smart Access Gateway (SAG) instances that you have created.

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 the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeSmartAccessGateways

The operation that you want to perform.

Set the value to DescribeSmartAccessGateways.

RegionId String No cn-hangzhou

The ID of the region where the SAG instance is deployed.

AssociatedCcnId String No ccn-bxuau4ezctt******

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

SmartAGId String No sag-c3m3n1khz58l******

The ID of the SAG instance.

Status String No Ordered

The status of the SAG instance. Valid values:

  • Ordered: Your order has been placed.
  • Delivered: Your order has been shipped.
  • Received: You have received the SAG device.
  • Returning: The order is being returned.
  • Active: The SAG instance has been activated.
  • init: The SAG instance is being initialized.
  • offline: The SAG device is disconnected from Alibaba Cloud.
Name String No sag

The name of the SAG instance.

PageSize Integer No 1

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

PageNumber Integer No 2

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

SerialNumber String No sag32a30121

The serial number (SN) of the SAG device.

AclIds String No acl-xhwhyuo43l0n******

The access control list (ACL) associated with the SAG instance.

UnboundAclIds String No acl-sjfbgngj***************

The ACLs that are not associated with the SAG instance. Separate multiple IDs with commas (,).

InstanceType String No hardware

The type of the instance. Valid values:

  • software: SAG APP instances.
  • hardware: SAG instances.
CanAssociateQos Boolean No false

Specifies whether the SAG instance can be associated with a quality of service (QoS) policy. Valid values:

  • true: The SAG instance can be associated with a QoS policy.
  • false: The SAG instance cannot be associated with a QoS policy.
HardwareType String No sag-1000

The model of the SAG device. Valid values:

  • sag-1000
  • sag-100wm
SoftwareVersion String No 1.0.0

The version of the SAG instance.

VersionComparator String No equals

The operator used to filter SAG instance versions. Valid values:

  • greater: versions later than the current one.
  • less: versions earlier than the current one.
  • equals: the current version.
BusinessState String No Normal

The status of the SAG instance. Valid values:

  • Normal: runs as expected.
  • Arrearage: has overdue payments.

Response parameters

Parameter Type Example Description
PageNumber Integer 2

The page number of the returned page.

PageSize Integer 2

The number of entries returned per page.

RequestId String 7F26258D-8BDE-4EC4-BB4D-4DDC64F64F77

The ID of the request.

SmartAccessGateways Array

The detailed information about the SAG instance.

SmartAccessGateway
AclIds String acl-shfhfhhfbnvkdg******

The ACL associated with the SAG instance.

AssociatedCcnId String ccn-bxuau4ezctts******

The ID of the CCN instance associated with the SAG instance.

AssociatedCcnName String ccn

The name of the associated CCN instance.

BackupSoftwareVersion String v1.6.0

The version of the SAG instance.

BackupStatus String Ordered

The status of the standby SAG device.

CidrBlock String 192.168.**. **/24

The CIDR blocks of terminals in the private network.

City String Hangzhou

The city where the SAG device is deployed.

CreateTime Long 1523604565000

The time when the SAG instance was created.

DataPlan Long 5

The data transfer plan of the SAG instance.

Description String docdesc

The description of the SAG instance.

EndTime Long 1526227200000

The time when the SAG instance expires.

HardwareVersion String sag-100wm

The model of the SAG device.

  • sag-1000
  • sag-100wm
Links Array

The list of network connections supported by the SAG instance.

Link
Bandwidth String 10M

The bandwidth of the network connection.

CommodityType String smartag

The type of the commodity. Valid values:

  • bandwidth: bandwidth resources.
  • smartag: SAG instances.
EndTime Long 1526227200000

The time when the SAG instance expires.

InstanceId String sag-v0fkpk4akfz********

The ID of the SAG instance.

RelateInstanceId String sag-v0fkpk4akfz5*******

The ID of the instance associated with the SAG instance.

RelateInstanceRegionId String cn-hangzhou

The region where the associated instance is deployed.

Status String Active

The status of the network connection.

The status of the broadband connection. Valid values:

  • Ordered: Your order has been placed.
  • Delivered: Your order has been shipped.
  • offline: The SAG device is disconnected from Alibaba Cloud.
  • Active: The SAG device is connected to Alibaba Cloud.
  • Arrearage: The SAG instance is stopped due to overdue payments.

The status of the physical connection established by the leased line.

  • normal: The physical connection works as expected.
  • arrears: A payment is overdue.
Type String ccn

The type of the network connection. Valid values:

  • ccn: established through a CCN instance.
  • vbr: established through a virtual border router (VBR).
MaxBandwidth String 2M

The bandwidth of the SAG instance.

Name String sag

The name of the SAG instance.

QosIds String qos-djh*****************

The ID of the QoS policy associated with the SAG instance.

RoutingStrategy String static

The routing method.

  • static: static routing.
  • dynamic: dynamic routing.
SecurityLockThreshold Integer 3600

The time that a disconnected SAG device remains locked. The time must be no shorter than zero second.

Unit: second.

SerialNumber String sag32a903******

The SN of the SAG device.

SmartAGId String sag-v0fkpk4akfz5******

The ID of the SAG instance.

SmartAGUid Long 12345556345555

The UID of the Alibaba Cloud account that owns the SAG instance.

SoftwareVersion String 1.0.0

The version of the SAG instance.

Status String Init

The status of the SAG instance.

UpBandwidth4G Integer 3

The maximum upstream bandwidth of network connections established over 4G.

UpBandwidthWan Integer 2

The maximum upstream bandwidth of network connections established on the WAN port of the SAG device.

UserCount Integer 12

The number of client accounts added to the SAG instance.

TotalCount Integer 2

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeSmartAccessGateways
&<Common request parameters>

Sample success responses

XML format

<DescribeSmartAccessGatewaysResponse>
	  <PageNumber>1</PageNumber>
	  <PageSize>10</PageSize>
	  <RequestId>23DD7A46-C36C-4593-A05C-E890252C5A38</RequestId>
	  <SmartAccessGateways>
		    <SmartAccessGateway>
			      <AssociatedCcnId>ccn-elyodlndl0******</AssociatedCcnId>
			      <AssociatedCcnName>bvt-test</AssociatedCcnName>
			      <BackupSoftwareVersion></BackupSoftwareVersion>
			      <CreateTime>1566442838000</CreateTime>
			      <HardwareVersion>sag-100wm</HardwareVersion>
			      <Links>
				        <Link>
					          <Bandwidth>10M</Bandwidth>
					          <CommodityType>smartag</CommodityType>
					          <InstanceId>sag-ot3uudy72dz******</InstanceId>
					          <RelateInstanceId>ccn-elyodlndl0******</RelateInstanceId>
					          <Status>Active</Status>
					          <Type>ccn</Type>
				        </Link>
			      </Links>
			      <MaxBandwidth>10M</MaxBandwidth>
			      <QosIds>qos-awfxl1adxeq****</QosIds>
			      <RoutingStrategy>static</RoutingStrategy>
			      <SecurityLockThreshold>0</SecurityLockThreshold>
			      <SerialNumber>sn-1566442***</SerialNumber>
			      <SmartAGId>sag-ot3uudy72dzj******</SmartAGId>
			      <Status>Offline</Status>
			      <UpBandwidth4G>4</UpBandwidth4G>
			      <UpBandwidthWan>2</UpBandwidthWan>
		    </SmartAccessGateway>
	  </SmartAccessGateways>
	  <TotalCount>1</TotalCount>
    </DescribeSmartAccessGatewaysResponse>

JSON format

{
    "PageNumber":1,
    "PageSize":10,
    "RequestId":"23DD7A46-C36C-4593-A05C-E890252C5A38",
    "SmartAccessGateways":{
        "SmartAccessGateway":[
            {
                "AssociatedCcnId":"ccn-elyodlndl0******",
                "AssociatedCcnName":"bvt-test",
                "BackupSoftwareVersion":"",
                "CreateTime":1566442838000,
                "HardwareVersion":"sag-100wm",
                "Links":{
                    "Link":[
                        {
                            "Bandwidth":"10M",
                            "CommodityType":"smartag",
                            "InstanceId":"sag-ot3uudy72dz******",
                            "RelateInstanceId":"ccn-elyodlndl0******",
                            "Status":"Active",
                            "Type":"ccn"
                        }
                    ]
                },
                "MaxBandwidth":"10M",
                "QosIds":"qos-awfxl1adxeq****",
                "RoutingStrategy":"static",
                "SecurityLockThreshold":0,
                "SerialNumber":"sn-1566442838",
                "SmartAGId":"sag-ot3uudy72dzj******",
                "Status":"Offline",
                "UpBandwidth4G":4,
                "UpBandwidthWan":2
            }
        ]
    },
    "TotalCount":1
}

Error codes

HttpCode Error code Error message Description
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you do not have the permission to manage the specified resource.
400 Param.InvalidVersionComparator The specified version comparison operator is invalid. The error message returned because the specified operator used to filter SAG instance versions is invalid.
400 InvalidRegionID The specified regionId does not exist. The error message returned because the specified region ID does not exist.

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