GetInstance - Amazon Cloud Map
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.

GetInstance

Gets information about a specified instance.

Request Syntax

{ "InstanceId": "string", "ServiceId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InstanceId

The ID of the instance that you want to get information about.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

ServiceId

The ID of the service that the instance is associated with.

Type: String

Length Constraints: Maximum length of 64.

Required: Yes

Response Syntax

{ "Instance": { "Attributes": { "string" : "string" }, "CreatorRequestId": "string", "Id": "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.

Instance

A complex type that contains information about a specified instance.

Type: Instance object

Errors

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

InstanceNotFound

No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

HTTP Status Code: 400

InvalidInput

One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

HTTP Status Code: 400

ServiceNotFound

No service exists with the specified ID.

HTTP Status Code: 400

Examples

GetInstance Example

This example illustrates one usage of GetInstance.

Sample Request

POST / HTTP/1.1 host:servicediscovery.us-west-2.amazonaws.com x-amz-date:20181118T211816Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20181118/us-west-2/servicediscovery/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target, Signature=[calculated-signature] x-amz-target:Route53AutoNaming_v20170314.GetInstance content-type:application/x-amz-json-1.1 content-length:[number of characters in the JSON string] { "InstanceId": "i-abcd1234", "ServiceId": "srv-e4anhexample0004" }

Sample Response

HTTP/1.1 200 Content-Length: [number of characters in the JSON string] Content-Type: application/x-amz-json-1.1 { "Instance": { "Id": "i-abcd1234", "Attributes": { "AWS_INSTANCE_IPV4": "192.0.2.44", "AWS_INSTANCE_PORT": "80", "color": "green", "region": "us-west-2", "stage": "beta" } } }

See Also

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