All Products
Search
Document Center

Smart Access Gateway:DescribeRouteDistributionStrategies

Last Updated:Mar 03, 2024

Queries route advertisement policies.

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 ID of the region where the Smart Access Gateway (SAG) instance is deployed.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-erx3qta5xg5zyq****
SourceTypestringYes

The type of route. Valid values:

  • cloud: Alibaba Cloud-facing routes. These routes allow SAG instances to access resources deployed on Alibaba Cloud.
  • local: on-premises network-facing routes. These routes allow SAG instances to communicate with on-premises terminals.
cloud
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCountinteger

The total number of routes.

5
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

944C2533-1BB7-4578-B6EB-DA05BB61C02A
PageNumberinteger

The page number of the returned page.

1
Strategiesobject []

A list of route advertisement policies.

Statusstring

The route status. Valid values:

  • normal: The route is working as expected.
  • revoked: The route has been withdrawn.
normal
StrategyPublishStatusstring

The route advertisement status. Valid values:

  • publish: The route has been advertised.
  • not_publish: The route has not been advertised.
publish
RouteDistributionstring

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
CreateTimelong

The timestamp that indicates when the health check instance was created. Unit: milliseconds.

1622617250000
SmartAGIdstring

The ID of the SAG instance.

sag-erx3qta5xg5zyq****
SourceTypestring

The type of the route. Valid values:

  • cloud: Alibaba Cloud-facing routes.
  • local: on-premises network-facing routes.
cloud
IsConflictboolean

Indicates whether routes are overlapped. Valid values:

  • true: yes
  • false: no
false
DestCidrBlockstring

The destination CIDR block.

192.168.3.0/24
ConflictInfostring

The information about overlapped routes.

"10.90.6.0/24":"vbr-wz900pom71qyr6x67qz65,vbr-wz9f8icxnlcom7riz0gfx"
HcInstanceIdstring

The ID of the health check instance.

hc-sztovuprqzgm50****
RouteSourcestring

The source of routes. Valid values:

  • Alibaba Cloud-facing routes

    • Virtual private clouds (VPCs) IDs: Routes that are learned from the VPCs.
    • Virtual border routers (VBRs): Routes that are learned from VBRs.
    • SAG instance IDs: Routes that are learned from SAG instances.
  • On-premises network-facing routes

    • STATIC: Static routes that are specified in the SAG console.
    • OSPF: Routes that are learned through the Open Shortest Path First (OSPF) protocol.
    • BGP: Routes that are learned through Border Gateway Protocol (BGP).
STATIC

Examples

Sample success responses

JSONformat

{
  "TotalCount": 5,
  "PageSize": 10,
  "RequestId": "944C2533-1BB7-4578-B6EB-DA05BB61C02A",
  "PageNumber": 1,
  "Strategies": {
    "Strategy": [
      {
        "Status": "normal",
        "StrategyPublishStatus": "publish",
        "RouteDistribution": "publish",
        "CreateTime": 1622617250000,
        "SmartAGId": "sag-erx3qta5xg5zyq****",
        "SourceType": "cloud",
        "IsConflict": false,
        "DestCidrBlock": "192.168.3.0/24",
        "ConflictInfo": "\"10.90.6.0/24\":\"vbr-wz900pom71qyr6x67qz65,vbr-wz9f8icxnlcom7riz0gfx\"",
        "HcInstanceId": "hc-sztovuprqzgm50****",
        "RouteSource": "STATIC"
      }
    ]
  }
}

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.InvalidSourceTypeThe specified route source type is invalid.The specified route source type is invalid.

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