文档

DescribeSmartAccessGatewayHa - 查询智能接入网关的高可用配置

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:DescribeSmartAccessGatewayHaRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

请求参数

名称类型必填描述示例值
SmartAGIdstring

要查询的智能接入网关实例 ID。

sag-pno62188piyc6txxxxx
RegionIdstring

智能接入网关实例的地域 ID。

cn-shanghai

返回参数

名称类型描述示例值
object
DeviceLevelBackupStatestring

设备级别备份状态。取值:

  • ON:开启。
  • OFF:关闭。
OFF
RequestIdstring

请求 ID。

582FE511-FEFE-42BC-BBF4-4F8ECF92Exxx
BackupDeviceIdstring

备用设备序列号。

sag11axxxx
LinkBackupInfoListobject []

链路备份信息。

MainLinkIdstring

主连接 ID。

lte
BackupLinkStatestring

备份链路状态。取值:

  • up:链路可用。
  • down:链路不可用。
down
LinkLevelBackupStatestring

链路级备份状态。取值:

  • ON:开启。
  • OFF:关闭。
ON
BackupLinkIdstring

备份链路 ID。

wan1
MainLinkStatestring

主链路状态。取值:

  • up:可用。
  • down:不可用。
up
LinkLevelBackupTypestring

链路级备份类型。取值:

  • DedicatedLineBackupMode:专线备份模式。
  • StandbyMode:双 WAN 口主备模式。
  • Off:无备份。
StandbyMode
SmartAGIdstring

智能接入网关实例 ID。

sag-i8mogwi9kisigc3xxxx
DeviceLevelBackupTypestring

设备级别高可用类型。取值:

  • warm_backup:双机热备。
  • cold_backup:双机冷备。
  • no_backup:无备份。
cold_backup
MainDeviceIdstring

主设备序列号。

sag11axxxx

示例

正常返回示例

JSON格式

{
  "DeviceLevelBackupState": "OFF",
  "RequestId": "582FE511-FEFE-42BC-BBF4-4F8ECF92Exxx",
  "BackupDeviceId": "sag11axxxx",
  "LinkBackupInfoList": {
    "LinkBackupInfoList": [
      {
        "MainLinkId": "lte",
        "BackupLinkState": "down",
        "LinkLevelBackupState": "ON",
        "BackupLinkId": "wan1",
        "MainLinkState": "up",
        "LinkLevelBackupType": "StandbyMode"
      }
    ]
  },
  "SmartAGId": "sag-i8mogwi9kisigc3xxxx",
  "DeviceLevelBackupType": "cold_backup",
  "MainDeviceId": "sag11axxxx"
}

错误码

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