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

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cen:DescribePublishedRouteEntries

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

*virtualborderrouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

*VPC

acs:vpc:*:{#accountId}:vpc/{#vpcId}

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

查询页码。默认值为 1

1

PageSize

integer

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

10

CenId

string

云企业网实例 ID。

cen-7qthudw0ll6jm****

ChildInstanceId

string

网络实例 ID。

vpc-bp18sth14qii3pnv****

ChildInstanceType

string

网络实例类型。取值:

  • VPC:专有网络。

  • VBR:边界路由器。

  • CCN:云连接网。

VPC

ChildInstanceRegionId

string

网络实例所属地域 ID。

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

cn-hangzhou

ChildInstanceRouteTableId

string

网络实例的路由表 ID。

vtb-bp174d1gje79u1g4****

DestinationCidrBlock

string

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

172.16.0.0/16

返回参数

名称

类型

描述

示例值

object

PageSize

integer

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

10

RequestId

string

请求 ID。

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

PageNumber

integer

查询页码。

1

TotalCount

integer

总条目数。

2

PublishedRouteEntries

object

PublishedRouteEntry

array<object>

路由条目信息列表。

object

NextHopId

string

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

ecs-bp18sth14qii3pn****

PublishStatus

string

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

  • Published:已发布。

  • NonPublished:未发布。

Published

ChildInstanceRouteTableId

string

网络实例的路由表 ID。

vtb-il7qut3mjgtlcbpk2****

NextHopType

string

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

  • 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

OperationalMode

boolean

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

  • true:允许发布或撤销。

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

true

DestinationCidrBlock

string

路由条目的目标网段。

172.16.0.0/16

RouteType

string

路由条目的类型。

  • CEN:表示通过云企业网传递的路由。

  • System:表示系统路由。

  • Custom:表示自定义路由。

System

Conflicts

object

Conflict

array<object>

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

object

Status

string

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

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

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

conflict

DestinationCidrBlock

string

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

192.168.20.0/24

InstanceId

string

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

ccn-0q3b7oviikmm9h****

InstanceType

string

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

  • VPC:专有网络。

  • VBR:边界路由器。

  • CCN:云连接网。

CCN

RegionId

string

产生路由条目冲突的对端的网络实例所属地域 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"
            }
          ]
        }
      }
    ]
  }
}

异常返回示例

JSON格式

{
  "TotalCount": 2, 
  "PublishRouteEntries": {
    "PublishRouteEntries": [
      {
        "DestinationCidrBlock": "100.64.0.0/10", 
        "NextHopId": "", 
        "NextHopType": "service", 
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2ie31", 
        "PublishStatus": "NonPublished", 
        "RouteConflicts": {
          "RouteConflicts": []
        }, 
        "RouteType": "System"
      }, 
      {
        "DestinationCidrBlock": "192.168.10.0/24", 
        "NextHopId": "", 
        "NextHopType": "local", 
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2ie31", 
        "PublishStatus": "Published", 
        "RouteConflicts": {
          "RouteConflicts": []
        }, 
        "RouteType": "System"
      }
    ]
  }, 
  "PageNumber": 1, 
  "RequestId": "FF1A7B2A-677F-4F71-96EA-6002B329F437", 
  "PageSize": 10
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterIllegal.CenInstanceId The parameter of CEN instance id is illegal.
400 ParameterIllegal.ChildInstanceRegionId The parameter of child instance region id is illegal.
400 VRC_ERROR VRC error
400 ParameterIllegal.ChildInstanceType The parameter of child instance type is illegal.
400 ParameterIllegal The parameter is illegal. 参数不合法。
400 InvalidParameter Invalid parameter. 参数不合法。
400 Unauthorized The AccessKeyId is unauthorized. 账号无权限操作。
500 InternalError Internal error.
404 Instance.NotExist The instance is not exist. 指定实例不存在。
409 InvalidOperation.ChildInstanceStatus The child-instance is not in a valid state for the operation.
409 InvalidOperation.CenInstanceStatus The CEN instance is not in a valid state for the operation. cen当前状态不支持该操作,请稍后重试。

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

变更历史

更多信息,参考变更详情