文档

DescribePublishedRouteEntries - 查询路由在CEN中的发布情况

更新时间:

您可以调用DescribePublishedRouteEntries接口查询已加载到CEN网络实例(VPC和VBR)的各条路由在CEN中的发布状态、路由条目下一跳关联的实例类型、是否允许发布或撤销该路由到云企业网等信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:DescribePublishedRouteEntriesREAD
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
  • virtualborderrouter
    acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}
  • VPC
    acs:vpc:*:{#accountId}:vpc/{#vpcId}

请求参数

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

查询页码。默认值为 1

1
PageSizeinteger

分页查询时每页显示的条目数。默认值为 10,取值范围:1~50

10
CenIdstring

云企业网实例 ID。

cen-7qthudw0ll6jm****
ChildInstanceIdstring

网络实例 ID。

vpc-bp18sth14qii3pnv****
ChildInstanceTypestring

网络实例类型。取值:

  • VPC:专有网络。

  • VBR:边界路由器。

  • CCN:云连接网。

VPC
ChildInstanceRegionIdstring

网络实例所属地域 ID。

您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。

cn-hangzhou
ChildInstanceRouteTableIdstring

网络实例的路由表 ID。

vtb-bp174d1gje79u1g4****
DestinationCidrBlockstring

要查询的路由条目的目标网段。

172.16.0.0/16

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时每页显示的条目数。

10
RequestIdstring

请求 ID。

FF1A7B2A-677F-4F71-96EA-6002B329F437
PageNumberinteger

查询页码。

1
TotalCountinteger

总条目数。

2
PublishedRouteEntriesobject []

路由条目信息列表。

NextHopIdstring

路由条目下一跳关联的实例 ID。

ecs-bp18sth14qii3pn****
PublishStatusstring

在云企业网中的发布状态:

  • Published:已发布。

  • NonPublished:未发布。

Published
ChildInstanceRouteTableIdstring

网络实例的路由表 ID。

vtb-il7qut3mjgtlcbpk2****
NextHopTypestring

路由条目下一跳关联的实例类型。

  • Instance:ECS 实例。
  • HaVip:高可用虚拟 IP。
  • RouterInterface:路由器接口。
  • NetworkInterface:弹性网卡。
  • VpnGateway:VPN 网关。
  • IPv6Gateway:IPv6 网关。
  • Ipv4Gateway:IPv4 网关。
  • NatGateway:NAT 网关。
  • Attachment:网络实例连接。
  • service:云服务。
  • VBR:边界路由器。
  • CCN:云连接网。
  • VPC:专有网络。
  • local:表示当前路由条目为网络实例的系统路由,没有下一跳。
  • TR:转发路由器。
  • BlackHole:表示当前路由条目为黑洞路由,没有下一跳。
  • EcRouterInterface:高速通道路由器接口。
  • HealthCheck:健康检查。
  • AS:云连接网接入网关。
  • classicLink:经典网络实例。
  • GatewayEndpoint:网关终端节点。
  • CPE:边界路由器连接的本地数据中心。
Instance
OperationalModeboolean

是否允许发布或撤销该路由到云企业网。

  • true:允许发布或撤销。

  • false:不允许发布或撤销。

true
DestinationCidrBlockstring

路由条目的目标网段。

172.16.0.0/16
RouteTypestring

路由条目的类型。

  • CEN:表示通过云企业网传递的路由。
  • System:表示系统路由。
  • Custom:表示自定义路由。
System
Conflictsobject []

产生冲突的路由条目信息列表。

Statusstring

路由条目产生冲突的原因。

  • conflict:路由条目的目标网段相同造成的冲突。

  • overflow:其他网络实例路由表的路由条目数量超出限制造成的冲突。

conflict
DestinationCidrBlockstring

产生冲突的路由条目的目标网段。

192.168.20.0/24
InstanceIdstring

产生路由冲突的对端的网络实例 ID。

ccn-0q3b7oviikmm9h****
InstanceTypestring

产生路由条目冲突的对端的网络实例类型。

  • VPC:专有网络。
  • VBR:边界路由器。
  • CCN:云连接网。
CCN
RegionIdstring

产生路由条目冲突的对端的网络实例所属地域 ID。

ccn-cn-shanghai

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "FF1A7B2A-677F-4F71-96EA-6002B329F437",
  "PageNumber": 1,
  "TotalCount": 2,
  "PublishedRouteEntries": {
    "PublishedRouteEntry": [
      {
        "NextHopId": " ecs-bp18sth14qii3pn****",
        "PublishStatus": "Published",
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2****",
        "NextHopType": "Instance",
        "OperationalMode": true,
        "DestinationCidrBlock": "172.16.0.0/16",
        "RouteType": "System",
        "Conflicts": {
          "Conflict": [
            {
              "Status": "conflict",
              "DestinationCidrBlock": "192.168.20.0/24",
              "InstanceId": "ccn-0q3b7oviikmm9h****",
              "InstanceType": "CCN",
              "RegionId": "ccn-cn-shanghai"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ParameterIllegal.CenInstanceIdThe parameter of CEN instance id is illegal.云企业网ID不正确。
400ParameterIllegal.ChildInstanceRegionIdThe parameter of child instance region id is illegal.网络实例所属地域信息不正确。
400VRC_ERRORVRC error-
400ParameterIllegal.ChildInstanceTypeThe parameter of child instance type is illegal.网络子实例类型不正确。
400ParameterIllegalThe parameter is illegal.参数不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。
404Instance.NotExistThe instance is not exist.指定实例不存在。
409InvalidOperation.ChildInstanceStatusThe child-instance is not in a valid state for the operation.网络子实例正在处理状态,请稍后再操作。
409InvalidOperation.CenInstanceStatusThe CEN instance is not in a valid state for the operation.cen当前状态不支持该操作,请稍后重试。
500InternalErrorInternal error.内部报错。

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

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