amazonaws.com – servicediscovery
Cloud Map
With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:servicediscovery/2017-03-14.json
- Provider
- amazonaws.com:servicediscovery / servicediscovery
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/servicediscovery/2017-03-14/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/servicediscovery/2017-03-14/openapi.yaml
Tools (28)
Extracted live via the executor SDK.
-
xAmzTargetRoute53AutoNamingV20170314CreateHttpNamespace.createHttpNamespaceCreates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
DiscoverInstancesrequest but can't be discovered using DNS.For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see in the Cloud Map Developer Guide.
-
xAmzTargetRoute53AutoNamingV20170314CreatePrivateDnsNamespace.createPrivateDnsNamespaceCreates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace
example.comand name your servicebackend, the resulting DNS name for the service isbackend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either aDiscoverInstancesrequest or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see in the Cloud Map Developer Guide. -
xAmzTargetRoute53AutoNamingV20170314CreatePublicDnsNamespace.createPublicDnsNamespaceCreates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace
example.comand name your servicebackend, the resulting DNS name for the service isbackend.example.com. You can discover instances that were registered with a public DNS namespace by using either aDiscoverInstancesrequest or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see in the Cloud Map Developer Guide.The
CreatePublicDnsNamespaceAPI operation is not supported in the Amazon Web Services GovCloud (US) Regions. -
xAmzTargetRoute53AutoNamingV20170314CreateService.createServiceCreates a service. This action defines the configuration for the following entities:
-
For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
-
A -
AAAA -
AandAAAA -
SRV -
CNAME
-
-
Optionally, a health check
After you create the service, you can submit a request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see in the Cloud Map Developer Guide.
-
-
xAmzTargetRoute53AutoNamingV20170314DeleteNamespace.deleteNamespaceDeletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
-
xAmzTargetRoute53AutoNamingV20170314DeleteService.deleteServiceDeletes a specified service. If the service still contains one or more registered instances, the request fails.
-
xAmzTargetRoute53AutoNamingV20170314DeregisterInstance.deregisterInstanceDeletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
-
xAmzTargetRoute53AutoNamingV20170314DiscoverInstances.discoverInstancesDiscovers registered instances for a specified namespace and service. You can use
DiscoverInstancesto discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances. -
xAmzTargetRoute53AutoNamingV20170314GetInstance.getInstanceGets information about a specified instance.
-
xAmzTargetRoute53AutoNamingV20170314GetInstancesHealthStatus.getInstancesHealthStatusGets the current health status (
Healthy,Unhealthy, orUnknown) of one or more instances that are associated with a specified service.There's a brief delay between when you register an instance and when the health status for the instance is available.
-
xAmzTargetRoute53AutoNamingV20170314GetNamespace.getNamespaceGets information about a namespace.
-
xAmzTargetRoute53AutoNamingV20170314GetOperation.getOperationGets information about any operation that returns an operation ID in the response, such as a
CreateServicerequest.To get a list of operations that match specified criteria, see .
-
xAmzTargetRoute53AutoNamingV20170314GetService.getServiceGets the settings for a specified service.
-
xAmzTargetRoute53AutoNamingV20170314ListInstances.listInstancesLists summary information about the instances that you registered by using a specified service.
-
xAmzTargetRoute53AutoNamingV20170314ListNamespaces.listNamespacesLists summary information about the namespaces that were created by the current Amazon Web Services account.
-
xAmzTargetRoute53AutoNamingV20170314ListOperations.listOperationsLists operations that match the criteria that you specify.
-
xAmzTargetRoute53AutoNamingV20170314ListServices.listServicesLists summary information for all the services that are associated with one or more specified namespaces.
-
xAmzTargetRoute53AutoNamingV20170314ListTagsForResource.listTagsForResourceLists tags for the specified resource.
-
xAmzTargetRoute53AutoNamingV20170314RegisterInstance.registerInstanceCreates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a
RegisterInstancerequest, the following occurs:-
For each DNS record that you define in the service that's specified by
ServiceId, a record is created or updated in the hosted zone that's associated with the corresponding namespace. -
If the service includes
HealthCheckConfig, a health check is created based on the settings in the health check configuration. -
The health check, if any, is associated with each of the new or updated records.
One
RegisterInstancerequest must complete before you can submit another request and specify the same service ID and instance ID.For more information, see .
When Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
-
If the health check is healthy: returns all the records
-
If the health check is unhealthy: returns the applicable value for the last healthy instance
-
If you didn't specify a health check configuration: returns all the records
For the current quota on the number of instances that you can register using the same namespace and using the same service, see in the Cloud Map Developer Guide.
-
-
xAmzTargetRoute53AutoNamingV20170314TagResource.tagResourceAdds one or more tags to the specified resource.
-
xAmzTargetRoute53AutoNamingV20170314UntagResource.untagResourceRemoves one or more tags from the specified resource.
-
xAmzTargetRoute53AutoNamingV20170314UpdateHttpNamespace.updateHttpNamespaceUpdates an HTTP namespace.
-
xAmzTargetRoute53AutoNamingV20170314UpdateInstanceCustomHealthStatus.updateInstanceCustomHealthStatusSubmits a request to change the health status of a custom health check to healthy or unhealthy.
You can use
UpdateInstanceCustomHealthStatusto change the status only for custom health checks, which you define usingHealthCheckCustomConfigwhen you create a service. You can't use it to change the status for Route 53 health checks, which you define usingHealthCheckConfig.For more information, see .
-
xAmzTargetRoute53AutoNamingV20170314UpdatePrivateDnsNamespace.updatePrivateDnsNamespaceUpdates a private DNS namespace.
-
xAmzTargetRoute53AutoNamingV20170314UpdatePublicDnsNamespace.updatePublicDnsNamespaceUpdates a public DNS namespace.
-
xAmzTargetRoute53AutoNamingV20170314UpdateService.updateServiceSubmits a request to perform the following operations:
-
Update the TTL setting for existing
DnsRecordsconfigurations -
Add, update, or delete
HealthCheckConfigfor a specified serviceYou can't add, update, or delete a
HealthCheckCustomConfigconfiguration.
For public and private DNS namespaces, note the following:
-
If you omit any existing
DnsRecordsorHealthCheckConfigconfigurations from anUpdateServicerequest, the configurations are deleted from the service. -
If you omit an existing
HealthCheckCustomConfigconfiguration from anUpdateServicerequest, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
-
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools