Modifies the remote access IP address of a Smart Access Gateway (SAG) device.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
SerialNumber String Yes sag-100-v1p7-9

The serial number (SN) of the SAG device.

SmartAGId String Yes sag-r79m060r6oy55******

The ID of the corresponding SAG instance.

Action String No ModifySagRemoteAccess

The name of this action.

Value: ModifySagRemoteAccess

RemoteAccessIp String No 10.XX.XX.2

The remote access IP address of the SAG device.

Response parameters

Parameter Type Example value Description
Code String 200

The returned status code.

Message String Successful

The message returned after calling the API.

RemoteAccessIp String 10.XX.XX.2

The remote access IP address.

RequestId String 4FF203D7-462D-498E-94F9-2B2FA462DD23

The ID of the request.

SerialNumber String sag61a344**

The SN of the SAG device.

Success Boolean true

Indicates whether the API call is successful.

Examples

Request example


http(s)://[Endpoint]/? Action=ModifySagRemoteAccess
&SerialNumber=sag-100-v1p7-9
&SmartAGId=sag-r79m060r6oy55******
&<CommonParameters>

Response example

XML format

<ModifySagRemoteAccessResponse>
	  <RemoteAccessIp>10.XX.XX.2</RemoteAccessIp>
	  <SerialNumber>sag61a344ge</SerialNumber>
	  <Message>Successful</Message>
	  <RequestId>4FF203D7-462D-498E-94F9-2B2FA462DD23</RequestId>
	  <Success>true</Success>
	  <Code>200</Code>
    </ModifySagRemoteAccessResponse>

JSON format

{
	"SerialNumber":"sag61a344ge",
	"RemoteAccessIp":"10.XX.XX.2",
	"Message":"Successful",
	"RequestId":"4FF203D7-462D-498E-94F9-2B2FA462DD23",
	"Success":true,
	"Code":"200"
}

Errors

HTTP status code Error code Error message Description
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. The version of the SAG device does not support this function.
400 VersionNotExist The specified version does not exist. The specified version does not exist.
403 InvalidId.SMARTAG The specified smart access gateway instance id is invalid. The specified SmartAGId is invalid.
403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. The status of the specified SAG instance does not permit this operation.
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. The version of the standby SAG device does not support this function.
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. The version of the active SAG device does not support this function.
403 IllegalRemoteIp.Conflict The specified IP address has been used. The specified remote access IP address is being used by other resources.
403 IllegalRemoteIp.RouteTableEntryConflict The specified IP address conflicts with route table entries. The specified remote access IP address conflicts with route table entries.

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