ListInstances
Lists summary information about the instances that you registered by using a specified service.
Request Syntax
{
"MaxResults": number
,
"NextToken": "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.
- MaxResults
-
The maximum number of instances that you want AWS Cloud Map to return in the response to a
ListInstances
request. If you don't specify a value forMaxResults
, AWS Cloud Map returns up to 100 instances.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
For the first
ListInstances
request, omit this value.If more than
MaxResults
instances match the specified criteria, you can submit anotherListInstances
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Type: String
Length Constraints: Maximum length of 4096.
Required: No
- ServiceId
-
The ID of the service that you want to list instances for.
Type: String
Length Constraints: Maximum length of 64.
Required: Yes
Response Syntax
{
"Instances": [
{
"Attributes": {
"string" : "string"
},
"Id": "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.
- Instances
-
Summary information about the instances that are associated with the specified service.
Type: Array of InstanceSummary objects
- NextToken
-
If more than
MaxResults
instances match the specified criteria, you can submit anotherListInstances
request to get the next group of results. Specify the value ofNextToken
from the previous response in the next request.Type: String
Length Constraints: Maximum length of 4096.
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
ListInstances Example
This example illustrates one usage of ListInstances.
Sample Request
POST / HTTP/1.1
host:servicediscovery.us-west-2.amazonaws.com
x-amz-date:20181118T211817Z
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.ListInstances
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"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
{
"Instances": [
{
"Id": "i-abcd1234",
"Attributes": {
"AWS_INSTANCE_IPV4": "192.0.2.44",
"AWS_INSTANCE_PORT": "80",
"color": "green",
"region": "us-west-2",
"stage": "beta"
}
},
{
"Id": "i-abcd1235",
"Attributes": {
"AWS_INSTANCE_IPV4": "192.0.2.45",
"AWS_INSTANCE_PORT": "80",
"color": "blue",
"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: