Queries whether the routes of a network instance attached to a Cloud Enterprise Network (CEN) instance are advertised.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribePublishedRouteEntries

The operation that you want to perform. Set the value to DescribePublishedRouteEntries.

CenId String Yes cen-7qthudw0ll6jm****

The ID of the CEN instance.

ChildInstanceId String Yes vpc-bp18sth14qii3pnv****

The ID of the network instance attached to the CEN instance.

ChildInstanceRegionId String Yes cn-hangzhou

The ID of the region where the network instance is deployed.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

ChildInstanceType String Yes VPC

The type of the network instance. Valid values:

  • VPC
  • VBR
  • CCN
PageNumber Integer No 1

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

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.

ChildInstanceRouteTableId String No vtb-bp174d1gje79u1g4****

The ID of the route table configured on the network instance.

DestinationCidrBlock String No 172.16.0.0/16

The destination CIDR block of the route that you want to query.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries to return on each page.

PublishedRouteEntries Array of PublishedRouteEntry

The array of routes.

PublishedRouteEntry
ChildInstanceRouteTableId String vtb-il7qut3mjgtlcbpk2****

The ID of the route table configured on the network instance.

Conflicts Array of Conflict

The array of conflicting routes.

Conflict
DestinationCidrBlock String 192.168.20.0/24

The destination CIDR block of the conflicting route.

InstanceId String ccn-0q3b7oviikmm9h****

The ID of the peer network instance on which conflicting routes are found.

InstanceType String CCN

The type of the peer network instance on which conflicting routes are found. Valid values:

  • VPC
  • VBR
  • CCN
RegionId String ccn-cn-shanghai

The region ID of the peer network instance on which conflicting routes are found is deployed.

Status String conflict

The cause of the route error. Valid values:

  • conflict: Routes have the same destination CIDR block.
  • overflow: The number of routes in the route table configured on another network instance has reached the upper limit.
DestinationCidrBlock String 172.16.0.0/16

The destination CIDR block of the route.

NextHopId String ecs-bp18sth14qii3pn****

The ID of the instance specified as the next hop in the route.

NextHopType String Instance

The type of the instance specified as the next hop in the route.

  • Instance: ECS instance
  • HaVip: HAVIP
  • RouterInterface: router interface
  • NetworkInterface: ENI
  • VpnGateway: VPN gateway
  • IPv6Gateway: IPv6 gateway
  • NatGateway: NAT gateway
  • Attachment: network instance connection
  • service: cloud service
  • VBR: virtual border router
  • CCN: CCN instance
  • VPC: virtual private cloud
  • local: system route. No next hop is specified.
  • TR: transit router
  • BlackHole: blackhole route. No next hop is specified.
  • EcRouterInterface: router interface for Express Connect
  • HealthCheck: health check
  • AS: access gateway for CCN
  • classic: classic network-type instance
  • GatewayEndpoint: gateway endpoint
  • CPE: data center connected by VBRs
OperationalMode Boolean true

Indicates whether the route is allowed to be advertised to or withdrawn from the CEN instance. Valid values:

  • true: The route is allowed to be advertised to or withdrawn from the CEN instance.
  • false: The route is not allowed to be advertised to or withdrawn from the CEN instance.
PublishStatus String Published

Indicates whether the route is advertised to the CEN instance. Valid values:

  • Published: The route is advertised to the CEN instance.
  • NonPublished: The route is not advertised to the CEN instance.
RouteType String System

The type of the route. Valid values:

  • CEN: route that is advertised through CEN
  • System: system route
  • Custom: custom route
RequestId String FF1A7B2A-677F-4F71-96EA-6002B329F437

The ID of the request.

TotalCount Integer 2

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribePublishedRouteEntries
&CenId=cen-7qthudw0ll6jm****
&ChildInstanceId=vpc-bp18sth14qii3pnv****
&ChildInstanceRegionId=cn-hangzhou
&ChildInstanceType=VPC
&<Common request parameters>

Sample responses

XML format

<DescribeRouteConflictResponse>
      <TotalCount>2</TotalCount>
      <PublishRouteEntries>
            <PublishRouteEntries>
                  <DestinationCidrBlock>100.64.0.0/10</DestinationCidrBlock>
                  <NextHopId></NextHopId>
                  <NextHopType>service</NextHopType>
                  <ChildInstanceRouteTableId>vtb-il7qut3mjgtlcbpk2****</ChildInstanceRouteTableId>
                  <PublishStatus>NonPublished</PublishStatus>
                  <RouteConflicts></RouteConflicts>
                  <RouteType>System</RouteType>
            </PublishRouteEntries>
            <PublishRouteEntries>
                  <DestinationCidrBlock>192.168.10.0/24</DestinationCidrBlock>
                  <NextHopId></NextHopId>
                  <NextHopType>local</NextHopType>
                  <ChildInstanceRouteTableId>vtb-il7qut3mjgtlcbpk2****</ChildInstanceRouteTableId>
                  <PublishStatus>Published</PublishStatus>
                  <RouteConflicts></RouteConflicts>
                  <RouteType>System</RouteType>
            </PublishRouteEntries>
      </PublishRouteEntries>
      <PageNumber>1</PageNumber>
      <RequestId>FF1A7B2A-677F-4F71-96EA-6002B329F437</RequestId>
      <PageSize>10</PageSize>
</DescribeRouteConflictResponse>

JSON format

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

Error codes

HttpCode Error codes Error message Description
400 ParameterIllegal.CenInstanceId The parameter of CEN instance id is illegal. The error message returned because the ID of the CEN instance is invalid.
400 ParameterIllegal.ChildInstanceRegionId The parameter of child instance region id is illegal. The error message returned because the ID of the region where the network instance is created is invalid.
409 InvalidOperation.ChildInstanceStatus The child-instance is not in a valid state for the operation. The error message returned because the operation is not allowed when the network instance is being processed. Try again later.
409 InvalidOperation.CenInstanceStatus The CEN instance is not in a valid state for the operation. The error message returned because the CEN instance is being processed. Try again later.
400 ParameterIllegal.ChildInstanceType The parameter of child instance type is illegal. The error message returned because the type of the network instance is invalid.
500 InternalError Internal error. The error message returned because an internal error occurred.

For a list of error codes, visit the API Error Center.