Amazon Web Services, Inc.

AWS Cloud Map

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…

Maps & location#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 30

  • POSTCreate http namespace/#X-Amz-Target=Route53AutoNaming_v20170314.CreateHttpNamespaceCreates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered…
  • POSTCreate private dns namespace/#X-Amz-Target=Route53AutoNaming_v20170314.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,…
  • POSTCreate public dns namespace/#X-Amz-Target=Route53AutoNaming_v20170314.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…
  • POSTCreate service/#X-Amz-Target=Route53AutoNaming_v20170314.CreateServiceCreates a service. This action defines the configuration for the following entities: For public and private DNS namespaces, one of the following combinations…
  • POSTDelete namespace/#X-Amz-Target=Route53AutoNaming_v20170314.DeleteNamespaceDeletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
  • POSTDelete service/#X-Amz-Target=Route53AutoNaming_v20170314.DeleteServiceDeletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request fails.
  • POSTDelete service attributes/#X-Amz-Target=Route53AutoNaming_v20170314.DeleteServiceAttributesDeletes specific attributes associated with a service.
  • POSTDeregister instance/#X-Amz-Target=Route53AutoNaming_v20170314.DeregisterInstanceDeletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
  • POSTDiscover instances/#X-Amz-Target=Route53AutoNaming_v20170314.DiscoverInstancesDiscovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace.…
  • POSTDiscover instances revision/#X-Amz-Target=Route53AutoNaming_v20170314.DiscoverInstancesRevisionDiscovers the increasing revision associated with an instance.
  • POSTGet instance/#X-Amz-Target=Route53AutoNaming_v20170314.GetInstanceGets information about a specified instance.
  • POSTGet instances health status/#X-Amz-Target=Route53AutoNaming_v20170314.GetInstancesHealthStatusGets the current health status ( Healthy , Unhealthy , or Unknown ) of one or more instances that are associated with a specified service. There's a brief…
  • POSTGet namespace/#X-Amz-Target=Route53AutoNaming_v20170314.GetNamespaceGets information about a namespace.
  • POSTGet operation/#X-Amz-Target=Route53AutoNaming_v20170314.GetOperationGets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request. To get a list of operations that…
  • POSTGet service/#X-Amz-Target=Route53AutoNaming_v20170314.GetServiceGets the settings for a specified service.
  • POSTGet service attributes/#X-Amz-Target=Route53AutoNaming_v20170314.GetServiceAttributesReturns the attributes associated with a specified service.
  • POSTList instances/#X-Amz-Target=Route53AutoNaming_v20170314.ListInstancesLists summary information about the instances that you registered by using a specified service.
  • POSTList namespaces/#X-Amz-Target=Route53AutoNaming_v20170314.ListNamespacesLists summary information about the namespaces that were created by the current Amazon Web Services account and shared with the current Amazon Web Services…
  • POSTList operations/#X-Amz-Target=Route53AutoNaming_v20170314.ListOperationsLists operations that match the criteria that you specify.
  • POSTList services/#X-Amz-Target=Route53AutoNaming_v20170314.ListServicesLists summary information for all the services that are associated with one or more namespaces.
  • POSTList tags for resource/#X-Amz-Target=Route53AutoNaming_v20170314.ListTagsForResourceLists tags for the specified resource.
  • POSTRegister instance/#X-Amz-Target=Route53AutoNaming_v20170314.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…
  • POSTTag resource/#X-Amz-Target=Route53AutoNaming_v20170314.TagResourceAdds one or more tags to the specified resource.
  • POSTUntag resource/#X-Amz-Target=Route53AutoNaming_v20170314.UntagResourceRemoves one or more tags from the specified resource.
  • POSTUpdate http namespace/#X-Amz-Target=Route53AutoNaming_v20170314.UpdateHttpNamespaceUpdates an HTTP namespace.
  • POSTUpdate instance custom health status/#X-Amz-Target=Route53AutoNaming_v20170314.UpdateInstanceCustomHealthStatusSubmits a request to change the health status of a custom health check to healthy or unhealthy. You can use UpdateInstanceCustomHealthStatus to change the…
  • POSTUpdate private dns namespace/#X-Amz-Target=Route53AutoNaming_v20170314.UpdatePrivateDnsNamespaceUpdates a private DNS namespace.
  • POSTUpdate public dns namespace/#X-Amz-Target=Route53AutoNaming_v20170314.UpdatePublicDnsNamespaceUpdates a public DNS namespace.
  • POSTUpdate service/#X-Amz-Target=Route53AutoNaming_v20170314.UpdateServiceSubmits a request to perform the following operations: Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig…
  • POSTUpdate service attributes/#X-Amz-Target=Route53AutoNaming_v20170314.UpdateServiceAttributesSubmits a request to update a specified service to add service-level attributes.

API details

Base URL
https://servicediscovery.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
30 operations on 30 pathsPOST 30
Description format
AWS Smithy model, API version 2017-03-14

How to test the AWS Cloud Map in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Cloud Map collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create http namespace” (POST /#X-Amz-Target=Route53AutoNaming_v20170314.CreateHttpNamespace), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Cloud Map?

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… It is listed under Maps & location and has 30 endpoints.

Who publishes the AWS Cloud Map?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Cloud Map?

Requests go to https://servicediscovery.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Cloud Map?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Cloud Map have?

30 operations on 30 paths (30 POST).

Is forking the AWS Cloud Map free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.