通過DescribeSmartAccessGateways查詢已建立的Smart Access Gateway執行個體-Smart Access Gateway-阿里雲

查詢已建立的Smart Access Gateway。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

smartag:DescribeSmartAccessGateways

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	否	Smart Access Gateway執行個體所屬地區的 ID。	cn-shanghai
AssociatedCcnId	string	否	Smart Access Gateway執行個體綁定的雲串連網執行個體 ID。	ccn-bxuau4ezctt****
SmartAGId	string	否	Smart Access Gateway執行個體 ID。	sag-6z21oj0vjjrx6s****
Status	string	否	Smart Access Gateway執行個體的狀態。取值： Ordered：已下單。 Delivered：已發貨。 Received：已收貨。 Returning：退貨中。 Active：活躍。 Init：初始化。 Offline：離線。	Active
Name	string	否	Smart Access Gateway執行個體的名稱。名稱長度為 2~128 個字元，以大小寫字母或中文開頭，可包含數字、底線（_）和短劃線（-）。	nametest
PageSize	integer	否	分頁查詢時每頁顯示的條目數。預設值：10。取值範圍：1~50。	10
PageNumber	integer	否	查詢頁碼。預設值：1。	1
SerialNumber	string	否	Smart Access Gateway裝置的序號。	sag32a3****
AclIds	string	否	Smart Access Gateway執行個體綁定的存取控制執行個體 ID。	acl-xhwhyuo43l0n****
UnboundAclIds	string	否	存取控制執行個體 ID。本參數表示查詢未綁定該存取控制執行個體 ID 的Smart Access Gateway執行個體資訊。多個存取控制執行個體 ID 以半形逗號（,）隔開。	acl-sjfbgngj****
InstanceType	string	否	Smart Access Gateway執行個體類型。取值： software：Smart Access Gateway App 版執行個體。 hardware：Smart Access Gateway硬體版執行個體。	hardware
CanAssociateQos	boolean	否	可否關聯 QoS 策略執行個體。取值： true：可以。 false：不可以。本參數表示查詢可否關聯 QoS 策略執行個體的Smart Access Gateway執行個體的資訊。	false
HardwareType	string	否	Smart Access Gateway裝置硬體規格。取值： sag-1000。 sag-100wm。	sag-100wm
SoftwareVersion	string	否	Smart Access Gateway裝置啟動並執行軟體版本。	2.3.0.0
VersionComparator	string	否	版本過濾符。取值： greater：大於目前的版本。 less：小於目前的版本。 equals：等於目前的版本。	equals
BusinessState	string	否	Smart Access Gateway執行個體的業務狀態。取值： Normal：正常。 Arrearage：欠費鎖定。	Normal
ResourceGroupId	string	否	Smart Access Gateway執行個體所屬的資源群組 ID。	rg-acfm2iu4fnc****
SmartAGIds	array	否	Smart Access Gateway執行個體 ID 列表。
	string	否	Smart Access Gateway執行個體 ID。	sag-6z21oj0vjjrx6s****
AssociatedCcnName	string	否	綁定的雲串連網執行個體的名稱。名稱長度為 2~100 個字元，以大小寫字母或中文開頭，可包含數字、底線（_）、半形句號（.）和短劃線（-）。	ccn

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
TotalCount	integer	列表條目數。	1
PageSize	integer	分頁查詢時每頁包含的條目數。	10
RequestId	string	請求 ID。	ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F
PageNumber	integer	列表的頁碼。	1
SmartAccessGateways	object
SmartAccessGateway	array<object>	Smart Access Gateway執行個體資訊列表。
	array<object>	Smart Access Gateway執行個體的資訊。
