Queries information about a Smart Access Gateway (SAG) instance.

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 DescribeSmartAccessGatewayAttribute

The operation that you want to perform. Set the value to DescribeSmartAccessGatewayAttribute.

RegionId String Yes cn-shanghai

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

You can call the DescribeRegions operation to query the most recent region list.

SmartAGId String Yes sag-6z21oj0vjjrx****

The ID of the SAG instance.

Response parameters

Parameter Type Example Description
UpBandwidth4G Integer 3

The maximum upstream bandwidth of 4G network connections established by the SAG device. Unit: Mbit/s.

Description String testdesc

The description of the SAG instance.

EndTime Long 1628265600000

The timestamp when the SAG instance expires.

ResourceGroupId String rg-acfm2iu4fnc****

The ID of the resource group to which the SAG instance belongs.

UserCount Integer 3

The number of client accounts for the SAG instance.

AssociatedCcnName String testname

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

MaxBandwidth String 50 M

The maximum bandwidth value of the SAG instance. Unit: Mbit/s.

VpnStatus String down

The status of the VPN connection. Valid values:

  • up: normal
  • down: abnormal
BoxControllerIp String 112.XX.XX.25

The public IP address of the active SAG device.

UpBandwidthWan Integer 4

The maximum upstream bandwidth of network connections established on the WAN port of the SAG device. Unit: Mbit/s.

CidrBlock String 10.0.9.0/24

The private CIDR block of the destination network with which the on-premises network or client needs to communicate.

QosIds Array of String qos-yca8p30w1jcrbt****

The ID of the quality of service (QoS) policy associated with the SAG instance.

Devices Array of Device

The information about the SAG device.

Device
SerialNumber String sage6gsdllbid****"

The serial number of the SAG device.

HaState String Active

Indicates whether the SAG device is an active or standby device. Valid values:

  • Active: an active device
  • Standby: a standby device
SecretKey String +T4nV8xkS4****

The key of the SAG device.

DpiSignatureDbVersion String 20201117_1_0-0.0.1

The version of the database that is used by the deep packet inspection (DPI) feature of the SAG device.

SoftwareVersion String 2.3.0.0

The software version of the SAG device.

DistributeSkStatus Integer 1

Indicates whether the key of the SAG device is activated. Valid values:

  • 1: yes
  • 0: no
MonitorVersion String 0.1.11.17

The monitoring version of the SAG device.

HcState String online

The health check status of the SAG device. Valid values:

  • online: connected to Alibaba Cloud
  • offline: disconnected from Alibaba Cloud
Name String testname

The name of the SAG instance.

OptimizationType Boolean fec

The transmission optimization type of the SAG instance. After transmission optimization is enabled, the default value is fec.

IpsecStatus String up

The status of the IPsec-VPN connection. Valid values:

  • up: normal
  • down: abnormal
RoutingStrategy String static

The method that the SAG instance uses to advertise routes to Alibaba Cloud.

  • static: static routing
  • dynamic: dynamic routing
AssociatedCcnId String ccn-iz26o9zye6lhoo****

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

FlowLogIds Array of String fl-0vv40lyu2un5qh****

The ID of the flow log with which the SAG instance is associated.

SmartAGId String sag-6z21oj0vjjrx6s****

The ID of the SAG instance.

InstanceType String sag-vcpe

The type of the SAG instance. Valid values:

  • sag-1000: indicates an SAG CPE instance and the instance is associated with an SAG-1000 device.
  • sag-10wm: indicates an SAG CPE instance and the instance is associated with an SAG-100WM device.
  • sag-software: indicates an SAG app instance.
  • sag-vcpe: indicates an SAG vCPE instance.
ResellerUid String 1688121212121212

The ID of the third-party reseller.

SecurityLockThreshold Integer 3600

The time threshold. If the SAG device remains offline for the specified period of time, the SAG device is locked.

Unit: seconds.

Status String Active

The status of the SAG instance. Valid values:

  • Ordered: to be shipped
  • Delivered: shipped
  • Received: activated
  • Unconfirmed: pending confirmation
  • Active: available
  • Offline: offline
  • Arrearage: locked due to overdue payments
RequestId String F02D092B-A0B7-4BA1-BCA7-014B953C5DC7

The ID of the request.

CreateTime Long 1622617250000

The timestamp when the SAG instance was created.

DataPlan Long 5

The data transfer plan of the SAG instance. Unit: GB.

Note Each client account has a data transfer plan free of charge for 5 GB each month.
EnableOptimization Boolean false

