Call UpdateSmartAccessGatewayOspfRoute to modify OSPF dynamic routing configuration - Smart Access Gateway

Modifies the Open Shortest Path First (OSPF) dynamic routing protocol configuration of a Smart Access Gateway (SAG) device. This operation is supported only for SAG instances that use the SCG5000 or SCG5000-5G device model and run device version 3.4.2 or later.

Operation description

You can modify the OSPF dynamic routing protocol configuration only for SCG5000 and SCG5000-5G devices that run device version 3.4.2 or later.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:UpdateSmartAccessGatewayOspfRoute

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SagInsId	string	Yes	The ID of the SAG instance.	sag-3manef62evrfr6****
SagSn	string	Yes	The serial number of the SAG device.	sagf4dk****
RegionId	string	Yes	The ID of the region where the SAG instance is deployed. For more information, see DescribeRegions.	cn-shanghai
RouterId	string	Yes	The OSPF router ID.	192.XX.XX.1
AreaId	integer	Yes	The OSPF area ID. The value must be an integer from 1 to 2147483647.	1
DeadTime	integer	Yes	The dead interval. Unit: seconds. The value must be an integer from 1 to 65535.	40
HelloTime	integer	Yes	The interval at which Hello packets are sent. Unit: seconds. The value must be an integer from 1 to 65535.	10
AuthenticationType	string	Yes	The authentication method. Valid values: NONE: No authentication is configured. CLEARTEXT: Plaintext authentication is used. MD5: MD5 authentication is used.	MD5
Md5KeyId	integer	No	The MD5 key ID. The value must be an integer from 1 to 2147483647. Note This parameter is required only when you set AuthenticationType to MD5.	7
Md5Key	string	No	The MD5 key. The value must be 1 to 47 characters in length. Note This parameter is required only when you set AuthenticationType to MD5.	5
Password	string	No	The password for plaintext authentication. The password must be 1 to 8 characters in length and can contain letters, digits, hyphens (-), and underscores (_). Note This parameter is required only when you set AuthenticationType to CLEARTEXT.	duuf****
InterfaceName	string	No	The port name. Note This parameter is not in use.	2
OspfNetworkType	string	No	The OSPF network type. Note This parameter is not in use.	NSSA
OspfCost	integer	No	The cost of the OSPF route. Note This parameter is not in use.	[110/11]
RedistributeProtocol	string	No	The route redistribution protocol. Note This parameter is not in use.	OSPF
Networks	string	No	The network segment. Note This parameter is not in use.	192.168.10.0/24
CrossAccount	boolean	No	Specifies whether to query only the SAG instances that belong to other Alibaba Cloud accounts. Valid values: false (default): No. true: Yes.	false
ResourceUid	string	No	The ID of the Alibaba Cloud account to which the resource belongs.	109790620697****

Response parameters

Parameter	Type	Description	Example
	object	The response that is returned.
Code	string	The response code. A value of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	9CF52A9E-FC3C-5CC8-B5EB-90DC03E9A531
Message	string	The response message.	successful

Examples

Success response

JSON format

{
  "Code": "200",
  "Success": true,
  "RequestId": "9CF52A9E-FC3C-5CC8-B5EB-90DC03E9A531",
  "Message": "successful"
}

Error codes

HTTP status code	Error code	Error message	Description
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.	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.	The specified SAG instance is inactive. You must activate the instance first.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.