DescribeSmartAccessGateways - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries Smart Access Gateway (SAG) instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeSmartAccessGateways	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the SAG instance is deployed.	cn-shanghai
AssociatedCcnId	string	No	The ID of the CCN instance with which the SAG instance is associated.	ccn-bxuau4ezctt****
SmartAGId	string	No	The ID of the SAG instance.	sag-6z21oj0vjjrx6s****
Status	string	No	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 device is active. init: The SAG device is being initialized. Offline: The SAG device is disconnected.	Active
Name	string	No	The name of the SAG instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.	nametest
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
SerialNumber	string	No	The serial number of the SAG device.	sag32a3****
AclIds	string	No	The ID of the ACL with which the SAG instance is associated.	acl-xhwhyuo43l0n****
UnboundAclIds	string	No	The ID of the ACL rule. Specifies that the SAG instance which is not associated with the ACL is queried. Separate ACL IDs with commas (,).	acl-sjfbgngj****
InstanceType	string	No	The type of the SAG instance. Valid values: software: an SAG app instance hardware: an SAG CPE instance	hardware
CanAssociateQos	boolean	No	Specifies whether the SAG instance can be associated with a quality of service (QoS) policy. Valid values: true: yes false: no Specifies whether to query SAG instances that cannot be associated with QoS policies.	false
HardwareType	string	No	The model of SAG device. Valid values: sag-1000 sag-100wm	sag-100wm
SoftwareVersion	string	No	The software version of the SAG device.	2.3.0.0
VersionComparator	string	No	The version filter. Valid values: greater: later than the current version less: earlier than the current version equals: equal to the current version	equals
BusinessState	string	No	The business status of the SAG instance. Valid values: Normal: running as expected. Arrearage: locked due to overdue payments.	Normal
ResourceGroupId	string	No	The ID of the resource group to which the SAG instance belongs.	rg-acfm2iu4fnc****
SmartAGIds	array	No	The IDs of the SAG instances.
	string	No	The ID of the SAG instance.	sag-6z21oj0vjjrx6s****
AssociatedCcnName	string	No	The name of the associated CCN instance. The name must be 2 to 100 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.	ccn

Response parameters

Parameter	Type	Description	Example
	object	The response.
