文档

DescribeRouteDistributionStrategies - 查询路由发布策略

更新时间:

调用DescribeRouteDistributionStrategies查询路由发布策略。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

智能接入网关实例的地域 ID。

cn-shanghai
SmartAGIdstring

智能接入网关实例 ID。

sag-erx3qta5xg5zyq****
SourceTypestring

路由类型:

  • cloud:云上路由。智能接入网关到云上资源的路由。

  • local:线下路由。智能接入网关到线下节点的路由。

cloud
PageNumberinteger

当前分页的页码数。默认值为 1

1
PageSizeinteger

分页展示时,每个分页包含的列表条目数。默认为 10

10

返回参数

名称类型描述示例值
object
TotalCountinteger

总共的路由条目数。

5
PageSizeinteger

分页展示时,每个分页包含的列表条目数。

10
RequestIdstring

请求 ID。

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

当前分页的页码数。

1
Strategiesobject []

路由策略列表。

Statusstring

路由状态:

  • normal:正常。

  • revoked:已撤销。

normal
StrategyPublishStatusstring

路由发布状态:

  • publish:已发布。

  • not_publish:未发布。

publish
RouteDistributionstring

路由发布策略:

  • publish:发布。
  • no_publish:不发布。
  • no_publish_and_publish_on_health_success:不发布-健康检查成功时发布。
  • no_publish_and_publish_on_health_fail:不发布-健康检查失败时发布。
  • publish_and_revoke_on_health_success:发布-健康检查成功时撤销。
  • publish_and_revoke_on_health_fail:发布-健康检查失败时撤销。

更多详情请参见关联健康检查路由发布

publish
CreateTimelong

健康检查实例的创建时间戳,单位为毫秒。

1622617250000
SmartAGIdstring

智能接入网关实例 ID。

sag-erx3qta5xg5zyq****
SourceTypestring

路由类型:

  • cloud:云上路由。

  • local:线下路由。

cloud
IsConflictboolean

是否存在路由冲突:

  • true:是。

  • false:否。

false
DestCidrBlockstring

目标网段。

192.168.3.0/24
ConflictInfostring

路由冲突信息。

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

健康检查实例 ID。

hc-sztovuprqzgm50****
RouteSourcestring

路由来源:

  • 云上路由

    • 专有网络(VPC)实例 ID:通过 VPC 学来的路由。
    • 虚拟边界路由器(VBR)实例 ID:通过 VBR 学来的路由。
    • 智能接入网关(SAG)实例 ID:通过 SAG 学来的路由。
  • 线下路由

    • STATIC:通过管理控制台添加的静态路由。
    • OSPF:通过 OSPF 路由协议学习来的路由。
    • BGP:通过 BGP 路由协议学习来的路由。
STATIC

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.智能接入网关实例ID为空。
400SAG.InstanceNoFoundThe specified SAG instance does not exist.智能接入网关实例不存在。
400RD.InvalidSourceTypeThe specified route source type is invalid.非法的路由来源类型。

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