Modifies the Open Shortest Path First (OSPF) settings of a Smart Access Gateway (SAG) instance.

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 Yes ModifySagRouteProtocolOspf

The operation that you want to perform. Set the value to ModifySagRouteProtocolOspf.

RegionId String Yes cn-shanghai

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

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.

RouterId String Yes 192.XX.XX.1

The ID of the router that has OSPF enabled.

Set the value to an IPv4 address.

AreaId Integer Yes 86

The ID of the OSPF area.

Valid values: 1 to 2147483647.

DeadTime Integer Yes 10

The timeout period of OSPF. Unit: seconds.

Valid values: 1 to 65535.

HelloTime Integer Yes 3

The time interval at which Hello packets are sent. Unit: seconds.

Valid values: 1 to 65535.

AuthenticationType String Yes NONE

The authentication method. Valid values:

  • NONE: does not enable 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.
Md5KeyId Integer Yes 7

The ID of the MD5 key.

Valid values: 1 to 2147483647.

Note This parameter is required only if AuthenticationType is set to MD5.
Md5Key String No 5

The MD5 key value.

Valid values: 1 to 47.

Note This parameter is required only if AuthenticationType is set to MD5.
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 This parameter is required only if AuthenticationType is set to CLEARTEXT.

Response parameters

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

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifySagRouteProtocolOspf
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30***
&RouterId=192.XX.XX.1
&AreaId=86
&DeadTime=10
&HelloTime=3
&AuthenticationType=NONE
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 error message returned because the specified SAG instance does not exist.
400 SAG.SoftwareNotSupport The specified SAG software edition instance does not support ACL. The error message returned because the SAG app instance does not support access control lists (ACLs).
400 InstanceNotExit The specified instance does not exist. The error message returned because the specified instance does not exist.
400 ConfigUnsynchronized The network configuration is not synchronized. The error message returned because the network configurations are not synchronized.
403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. The error message returned because the specified SAG device is not connected to Alibaba Cloud and the system failed to process the request.
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. The error message returned because the current version of the specified SAG device does not support this feature.
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. The error message returned because 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 error message returned because the current version of the standby SAG device does not support this feature.
500 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. The error message returned because the specified SAG instance has expired. Renew the SAG instance.
500 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. The error message returned because the specified SAG instance is not activated. Activate the SAG instance first.
500 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. The error message returned because the specified SAG device is not connected to Alibaba Cloud and the system failed to process the request.

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