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
RegionId String No 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.

AssociatedCcnId String No ccn-bxuau4ezctt****

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

SmartAGId String No sag-c3m3n1khz58l****

The ID of the SAG instance.

Status String No 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
Name String No nametest

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.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

PageNumber Integer No 1

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

Action String No DescribeSmartAccessGateways

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

SerialNumber String No sag32a3****

The serial number of the SAG device.

AclIds String No acl-xhwhyuo43l****

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

UnboundAclIds String No acl-sjfbgngj****

The ID of ACL.

This parameter specifies that the SAG instance that is not associated with the ACL is queried. Separate ACL IDs with commas (,).

InstanceType String No hardware

The type of the SAG instance. Valid values:

  • software: an SAG app instance
  • hardware: an SAG CPE instance
CanAssociateQos Boolean No false

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

  • true: yes
  • false: no

This parameter specifies whether you want to query SAG instances that cannot be associated with QoS policies.

HardwareType String No sag-1000

The model of SAG device. Valid values:

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

The software version of the SAG device.

VersionComparator String No equals

The version filter. Valid values:

  • greater: later than the current version
  • less: earlier than the current version
  • equals: equal to the current version
BusinessState String No Normal

The business status of the SAG instance. Valid values:

  • Normal: normal
  • Arrearage: locked due to overdue payments
ResourceGroupId String No rg-acfm2iu4fnc****

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

SmartAGIds.N String No sag-v0a6qd069p7zk****

The ID of the SAG instance.

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The total number of entries returned.

PageSize Integer 10

The number of entries returned per page.

RequestId String ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

SmartAccessGateways Array of SmartAccessGateway

The list of SAG instances.

SmartAccessGateway
SerialNumber String sage6gsdllbid****,sage6nniq3dqa****

The serial number of the SAG device.

Status String Active

The status of the SAG instance.

UpBandwidth4G Integer 3

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

BackupStatus String Active

The status of the standby SAG device.

IdaasApplicationId String idaas-cn-hangzhou-l7j0wf0crzea****

The ID of the Identity as a Service (IDaaS) application associated with the SAG instance.

SoftwareVersion String 2.3.0.0

The software version of the active SAG device.

CreateTime Long 1622617250000

The timestamp when the SAG instance was created.

SmartAGId String sag-6z21oj0vjjrx6s****

The ID of the SAG instance.

UpBandwidthWan Integer 2

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

City String cn-shanghai

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

AclIds String acl-shfhfhhfbnvkdg******

The ID of the ACL with which the SAG instance is associated.

QosIds String qos-djh****

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

CidrBlock String 172.16.1.0/24

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

Description String docdesc

The description of the SAG instance.

IpsecStatus String down

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

  • up: normal
  • down: abnormal
EnterpriseCode String 12P****

The ID of the enterprise code bound to the SAG instance.

DpiStatus String Off

The status of the deep packet inspection (DPI) feature. Valid values:

  • On: enabled
  • Off: disabled
AssociatedCcnId String ccn-iz26o9zye6lhoo****

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

Name String testname

The name of the SAG instance.

HardwareVersion String sag-100wm

The type of the SAG instance.

  • 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.
IdaasId String idaas-cn-hangzhou-1ahixtl****

The ID of the IDaaS instance with which the SAG instance is associated.

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.
AssociatedCcnName String ccn

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

ResellerUid String 12345556345555

The ID of the third-party reseller.

DpiMonitorStatus String Active

The status of the DPI-based monitoring feature. Valid values:

  • Active: enabled
  • Inactive: disabled
MaxBandwidth String 50 M

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

SmartAGUid Long 12345556345555

The ID of the Alibaba Cloud account to which the SAG instance belongs.

BackupSoftwareVersion String 2.3.0.0

The software version of the standby SAG device.

EndTime Long 1628265600000

The timestamp when the SAG instance expires.

ResellerInstanceId String sag-v0fkpk4akfz5******

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

VpnStatus String down

The status of the 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
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.

Links Array of Link

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

Link
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 virtual border routers (VBRs) and Express Connect circuits.
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
EndTime Long 1628265600000

The timestamp when the connection expires.

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-iz26o9zye6lhoo****

The ID of the instance associated with the connection.

InstanceId String sag-6z21oj0vjjrx6s****

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.
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.

AccessPointId String 238

The ID of the access point for the SAG instance.

ApplicationBandwidthPackageId String abwp-7963l7iqnquyj3****

