DiscoverInstancesRequest

Request body for discovering instances.

Cloud MapService DiscoveryMicroservicesDNS

Properties

Name	Type	Description
NamespaceName	string	The HttpName name of the namespace.
ServiceName	string	The name of the service that you specified when you registered the instance.
MaxResults	integer	The maximum number of instances that you want Cloud Map to return.
HealthStatus	string	The health status of the instances that you want to discover.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cloud-map/refs/heads/main/json-schema/cloud-map-discover-instances-request-schema.json",
  "title": "DiscoverInstancesRequest",
  "description": "Request body for discovering instances.",
  "type": "object",
  "properties": {
    "NamespaceName": {
      "type": "string",
      "description": "The HttpName name of the namespace.",
      "example": "production.internal"
    },
    "ServiceName": {
      "type": "string",
      "description": "The name of the service that you specified when you registered the instance.",
      "example": "payment-service"
    },
    "MaxResults": {
      "type": "integer",
      "description": "The maximum number of instances that you want Cloud Map to return."
    },
    "HealthStatus": {
      "type": "string",
      "enum": [
        "HEALTHY",
        "UNHEALTHY",
        "ALL",
        "HEALTHY_OR_ELSE_ALL"
      ],
      "description": "The health status of the instances that you want to discover."
    }
  },
  "required": [
    "NamespaceName",
    "ServiceName"
  ]
}