API компактного и выровненного текста (CAT)

JSON отлично подходит… для компьютеров. Даже при красивом форматировании поиск взаимосвязей в данных может быть утомительным. Глазам человека, особенно при просмотре терминала, необходим компактный и выровненный текст. API компактного и выровненного текста (CAT) предназначены для удовлетворения этой потребности.

Все команды cat принимают параметр запроса help для просмотра всех заголовков и информации, которые они предоставляют, и команда /_cat в одиночку перечисляет все доступные команды.

Каждая из команд принимает параметр запроса v для включения подробного вывода. Например:

resp = client.cat.master(
    v=True,
)
print(resp)

response = client.cat.master(
  v: true
)
puts response

const response = await client.cat.master({
  v: "true",
});
console.log(response);

GET _cat/master?v=true

Возможный ответ:

id                     host      ip        node
u_n93zwxThWHi1PDBJAGAg 127.0.0.1 127.0.0.1 u_n93zw

Каждая из команд принимает параметр запроса help, который выведет доступные столбцы. Например:

resp = client.cat.master(
    help=True,
)
print(resp)

response = client.cat.master(
  help: true
)
puts response

const response = await client.cat.master({
  help: "true",
});
console.log(response);

GET _cat/master?help

Возможный ответ:

id   |   | node id
host | h | host name
ip   |   | ip address
node | n | node name

Каждая из команд принимает параметр запроса h, который заставляет отображаться только указанные столбцы. Например:

resp = client.cat.nodes(
    h="ip,port,heapPercent,name",
)
print(resp)

response = client.cat.nodes(
  h: 'ip,port,heapPercent,name'
)
puts response

const response = await client.cat.nodes({
  h: "ip,port,heapPercent,name",
});
console.log(response);

GET _cat/nodes?h=ip,port,heapPercent,name

Ответ:

127.0.0.1 9300 27 sLBaIGK

Вы также можете запросить несколько столбцов, используя простые подстановочные знаки, такие как /_cat/thread_pool?h=ip,queue*, чтобы получить все заголовки (или псевдонимы), начинающиеся с queue.

Многие команды предоставляют несколько типов числового вывода, таких как байты, размер или значение времени. По умолчанию эти типы форматируются для человека, например, 3.5mb вместо 3763212. Человеческие значения не могут быть сортированы по числовому порядку, поэтому для операций, где порядок важен, можно изменить этот формат.

Предположим, вам нужно найти самый большой индекс в кластере (используемое хранилище всеми фрагментами, а не количество документов). API /_cat/indices идеально подходит. Вам нужно добавить три вещи в запрос API:

resp = client.cat.indices(
    bytes="b",
    s="store.size:desc,index:asc",
    v=True,
)
print(resp)

response = client.cat.indices(
  bytes: 'b',
  s: 'store.size:desc,index:asc',
  v: true
)
puts response

const response = await client.cat.indices({
  bytes: "b",
  s: "store.size:desc,index:asc",
  v: "true",
});
console.log(response);

GET _cat/indices?bytes=b&s=store.size:desc,index:asc&v=true

API возвращает следующий ответ:

health status index            uuid                   pri rep docs.count docs.deleted store.size pri.store.size dataset.size
yellow open   my-index-000001  u8FNjxh8Rfy_awN11oDKYQ   1   1       1200            0      72171         72171         72171
green  open   my-index-000002  nYFWZEO7TUiOjLQXBaYJpA   1   0          0            0        230          230            230

Если вы хотите изменить единицы измерения времени, используйте параметр time.

Если вы хотите изменить единицы измерения размера, используйте параметр size.

Если вы хотите изменить единицы измерения байтов, используйте параметр bytes.

% curl 'localhost:9200/_cat/indices?format=json&pretty'
[
  {
    "pri.store.size": "650b",
    "health": "yellow",
    "status": "open",
    "index": "my-index-000001",
    "pri": "5",
    "rep": "1",
    "docs.count": "0",
    "docs.deleted": "0",
    "store.size": "650b"
  }
]

В настоящее время поддерживаются следующие форматы (для параметра ?format=): - текст (по умолчанию) - json - smile - yaml - cbor

Альтернативно, вы можете установить заголовок HTTP "Accept" на соответствующий формат мультимедиа. Все вышеперечисленные форматы поддерживаются, параметр GET имеет приоритет над заголовком. Например:

% curl '192.168.56.10:9200/_cat/indices?pretty' -H "Accept: application/json"
[
  {
    "pri.store.size": "650b",
    "health": "yellow",
    "status": "open",
    "index": "my-index-000001",
    "pri": "5",
    "rep": "1",
    "docs.count": "0",
    "docs.deleted": "0",
    "store.size": "650b"
  }
]

Каждая из команд принимает параметр запроса s, который сортирует таблицу по указанным в качестве значения параметра столбцам. Столбцы указываются либо по имени, либо по псевдониму и предоставляются через запятую. По умолчанию сортировка выполняется по возрастанию. Добавление :desc к столбцу инвертирует порядок для этого столбца. :asc также принимается, но демонстрирует такое же поведение, как порядок сортировки по умолчанию.

Например, со строкой сортировки s=column1,column2:desc,column3 таблица будет отсортирована по столбцу1 в порядке возрастания, по столбцу2 в порядке убывания и по столбцу3 в порядке возрастания.

resp = client.cat.templates(
    v=True,
    s="order:desc,index_patterns",
)
print(resp)

response = client.cat.templates(
  v: true,
  s: 'order:desc,index_patterns'
)
puts response

const response = await client.cat.templates({
  v: "true",
  s: "order:desc,index_patterns",
});
console.log(response);

GET _cat/templates?v=true&s=order:desc,index_patterns

возвращает:

name                  index_patterns order version
pizza_pepperoni       [*pepperoni*]  2
sushi_california_roll [*avocado*]    1     1
pizza_hawaiian        [*pineapples*] 1