DescribeRouteDistributionStrategies - Smart Access Gateway

Queries route advertisement policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeRouteDistributionStrategies	get	All Resources ``	none	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-erx3qta5xg5zyq****
SourceType	string	Yes	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
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of routes.	5
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	944C2533-1BB7-4578-B6EB-DA05BB61C02A
PageNumber	integer	The page number of the returned page.	1
Strategies	array<object>	A list of route advertisement policies.
Strategy	object
Status	string	The route status. Valid values: normal: The route is working as expected. revoked: The route has been withdrawn.	normal
StrategyPublishStatus	string	The route advertisement status. Valid values: publish: The route has been advertised. not_publish: The route has not been advertised.	publish
RouteDistribution	string	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
CreateTime	long	The timestamp that indicates when the health check instance was created. Unit: milliseconds.	1622617250000
SmartAGId	string	The ID of the SAG instance.	sag-erx3qta5xg5zyq****
SourceType	string	The type of the route. Valid values: cloud: Alibaba Cloud-facing routes. local: on-premises network-facing routes.	cloud
IsConflict	boolean	Indicates whether routes are overlapped. Valid values: true: yes false: no	false
DestCidrBlock	string	The destination CIDR block.	192.168.3.0/24
ConflictInfo	string	The information about overlapped routes.	"10.90.6.0/24":"vbr-wz900pom71qyr6x67qz65,vbr-wz9f8icxnlcom7riz0gfx"
HcInstanceId	string	The ID of the health check instance.	hc-sztovuprqzgm50****
RouteSource	string	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 code	Error code	Error message	Description
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	RD.InvalidSourceType	The specified route source type is invalid.	The specified route source type is invalid.

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