SerialNumber	string	Smart Access Gateway裝置的序號。	sage6gsdllbid**,sage6nniq3dqa**
Status	string	Smart Access Gateway執行個體的狀態。 Ordered：已下單。 Delivered：已發貨。 Received：已收貨。 Returning：退貨中。 Active：活躍。 Init：初始化。 Offline：離線。	Active
UpBandwidth4G	integer	Smart Access Gateway裝置 4G 公網最大上行頻寬。單位：Mbps。	3
BackupStatus	string	Smart Access Gateway的備份狀態。取值： closed：未開啟。 opened：已開啟。 opening：開啟中。	Active
IdaasApplicationId	string	Smart Access Gateway執行個體關聯的 IDaaS 應用 ID。	idaas-cn-hangzhou-l7j0wf0crzea****
SoftwareVersion	string	Smart Access Gateway主裝置啟動並執行軟體版本。	2.3.0.0
CreateTime	integer	Smart Access Gateway執行個體的建立時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立Smart Access Gateway執行個體時的總時間長度。	1622617250000
SmartAGId	string	Smart Access Gateway執行個體 ID。	sag-6z21oj0vjjrx6s****
UpBandwidthWan	integer	Smart Access Gateway裝置 WAN 口最大上行頻寬。單位：Mbps。	2
City	string	Smart Access Gateway裝置所在城市 ID。	cn-shanghai
AclIds	string	Smart Access Gateway執行個體綁定的存取控制執行個體 ID。	acl-shfhfhhfbnvkdg****
QosIds	string	Smart Access Gateway執行個體綁定的 QoS 策略執行個體 ID。	qos-djh****
IRIds	string	Smart Access Gateway執行個體關聯的智能選路 ID 列表	ir-7unf5nom01ygrg****
CidrBlock	string	本網或用戶端要與雲上通訊的私網網段。	10.0.9.0/24
Description	string	Smart Access Gateway執行個體的描述資訊。	docdesc
IpsecStatus	string	ipsecVPN 串連狀態。 up：ipsecVPN 串連正常。 down：ipsecVPN 串連異常。	up
EnterpriseCode	string	Smart Access Gateway執行個體綁定的企業碼 ID。	12P****
DpiStatus	string	Smart Access Gateway執行個體 DPI 功能開啟狀態。 On：已開啟。 Off：未開啟。	Off
AssociatedCcnId	string	Smart Access Gateway執行個體綁定的雲串連網執行個體 ID。	ccn-iz26o9zye6lhoo****
Name	string	Smart Access Gateway執行個體的名稱。	testname
HardwareVersion	string	Smart Access Gateway執行個體類型。 sag-1000：標識當前執行個體為Smart Access Gateway硬體版執行個體，且執行個體連結的裝置類型為 SAG-1000。 sag-100wm：標識當前執行個體為Smart Access Gateway硬體版執行個體，且執行個體連結的裝置類型為 SAG-100WM。 sag-software：標識當前執行個體為Smart Access Gateway APP 執行個體。 sag-vcpe：標識當前執行個體為Smart Access Gateway vCPE 執行個體。	sag-100wm
IdaasId	string	Smart Access Gateway執行個體綁定的 IDaaS 執行個體 ID。	idaas-cn-hangzhou-1ahixtl****
DataPlan	integer	Smart Access Gateway執行個體的通話方案。單位：GB。說明目前僅支援每個帳號每個月贈送 5 GB 流量。	5
AssociatedCcnName	string	Smart Access Gateway執行個體綁定的雲串連網執行個體名稱。	ccn
ResellerUid	string	經銷商的阿里雲帳號 ID。	25346073170691****
DpiMonitorStatus	string	Smart Access Gateway執行個體 DPI 監控功能開啟狀態。 Active：已開啟。 Inactive：未開啟。	Inactive
MaxBandwidth	string	Smart Access Gateway執行個體的頻寬峰值。單位：Mbps。	50M
SmartAGUid	integer	Smart Access Gateway執行個體的所屬的帳號 ID。	1210123456123456
BackupSoftwareVersion	string	Smart Access Gateway備裝置啟動並執行軟體版本。	2.3.0.0
EndTime	integer	Smart Access Gateway執行個體的到期時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至Smart Access Gateway執行個體到期時的總時間長度。	1628265600000
ResellerInstanceId	string	經銷商Smart Access Gateway執行個體 ID。	sag-v0fkpk4akfz5****
VpnStatus	string	aliVPN 串連狀態。 up：aliVPN 串連正常。 down：aliVPN 串連異常。	down
RoutingStrategy	string	Smart Access Gateway執行個體的線下路由同步方式。 static：靜態路由。 dynamic：動態路由。	static
SecurityLockThreshold	integer	Smart Access Gateway裝置離線鎖定的時間閾值。單位：秒。	3600
Links	object
Link	array<object>	本網接入阿里雲的鏈路資訊列表。
	object
