AWS Cloud Map
API Reference (API Version 2017-03-14)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


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.


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

Type: String

Length Constraints: Maximum length of 64.

Required: Yes


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.


A complex type that contains information about a specified instance.

Type: Instance object


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


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


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


No service exists with the specified ID.

HTTP Status Code: 400


GetInstance Example

Sample Request

POST / HTTP/1.1 x-amz-date:20181118T211816Z authorization: AWS4-HMAC-SHA256 Credential=AKIAIIO2CIV3EXAMPLE/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: 59 Content-Type: application/x-amz-json-1.1 { "Instance": { "Id": "i-abcd1234", "Attributes": { "AWS_INSTANCE_IPV4": "", "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 AWS SDKs, see the following: