Документация по API

На этой странице представлена ​​справочная документация по конечным точкам API генератора конфигурации метрик (MCG).

Обзор конечных точек

В следующих разделах подробно описаны доступные в MCG API-интерфейсы.

Конфигурация метрик

• POST /api/v1/generate_metrics_config : Создает экземпляр MetricsConfig на основе сведений о запросе на настройку метрик.
• POST /api/v1/get_file_descriptor_set : Возвращает дескрипторы файлов для заданного MetricsConfig для декодирования отчетов.
• POST /api/v1/validate_metrics_config : Проверяет переданный MetricsConfig , возвращая список всех ошибок проверки.

Каталоги автомобильных сигнальных устройств

• POST /api/v1/vs/ : Создать новый или обновить существующий каталог сигналов транспортного средства.
• GET /api/v1/vs/ : Отображение всех метаданных каталога сигналов транспортных средств.
• DELETE /api/v1/vs/{version} : Удалить указанный каталог сигналов транспортного средства.

Статус обслуживания

• GET /health : Проверить состояние сервиса.

Типы содержимого Protobuf

Несколько API-интерфейсов принимают или возвращают данные в формате Protocol Buffer (protobuf). Используются два типа содержимого:

• application/x-protobuf : Указывает данные protobuf в двоичном формате. Этот формат эффективен для межмашинной связи, но не является удобочитаемым для человека.
• text/x-protobuf : Указывает данные protobuf в текстовом формате, удобочитаемом для человека и полезном для отладки или ручной проверки.

Если конечная точка поддерживает несколько форматов protobuf для запроса или ответа, используйте заголовок Content-Type для указания формата данных запроса и заголовок Accept для указания выбранного формата данных ответа. Например:

• -H 'Content-Type: application/x-protobuf'
• -H 'Accept: text/x-protobuf'

Вызовите API

В примерах на этой странице для вызова REST API используется curl , и предполагается, что вы установили переменную среды SERVICE_URL , указывающую на хост, где развернут MCG. При локальном запуске это обычно http://localhost:8005 .

Чтобы выбрать удаленный экземпляр Cloud Run, установите SERVICE_URL с помощью gcloud . Затем добавьте заголовок авторизации с токеном идентификации OpenID Connect (OIDC) к вашей команде curl :

SERVICE_URL=$(gcloud run services describe mcg-service --region=<var label="Google Cloud region">GCP_REGION</var> --format='value(status.url)')

# Authorization header to append to curl command:
-H "Authorization: Bearer $(gcloud auth print-identity-token)"

Конфигурация метрик

В этом разделе описаны конечные точки для генерации и проверки конфигураций метрик.

POST /api/v1/generate_metrics_config

Создайте экземпляр MetricsConfig на основе сведений о запросе на настройку метрик. Этот процесс включает проверку, и если генерация не удается из-за нарушений схемы, недопустимых ссылок, циклических зависимостей или других проблем, API возвращает список сведений об ошибке.

curl -H "Content-Type: application/json" \
  -H "Accept: text/x-protobuf" \
  --data-binary @PATH_TO_METRICS_CONFIG_JSON \
  "$SERVICE_URL/api/v1/generate_metrics_config"
      

POST /api/v1/get_file_descriptor_set

Возвращает дескрипторы файлов для заданного MetricsConfig для декодирования отчетов.

curl -H "Content-Type: application/x-protobuf" \
  -H "Accept: application/x-protobuf" \
  --data-binary @PATH_TO_METRICS_CONFIG_PB \
  "$SERVICE_URL/api/v1/get_file_descriptor_set"
      

POST /api/v1/validate_metrics_config

Проверьте предоставленный MetricsConfig , вернув список всех ошибок проверки.

curl -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data-binary @PATH_TO_METRICS_CONFIG_JSON \
  "$SERVICE_URL/api/v1/validate_metrics_config"
      

Каталоги автомобильных сигнальных устройств

В этом разделе описываются конечные точки для управления каталогами сигналов транспортных средств.

POST /api/v1/vs/

Создать новый или обновить существующий каталог автомобильных сигналов.

{
  "version": "string",
  "vehicle_signals": "string"
}

{"version": "string"}

curl -H "Content-Type: application/json" \
  --data-binary @- "$SERVICE_URL/api/v1/vs/" << EOF
{
  "version": "v1.0",
  "vehicle_signals": "VEHICLE_SIGNALS_BASE64"
}
EOF
      

GET /api/v1/vs/

Перечислите все метаданные каталога автомобильных сигналов.

{"versions": [{"version": "string"}]}

curl "$SERVICE_URL/api/v1/vs/"
      

Удалить /api/v1/vs/{version}

Удалите указанный каталог сигналов транспортного средства.

{"version": "string"}

curl --request DELETE "$SERVICE_URL/api/v1/vs/v1.0"
      

Статус обслуживания

В этом разделе описаны конечные точки для проверки работоспособности сервисов.

GET /health

Проверьте работоспособность сервиса.

curl "$SERVICE_URL/health"
      

Ответы об ошибках

Когда вызов API приводит к ошибке ( HTTP status 4xx или 5xx ), тело ответа содержит объект ошибки со следующей структурой:

{
  "error": {
    "code": 400,
    "status": "INVALID_ARGUMENT",
    "message": "Request validation failed",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.BadRequest",
        "fieldViolations": [
          {
            "field": "fieldName",
            "description": "error description"
          }
        ]
      }
    ]
  }
}