Indicates whether the transmission optimization feature is enabled.

  • true: enabled
  • false: disabled

You can submit a ticket to enable the transmission optimization feature.

City String cn-shanghai

The ID of the city where the SAG device is deployed.

ResellerInstanceId String sag-v0fkpk4akfz5******

The ID of the instance provided by the third-party reseller.

SerialNumber String sage6gsdllbidl****,sage6nniq3d****

The serial number of the SAG device.

BackupBoxControllerIp String 112.XX.XX.27

The public IP address of the standby SAG device.

TrafficMasterSn String sage6nniq3d****

The serial number of the active SAG device.

AccessPointId String 238

The ID of the access point for the SAG instance.

Links Array of Link

The list of connections between the on-premises network and Alibaba Cloud.

Link
HealthCheckTargetIp String 100.XX.XX.144

The IP address of the virtual border router (VBR).

Note When you create a health check for an Express Connect circuit, you must specify the IP address of the VBR as the destination address.
EndTime Long 1628265600000

The timestamp when the connection expires.

Status String Active

The status of the network connection.

The status of the bandwidth connection:

  • Ordered: to be shipped
  • Delivered: shipped
  • Offline: offline
  • Active: available
  • Arrearage: locked due to overdue payments

The status of the Express Connect circuit:

  • normal: normal
  • arrears: payments overdue
Type String ccn

The type of the network connection. Valid values:

  • ccn: indicates that the on-premises network is connected to Alibaba Cloud through CCN.
  • vbr: indicates that the on-premises network is connected to Alibaba Cloud through VBRs and Express Connect circuits.
Bandwidth String 50 M

The bandwidth value of the connection. Unit: Mbit/s.

RelateInstanceRegionId String cn-shanghai

The region ID of the instance with which the connection is associated.

RelateInstanceId String ccn-iz26o9zye6lho****

The ID of the instance associated with the connection.

InstanceId String sag-6z21oj0vjjrx****

The ID of the product instance.

CommodityType String smartag

The product type of bandwidth. Valid values:

  • bandwidth: indicates that the SAG instance and bandwidth resources can be separately purchased.
  • smartag: indicates that the SAG instance and bandwidth resources must be purchased together.
AclIds Array of String acl-9p14e8y1red6kv****

The ID of the access control list (ACL) with which the SAG instance is associated.

ApplicationBandwidthPackageId String abwp-7963l7iqnquyj3****

The ID of the bandwidth plan for application acceleration that is associated with the SAG instance.

ApplicationBandwidthPackageName String testname

The name of the bandwidth plan for application acceleration that is associated with the SAG instance.

AccelerateBandwidth Long 1

The maximum bandwidth value for application acceleration. Unit: Mbit/s.

ApplicationBandwidthPackageBussinessStatus String Normal

The status of the bandwidth plan for application acceleration.

  • Abnormal: abnormal
  • Normal: normal
ApplicationBandwidthPackageOperationLocks Object

Indicates whether the bandwidth plan is locked.

LockType String FinancialLocked

The type of the reason why the bandwidth plan is locked. The value is set to FinancialLocked.

LockReason String Message

The reason why the bandwidth plan is locked.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSmartAccessGatewayAttribute
&RegionId=cn-shanghai
&SmartAGId=sag-6z21oj0vjjrx****
&Common request parameters

