All Products
Search
Document Center

Smart Access Gateway:ModifyRouteDistributionStrategy

Last Updated:Mar 03, 2024

Modifies the route advertisement policy for a CIDR block.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the Smart Access Gateway (SAG) instance.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-erx3qta5xg5zyq****
HcInstanceIdstringYes

The ID of the health check instance.

hc-sztovuprqzgm50****
SourceTypestringYes

The type of the route source. Valid values:

  • cloud: Alibaba Cloud-facing routes.
  • local: private network-facing routes.
local
DestCidrBlockstringYes

The destination CIDR block.

172.XX.XX.0/24
RouteSourcestringYes

The source of routes. Valid values:

  • Alibaba Cloud-facing routes

    • The ID of the Virtual Private Cloud (VPC): learns routes from the VPC network.
    • The ID of the virtual border router (VBR): learns routes from the VBR.
    • The ID of the SAG instance: learns routes from the SAG instance.
  • Private network-facing routes

    • STATIC: static routes specified in the SAG console.
    • OSPF: learns routes through the Open Shortest Path First (OSPF) protocol.
    • BGP: learns routes through Border Gateway Protocol (BGP).
OSPF
RouteDistributionstringYes

The route advertisement policy. Valid values:

  • publish: advertises routes.
  • no_publish: does not advertise routes.
  • no_publish_and_publish_on_health_success: routes are advertised only when they pass the health check.
  • no_publish_and_publish_on_health_fail: routes are advertised only when they fail the health check.
  • publish_and_revoke_on_health_success: advertised routes are withdrawn only when they pass the health check.
  • publish_and_revoke_on_health_fail: advertised routes are withdrawn only when they fail the health check.

For more information, see Configure health checks and Advertise routes.

publish

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

24C58BD0-1679-4942-9D42-00B635DAAADB

Examples

Sample success responses

JSONformat

{
  "RequestId": "24C58BD0-1679-4942-9D42-00B635DAAADB"
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400RD.InvalidDestCidrBlockThe specified destination CIDR block is invalid.The specified destination CIDR block is invalid.
400RD.InvalidHcInstanceIdThe specified network health check instance ID is invalid.The specified network health check instance ID is invalid.
400RD.InvalidRouteDistributionThe specified route distribution policy is invalid.The specified route distribution policy is invalid.
400RD.InvalidRouteSourceThe specified route source is invalid.The specified route source is invalid.
400RD.InvalidSourceTypeThe specified route source type is invalid.The specified route source type is invalid.
400HC.InstanceNoFoundThe specified network health check instance does not exist.The specified network health check instance does not exist.
400SAG.ArrearageThe specified SAG instance has overdue payments. Renew the instance first.The specified SAG instance has overdue payments. Renew the instance first.
400SAG.NoActiveThe specified SAG instance has not been activated.The specified SAG instance has not been activated.
400SAG.SoftwareNotSupportFeatureThe specified SAG Software instance does not support this feature.The specified SAG Software instance does not support this feature.
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.
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.

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