DescribeVirtualService - 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).

DescribeVirtualService

Describes an existing virtual service.

Request Syntax

GET /v20190125/meshes/meshName/virtualServices/virtualServiceName?meshOwner=meshOwner HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

meshName

The name of the service mesh that the virtual service 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.

virtualServiceName

The name of the virtual service to describe.

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": { "provider": { ... } }, "status": { "status": "string" }, "virtualServiceName": "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 service 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 service.

Type: VirtualServiceSpec object

status

The current status of the virtual service.

Type: VirtualServiceStatus object

virtualServiceName

The name of the virtual service.

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 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

This example describes a virtual service named colorgateway.default.svc.cluster.local in the ecs-mesh service mesh.

Sample Request

GET /v20190125/meshes/ecs-mesh/virtualServices/colorgateway.default.svc.cluster.local HTTP/1.1 Host: appmesh.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20190228T000705Z Authorization: AUTHPARAMS

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: 3b822acc-bd78-4ea6-9831-8cd989dd37ec content-type: application/json content-length: 456 date: Thu, 28 Feb 2019 00:07:04 GMT x-envoy-upstream-service-time: 30 server: envoy Connection: keep-alive { "meshName": "ecs-mesh", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/ecs-mesh/virtualService/colorgateway.default.svc.cluster.local", "createdAt": 1.551311807444E9, "lastUpdatedAt": 1.551311807444E9, "uid": "dd06064b-e542-40a9-bbc7-e381a47ea0e0", "version": 1 }, "spec": { "provider": { "virtualNode": { "virtualNodeName": "colorgateway-vn" }, "virtualRouter": null } }, "status": { "status": "ACTIVE" }, "virtualServiceName": "colorgateway.default.svc.cluster.local" }

See Also

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