All Products
Search
Document Center

Smart Access Gateway:ModifySagPortRouteProtocol

Last Updated:Mar 03, 2024

You can call this operation to modify the routing protocol of a port.

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:ModifySagPortRouteProtocolWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the Smart Access Gateway (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****
PortNamestringYes

The name of the port.

2
VlanstringNo

The VLAN ID.

2
RouteProtocolstringYes

The routing protocol. Valid values:

  • STATIC: uses a static routing protocol.
  • OSPF: uses the Open Shortest Path First protocol (OSPF).
  • BGP: uses the Border Gateway Protocol (BGP).
STATIC
RemoteIpstringNo

The IP address of the peer device.

Note You must set this parameter when you enable BGP.
192.XX.XX.1
RemoteAsstringNo

The BGP autonomous system number (ASN) of the peer device.

Note You must set this parameter when you enable BGP.
65535

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CE6642D4-21EB-4168-9BF9-F217953F9892

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892"
}

Error codes

HTTP status codeError codeError message
400Sag.RouteProtocolPortNotExistThe port specified for the dynamic routing protocol does not exist.
400Sag.EccRouteTypeErrorAn ECC port supports the BGP protocol only.
400Sag.RouteTypeNotMatchThe routing protocol type must be the same as the global routing protocol type.

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