Queries the routes configured on a network instance that is attached to a Cloud Enterprise Network (CEN) instance.

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 DescribeCenChildInstanceRouteEntries

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

CenId String Yes cen-7qthudw0ll6jmc****

The ID of the CEN instance.

ChildInstanceId String Yes vpc-bp18sth14qii3pnvo****

The ID of the network 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
Status String No Active

The status of the routes that you want to query. Valid values:

  • Active: active routes
  • Candidate: standby routes
  • Rejected: rejected routes
  • Prohibited: prohibited routes
  • All (default value): all routes
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.

Response parameters

Parameter Type Example Description
CenRouteEntries Array of CenRouteEntry

The array of routes.

CenRouteEntry
AsPaths List 65501

The AS paths of the routes.

CenRouteMapRecords Array of CenRouteMapRecord

The route maps that the routes match.

CenRouteMapRecord
RegionId String cn-hangzhou

The ID of the region where the route map is applied.

RouteMapId String cenrmap-w4yf7toozfol3q****

The ID of the route map.

Communities List 65501:1

The community attributes of the routes.

Conflicts Array of Conflict

The array of conflicting routes.

Conflict
DestinationCidrBlock String 192.168.1.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.

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

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

Status String conflict

The cause of the route error. Valid values:

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

The destination CIDR block of the route.

NextHopInstanceId String vbr-bp13gtbhdp0pfqg6s****

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

NextHopRegionId String cn-hangzhou

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

NextHopType String VBR

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.
RouteTableId String vtb-bp1r9pvl4xen8s9ju****

The ID of the route table.

Status String Active

The status of the route. Valid values:

  • Active: The route is active.
  • Candidate: The route is a standby route.
  • Rejected: The route is rejected.
  • Prohibited: The route is prohibited.
Type String CEN

The type of the route. Valid values:

  • CEN: route that is advertised through CEN
  • System: system route
  • Custom: custom route
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 17A57456-EF48-419D-9AE6-9B03D9996018

The ID of the request.

TotalCount Integer 4

The total number of entries returned.

Examples

Sample requests

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

Sample responses

XML format

<DescribeCenChildInstanceRouteEntriesResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>4</TotalCount>
      <PageSize>10</PageSize>
      <RequestId>17A57456-EF48-419D-9AE6-9B03D9996018</RequestId>
      <CenRouteEntries>
            <CenRouteEntry>
                  <NextHopInstanceId>vbr-bp13gtbhdp0pfqg6s****</NextHopInstanceId>
                  <CenRouteMapRecords>
                        <CenRouteMapRecord>
                              <RouteMapId>cenrmap-4lcjxzo2zyqjd3****</RouteMapId>
                              <RegionId>cn-hangzhou</RegionId>
                        </CenRouteMapRecord>
                  </CenRouteMapRecords>
                  <OperationalMode>false</OperationalMode>
                  <Status>Active</Status>
                  <AsPaths></AsPaths>
                  <Communities></Communities>
                  <Type>CEN</Type>
                  <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
                  <NextHopRegionId>cn-hangzhou</NextHopRegionId>
                  <NextHopType>VBR</NextHopType>
                  <Conflicts></Conflicts>
                  <DestinationCidrBlock>10.0.0.0/24</DestinationCidrBlock>
            </CenRouteEntry>
            <CenRouteEntry>
                  <CenRouteMapRecords></CenRouteMapRecords>
                  <OperationalMode>false</OperationalMode>
                  <Status>Active</Status>
                  <AsPaths></AsPaths>
                  <Communities></Communities>
                  <Type>System</Type>
                  <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
                  <NextHopType>service</NextHopType>
                  <Conflicts></Conflicts>
                  <DestinationCidrBlock>100.64.0.0/10</DestinationCidrBlock>
                  <PublishStatus>NonPublished</PublishStatus>
            </CenRouteEntry>
            <CenRouteEntry>
                  <CenRouteMapRecords></CenRouteMapRecords>
                  <OperationalMode>true</OperationalMode>
                  <Status>Active</Status>
                  <AsPaths></AsPaths>
                  <Communities></Communities>
                  <Type>System</Type>
                  <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
                  <NextHopType>local</NextHopType>
                  <Conflicts></Conflicts>
                  <DestinationCidrBlock>172.16.0.0/24</DestinationCidrBlock>
                  <PublishStatus>Published</PublishStatus>
            </CenRouteEntry>
            <CenRouteEntry>
                  <NextHopInstanceId>vbr-bp13gtbhdp0pfqg6s****</NextHopInstanceId>
                  <CenRouteMapRecords>
                        <CenRouteMapRecord>
                              <RouteMapId>cenrmap-4lcjxzo2zyqjd3****</RouteMapId>
                              <RegionId>cn-hangzhou</RegionId>
                        </CenRouteMapRecord>
                  </CenRouteMapRecords>
                  <OperationalMode>false</OperationalMode>
                  <Status>Active</Status>
                  <AsPaths></AsPaths>
                  <Communities></Communities>
                  <Type>CEN</Type>
                  <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
                  <NextHopRegionId>cn-hangzhou</NextHopRegionId>
                  <NextHopType>VBR</NextHopType>
                  <Conflicts></Conflicts>
                  <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>
            </CenRouteEntry>
      </CenRouteEntries>
