DescribeSmartAccessGatewayAttribute - Smart Access Gateway

You can call the DescribeSmartAccessGatewayAttribute operation to query the details of a specific Smart Access Gateway instance.

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:DescribeSmartAccessGatewayAttribute

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Smart Access Gateway instance. Call the DescribeRegions operation to obtain the region ID.	cn-shanghai
SmartAGId	string	Yes	The ID of the Smart Access Gateway instance.	sag-6z21oj0vjjrx****

Response elements

Element	Type	Description	Example
	object	The response parameters.
UpBandwidth4G	integer	The maximum upstream bandwidth of the 4G link for the Smart Access Gateway device. Unit: Mbps.	3
Description	string	The description of the Smart Access Gateway instance.	testdesc
EndTime	integer	The timestamp that indicates when the Smart Access Gateway instance expires.	1628265600000
ResourceGroupId	string	The ID of the resource group to which the Smart Access Gateway instance belongs.	rg-acfm2iu4fnc****
UserCount	integer	The number of client accounts for the Smart Access Gateway instance.	3
AssociatedCcnName	string	The name of the Cloud Connect Network (CCN) instance that is attached to the Smart Access Gateway instance.	testname
MaxBandwidth	string	The maximum bandwidth of the Smart Access Gateway instance. Unit: Mbps.	50 M
VpnStatus	string	The status of the VPN connection. up: The VPN connection is normal. down: The VPN connection is abnormal.	down
BoxControllerIp	string	The public IP address of the master Smart Access Gateway device.	112.XX.XX.25
UpBandwidthWan	integer	The maximum upstream bandwidth of the WAN port on the Smart Access Gateway device. Unit: Mbps.	4
CidrBlock	string	The private CIDR block that is used to connect the on-premises network or clients to the cloud.	10.0.9.0/24
QosIds	object
QosId	array	The information about the Quality of Service (QoS) policies that are attached to the Smart Access Gateway instance.
	string	The ID of the QoS policy that is attached to the Smart Access Gateway instance.	qos-yca8p30w1jcrbt****
IRIds	object
IRId	array	The information about the intelligent routing policies that are attached to the Smart Access Gateway instance.
	string	The ID of the intelligent routing policy that is attached to the Smart Access Gateway instance.	ir-yca8p30w1jcrbt****
Devices	object
Device	array<object>	The list of Smart Access Gateway devices.
	object	The information about the Smart Access Gateway device.
SerialNumber	string	The serial number of the Smart Access Gateway device.	sage6gsdllbid****"
HaState	string	The high availability (HA) status of the Smart Access Gateway device. Active: The device is the active device. Standby: The device is the standby device.	Active
SecretKey	string	The key of the Smart Access Gateway device.	+T4nV8xkS4****
DpiSignatureDbVersion	string	The version of the deep packet inspection (DPI) signature database that is used by the Smart Access Gateway device.	20201117_1_0-0.0.1
SoftwareVersion	string	The software version of the Smart Access Gateway device.	2.3.0.0
DistributeSkStatus	integer	The activation status of the key for the Smart Access Gateway device. 1: Activated. 0: Not activated.	1
MonitorVersion	string	The monitoring version of the Smart Access Gateway device.	0.1.11.17
HcState	string	The health check status of the Smart Access Gateway device. online: The device is online and connected to Alibaba Cloud. offline: The device is offline and not connected to Alibaba Cloud.	online
Name	string	The name of the Smart Access Gateway instance.	testname
OptimizationType	boolean	The retransmission optimization type of the Smart Access Gateway instance. If retransmission optimization is enabled, the default value is fec.	fec
IpsecStatus	string	The status of the IPsec-VPN connection. up: The IPsec-VPN connection is normal. down: The IPsec-VPN connection is abnormal.	up
RoutingStrategy	string	The method that is used to synchronize on-premises routes to the Smart Access Gateway instance. static: Static routing. dynamic: Dynamic routing.	static
AssociatedCcnId	string	The ID of the CCN instance that is attached to the Smart Access Gateway instance.	ccn-iz26o9zye6lhoo****
FlowLogIds	object
FlowLogId	array	The information about the flow log instances that are attached to the Smart Access Gateway instance.
	string	The ID of the flow log instance that is attached to the Smart Access Gateway instance.	fl-0vv40lyu2un5qh****
