DescribeSmartAccessGateways_智能接入网关_API文档

2018-03-13

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

smartag:DescribeSmartAccessGateways	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
RegionIdstring	智能接入网关实例所属地域的 ID。示例值:cn-shanghai参考取值来源: DescribeRegions
AssociatedCcnIdstring	智能接入网关实例绑定的云连接网实例 ID。示例值:ccn-bxuau4ezctt****
SmartAGIdstring	智能接入网关实例 ID。示例值:sag-6z21oj0vjjrx6s****参考取值来源: AddSnatEntry BindSmartAccessGateway CreateSmartAccessGateway ListSmartAGByAccessPoint
Statusstring	智能接入网关实例的状态。取值：展开详情示例值:Active
Namestring	智能接入网关实例的名称。展开详情示例值:nametest
PageSizeinteger<int32>	分页查询时每页显示的条目数。默认值：10。取值范围：1~50。示例值:10
PageNumberinteger<int32>	查询页码。默认值：1。示例值:1
SerialNumberstring	智能接入网关设备的序列号。示例值:sag32a3****参考取值来源: BindSerialNumber
AclIdsstring	智能接入网关实例绑定的访问控制实例 ID。示例值:acl-xhwhyuo43l0n****
UnboundAclIdsstring	访问控制实例 ID。展开详情示例值:acl-sjfbgngj****
InstanceTypestring	智能接入网关实例类型。取值：展开详情示例值:hardware枚举值:softwarehardware
CanAssociateQosboolean	可否关联 QoS 策略实例。取值：展开详情示例值:false
HardwareTypestring	智能接入网关设备硬件规格。取值：展开详情示例值:sag-100wm
SoftwareVersionstring	智能接入网关设备运行的软件版本。示例值:2.3.0.0
VersionComparatorstring	版本过滤符。取值：展开详情示例值:equals
BusinessStatestring	智能接入网关实例的业务状态。取值：展开详情示例值:Normal
ResourceGroupIdstring	智能接入网关实例所属的资源组 ID。示例值:rg-acfm2iu4fnc****
SmartAGIdsarray<string>	智能接入网关实例 ID 列表。子级条数 <= 50
AssociatedCcnNamestring	绑定的云连接网实例的名称。展开详情示例值:ccn

返回参数

字段名称	字段详情
TotalCountinteger<int32>	列表条目数。示例值:1
PageSizeinteger<int32>	分页查询时每页包含的条目数。示例值:10
RequestIdstring	请求 ID。示例值:ADE68CEE-8E4F-4D0B-9EE9-2C2FFAABF41F
PageNumberinteger<int32>	列表的页码。示例值:1
SmartAccessGatewaysobject

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	Param.InvalidVersionComparator	The specified version comparison operator is invalid.	诊断
400	InvalidRegionID	The specified regionId does not exist.	诊断
403	Forbidden	User not authorized to operate on the specified resource.	诊断

变更历史

	变更时间	变更内容概要	操作
	2022-11-14	变更返回参数
	2022-09-06	变更返回参数
	2022-06-24	新增请求参数AssociatedCcnName

相关示例