All Products
Search
Document Center

Cloud Enterprise Network:DescribeTransitRouteTableAggregation

Last Updated:Oct 22, 2024

Queries the aggregate routes on an Enterprise Edition transit router.

Operation description

You can set the TransitRouteTableId and TransitRouteTableAggregationCidr parameters to specify the aggregate routes that you want to query. If you set only the TransitRouteTableId parameter, all aggregate routes in the specified route table are queried.

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:DescribeTransitRouteTableAggregationget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransitRouteTableIdstringYes

The ID of the route table of the Enterprise Edition transit router.

vtb-6ehgc262hr170qgyc****
TransitRouteTableAggregationCidrstringNo

The destination CIDR block of the aggregate route.

192.168.10.0/24
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can only contain ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
02fb3da4-130e-11e9-8e44-001****
MaxResultslongNo

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 or no subsequent query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataarray<object>

A list of aggregate routes.

Dataobject

The information about the aggregate route.

Namestring

The name of the aggregate route.

nametest
TransitRouteTableAggregationCidrstring

The destination CIDR block of the aggregate route.

192.168.10.0/24
Scopestring

The scope of networks that you want to advertise the aggregate route.

The valid value is VPC, which indicates that the aggregate route is advertised to all virtual private clouds (VPCs) that are in associated forwarding correlation with the Enterprise Edition transit router and have route synchronization enabled.

VPC
RouteTypestring

The type of the aggregate route.

The valid value is Static, which indicates a static route. By default, aggregate routes advertised to a VPC are considered custom routes.

Static
Descriptionstring

The description of the aggregate route.

desctest
TrRouteTableIdstring

The ID of the route table of the Enterprise Edition transit router.

vtb-6ehgc262hr170qgyc****
Statusstring

The status of the advertisement of the aggregate route. Valid values:

  • AllConfigured: The aggregate route is advertised to all VPCs.
  • Configuring: The aggregate route is being advertised.
  • ConfigFailed: The aggregate route failed to be advertised.
  • PartialConfigured: Failed to advertise the aggregate route to some VPCs.
  • Deleting: The aggregate route is being deleted.
AllConfigured
Countinteger

The number of entries returned per page.

20
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:

  • If NextToken is empty, no next page exists.
  • If a value is returned for NextToken, the value is the token that determines the start point of the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
Totalinteger

The total number of entries returned.

1
RequestIdstring

The ID of the request.

0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

Examples

Sample success responses

JSONformat

{
  "Data": [
    {
      "Name": "nametest",
      "TransitRouteTableAggregationCidr": "192.168.10.0/24",
      "Scope": "VPC",
      "RouteType": "Static",
      "Description": "desctest",
      "TrRouteTableId": "vtb-6ehgc262hr170qgyc****",
      "Status": "AllConfigured"
    }
  ],
  "Count": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "Total": 1,
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParam.transitRouterRouteTableIdMissing the parameter transitRouter route table id.The error message returned because the transitRouterRouteTableId parameter is not set.
400IllegalParam.NextTokenThe nextToken is illegal.The error message returned because the NextToken parameter is set to an invalid value.
400InstanceNotExist.TransitRouterRouteTableThe transitRouter route table is not found.-
400InvalidCidrBlockThe transitRouteTableAggregationCidr is invalid.-
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
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
2023-08-04The Error code has changedView Change Details
2023-03-22The Error code has changedView Change Details