All Products
Search

This Product

    Smart Access Gateway:ModifySagRouteProtocolOspf

    Document Center

    Smart Access Gateway:ModifySagRouteProtocolOspf

    Last Updated:Mar 29, 2024

    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.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    smartag:ModifySagRouteProtocolOspfWrite
    • SmartAccessGateway
      acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-shanghai
    SmartAGIdstringYes

    The ID of the SAG instance.

    		sag-whfn****
    SmartAGSnstringYes

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

    		sag32a30***
    RouterIdstringYes

    The ID of the router that has OSPF enabled.

    Set the value to an IPv4 address.

    		192.XX.XX.1
    AreaIdintegerYes

    The ID of the OSPF area.

    Valid values: 1 to 2147483647.

    		86
    DeadTimeintegerYes

    The timeout period of OSPF. Unit: seconds.

    Valid values: 1 to 65535.

    		10
    HelloTimeintegerYes

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

    Valid values: 1 to 65535.

    		3
    AuthenticationTypestringYes

    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.
    		NONE
    Md5KeyIdintegerYes

    The ID of the MD5 key.

    Valid values: 1 to 2147483647.

    Note This parameter is required only if AuthenticationType is set to MD5.
    		7
    Md5KeystringNo

    The MD5 key value.

    Valid values: 1 to 47.

    Note This parameter is required only if AuthenticationType is set to MD5.
    		5
    PasswordstringNo

    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.
    		1212****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		191DC00D-00C0-475C-99B8-ADBB82496405

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
    400SAG.SoftwareNotSupportThe specified SAG software edition instance does not support ACL.The specified SAG software edition instance does not support ACL.
    400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
    400ConfigUnsynchronizedThe network configuration is not synchronized.Network settings are not synchronized.
    403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.
    403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
    403FeatureNotSupportForActiveSmartAGThe current edition of the active smart access gateway does not support this feature.The current edition of the active SAG instance does not support this feature.
    403FeatureNotSupportForStandBySmartAGThe current edition of the standby smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
    500SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.The specified Smart Access Gateway has expired.
    500SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
    500SmartAccessGatewayOfflineThe request cannot be completed. The Smart Access Gateway is offline.The SAG device is disconnected. The request cannot be processed.

    For a list of error codes, visit the Service error codes.