ListGatewayRoutes
Returns a list of existing gateway routes that are associated to a virtual gateway.
Request Syntax
GET /v20190125/meshes/meshName
/virtualGateway/virtualGatewayName
/gatewayRoutes?limit=limit
&meshOwner=meshOwner
&nextToken=nextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- limit
-
The maximum number of results returned by
ListGatewayRoutes
in paginated output. When you use this parameter,ListGatewayRoutes
returns onlylimit
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListGatewayRoutes
request with the returnednextToken
value. This value can be between 1 and 100. If you don't use this parameter,ListGatewayRoutes
returns up to 100 results and anextToken
value if applicable.Valid Range: Minimum value of 1. Maximum value of 100.
- meshName
-
The name of the service mesh to list gateway routes in.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- meshOwner
-
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
Length Constraints: Fixed length of 12.
- nextToken
-
The
nextToken
value returned from a previous paginatedListGatewayRoutes
request wherelimit
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. - virtualGatewayName
-
The name of the virtual gateway to list gateway routes in.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"gatewayRoutes": [
{
"arn": "string",
"createdAt": number,
"gatewayRouteName": "string",
"lastUpdatedAt": number,
"meshName": "string",
"meshOwner": "string",
"resourceOwner": "string",
"version": number,
"virtualGatewayName": "string"
}
],
"nextToken": "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.
- gatewayRoutes
-
The list of existing gateway routes for the specified service mesh and virtual gateway.
Type: Array of GatewayRouteRef objects
- nextToken
-
The
nextToken
value to include in a futureListGatewayRoutes
request. When the results of aListGatewayRoutes
request exceedlimit
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
Errors
- BadRequestException
-
The request syntax was malformed. Check your request syntax and try again.
HTTP Status Code: 400
- ForbiddenException
-
You don't have permissions to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- NotFoundException
-
The specified resource doesn't exist. Check your request syntax and try again.
HTTP Status Code: 404
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the service.
HTTP Status Code: 503
- TooManyRequestsException
-
The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.
HTTP Status Code: 429
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an AWS Signature Version 4
signature. For more information about creating these signatures, see Signature
Version 4 Signing Process in the
AWS General
Reference.
You need to learn how to sign HTTP requests only if you intend to manually
create them. When you use the AWS Command Line Interface (AWS CLI)
Example
The following example lists gateway routes that are associated with the virtual
gateway named myVirtualGateway
in the apps
service mesh.
Sample Request
GET /v20190125/meshes/apps/virtualGateway/myVirtualGateway/gatewayRoutes HTTP/1.1
Host: appmesh.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20200608T190053Z
Authorization: AUTHPARAMS
Sample Response
HTTP/1.1 200 OK
x-amzn-requestid: b82c3691-a7a9-4d99-acf6-0f9a81db9beb
content-type: application/json
content-length: 393
date: Mon, 08 Jun 2020 20:52:25 GMT
x-envoy-upstream-service-time: 26
server: envoy
Connection: keep-alive
{
"gatewayRoutes": [{
"arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualGateway/myVirtualGateway/gatewayRoute/myGatewayRoute",
"createdAt": 1.591642091122E9,
"gatewayRouteName": "myGatewayRoute",
"lastUpdatedAt": 1.591642091122E9,
"meshName": "myApps",
"meshOwner": "123456789012",
"resourceOwner": "123456789012",
"version": 1,
"virtualGatewayName": "myVirtualGateway"
}],
"nextToken": null
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: