You can call this operation to modify the Open Shortest Path First (OSPF) configurations of a Smart Access Gateway (SAG) device.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No ModifySagRouteProtocolOspf

The operation that you want to perform.

Set the value to ModifySagRouteProtocolOspf.

AreaId Integer Yes 86

The ID of the OSPF area.

Valid values: 1 to 2147483647.

AuthenticationType String Yes NONE

The authentication method. Valid values:

  • NONE: disables authentication.
  • CLEARTEXT: uses plaintext authentication. You must enter the plaintext password.
  • MD5: uses MD5 authentication. You must enter the MD5 key ID and the MD5 key.
DeadTime Integer Yes 10

The timeout period that the router waits for a hello packet from the neighbor device before declaring the neighbor device dead. Unit: second.

Valid values: 1 to 65535.

HelloTime Integer Yes 3

The time interval at which hello packets are sent. Unit: second.

Valid values: 1 to 65535.

RegionId String Yes cn-shanghai

The ID of the region where the SAG instance is deployed.

RouterId String Yes 192.XX.XX.1

The ID of the router that has OSPF enabled.

The ID is an IPv4 address.

SmartAGId String Yes sag-whfn****

The ID of the SAG instance.

SmartAGSn String Yes sag32a30***

The serial number of the SAG device associated with the SAG instance.

Md5KeyId Integer No 7

The ID of the MD5 key.

Valid values: 1 to 2147483647.

Note If you select MD5 as the authentication type, you must set this parameter.
Md5Key String No 1234***

The value of the MD5 key.

Valid values: 1 to 47.

Note If you select MD5 as the authentication type, you must set this parameter.
Password String No 1212****

The plaintext password.

The password must be 1 to 8 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).

Note If you select CLEARTEXT as the authentication type, you must set this parameter.

Response parameters

Parameter Type Example Description
RequestId String 191DC00D-00C0-475C-99B8-ADBB82496405

The ID of the request.

Examples

Sample requests

http(s)://smartag.cn-shanghai.aliyuncs.com/? Action=ModifySagRouteProtocolOspf
&AreaId=86
&AuthenticationType=NONE
&DeadTime=10
&HelloTime=3
&Md5KeyId=7
&RegionId=cn-shanghai
&RouterId=192.XX.XX.1
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30***
&<Common request parameters>

Sample success responses

XML format

<ModifySagRouteProtocolOspfResponse>
      <RequestId>191DC00D-00C0-475C-99B8-ADBB82496405</RequestId>
</ModifySagRouteProtocolOspfResponse>

JSON format

{
"RequestId": "191DC00D-00C0-475C-99B8-ADBB82496405"
}

Error codes

HttpCode Error code Error message Description
400 SAG.InstanceNoFound The specified SAG instance does not exist. The specified SAG instance does not exist.
400 SAG.SoftwareNotSupport The specified SAG software edition instance does not support ACL. The SAG APP instance does not support access control lists (ACLs).
500 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. The specified SAG instance has expired and stops running. Renew the SAG instance.
500 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. The specified SAG instance is not activated. Activate the SAG instance.
403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. The system failed to process the request because the specified SAG device is not connected to Alibaba Cloud.
500 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. The system failed to process the request because the specified SAG device is not connected to Alibaba Cloud.
400 InstanceNotExit The specified instance does not exist. The specified SAG instance does not exist.
400 ConfigUnsynchronized The network configuration is not synchronized. The network configurations are not synchronized.
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. The current version of the SAG device does not support this feature.
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. The current version of the active SAG device does not support this feature.
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. The current version of the standby SAG device does not support this feature.

For a list of error codes, visit the API Error Center.