SmartAGId	string	The ID of the Smart Access Gateway instance.	sag-6z21oj0vjjrx6s****
InstanceType	string	The type of the Smart Access Gateway instance. sag-1000: The instance is a hardware-based Smart Access Gateway instance and is bound to an SAG-1000 device. sag-10wm: The instance is a hardware-based Smart Access Gateway instance and is bound to an SAG-100WM device. sag-software: The instance is a Smart Access Gateway app instance. sag-vcpe: The instance is a Smart Access Gateway vCPE instance.	sag-vcpe
ResellerUid	string	The ID of the reseller's account.	1210123456123456
SecurityLockThreshold	integer	The period of time after which a Smart Access Gateway device is locked due to being offline. Unit: seconds.	3600
Status	string	The status of the Smart Access Gateway instance. Ordered: The instance is waiting for shipment. Delivered: The instance is shipped. Received: The instance is activated. Unconfirmed: The instance is pending confirmation. Active: The instance is active. Offline: The instance is offline. Arrearage: The instance is locked due to an overdue payment.	Active
RequestId	string	The request ID.	F02D092B-A0B7-4BA1-BCA7-014B953C5DC7
CreateTime	integer	The timestamp that indicates when the Smart Access Gateway instance was created.	1622617250000
DataPlan	integer	The data plan of the Smart Access Gateway instance. Unit: GB. Note Each account is provided with 5 GB of data for free each month.	5
EnableOptimization	boolean	Indicates whether retransmission optimization is enabled for the Smart Access Gateway instance. true: Enabled. false: Disabled.	false
City	string	The city ID where the Smart Access Gateway device is located.	cn-shanghai
ResellerInstanceId	string	The ID of the reseller's instance.	sag-v0fkpk4akfz5******
SerialNumber	string	The serial number of the Smart Access Gateway device.	sage6gsdllbidl**,sage6nniq3d**
BackupBoxControllerIp	string	The public IP address of the standby Smart Access Gateway device.	112.XX.XX.27
TrafficMasterSn	string	The serial number of the Smart Access Gateway device that is currently used to forward traffic.	sage6nniq3d****
AccessPointId	string	The ID of the access point for the Smart Access Gateway instance.	238
Links	object
Link	array<object>	The list of links that connect the on-premises network to Alibaba Cloud.
	object	The information about the link that connects the on-premises network to Alibaba Cloud.
HealthCheckTargetIp	string	The IP address of the virtual border router (VBR). Note When creating a health check for a leased line, set the destination IP address to the IP address of the VBR.	100.XX.XX.144
EndTime	integer	The timestamp that indicates when the link expires.	1628265600000
Status	string	The status of the link. The status of a broadband link: Ordered: The link is waiting for shipment. Delivered: The link is shipped. Offline: The link is offline. Active: The link is active. Arrearage: The link is locked due to an overdue payment. The status of a leased line: normal: Normal. arrears: Overdue.	Active
Type	string	The link type. ccn: The on-premises network is connected to Alibaba Cloud through a CCN instance. vbr: The on-premises network is connected to Alibaba Cloud through a leased line that is connected to a VBR.	ccn
Bandwidth	string	The bandwidth of the link. Unit: Mbps.	50 M
RelateInstanceRegionId	string	The region ID of the instance that is associated with the link.	cn-shanghai
RelateInstanceId	string	The ID of the instance that is associated with the link.	ccn-iz26o9zye6lho****
InstanceId	string	The ID of the commodity instance.	sag-6z21oj0vjjrx****
CommodityType	string	The commodity type of the link bandwidth: bandwidth: The Smart Access Gateway instance and bandwidth are purchased separately. smartag: The Smart Access Gateway instance and bandwidth are purchased in a bundle.	smartag
AclIds	object
AclId	array	The information about the access control list (ACL) instances that are attached to the Smart Access Gateway instance.
	string	The ID of the ACL instance that is attached to the Smart Access Gateway instance.	acl-9p14e8y1red6kv****
