Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

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 Amazon Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Amazon 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 another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Type: String

Length Constraints: Maximum length of 4096.

Required: No

ServiceId

The ID or Amazon Resource Name (ARN) of the service that you want to list instances for. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Amazon Cloud Map namespace sharing in the Amazon Cloud Map Developer Guide.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "Instances": [ 
      { 
         "Attributes": { 
            "string" : "string" 
         },
         "CreatedByAccount": "string",
         "Id": "string"
      }
   ],
   "NextToken": "string",
   "ResourceOwner": "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

Type: String

Length Constraints: Maximum length of 4096.

ResourceOwner

The ID of the Amazon account that created the namespace that contains the specified service. If this isn't your account ID, it's the ID of the account that shared the namespace with your account.

Type: String

Length Constraints: Fixed length of 12.

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 request lists information about all instances associated with the specified service.

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"
            },
            "CreatedByAccount": "123456789012"
        },
        {
            "Id": "i-abcd1235",
            "Attributes": {
                "AWS_INSTANCE_IPV4": "192.0.2.45",
                "AWS_INSTANCE_PORT": "80",
                "color": "blue",
                "region": "us-west-2",
                "stage": "beta"
            },
            "CreatedByAccount": "123456789012"
        }
    ],
    "ResourceOwner": "123456789012"
}

ListInstances Example using service ARN

This example request lists information about all instances associated with a service in a shared namespace using the service ARN. The blue service is created by namespace consumer 111122223333 and the green service is created by the namespace owner 123456789012.

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": "arn:aws:servicediscovery:us-west-2:123456789012:service/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"
            },
            "CreatedByAccount": "123456789012"
        },
        {
            "Id": "i-abcd1235",
            "Attributes": {
                "AWS_INSTANCE_IPV4": "192.0.2.45",
                "AWS_INSTANCE_PORT": "80",
                "color": "blue",
                "region": "us-west-2",
                "stage": "beta"
            },
            "CreatedByAccount": "111122223333"
        }
    ],
    "ResourceOwner": "123456789012"
}