DescribeVirtualGateway - Amazon App Mesh
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DescribeVirtualGateway

Describes an existing virtual gateway.

Request Syntax

GET /v20190125/meshes/meshName/virtualGateways/virtualGatewayName?meshOwner=meshOwner HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

meshName

The name of the service mesh that the gateway route resides in.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

meshOwner

The Amazon 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.

virtualGatewayName

The name of the virtual gateway to describe.

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 { "meshName": "string", "metadata": { "arn": "string", "createdAt": number, "lastUpdatedAt": number, "meshOwner": "string", "resourceOwner": "string", "uid": "string", "version": number }, "spec": { "backendDefaults": { "clientPolicy": { "tls": { "certificate": { ... }, "enforce": boolean, "ports": [ number ], "validation": { "subjectAlternativeNames": { "match": { "exact": [ "string" ] } }, "trust": { ... } } } } }, "listeners": [ { "connectionPool": { ... }, "healthCheck": { "healthyThreshold": number, "intervalMillis": number, "path": "string", "port": number, "protocol": "string", "timeoutMillis": number, "unhealthyThreshold": number }, "portMapping": { "port": number, "protocol": "string" }, "tls": { "certificate": { ... }, "mode": "string", "validation": { "subjectAlternativeNames": { "match": { "exact": [ "string" ] } }, "trust": { ... } } } } ], "logging": { "accessLog": { ... } } }, "status": { "status": "string" }, "virtualGatewayName": "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.

meshName

The name of the service mesh that the virtual gateway resides in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

metadata

An object that represents metadata for a resource.

Type: ResourceMetadata object

spec

The specifications of the virtual gateway.

Type: VirtualGatewaySpec object

status

The current status of the virtual gateway.

Type: VirtualGatewayStatus object

virtualGatewayName

The name of the virtual gateway.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

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 Amazon Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI) or one of the Amazon SDKs to make requests to Amazon, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

The following example describes a virtual gateway named myVirtualGateway that is in the apps service mesh.

Sample Request

GET /v20190125/meshes/apps/virtualGateways/myVirtualGateway 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: 20200706T145910Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: 52e5ee7c-7434-4ca0-885e-5c9d8a7bbaf8 content-type: application/json content-length: 513 date: Mon, 06 Jul 2020 14:59:10 GMT x-envoy-upstream-service-time: 19 server: envoy Connection: keep-alive { "meshName": "apps", "metadata": { "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualGateway/myVirtualGateway", "createdAt": 1.594046778215E9, "lastUpdatedAt": 1.594046778215E9, "meshOwner": "123456789012", "resourceOwner": "123456789012", "uid": "ff111ff2-33ff-4ff4-ffff-111f111f111f", "version": 1 }, "spec": { "backendDefaults": null, "listeners": [{ "healthCheck": null, "portMapping": { "port": 80, "protocol": "http2" }, "tls": null }], "logging": null }, "status": { "status": "ACTIVE" }, "virtualGatewayName": "myVirtualGateway" }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: