2017-07-14 15:45:08 -04:00
|
|
|
---
|
2020-09-01 10:14:13 -05:00
|
|
|
layout: commands
|
2020-04-07 14:55:19 -04:00
|
|
|
page_title: 'Commands: Catalog List Datacenters'
|
2023-01-26 12:42:13 -06:00
|
|
|
description: >-
|
|
|
|
|
The `consul catalog datacenters` command returns a list of all known datacenters.
|
2017-07-14 15:45:08 -04:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Consul Catalog List Datacenters
|
|
|
|
|
|
|
|
|
|
Command: `consul catalog datacenters`
|
|
|
|
|
|
2023-01-25 10:52:43 -06:00
|
|
|
Corresponding HTTP API Endpoint: [\[GET\] /v1/catalog/datacenters](/consul/api-docs/catalog#list-datacenters)
|
2022-01-10 12:40:11 -05:00
|
|
|
|
2017-07-14 15:45:08 -04:00
|
|
|
The `catalog datacenters` command prints all known datacenters.
|
|
|
|
|
|
2023-01-25 10:52:43 -06:00
|
|
|
The table below shows this command's [required ACLs](/consul/api-docs/api-structure#authentication). Configuration of
|
|
|
|
|
[blocking queries](/consul/api-docs/features/blocking) and [agent caching](/consul/api-docs/features/caching)
|
2022-01-10 16:44:56 -05:00
|
|
|
are not supported from commands, but may be from the corresponding HTTP endpoint.
|
|
|
|
|
|
|
|
|
|
| ACL Required |
|
|
|
|
|
| ------------ |
|
|
|
|
|
| `none` |
|
|
|
|
|
|
2017-07-14 15:45:08 -04:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
List all datacenters:
|
|
|
|
|
|
2020-05-19 14:32:38 -04:00
|
|
|
```shell-session
|
2017-07-14 15:45:08 -04:00
|
|
|
$ consul catalog datacenters
|
|
|
|
|
dc1
|
|
|
|
|
dc2
|
|
|
|
|
dc3
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: `consul catalog datacenters [options]`
|
|
|
|
|
|
|
|
|
|
#### API Options
|
|
|
|
|
|
2020-04-07 14:55:19 -04:00
|
|
|
@include 'http_api_options_client.mdx'
|
2020-04-07 19:56:08 -04:00
|
|
|
|
2020-04-07 14:55:19 -04:00
|
|
|
@include 'http_api_options_server.mdx'
|
