Выбор полного поддерева метрик

API Ключ-АСТРОМ / Эндпойнты среды / Развёртывание / Метрики v2 / Примеры и варианты использования / Выбор полного поддерева метрик

Конечная точка метрик GET предоставляет вам возможность выбрать полное поддерево метрик со звездочкой в ​​конце ( *). Подстановочный знак звездочки выбирает все показатели родителя без необходимости указывать каждый из них.

В этом примере показано, как получить дескрипторы всех показателей ЦП хоста.

Чтобы сделать ответ короче, мы будем запрашивать только следующие параметры:

• Ключ метрики
• Показать имя
• Агрегация по умолчанию

Конечно, вы можете запросить полные дескрипторы метрики. Чтобы узнать, как это сделать, посмотрите пример выбора нескольких метрик .

Настроить запрос

Мы должны установить следующие параметры запроса:

• селектор метрики в builtin:host.cpu.*.
• поля до displayName,defaultAggregation. Обратите внимание, что metricIdздесь это опущено, потому что оно всегда присутствует в ответе.

Вы можете получить ответ в двух форматах:

• JSON: установите для заголовка Acceptapplication/json запроса значение .
• Таблица CSV: установите для заголовка Accepttext/csv; header=present запроса значение . Если вас не интересует строка заголовка, используйте text/csv; header=absent.

Чтобы аутентифицировать запрос, установите для заголовка AuthorizationApi-token {your-token} запроса значение . Токен должен иметь разрешение на чтение метрик ( ).metrics.read

Curl

Вот Curl-код запроса. Обязательно используйте URL-адрес вашей собственной среды и настоящий токен API.

Полезная нагрузка JSON

curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,defaultAggregation&metricSelector=builtin:host.cpu.*' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: application/json'

Полезная нагрузка таблицы CSV

curl -L -X GET 'https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,defaultAggregation&metricSelector=builtin:host.cpu.*' \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Accept: text/csv; header=present'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru/api/v2/metrics?fields=displayName,defaultAggregation&metricSelector=builtin:host.cpu.*

Ответ

Оба примера содержат полную полезную нагрузку; ничего не урезано.

Полезная нагрузка JSON

{
  "totalCount": 17,
  "nextPageKey": null,
  "metrics": [
    {
      "metricId": "builtin:host.cpu.entc",
      "displayName": "AIX Entitlement used",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.entConfig",
      "displayName": "AIX Entitlement configured",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.idle",
      "displayName": "CPU idle",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.iowait",
      "displayName": "CPU I/O wait",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.load",
      "displayName": "System load",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.load15m",
      "displayName": "System load15m",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.load5m",
      "displayName": "System load5m",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.msu.avg",
      "displayName": "MSU average",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.msu.capacity",
      "displayName": "MSU capacity",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.other",
      "displayName": "CPU other",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.physc",
      "displayName": "AIX Physical consumed",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.steal",
      "displayName": "CPU steal",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.system",
      "displayName": "CPU system",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.usage",
      "displayName": "CPU usage %",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.user",
      "displayName": "CPU user",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.ziip.eligible",
      "displayName": "zIIP eligible",
      "defaultAggregation": {
        "type": "avg"
      }
    },
    {
      "metricId": "builtin:host.cpu.ziip.usage",
      "displayName": "zIIP usage",
      "defaultAggregation": {
        "type": "avg"
      }
    }
  ]
}

Полезная нагрузка таблицы CSV

metricId,displayName,defaultAggregation
builtin:host.cpu.entc,AIX Entitlement used,avg
builtin:host.cpu.entConfig,AIX Entitlement configured,avg
builtin:host.cpu.idle,CPU idle,avg
builtin:host.cpu.iowait,CPU I/O wait,avg
builtin:host.cpu.load,System load,avg
builtin:host.cpu.load15m,System load15m,avg
builtin:host.cpu.load5m,System load5m,avg
builtin:host.cpu.msu.avg,MSU average,avg
builtin:host.cpu.msu.capacity,MSU capacity,avg
builtin:host.cpu.other,CPU other,avg
builtin:host.cpu.physc,AIX Physical consumed,avg
builtin:host.cpu.steal,CPU steal,avg
builtin:host.cpu.system,CPU system,avg
builtin:host.cpu.usage,CPU usage %,avg
builtin:host.cpu.user,CPU user,avg
builtin:host.cpu.ziip.eligible,zIIP eligible,avg
builtin:host.cpu.ziip.usage,zIIP usage,avg