All Products
Search
Document Center

Cloud Enterprise Network:ListCenChildInstanceRouteEntriesToAttachment

Last Updated:Oct 22, 2024

Queries routes in route tables of network instances that point to network instance connections on Enterprise Edition transit routers.

Operation description

Before you call the ListCenChildInstanceRouteEntriesToAttachment operation, make sure that all request parameter values are valid. If a parameter is set to an invalid value, a request ID is returned, but the routes to the network instance are not returned.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cen:ListCenChildInstanceRouteEntriesToAttachmentget
  • TransitRouterPeerAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MaxResultsintegerNo

The number of entries to return on each page. Default value: 20.

20
NextTokenstringNo

The token that determines the start point of the query. Valid values:

  • If this is your first query and no subsequent queries are to be sent, ignore this parameter.
  • If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
CenIdstringNo

The ID of the CEN instance.

cen-dc4vwznpwbobrl****
ChildInstanceRouteTableIdstringYes

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

vtb-bp174d1gje79u1g4t****
TransitRouterAttachmentIdstringYes

The ID of the network instance connection.

tr-attach-r6g0m3epjehw57****
RouteFilterarray<object>No

The filter condition for the destination CIDR block.

objectNo
KeystringNo

The match mode of the route.

  • prefix-exact-match: exact match.
prefix-exact-match
ValuearrayNo

The destination CIDR blocks.

stringNo

The destination CIDR block.

10.0.0.0/8
ServiceTypestringNo

Specifies whether to host the route. If you leave the parameter empty, the route is not hosted. A value of TR specifies that the route is hosted on a transit router.

TR

Response parameters

ParameterTypeDescriptionExample
object

The response.

NextTokenstring

The token that determines the start point of the next query. Valid values:

  • If NextToken is not returned, it indicates that no additional results exist.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The ID of the region.

530BC816-F575-412A-AAB2-435125D26328
RouteEntryarray<object>

The detailed information about the route.

TransitRouterAssociationobject

The detailed information about the route.

CenIdstring

The ID of the CEN instance.

cen-9adwg6ghpq8oq4dp7q
TransitRouterAttachmentIdstring

The ID of the network instance connection.

tr-attach-y463sghkkv1loe****
Statusstring

The status of the route. Valid values:

  • Available: The route is available.
  • Pending: The route is being configured.
  • Modifying: the route is being modified.
Available
ServiceTypestring

Indicates whether the route is hosted. If the parameter is empty, the route is not hosted. A value of TR indicates that the route is hosted on a transit router.

TR
DestinationCidrBlockstring

The destination CIDR block of the route.

10.0.0.0/8
ChildInstanceRouteTableIdstring

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

vtb-bp1tlaj1c4nxr2t3e****

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "530BC816-F575-412A-AAB2-435125D26328",
  "RouteEntry": [
    {
      "CenId": "cen-9adwg6ghpq8oq4dp7q",
      "TransitRouterAttachmentId": "tr-attach-y463sghkkv1loe****",
      "Status": "Available",
      "ServiceType": "TR",
      "DestinationCidrBlock": "10.0.0.0/8",
      "ChildInstanceRouteTableId": "vtb-bp1tlaj1c4nxr2t3e****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.NextTokenThe parameter NextToken is invalid.The error message returned because the NextToken parameter is set to an invalid value. Check the value and try again.
400MissingParam.TransitRouterAttachmentIdThe parameter TransitRouterAttachmentId is Missing.The error message returned because the TransitRouterAttachmentId parameter is not set.
400MissingParam.ChildInstanceRouteTableIdThe parameter ChildInstanceRouteTableId is Missing.-
400MissingParam.ChildInstanceRouteTableIdThe parameter TransitRouterAttachmentId is Missing.The error message returned because the ChildInstanceRouteTableId parameter is not set.
400InvalidParam.RouteFilterThe parameter RouteFilter is invalid.The error message returned because the specified route filter is invalid.
400ResourceNotFound.TransitRouterAttachmentThe specified TransitRouterAttachment does not exist.-
400InvalidParam.RoutFilterKeyThe specified Key of RouteFilter is invalid.The error message returned because the specified route filter key is invalid.
400InvalidParam.CenIdThe specified CEN does not exist.-
400OperationFailed.CenInstanceStatusThe CEN instance is not in a valid state for the operation.-
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history