The ID 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.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-shanghai
&AssociatedCcnId=ccn-bxuau4ezctt****
&SmartAGId=sag-c3m3n1khz58l****
&Status=Active
&Name=nametest
&PageSize=10
&PageNumber=1
&Action=DescribeSmartAccessGateways
&SerialNumber=sag32a3****
&AclIds=acl-xhwhyuo43l****
&UnboundAclIds=acl-sjfbgngj****
&InstanceType=hardware
&CanAssociateQos=false
&HardwareType=sag-1000
&SoftwareVersion=2.3.0.0
&BusinessState=Normal
&ResourceGroupId=rg-acfm2iu4fnc****
&SmartAGIds=["sag-v0a6qd069p7zk****"]
&Common request parameters

Sample responses

XML format

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

<DescribeSmartAccessGatewaysResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F</RequestId>
    <PageNumber>1</PageNumber>
    <SmartAccessGateways>
        <SmartAccessGateway>
            <Status>Active</Status>
            <EndTime>1628265600000</EndTime>
            <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
            <CreateTime>1622617250000</CreateTime>
            <AssociatedCcnName>zxtest-202106</AssociatedCcnName>
            <MaxBandwidth>50M</MaxBandwidth>
            <VpnStatus>down</VpnStatus>
            <CidrBlock>10.0.9.0/24</CidrBlock>
            <DpiMonitorStatus>Inactive</DpiMonitorStatus>
            <HardwareVersion>sag-vcpe</HardwareVersion>
            <Name>zxtest-202106</Name>
            <SoftwareVersion>2.3.0.0</SoftwareVersion>
            <SerialNumber>sage6gsdllbid****,sage6nniq3dqa****</SerialNumber>
            <IpsecStatus>up</IpsecStatus>
            <RoutingStrategy>static</RoutingStrategy>
            <AccessPointId>238</AccessPointId>
            <Links>
                <Link>
                    <Status>Active</Status>
                    <Type>ccn</Type>
                    <EndTime>1628265600000</EndTime>
                    <InstanceId>sag-6z21oj0vjjrx6s****</InstanceId>
                    <RelateInstanceId>ccn-iz26o9zye6lhoo****</RelateInstanceId>
                    <Bandwidth>50M</Bandwidth>
                    <CommodityType>smartag</CommodityType>
                </Link>
            </Links>
            <AssociatedCcnId>ccn-iz26o9zye6lhoo****</AssociatedCcnId>
            <BackupSoftwareVersion>2.3.0.0</BackupSoftwareVersion>
            <SmartAGId>sag-6z21oj0vjjrx6s****</SmartAGId>
            <DpiStatus>Off</DpiStatus>
            <SecurityLockThreshold>0</SecurityLockThreshold>
            <BackupStatus>Active</BackupStatus>
        </SmartAccessGateway>
    </SmartAccessGateways>
</DescribeSmartAccessGatewaysResponse>

JSON format

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

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F",
  "PageNumber" : 1,
  "SmartAccessGateways" : {
    "SmartAccessGateway" : [ {
      "Status" : "Active",
      "EndTime" : 1628265600000,
      "ResourceGroupId" : "rg-acfm2iu4fnc****",
      "CreateTime" : 1622617250000,
      "AssociatedCcnName" : "zxtest-202106",
      "MaxBandwidth" : "50M",
      "VpnStatus" : "down",
      "CidrBlock" : "10.0.9.0/24",
      "DpiMonitorStatus" : "Inactive",
      "HardwareVersion" : "sag-vcpe",
      "Name" : "zxtest-202106",
      "SoftwareVersion" : "2.3.0.0",
      "SerialNumber" : "sage6gsdllbid****,sage6nniq3dqa****",
      "IpsecStatus" : "up",
      "RoutingStrategy" : "static",
      "AccessPointId" : 238,
      "Links" : {
        "Link" : [ {
          "Status" : "Active",
          "Type" : "ccn",
          "EndTime" : 1628265600000,
          "InstanceId" : "sag-6z21oj0vjjrx6s****",
          "RelateInstanceId" : "ccn-iz26o9zye6lhoo****",
          "Bandwidth" : "50M",
          "CommodityType" : "smartag"
        } ]
      },
      "AssociatedCcnId" : "ccn-iz26o9zye6lhoo****",
      "BackupSoftwareVersion" : "2.3.0.0",
      "SmartAGId" : "sag-6z21oj0vjjrx6s****",
      "DpiStatus" : "Off",
      "SecurityLockThreshold" : 0,
      "BackupStatus" : "Active"
    } ]
  }
}

Error codes

HttpCode Error code Error message Description
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.
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you do not have the permissions to manage the specified resource.

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