ApplicationBandwidthPackageId	string	The ID of the bandwidth plan for application acceleration that is attached to the Smart Access Gateway instance.	abwp-7963l7iqnquyj3****
ApplicationBandwidthPackageName	string	The name of the bandwidth plan for application acceleration that is attached to the Smart Access Gateway instance.	testname
AccelerateBandwidth	integer	The maximum application acceleration bandwidth of the Smart Access Gateway instance. Unit: Mbps.	1
ApplicationBandwidthPackageBussinessStatus	string	The status of the bandwidth plan for application acceleration. Abnormal: Abnormal. Normal: Normal.	Normal
ApplicationBandwidthPackageOperationLocks	object	The lock information about the bandwidth plan for application acceleration.
LockType	string	The lock type. The value is FinancialLocked.	FinancialLocked
LockReason	string	The reason why the instance is locked.	Message
Position	string	The location of the cartridge.	shanghai
EnableSoftwareConnectionAudit	boolean	Indicates whether to enable connection log auditing for the Smart Access Gateway app instance. Valid values: true: Enables connection log auditing for the Smart Access Gateway app instance. false: Disables connection log auditing for the Smart Access Gateway app instance.	true

Examples

Success response

JSON format

{
  "UpBandwidth4G": 3,
  "Description": "testdesc",
  "EndTime": 1628265600000,
  "ResourceGroupId": "rg-acfm2iu4fnc****",
  "UserCount": 3,
  "AssociatedCcnName": "testname",
  "MaxBandwidth": "50 M",
  "VpnStatus": "down",
  "BoxControllerIp": "112.XX.XX.25",
  "UpBandwidthWan": 4,
  "CidrBlock": "10.0.9.0/24",
  "QosIds": {
    "QosId": [
      "qos-yca8p30w1jcrbt****"
    ]
  },
  "IRIds": {
    "IRId": [
      "ir-yca8p30w1jcrbt****"
    ]
  },
  "Devices": {
    "Device": [
      {
        "SerialNumber": "sage6gsdllbid****\"",
        "HaState": "Active",
        "SecretKey": "+T4nV8xkS4****",
        "DpiSignatureDbVersion": "20201117_1_0-0.0.1",
        "SoftwareVersion": "2.3.0.0",
        "DistributeSkStatus": 1,
        "MonitorVersion": "0.1.11.17",
        "HcState": "online"
      }
    ]
  },
  "Name": "testname",
  "OptimizationType": true,
  "IpsecStatus": "up",
  "RoutingStrategy": "static",
  "AssociatedCcnId": "ccn-iz26o9zye6lhoo****",
  "FlowLogIds": {
    "FlowLogId": [
      "fl-0vv40lyu2un5qh****"
    ]
  },
  "SmartAGId": "sag-6z21oj0vjjrx6s****",
  "InstanceType": "sag-vcpe",
  "ResellerUid": "1210123456123456",
  "SecurityLockThreshold": 3600,
  "Status": "Active",
  "RequestId": "F02D092B-A0B7-4BA1-BCA7-014B953C5DC7",
  "CreateTime": 1622617250000,
  "DataPlan": 5,
  "EnableOptimization": false,
  "City": "cn-shanghai",
  "ResellerInstanceId": "sag-v0fkpk4akfz5******",
  "SerialNumber": "sage6gsdllbidl****,sage6nniq3d****",
  "BackupBoxControllerIp": "112.XX.XX.27",
  "TrafficMasterSn": "sage6nniq3d****",
  "AccessPointId": "238",
  "Links": {
    "Link": [
      {
        "HealthCheckTargetIp": "100.XX.XX.144",
        "EndTime": 1628265600000,
        "Status": "Active",
        "Type": "ccn",
        "Bandwidth": "50 M",
        "RelateInstanceRegionId": "cn-shanghai",
        "RelateInstanceId": "ccn-iz26o9zye6lho****",
        "InstanceId": "sag-6z21oj0vjjrx****",
        "CommodityType": "smartag"
      }
    ]
  },
  "AclIds": {
    "AclId": [
      "acl-9p14e8y1red6kv****"
    ]
  },
  "ApplicationBandwidthPackageId": "abwp-7963l7iqnquyj3****",
  "ApplicationBandwidthPackageName": "testname",
  "AccelerateBandwidth": 1,
  "ApplicationBandwidthPackageBussinessStatus": "Normal",
  "ApplicationBandwidthPackageOperationLocks": {
    "LockType": "FinancialLocked",
    "LockReason": "Message"
  },
  "Position": "shanghai",
  "EnableSoftwareConnectionAudit": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.