调用DescribeSmartAccessGateways查询已创建的智能接入网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeSmartAccessGateways |
执行的操作。 取值: DescribeSmartAccessGateways。 |
RegionId | String | 否 | cn-hangzhou |
智能接入网关的所属区域ID。 |
AssociatedCcnId | String | 否 | ccn-bxuau4ezctt****** |
绑定的云连接网ID。 |
SmartAGId | String | 否 | sag-c3m3n1khz58l****** |
智能接入网关ID。 |
Status | String | 否 | Ordered |
智能接入网关状态,取值:
|
Name | String | 否 | sag |
智能接入网关名称。 |
PageSize | Integer | 否 | 1 |
分页查询时设置的每页行数,默认值为10,最大值为50。 |
PageNumber | Integer | 否 | 2 |
实例状态列表的页码,默认值是1。 |
SerialNumber | String | 否 | sag32a30121 |
智能接入网关的序列号。 |
AclIds | String | 否 | acl-xhwhyuo43l0n****** |
智能接入网关实例绑定的访问控制规则。 |
UnboundAclIds | String | 否 | acl-sjfbgngj*************** |
未关联到该ACL,多个ID用逗号隔开。 |
InstanceType | String | 否 | hardware |
实例类型,取值:
|
CanAssociateQos | Boolean | 否 | false |
能否关联QOS策略,取值:
|
HardwareType | String | 否 | sag-1000 |
硬件类型,取值:
|
SoftwareVersion | String | 否 | 1.0.0 |
智能接入网关的软件版本。 |
VersionComparator | String | 否 | equals |
版本过滤符,取值:
|
BusinessState | String | 否 | Normal |
业务状态,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 2 |
当前页码。 |
PageSize | Integer | 2 |
当前分页包含多少条目。 |
RequestId | String | 7F26258D-8BDE-4EC4-BB4D-4DDC64F64F77 |
请求ID。 |
SmartAccessGateways | Array |
智能接入网关的详细信息。 |
|
SmartAccessGateway | |||
AclIds | String | acl-shfhfhhfbnvkdg****** |
智能接入网关实例绑定的访问控制规则。 |
AssociatedCcnId | String | ccn-bxuau4ezctts****** |
绑定的云连接网ID。 |
AssociatedCcnName | String | ccn |
绑定的云连接网名称。 |
BackupSoftwareVersion | String | v1.6.0 |
备份的智能接入网关软件版本。 |
BackupStatus | String | Ordered |
备份的智能接入网关状态。 |
CidrBlock | String | 192.168.**.**/24 |
线下机构客户端通信的私网网段。 |
City | String | 杭州 |
城市。 |
CreateTime | Long | 1523604565000 |
智能接入网关的创建时间。 |
DataPlan | Long | 5 |
套餐流量。 |
Description | String | docdesc |
智能接入网关描述。 |
EndTime | Long | 1526227200000 |
智能接入网关的到期时间。 |
HardwareVersion | String | sag-100wm |
实例类型。
|
Links | Array |
链路列表。 |
|
Link | |||
Bandwidth | String | 10M |
带宽。 |
CommodityType | String | smartag |
商品类型。
|
EndTime | Long | 1526227200000 |
到期时间。 |
InstanceId | String | sag-v0fkpk4akfz******** |
实例ID。 |
RelateInstanceId | String | sag-v0fkpk4akfz5******* |
相关实例ID。 |
RelateInstanceRegionId | String | cn-hangzhou |
相关实例所在的区域。 |
Status | String | Active |
链路状态。 宽带状态:
专线状态:
|
Type | String | ccn |
链路类型。
|
MaxBandwidth | String | 2M |
智能接入网关的带宽。 |
Name | String | sag |
智能接入网关名称。 |
QosIds | String | qos-djh***************** |
智能接入网关绑定的Qos策略实例ID。 |
RoutingStrategy | String | static |
路由策略。
|
SecurityLockThreshold | Integer | 3600 |
离线锁定功能用户设定的阈值,大于等于0。 单位:秒。 |
SerialNumber | String | sag32a903****** |
智能接入网关的序列号。 |
SmartAGId | String | sag-v0fkpk4akfz5****** |
智能接入网关ID。 |
SmartAGUid | Long | 12345556345555 |
智能接入网关实例的用户ID。 |
SoftwareVersion | String | 1.0.0 |
智能接入网关的软件版本。 |
Status | String | Init |
智能接入网关的状态。 |
UpBandwidth4G | Integer | 3 |
4G公网最大上行带宽。 |
UpBandwidthWan | Integer | 2 |
Wan口最大上行带宽。 |
UserCount | Integer | 12 |
用户账号个数。 |
TotalCount | Integer | 2 |
列表条目数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeSmartAccessGateways
&<公共请求参数>
正常返回示例
XML
格式
<DescribeSmartAccessGatewaysResponse>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<RequestId>23DD7A46-C36C-4593-A05C-E890252C5A38</RequestId>
<SmartAccessGateways>
<SmartAccessGateway>
<AssociatedCcnId>ccn-elyodlndl0******</AssociatedCcnId>
<AssociatedCcnName>bvt-test</AssociatedCcnName>
<BackupSoftwareVersion></BackupSoftwareVersion>
<CreateTime>1566442838000</CreateTime>
<HardwareVersion>sag-100wm</HardwareVersion>
<Links>
<Link>
<Bandwidth>10M</Bandwidth>
<CommodityType>smartag</CommodityType>
<InstanceId>sag-ot3uudy72dz******</InstanceId>
<RelateInstanceId>ccn-elyodlndl0******</RelateInstanceId>
<Status>Active</Status>
<Type>ccn</Type>
</Link>
</Links>
<MaxBandwidth>10M</MaxBandwidth>
<QosIds>qos-awfxl1adxeq****</QosIds>
<RoutingStrategy>static</RoutingStrategy>
<SecurityLockThreshold>0</SecurityLockThreshold>
<SerialNumber>sn-1566442***</SerialNumber>
<SmartAGId>sag-ot3uudy72dzj******</SmartAGId>
<Status>Offline</Status>
<UpBandwidth4G>4</UpBandwidth4G>
<UpBandwidthWan>2</UpBandwidthWan>
</SmartAccessGateway>
</SmartAccessGateways>
<TotalCount>1</TotalCount>
</DescribeSmartAccessGatewaysResponse>
JSON
格式
{
"PageNumber":1,
"PageSize":10,
"RequestId":"23DD7A46-C36C-4593-A05C-E890252C5A38",
"SmartAccessGateways":{
"SmartAccessGateway":[
{
"AssociatedCcnId":"ccn-elyodlndl0******",
"AssociatedCcnName":"bvt-test",
"BackupSoftwareVersion":"",
"CreateTime":1566442838000,
"HardwareVersion":"sag-100wm",
"Links":{
"Link":[
{
"Bandwidth":"10M",
"CommodityType":"smartag",
"InstanceId":"sag-ot3uudy72dz******",
"RelateInstanceId":"ccn-elyodlndl0******",
"Status":"Active",
"Type":"ccn"
}
]
},
"MaxBandwidth":"10M",
"QosIds":"qos-awfxl1adxeq****",
"RoutingStrategy":"static",
"SecurityLockThreshold":0,
"SerialNumber":"sn-1566442838",
"SmartAGId":"sag-ot3uudy72dzj******",
"Status":"Offline",
"UpBandwidth4G":4,
"UpBandwidthWan":2
}
]
},
"TotalCount":1
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | Forbidden | User not authorized to operate on the specified resource. | 用户没有操作此资源的权限 |
400 | Param.InvalidVersionComparator | The specified version comparison operator is invalid. | 非法的版本比较操作值。 |
400 | InvalidRegionID | The specified regionId does not exist. | 指定的RegionId不存在 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交