使用DescribeSagHa查询智能接入网关的高可用配置-智能接入网关-阿里云-智能接入网关(SAG)-阿里云帮助中心

调用DescribeSagHa查询智能接入网关的高可用配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

smartag:DescribeSagHa

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	智能接入网关实例地域 ID。	cn-shanghai
SmartAGId	string	是	智能接入网关实例 ID。	sag-whfn****
SmartAGSn	string	是	绑定的智能接入网关设备序列号。	sag32a30****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	273D62FD-E346-4959-AA18-D79B9276FEFB
Mode	string	HA 模式： NONE：HA 功能未开启。 STATIC：静态模式。 DYNAMIC：动态模式。	NONE
Ports	array<object>	端口信息列表。
	object
PortName	string	端口名称。	5
VirtualIp	string	智能接入网关的虚拟 IP 地址。	192.XX.XX.1
TaskStates	array<object>	查询任务信息列表。
	object
ErrorMessage	string	错误信息。Successful 标识查询任务成功。	Successful
State	string	异步任务状态： Initialized：查询任务初始化。 Offline：智能接入网关设备离线未下发查询任务，智能接入网关设备上线后会继续下发。 Succeed：查询任务下发成功。 Processing：查询任务下发中。 VersionNotSupport：智能接入网关设备当前版本不支持。 BuildRequestError：管控不支持。 HardwareError：由于设备原因查询任务下发失败。 TaskNotExist：查询任务不存在。 OfflineNotConfiged：智能接入网关设备离线未下发查询任务，智能接入网关设备上线后也不会下发。	Succeed
ErrorCode	string	错误码。200 标识查询任务成功。	200
CreateTime	string	查询任务创建时间。	1586836343000

示例

正常返回示例

JSON格式

{
  "RequestId": "273D62FD-E346-4959-AA18-D79B9276FEFB",
  "Mode": "NONE",
  "Ports": [
    {
      "PortName": "5",
      "VirtualIp": "192.XX.XX.1"
    }
  ],
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586836343000"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	智能接入网关实例不存在。
400	SAG.SoftwareNotSupport	The specified SAG software edition instance does not support ACL.	智能接入网关软件版实例不支持ACL。
400	InstanceNotExit	The specified instance does not exist.	指定的实例不存在。
400	ConfigUnsynchronized	The network configuration is not synchronized.	网络配置未同步。
500	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.
500	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.
500	SmartAccessGatewayOffline	The request cannot be completed. The Smart Access Gateway is offline.
403	SmartAccessGatewayNotOnline	The specified smart access gateway is not online.	该智能接入网关当前不是在线状态，无法完成操作。
403	FeatureNotSupport	The current edition of the smart access gateway does not support this feature.	智能接入网关当前版本不支持该功能特性。
403	FeatureNotSupportForActiveSmartAG	The current edition of the active smart access gateway does not support this feature.	主智能接入网关的当前版本不支持该功能特性。
403	FeatureNotSupportForStandBySmartAG	The current edition of the standby smart access gateway does not support this feature.	备智能接入网关的当前版本不支持该功能特性。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。