调用DescribeSmartAccessGatewayAttribute接口查询指定智能接入网关实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
smartag:DescribeSmartAccessGatewayAttribute | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 智能接入网关实例所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-shanghai |
SmartAGId | string | 是 | 智能接入网关实例 ID。 | sag-6z21oj0vjjrx**** |
返回参数
示例
正常返回示例
JSON
格式
{
"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": "阿里巴巴西溪园区",
"EnableSoftwareConnectionAudit": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能接入网关实例不存在。 |
访问错误中心查看更多错误码。