AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . servicediscovery ]
Discovers registered instances for a specified namespace and service. You can use DiscoverInstances
to discover instances for any type of namespace. DiscoverInstances
returns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.
See also: AWS API Documentation
discover-instances
--namespace-name <value>
--service-name <value>
[--max-results <value>]
[--query-parameters <value>]
[--optional-parameters <value>]
[--health-status <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--namespace-name
(string)
TheHttpName
name of the namespace. It's found in theHttpProperties
member of theProperties
member of the namespace. In most cases,Name
andHttpName
match. However, if you reuseName
for namespace creation, a generated hash is added toHttpName
to distinguish the two.
--service-name
(string)
The name of the service that you specified when you registered the instance.
--max-results
(integer)
The maximum number of instances that you want Cloud Map to return in the response to aDiscoverInstances
request. If you don't specify a value forMaxResults
, Cloud Map returns up to 100 instances.
--query-parameters
(map)
Filters to scope the results based on custom attributes for the instance (for example,
{version=v1, az=1a}
). Only instances that match all the specified key-value pairs are returned.key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--optional-parameters
(map)
Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the
QueryParameters
parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in theQueryParameters
parameter are returned.key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--health-status
(string)
The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.
HEALTHYReturns healthy instances.
UNHEALTHYReturns unhealthy instances.
ALLReturns all instances.
HEALTHY_OR_ELSE_ALLReturns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.
Possible values:
HEALTHY
UNHEALTHY
ALL
HEALTHY_OR_ELSE_ALL
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To discover registered instances
The following discover-instances
example discovers registered instances.
aws servicediscovery discover-instances \
--namespace-name example.com \
--service-name myservice \
--max-results 10 \
--health-status ALL
Output:
{
"Instances": [
{
"InstanceId": "myservice-53",
"NamespaceName": "example.com",
"ServiceName": "myservice",
"HealthStatus": "UNKNOWN",
"Attributes": {
"AWS_INSTANCE_IPV4": "172.2.1.3",
"AWS_INSTANCE_PORT": "808"
}
}
]
}
Instances -> (list)
A complex type that contains one
HttpInstanceSummary
for each registered instance.(structure)
In a response to a DiscoverInstances request,
HttpInstanceSummary
contains information about one instance that matches the values that you specified in the request.InstanceId -> (string)
The ID of an instance that matches the values that you specified in the request.NamespaceName -> (string)
TheHttpName
name of the namespace. It's found in theHttpProperties
member of theProperties
member of the namespace.ServiceName -> (string)
The name of the service that you specified when you registered the instance.HealthStatus -> (string)
If you configured health checking in the service, the current health status of the service instance.Attributes -> (map)
If you included any attributes when you registered the instance, the values of those attributes.
key -> (string)
value -> (string)
InstancesRevision -> (long)
The increasing revision associated to the response Instances list. If a new instance is registered or deregistered, theInstancesRevision
updates. The health status updates don't updateInstancesRevision
.