UpdateSmartAccessGatewayOspfRoute_智能接入网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

目前仅设备版本为 3.4.2 及以上的 SCG5000 和 SCG5000-5G 设备支持修改智能接入网关设备动态路由协议 OSPF 的配置。

流控信息

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

授权信息

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

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
smartag:UpdateSmartAccessGatewayOspfRoute
Write
全部资源
*

请求参数

字段名称字段详情
SagInsIdstring

智能接入网关实例 ID。

示例值:sag-3manef62evrfr6****
SagSnstring

智能接入网关设备序列号。

示例值:sagf4dk****
RegionIdstring

智能接入网关实例所属的地域 ID。展开详情

示例值:cn-shanghai参考取值来源:
    DescribeRegions
RouterIdstring

OSPF 路由器 ID。

示例值:192.XX.XX.1
AreaIdinteger<int32>

OSPF 区域 ID。展开详情

示例值:1
DeadTimeinteger<int32>

OSPF 超时时间间隔。单位:秒。展开详情

示例值:40
HelloTimeinteger<int32>

发送 Hello 报文的时间间隔。单位:秒。展开详情

示例值:10
AuthenticationTypestring

认证类型。取值:展开详情

示例值:MD5
Md5KeyIdinteger<int32>

MD5 Key 的编号。展开详情

示例值:7
Md5Keystring

MD5 Key 值。展开详情

示例值:5
Passwordstring

明文认证密码。展开详情

示例值:duuf****
InterfaceNamestring

端口名称。展开详情

示例值:2
OspfNetworkTypestring

OSPF 区域类型。展开详情

示例值:NSSA
OspfCostinteger<int32>

OSPF 路由开销值。展开详情

示例值:[110/11]
RedistributeProtocolstring

路由重分发协议。展开详情

示例值:OSPF
Networksstring

网段。展开详情

示例值:192.168.10.0/24参考取值来源:
    DescribeCloudConnectNetworks
CrossAccountboolean

是否只查询跨账号所属的智能接入网关实例。取值:展开详情

示例值:false
ResourceUidstring

资源所属的阿里云账号(主账号)ID。

示例值:109790620697****

返回参数

字段名称字段详情
Codestring

响应码。200 标识查询任务成功。

示例值:200
Successboolean

是否成功。取值:展开详情

示例值:true
RequestIdstring

请求 ID。

示例值:9CF52A9E-FC3C-5CC8-B5EB-90DC03E9A531
Messagestring

响应消息。

示例值:successful

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
GATEWAY.InvalidSN
The specified gateway serial number does not exist.诊断
400
InternalError
Internal server error诊断
400
ParamCommonNotNull
Parameter must not be null诊断
400
SAG.InstanceNoFound
The specified SAG instance does not exist.诊断
400
SAG.SoftwareNotSupport
The specified software instance does not support ACL.诊断
400
SmartAccessGatewayNotActivated
The specified Smart Access Gateway has not been activated.诊断
400
DeviceNotExist
The specified device does not exist诊断
400
MissParameter.GatewayId
The input parameter GatewayId that is mandatory for processing this model is not supplied.诊断
400
MissParameter.RouterId
The input parameter RouterId that is mandatory for processing this model is not supplied.诊断
400
MissParameter.AreaId
The input parameter AreaId that is mandatory for processing this model is not supplied.诊断
400
MissParameter.HelloTime
The input parameter HelloTime that is mandatory for processing this model is not supplied.诊断
400
MissParameter.DeadTime
The input parameter DeadTime that is mandatory for processing this model is not supplied.诊断
400
MissParameter.InterfaceName
The input parameter InterfaceName that is mandatory for processing this model is not supplied.诊断
400
MissParameter.OspfCost
The input parameter OspfCost that is mandatory for processing this model is not supplied.诊断
400
InvalidParameter.RouterId
The input parameter RouterId is illegal, please check your input.诊断
400
InvalidParameter.AreaId
The input parameter AreaId is illegal, please check your input.诊断
400
InvalidParameter.HelloTime
The input parameter HelloTime is illegal, please check your input.诊断
400
InvalidParameter.DeadTime
The input parameter DeadTime is illegal, please check your input.诊断
400
InvalidParameter.AuthenticationType
The input parameter AuthenticationType is illegal, please check your input.诊断
400
InvalidParameter.Password
The input parameter Password is illegal, please check your input.诊断
400
InvalidParameter.Md5KeyId
The input parameter Md5KeyId is illegal, please check your input.诊断
400
InvalidParameter.Md5Key
The input parameter Md5Key is illegal, please check your input.诊断
400
InvalidParameter.OspfCost
The input parameter OspfCost is illegal, please check your input.诊断
400
MissParameter.AuthenticationType
The input parameter AuthenticationType that is mandatory for processing this model is not supplied.诊断
400
InvalidParameter.RedistributeProtocol
The input parameter RedistributeProtocol is illegal, please check your input.诊断
400
InvalidParameter.Networks
The input parameter Networks is illegal, please check your input.诊断
400
FeatureNotSupport
The current edition of the smart access gateway does not support this feature.诊断

变更历史

变更时间变更内容概要操作
2022-11-14
新增OpenAPI,修改SAG设备动态路由协议OSPF的配置

相关示例