Бізнес-блок

Сервісна діагностика

Безпечна перевірка доступності серверного API для бази поточного клієнта.

1усього
1читання
0запис
Показано 1 із 1 Глобальний пошук · Ctrl + K — пошук на сторінці
Кожна картка містить готовий HTTP-приклад. Значення в ньому демонстраційні: замініть їх даними зі своєї бази. Для операцій запису використовуйте новий Idempotency-Key для кожної окремої бізнес-операції. Як сформувати ключ і повторювати запит.
service

Сервіс

1 методів
service.pingПеревіряє доступ до бази поточного клієнта через дозволений серверний API. читання diagnostics.read з 0.4.0

Перевіряє доступ до бази поточного клієнта через дозволений серверний API.

Перевірити JSON JSON Schema
Стабільність: стабільний Scope: diagnostics.read Idempotency-Key: не потрібен

Параметри params

Параметри не потрібні. Передайте порожній об’єкт {}.
Точна схема параметрів 
{}

Результат

Форма відповіді: status
ПолеЗмістТипПриклад
Метод повертає службовий статус без додаткових бізнес-полів.
Точна схема результату 
{
    "mode": "status",
    "fields": [],
    "field_specs": {}
}

Приклад запиту

POST /v1/rpc HTTP/1.1
Host: api13.arm20.com
Authorization: Bearer Ваш ключ API
Content-Type: application/json

{
    "method": "service.ping",
    "params": [],
    "id": "example-service-ping"
}

Замініть демонстраційні значення даними зі своєї бази.

Приклад успішної відповіді

{
    "ok": true,
    "data": {
        "method": "service.ping",
        "result": {
            "upstream": {
                "name": "UPMAPI",
                "version": "1",
                "resource": "service"
            },
            "status": {
                "code": "OK",
                "operation": "ping"
            },
            "rows": []
        },
        "id": "example-service-ping"
    },
    "request_id": "req_example_0123456789abcdef"
}
Помилки та повтори цього методу
КодHTTPПричинаДія клієнта
INVALID_PARAMETER422Один із параметрів має неправильний тип, формат або значення.Виправити запит; автоматично не повторювати.
UPSTREAM_FAILURE502Сервер бізнес-операції недоступний або відхилив безпечний контракт.Дозволений повтор із backoff.