Type	string	鏈路類型。 ccn：表示本網通過雲串連網接入阿里雲。 vbr：表示本網通過邊界路由器及物理專線接入阿里雲。	ccn
Status	string	鏈路狀態。寬頻鏈路狀態： Ordered：待發貨。 Delivered：已發貨。 Offline：離線。 Active：可用。 Arrearage：欠費鎖定。物理專線鏈路狀態： normal：正常。 arrears：欠費。	Active
EndTime	integer	鏈路到期時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至鏈路到期時的總時間長度。	1628265600000
Bandwidth	string	鏈路頻寬值。單位：Mbps。	50M
RelateInstanceRegionId	string	鏈路相關執行個體所在的地區 ID。	cn-shanghai
RelateInstanceId	string	鏈路相關執行個體 ID。	ccn-iz26o9zye6lhoo****
InstanceId	string	商品執行個體 ID。	sag-6z21oj0vjjrx6s****
CommodityType	string	鏈路頻寬的商品類型。 bandwidth：表示Smart Access Gateway和頻寬為拆分售賣類型。 smartag：表示Smart Access Gateway和頻寬為組合售賣類型。	smartag
ResourceGroupId	string	Smart Access Gateway執行個體所屬資源群組 ID。	rg-acfm2iu4fnc****
UserCount	integer	Smart Access Gateway執行個體用戶端帳號數量。	3
AccessPointId	string	Smart Access Gateway執行個體存取點 ID。	238
ApplicationBandwidthPackageId	string	Smart Access Gateway執行個體綁定的應用加速頻寬包 ID。	abwp-7963l7iqnquyj3****
AccelerateBandwidth	integer	Smart Access Gateway執行個體的應用加速頻寬峰值。單位：Mbps。	1
EnableSoftwareConnectionAudit	boolean	是否已開啟 SAG App 串連日誌審計。取值： true：已開啟 SAG App 串連日誌審計。 false：未開啟 SAG App 串連日誌審計。	true
Position	string	Smart Access Gateway執行個體位置資訊。	[{\"adcode\":\"\",\"label\":\"山東省青島市即墨區\",\"value\":\"B02140800T\",\"center\":\"120.989576,36.487512\",\"_new\":\"true\"}]
Isp	string	Smart Access Gateway執行個體使用的電訊廠商名字。	電信
EnableAdvancedMonitor	boolean	Smart Access Gateway執行個體是否已開啟深度監控。取值： true：已開啟。 false：未開啟。	true

樣本

正常返回樣本

JSON格式

{
  "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\\\":\\\"山東省青島市即墨區\\\",\\\"value\\\":\\\"B02140800T\\\",\\\"center\\\":\\\"120.989576,36.487512\\\",\\\"_new\\\":\\\"true\\\"}]",
        "Isp": "電信",
        "EnableAdvancedMonitor": true
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Param.InvalidVersionComparator	The specified version comparison operator is invalid.	非法的版本比較操作值。
400	InvalidRegionID	The specified regionId does not exist.	指定的RegionId不存在。
403	Forbidden	User not authorized to operate on the specified resource.	使用者沒有操作此資源的許可權。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。