Перейти к содержанию

Получение конфигурации агента сбора по ID

Запрос

Тип Метод
GET /agents/{agent_id}/config

Описание: При выполнении запроса будет возвращена конфигурация агента сбора с соответствующим ID.

Пример запроса

GET
https://127.0.0.1:9000/cm/api/v2/agents/{agent_id}/config

Path параметры запроса:

Параметр Описание
{id} Идентификатор агента сбора

Header параметры запроса:

Параметр Описание
If-None-Match Хэш-сумма текущего конфига (sha256). Строка длиной 64 символа

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Тело ответа:

Параметр Тип Описание
hash string Хэш-сумма нового конфига
config object/null<Config> Объект настроек Агента сбора
Пример ответа

{
  "hash": "string",
  "config": {
    "cm_url": "https://172.30.254.70:9000/cm",
    "api_key": "7f819f8f-8220-4dcd-b7e3-37c81ead8b7a",
    "skip_verify": true,
    "config_update_freq_sec": 30,
    "secret_file": "string",
    "secret_storage": "string",
    "disk_usage": {
      "stop_limit_pct": 95,
      "restart_limit_pct": 85,
      "disk_overflow_behavior": "turn_off",
      "disk_check_freq_sec": 60
    },
    "controller": {
      "port": 48000,
      "inputs_grpc_port": 48006,
      "senders_grpc_port": 48001
    },
    "journal": {
      "port": 48004,
      "log_level": "DEBUG",
      "log_path": "C:\\log-collector\\journal.log",
      "rotation_size": 100,
      "max_backups": 0,
      "max_age": 0
    },
    "api_server": {
      "address": "string",
      "port": 48004,
      "read_timeout": 0,
      "write_timeout": 0,
      "enable_tls": true,
      "cert_file": "string",
      "key_file": "string",
      "cert_key_pass": "string",
      "require_client_cert": true,
      "ca_file": "string",
      "log_level": "DEBUG"
    },
    "metric_server": {
      "port": 48005,
      "log_level": "DEBUG"
    },
    "inputs": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "opsec_lea_input",
        "_": {
          "host": null,
          "poll_interval": 1,
          "auth": {
            "auth_port": 1024,
            "auth_type": "SSLCA",
            "opsec_sic_name": "string",
            "opsec_sslca_file": "string",
            "opsec_entity_sic_name": "string",
            "opsec_sic_policy_file": "string"
          },
          "log_filename": "string",
          "log_level": "DEBUG"
        }
      }
    ],
    "routes": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    }
  }
}

Другие возможные ответы

Код Ответ Описание
400 Bad Request Неверный тип параметра запроса, либо отсутствует обязательный параметр
401 no auth header Не передан заголовок авторизации (PgrApiKey или Authorization)
500 Internal Server Error Другие ошибки сервера

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

Код 400

{
  "error": "Bad Request",
  "error_code": 400
}

Код 401

{
  "error": "no auth header"
  "error_code": 401
}

Код 500

{
  "error": "Internal Server Error",
  "error_code": 500
}