</DescribeCenChildInstanceRouteEntriesResponse>

JSON format

{
    "PageNumber": 1,
    "TotalCount": 4,
    "PageSize": 10,
    "RequestId": "17A57456-EF48-419D-9AE6-9B03D9996018",
    "CenRouteEntries": {
        "CenRouteEntry": [
            {
                "NextHopInstanceId": "vbr-bp13gtbhdp0pfqg6s****",
                "CenRouteMapRecords": {
                    "CenRouteMapRecord": [
                        {
                            "RouteMapId": "cenrmap-4lcjxzo2zyqjd3****",
                            "RegionId": "cn-hangzhou"
                        }
                    ]
                },
                "OperationalMode": false,
                "Status": "Active",
                "AsPaths": {
                    "AsPath": []
                },
                "Communities": {
                    "Community": []
                },
                "Type": "CEN",
                "RouteTableId": "vtb-bp1r9pvl4xen8s9ju****",
                "NextHopRegionId": "cn-hangzhou",
                "NextHopType": "VBR",
                "Conflicts": {
                    "Conflict": []
                },
                "DestinationCidrBlock": "10.0.0.0/24"
            },
            {
                "CenRouteMapRecords": {
                    "CenRouteMapRecord": []
                },
                "OperationalMode": false,
                "Status": "Active",
                "AsPaths": {
                    "AsPath": []
                },
                "Communities": {
                    "Community": []
                },
                "Type": "System",
                "RouteTableId": "vtb-bp1r9pvl4xen8s9ju****",
                "NextHopType": "service",
                "Conflicts": {
                    "Conflict": []
                },
                "DestinationCidrBlock": "100.64.0.0/10",
                "PublishStatus": "NonPublished"
            },
            {
                "CenRouteMapRecords": {
                    "CenRouteMapRecord": []
                },
                "OperationalMode": true,
                "Status": "Active",
                "AsPaths": {
                    "AsPath": []
                },
                "Communities": {
                    "Community": []
                },
                "Type": "System",
                "RouteTableId": "vtb-bp1r9pvl4xen8s9ju****",
                "NextHopType": "local",
                "Conflicts": {
                    "Conflict": []
                },
                "DestinationCidrBlock": "172.16.0.0/24",
                "PublishStatus": "Published"
            },
            {
                "NextHopInstanceId": "vbr-bp13gtbhdp0pfqg6s****",
                "CenRouteMapRecords": {
                    "CenRouteMapRecord": [
                        {
                            "RouteMapId": "cenrmap-4lcjxzo2zyqjd3****",
                            "RegionId": "cn-hangzhou"
                        }
                    ]
                },
                "OperationalMode": false,
                "Status": "Active",
                "AsPaths": {
                    "AsPath": []
                },
                "Communities": {
                    "Community": []
                },
                "Type": "CEN",
                "RouteTableId": "vtb-bp1r9pvl4xen8s9ju****",
                "NextHopRegionId": "cn-hangzhou",
                "NextHopType": "VBR",
                "Conflicts": {
                    "Conflict": []
                },
                "DestinationCidrBlock": "192.168.2.0/24"
            }
        ]
    }
}

Error codes

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