Sample responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSmartAccessGatewayAttributeResponse>
    <EndTime>1628265600000</EndTime>
    <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
    <AssociatedCcnName>zxtest-202106</AssociatedCcnName>
    <MaxBandwidth>50M</MaxBandwidth>
    <VpnStatus>down</VpnStatus>
    <BoxControllerIp>112.XX.XX.25</BoxControllerIp>
    <CidrBlock>10.0.9.0/24</CidrBlock>
    <Devices>
        <Device>
            <MonitorVersion>2.0.3.0</MonitorVersion>
            <SecretKey>+T4nV8xkS4****</SecretKey>
            <SoftwareVersion>2.3.0.0</SoftwareVersion>
            <SerialNumber>sage6gsdllbid****</SerialNumber>
            <HaState>Active</HaState>
            <DpiSignatureDbVersion>20201117_1_0-0.0.1</DpiSignatureDbVersion>
            <DistributeSkStatus>1</DistributeSkStatus>
            <HcState>online</HcState>
        </Device>
        <Device>
            <MonitorVersion>2.0.3.0</MonitorVersion>
            <SecretKey>X8Sfepq8qIn****</SecretKey>
            <SoftwareVersion>2.3.0.0</SoftwareVersion>
            <SerialNumber>sage6nniq3dqa****</SerialNumber>
            <HaState>Standby</HaState>
            <DpiSignatureDbVersion>20201117_1_0-0.0.1</DpiSignatureDbVersion>
            <DistributeSkStatus>0</DistributeSkStatus>
            <HcState>online</HcState>
        </Device>
    </Devices>
    <Name>zxtest-202106</Name>
    <IpsecStatus>up</IpsecStatus>
    <RoutingStrategy>static</RoutingStrategy>
    <AssociatedCcnId>ccn-iz26o9zye6lhoo****</AssociatedCcnId>
    <SmartAGId>sag-6z21oj0vjjrx6s****</SmartAGId>
    <InstanceType>sag-vcpe</InstanceType>
    <SecurityLockThreshold>0</SecurityLockThreshold>
    <Status>Active</Status>
    <RequestId>F02D092B-A0B7-4BA1-BCA7-014B953C5DC7</RequestId>
    <CreateTime>1622617250000</CreateTime>
    <SerialNumber>sage6gsdllbidl****,sage6nniq3d****</SerialNumber>
    <BackupBoxControllerIp>112.XX.XX.27</BackupBoxControllerIp>
    <TrafficMasterSn>sage6nniq3d****</TrafficMasterSn>
    <AccessPointId>238</AccessPointId>
    <Links>
        <Link>
            <Status>Active</Status>
            <Type>ccn</Type>
            <EndTime>1628265600000</EndTime>
            <InstanceId>sag-6z21oj0vjjrx****</InstanceId>
            <RelateInstanceId>ccn-iz26o9zye6lho****</RelateInstanceId>
            <Bandwidth>50M</Bandwidth>
            <CommodityType>smartag</CommodityType>
        </Link>
    </Links>
</DescribeSmartAccessGatewayAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "EndTime" : 1628265600000,
  "ResourceGroupId" : "rg-acfm2iu4fnc****",
  "AssociatedCcnName" : "zxtest-202106",
  "MaxBandwidth" : "50M",
  "VpnStatus" : "down",
  "BoxControllerIp" : "112.XX.XX.25",
  "CidrBlock" : "10.0.9.0/24",
  "Devices" : {
    "Device" : [ {
      "MonitorVersion" : "2.0.3.0",
      "SecretKey" : "+T4nV8xkS4****",
      "SoftwareVersion" : "2.3.0.0",
      "SerialNumber" : "sage6gsdllbid****",
      "HaState" : "Active",
      "DpiSignatureDbVersion" : "20201117_1_0-0.0.1",
      "DistributeSkStatus" : 1,
      "HcState" : "online"
    }, {
      "MonitorVersion" : "2.0.3.0",
      "SecretKey" : "X8Sfepq8qIn****",
      "SoftwareVersion" : "2.3.0.0",
      "SerialNumber" : "sage6nniq3dqa****",
      "HaState" : "Standby",
      "DpiSignatureDbVersion" : "20201117_1_0-0.0.1",
      "DistributeSkStatus" : 0,
      "HcState" : "online"
    } ]
  },
  "Name" : "zxtest-202106",
  "IpsecStatus" : "up",
  "RoutingStrategy" : "static",
  "AssociatedCcnId" : "ccn-iz26o9zye6lhoo****",
  "SmartAGId" : "sag-6z21oj0vjjrx6s****",
  "InstanceType" : "sag-vcpe",
  "SecurityLockThreshold" : 0,
  "Status" : "Active",
  "RequestId" : "F02D092B-A0B7-4BA1-BCA7-014B953C5DC7",
  "CreateTime" : 1622617250000,
  "SerialNumber" : "sage6gsdllbidl****,sage6nniq3d****",
  "BackupBoxControllerIp" : "112.XX.XX.27",
  "TrafficMasterSn" : "sage6nniq3d****",
  "AccessPointId" : 238,
  "Links" : {
    "Link" : [ {
      "Status" : "Active",
      "Type" : "ccn",
      "EndTime" : 1628265600000,
      "InstanceId" : "sag-6z21oj0vjjrx****",
      "RelateInstanceId" : "ccn-iz26o9zye6lho****",
      "Bandwidth" : "50M",
      "CommodityType" : "smartag"
    } ]
  }
}

Error codes

HttpCode Error code Error message Description
400 SAG.InstanceNoFound The specified SAG instance does not exist. The error message returned because the specified SAG instance does not exist.

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