Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetNetworkRoutes

Gets the network routes of the specified global network.

Request Syntax


POST /global-networks/globalNetworkId/network-routes HTTP/1.1
Content-type: application/json

{
   "DestinationFilters": { 
      "string" : [ "string" ]
   },
   "ExactCidrMatches": [ "string" ],
   "LongestPrefixMatches": [ "string" ],
   "PrefixListIds": [ "string" ],
   "RouteTableIdentifier": { 
      "CoreNetworkNetworkFunctionGroup": { 
         "CoreNetworkId": "string",
         "EdgeLocation": "string",
         "NetworkFunctionGroupName": "string"
      },
      "CoreNetworkSegmentEdge": { 
         "CoreNetworkId": "string",
         "EdgeLocation": "string",
         "SegmentName": "string"
      },
      "TransitGatewayRouteTableArn": "string"
   },
   "States": [ "string" ],
   "SubnetOfMatches": [ "string" ],
   "SupernetOfMatches": [ "string" ],
   "Types": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

globalNetworkId

The ID of the global network.

Length Constraints: Minimum length of 0. Maximum length of 50.

Pattern: [\s\S]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

DestinationFilters

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

Type: String to array of strings map

Key Length Constraints: Maximum length of 128.

Key Pattern: ^[0-9a-zA-Z\.-]*$

Length Constraints: Maximum length of 255.

Pattern: ^[0-9a-zA-Z\*\.\\/\?-]*$

Required: No

ExactCidrMatches

An exact CIDR block.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

LongestPrefixMatches

The most specific route that matches the traffic (longest prefix match).

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

PrefixListIds

The IDs of the prefix lists.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

RouteTableIdentifier

The ID of the route table.

Type: RouteTableIdentifier object

Required: Yes

States

The route states.

Type: Array of strings

Valid Values: ACTIVE | BLACKHOLE

Required: No

SubnetOfMatches

The routes with a subnet that match the specified CIDR filter.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

SupernetOfMatches

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\s\S]*

Required: No

Types

The route types.

Type: Array of strings

Valid Values: PROPAGATED | STATIC

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CoreNetworkSegmentEdge": { 
      "CoreNetworkId": "string",
      "EdgeLocation": "string",
      "SegmentName": "string"
   },
   "NetworkRoutes": [ 
      { 
         "DestinationCidrBlock": "string",
         "Destinations": [ 
            { 
               "CoreNetworkAttachmentId": "string",
               "EdgeLocation": "string",
               "NetworkFunctionGroupName": "string",
               "ResourceId": "string",
               "ResourceType": "string",
               "SegmentName": "string",
               "TransitGatewayAttachmentId": "string"
            }
         ],
         "PrefixListId": "string",
         "State": "string",
         "Type": "string"
      }
   ],
   "RouteTableArn": "string",
   "RouteTableTimestamp": number,
   "RouteTableType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CoreNetworkSegmentEdge

Describes a core network segment edge.

Type: CoreNetworkSegmentEdgeIdentifier object

NetworkRoutes

The network routes.

Type: Array of NetworkRoute objects

RouteTableArn

The ARN of the route table.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1500.

Pattern: [\s\S]*

RouteTableTimestamp

The route table creation time.

Type: Timestamp

RouteTableType

The route table type.

Type: String

Valid Values: TRANSIT_GATEWAY_ROUTE_TABLE | CORE_NETWORK_SEGMENT | NETWORK_FUNCTION_GROUP

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal error.

RetryAfterSeconds: Indicates when to retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

Context: The specified resource could not be found.
ResourceId: The ID of the resource.
ResourceType: The resource type.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

RetryAfterSeconds: Indicates when to retry the request.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints.

Fields: The fields that caused the error, if applicable.
Reason: The reason for the error.

HTTP Status Code: 400