TotalCount	integer	The total number of entries returned.	1
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F
PageNumber	integer	The page number of the returned page.	1
SmartAccessGateways	object []	A list of SAG instances.
SerialNumber	string	The serial number of the SAG device.	sage6gsdllbid**,sage6nniq3dqa**
Status	string	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 device is active. init: The SAG device is being initialized. Offline: The SAG device is disconnected.	Active
UpBandwidth4G	integer	The maximum upstream bandwidth of 4G network connections established by the SAG device. Unit: Mbit/s.	3
BackupStatus	string	The status of the SAG backup device.	Active
IdaasApplicationId	string	The ID of the Identity as a Service (IDaaS) application associated with the SAG instance.	idaas-cn-hangzhou-l7j0wf0crzea****
SoftwareVersion	string	The software version of the active SAG device.	2.3.0.0
CreateTime	long	The timestamp when the SAG instance was created. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1622617250000
SmartAGId	string	The ID of the SAG instance.	sag-6z21oj0vjjrx6s****
UpBandwidthWan	integer	The maximum upstream bandwidth of network connections established on the WAN port of the SAG device. Unit: Mbit/s.	2
City	string	The ID of the city where the SAG device is deployed.	cn-shanghai
AclIds	string	The ID of the ACL with which the SAG instance is associated.	acl-shfhfhhfbnvkdg****
QosIds	string	The ID of the QoS policy associated with the SAG instance.	qos-djh****
IRIds	string	The IDs of the intelligent routing policies that are associated with the SAG instance.	ir-7unf5nom01ygrg****
CidrBlock	string	The private CIDR block of the destination network with which the on-premises network or client needs to communicate.	10.0.9.0/24
Description	string	The description of the SAG instance.	docdesc
IpsecStatus	string	The status of the IPsec-VPN connection. Valid values: up: normal down: abnormal	up
EnterpriseCode	string	The ID of the enterprise code associated with the SAG instance.	12P****
DpiStatus	string	The status of the deep packet inspection (DPI) feature. Valid values: On: enabled Off: disabled	Off
AssociatedCcnId	string	The ID of the CCN instance with which the SAG instance is associated.	ccn-iz26o9zye6lhoo****
Name	string	The name of the SAG instance.	testname
HardwareVersion	string	The type of the SAG instance. Valid values: sag-1000: an SAG CPE instance that is associated with an SAG-1000 device. sag-100wm: an SAG CPE instance that is associated with an SAG-100WM device. sag-software: an SAG app instance. sag-vcpe: an SAG vCPE instance.	sag-100wm
IdaasId	string	The ID of the IDaaS instance with which the SAG instance is associated.	idaas-cn-hangzhou-1ahixtl****
DataPlan	long	The data transfer plan of the SAG instance. Unit: GB. Note Each client account is assigned a free data transfer quota of 5 GB per month.	5
AssociatedCcnName	string	The name of the CCN instance associated with the SAG instance.	ccn
ResellerUid	string	The Alibaba Cloud account ID of the third-party reseller.	25346073170691****
DpiMonitorStatus	string	The status of the DPI-based monitoring feature. Valid values: Active: enabled Inactive: disabled	Inactive
MaxBandwidth	string	The maximum bandwidth value of the SAG instance. Unit: Mbit/s.	50M
SmartAGUid	long	The ID of the region where the SAG instance is deployed.	1210123456123456
BackupSoftwareVersion	string	The software version of the standby SAG device.	2.3.0.0
EndTime	long	The timestamp when the SAG instance expires. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1628265600000
ResellerInstanceId	string	The ID of the SAG instance that belongs to the reseller.	sag-v0fkpk4akfz5****
VpnStatus	string	The status of the VPN connection. Valid values: up: normal down: abnormal	down
RoutingStrategy	string	The method that the SAG instance uses to advertise routes to Alibaba Cloud. static: static routing dynamic: dynamic routing	static
SecurityLockThreshold	integer	The time threshold. If the SAG device remains offline for the specified period of time, the SAG device is locked. Unit: seconds.	3600
Links	object []	A list of connections between the on-premises network and Alibaba Cloud.
Type	string	The type of the network connection. Valid values: ccn: The on-premises network is connected to Alibaba Cloud through CCN. vbr: The on-premises network is connected to Alibaba Cloud through virtual border routers (VBRs) and Express Connect circuits.	ccn
Status	string	The status of the network connection. Valid values: Ordered: The order is to be shipped. Delivered: The order is shipped. Offline: The connection is disconnected. Active: The SAG device is available. Arrearage: The SAG device is locked due to overdue payments. The status of the Express Connect circuit. Valid values: normal: normal arrears: overdue payments	Active
EndTime	long	The timestamp when the connection expires. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1628265600000
Bandwidth	string	The bandwidth value of the connection. Unit: Mbit/s.	50M
RelateInstanceRegionId	string	The region ID of the instance with which the connection is associated.	cn-shanghai
RelateInstanceId	string	The ID of the instance associated with the connection.	ccn-iz26o9zye6lhoo****
InstanceId	string	The ID of the product instance.	sag-6z21oj0vjjrx6s****
CommodityType	string	The product type. Valid values: bandwidth: The SAG instance and bandwidth resources can be separately purchased. smartag: The SAG instance and bandwidth resources must be purchased as a bundle.	smartag
ResourceGroupId	string	The ID of the resource group to which the SAG instance belongs.	rg-acfm2iu4fnc****
UserCount	integer	The number of client accounts for the SAG instance.	3
AccessPointId	string	The ID of the access point for the SAG instance.	238
ApplicationBandwidthPackageId	string	The ID of the bandwidth plan for application acceleration that is associated with the SAG instance.	abwp-7963l7iqnquyj3****
AccelerateBandwidth	long	The maximum bandwidth value for application acceleration. Unit: Mbit/s.	1
EnableSoftwareConnectionAudit	boolean	Indicates whether auditing is enabled for the network connection logs of the SAS app instance. Valid values: true: enabled false: disabled	true
Position	string	The location information about the SAG instance.	\[{\\"adcode\\":\\"\\",\\"label\\":\\"Jimo District, Qingdao, Shandong province\\",\\"value\\":\\"B02140800T\\",\\"center\\":\\"120.989576,36.487512\\",\\"\_new\\":\\"true\\"}]
Isp	string	The Internet service provider (ISP) of the SAG instance.	China Telecom
EnableAdvancedMonitor	boolean	Indicates whether DPI is enabled for the SAG instance. Valid values: true: enabled false: disabled	true

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F",
  "PageNumber": 1,
  "SmartAccessGateways": {
    "SmartAccessGateway": [
      {
        "SerialNumber": "sage6gsdllbid****,sage6nniq3dqa****",
        "Status": "Active",
        "UpBandwidth4G": 3,
        "BackupStatus": "Active",
        "IdaasApplicationId": "idaas-cn-hangzhou-l7j0wf0crzea****",
        "SoftwareVersion": "2.3.0.0",
        "CreateTime": 1622617250000,
        "SmartAGId": "sag-6z21oj0vjjrx6s****",
        "UpBandwidthWan": 2,
        "City": "cn-shanghai",
        "AclIds": "acl-shfhfhhfbnvkdg****",
        "QosIds": "qos-djh****",
        "IRIds": "ir-7unf5nom01ygrg****",
        "CidrBlock": "10.0.9.0/24",
        "Description": "docdesc",
        "IpsecStatus": "up",
        "EnterpriseCode": "12P****",
        "DpiStatus": "Off",
        "AssociatedCcnId": "ccn-iz26o9zye6lhoo****",
        "Name": "testname",
        "HardwareVersion": "sag-100wm",
        "IdaasId": "idaas-cn-hangzhou-1ahixtl****",
        "DataPlan": 5,
        "AssociatedCcnName": "ccn",
        "ResellerUid": "25346073170691****",
        "DpiMonitorStatus": "Inactive",
        "MaxBandwidth": "50M",
        "SmartAGUid": 1210123456123456,
        "BackupSoftwareVersion": "2.3.0.0",
        "EndTime": 1628265600000,
        "ResellerInstanceId": "sag-v0fkpk4akfz5****",
        "VpnStatus": "down",
        "RoutingStrategy": "static",
        "SecurityLockThreshold": 3600,
        "Links": {
          "Link": [
            {
              "Type": "ccn",
              "Status": "Active",
              "EndTime": 1628265600000,
              "Bandwidth": "50M",
              "RelateInstanceRegionId": "cn-shanghai",
              "RelateInstanceId": "ccn-iz26o9zye6lhoo****",
              "InstanceId": "sag-6z21oj0vjjrx6s****",
              "CommodityType": "smartag"
            }
          ]
        },
        "ResourceGroupId": "rg-acfm2iu4fnc****",
        "UserCount": 3,
        "AccessPointId": "238",
        "ApplicationBandwidthPackageId": "abwp-7963l7iqnquyj3****",
        "AccelerateBandwidth": 1,
        "EnableSoftwareConnectionAudit": true,
        "Position": "\\[{\\\\\"adcode\\\\\":\\\\\"\\\\\",\\\\\"label\\\\\":\\\\\"Jimo District, Qingdao, Shandong province\\\\\",\\\\\"value\\\\\":\\\\\"B02140800T\\\\\",\\\\\"center\\\\\":\\\\\"120.989576,36.487512\\\\\",\\\\\"\\_new\\\\\":\\\\\"true\\\\\"}]\n",
        "Isp": "China Telecom\n",
        "EnableAdvancedMonitor": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Param.InvalidVersionComparator	The specified version comparison operator is invalid.	The specified version comparison operator is invalid.
400	InvalidRegionID	The specified regionId does not exist.	The specified region ID does not exist.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have permissions to manage the specified resource.

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