Call the ModifySagPortRouteProtocol API to modify the routing protocol of a port - Smart Access Gateway

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:ModifySagPortRouteProtocol

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Smart Access Gateway (SAG) instance is deployed.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG instance.	sag-whfn****
SmartAGSn	string	Yes	The serial number of the SAG device associated with the SAG instance.	sag32a30****
PortName	string	Yes	The name of the port.	2
Vlan	string	No	The VLAN ID.	2
RouteProtocol	string	Yes	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
RemoteIp	string	No	The IP address of the peer device. Note You must set this parameter when you enable BGP.	192.XX.XX.1
RemoteAs	string	No	The BGP autonomous system number (ASN) of the peer device. Note You must set this parameter when you enable BGP.	65535

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CE6642D4-21EB-4168-9BF9-F217953F9892

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	Sag.RouteProtocolPortNotExist	The port specified for the dynamic routing protocol does not exist.
400	Sag.EccRouteTypeError	An ECC port supports the BGP protocol only.
400	Sag.RouteTypeNotMatch	The routing protocol type must be the same as the global routing protocol type.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.