调用DescribeSagHa查询智能接入网关的高可用配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeSagHa |
要执行的操作。 取值:DescribeSagHa。 |
RegionId | String | 是 | cn-shanghai |
智能接入网关实例地域ID。 |
SmartAGId | String | 是 | sag-whfn**** |
智能接入网关实例ID。 |
SmartAGSn | String | 是 | sag32a30**** |
绑定的智能接入网关设备序列号。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Mode | String | NONE |
HA模式:
|
Ports | Array |
端口信息列表。 |
|
PortName | String | 5 |
端口名称。 |
VirtualIp | String | 192.XX.XX.1 |
智能接入网关的虚拟IP地址。 |
RequestId | String | 273D62FD-E346-4959-AA18-D79B9276FEFB |
请求ID。 |
TaskStates | Array |
查询任务信息列表。 |
|
CreateTime | String | 1586836343000 |
查询任务创建时间。 |
ErrorCode | String | 200 |
错误码。200标识查询任务成功。 |
ErrorMessage | String | Successful |
错误信息。Successful标识查询任务成功。 |
State | String | Succeed |
异步任务状态:
|
示例
请求示例
http(s)://smartag.cn-shanghai.aliyuncs.com/?Action=DescribeSagHa
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeSagHaResponse>
<RequestId>0EF71E33-011D-45DC-B942-8F1241D931E3</RequestId>
<Mode>DYNAMIC</Mode>
<TaskStates>
<State>Succeed</State>
<CreateTime>1586836343000</CreateTime>
<ErrorCode>200</ErrorCode>
<ErrorMessage>Successful</ErrorMessage>
</TaskStates>
</DescribeSagHaResponse>
JSON
格式
{
"RequestId": "0EF71E33-011D-45DC-B942-8F1241D931E3",
"Mode": "DYNAMIC",
"TaskStates": [
{
"State": "Succeed",
"CreateTime": 1586836343000,
"ErrorCode": "200",
"ErrorMessage": "Successful"
}
]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | SAG.InstanceNoFound | The specified SAG instance does not exist. | 智能网关实例不存在。 |
400 | SAG.SoftwareNotSupport | The specified SAG software edition instance does not support ACL. | 智能接入网关软件版实例不支持ACL。 |
500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | 该智能接入网关已经到期停服,请续费。 |
500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | 该智能接入网关尚未激活,请先激活该实例。 |
403 | SmartAccessGatewayNotOnline | The specified smart access gateway is not online. | 该智能接入网关当前不是在线状态,无法完成操作。 |
500 | SmartAccessGatewayOffline | The request cannot be completed. The Smart Access Gateway is offline. | 智能接入网关离线,请求无法完成。 |
400 | InstanceNotExit | The specified instance does not exist. | 指定的实例不存在 |
400 | ConfigUnsynchronized | The network configuration is not synchronized. | 网络配置未同步 |
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. | 备智能接入网关的当前版本不支持该功能特性 |
访问错误中心查看更多错误码。