Download OpenAPI specification:
Спецификация Producer API узла COOPOS (nodeos). Включение плагина — в документации на https://coopenomics.world.
Возвращает, приостановлен ли узел-продюсер. Без аргументов.
{- "code": 400,
- "message": "Invalid Request",
- "error": {
- "code": 3200006,
- "name": "invalid_http_request",
- "what": "invalid http request",
- "details": [
- {
- "message": "Unable to parse valid input from POST body",
- "file": "http_plugin.hpp",
- "line_number": 246,
- "method": "parse_params"
}
]
}
}Возвращает текущие параметры времени выполнения узла-продюсера.
{- "max_transaction_time": 100,
- "max_irreversible_block_age": -1,
- "produce_time_offset_us": -100000,
- "last_block_time_offset_us": -200000,
- "max_scheduled_transaction_time_per_block_ms": 100,
- "subjective_cpu_leeway_us": 10,
- "incoming_defer_ratio": "1.00000000000000000",
- "greylist_limit": 1000
}Обновляет параметры времени выполнения узла-продюсера. Можно передать любое подмножество полей.
| max_transaction_time | integer Максимальное время выполнения транзакции |
| max_irreversible_block_age | integer Максимальный «возраст» необратимого блока |
| produce_time_offset_us | integer Смещение времени производства (мкс) |
| last_block_time_offset_us | integer Смещение времени последнего блока (мкс) |
| max_scheduled_transaction_time_per_block_ms | integer Максимальное время отложенных транзакций на блок (мс) |
| subjective_cpu_leeway_us | integer Допуск субъективного CPU (мкс) |
| incoming_defer_ratio | string Доля входящих отложенных транзакций (строка, парсится в double) |
| greylist_limit | integer Лимит числа имён (Name) в сером списке |
{- "max_transaction_time": 100,
- "max_irreversible_block_age": -1,
- "produce_time_offset_us": -100000,
- "last_block_time_offset_us": -200000,
- "max_scheduled_transaction_time_per_block_ms": 100,
- "subjective_cpu_leeway_us": 10,
- "incoming_defer_ratio": "1.00000000000000000",
- "greylist_limit": 1000
}{- "result": "ok"
}Добавляет учётные записи в серый список узла-продюсера. Нужна хотя бы одна запись.
Array of Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string) (Имя учётной записи) Имена учётных записей для добавления |
{- "accounts": [
- "string"
]
}{- "result": "ok"
}Удаляет учётные записи из серого списка узла-продюсера. Нужна хотя бы одна запись.
Array of Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string) (Имя учётной записи) Имена учётных записей для удаления |
{- "accounts": [
- "string"
]
}{- "result": "ok"
}Возвращает белые и чёрные списки узла-продюсера в виде JSON-объекта.
{- "actor_whitelist": [
- "string"
], - "actor_blacklist": [
- "string"
], - "contract_whitelist": [
- "string"
], - "contract_blacklist": [
- "string"
], - "action_blacklist": [
- [
- "string"
]
], - "key_blacklist": [
- "string"
]
}Задаёт белые и чёрные списки узла-продюсера. Тело запроса — JSON с полями списков.
Array of Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string) (Имя учётной записи) | |
Array of Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string) (Имя учётной записи) | |
Array of Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string) (Имя учётной записи) | |
Array of Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string) (Имя учётной записи) | |
Array of (Имя учётной записи (Привилегированное имя (string) or Базовое имя (string) or Имя из аукциона (string) or Прочее имя (string))) or Сигнатура действия (C++) (string)[ items ] | |
| key_blacklist | Array of strings (Тип/значение ключа) |
{- "actor_whitelist": [
- "string"
], - "actor_blacklist": [
- "string"
], - "contract_whitelist": [
- "string"
], - "contract_blacklist": [
- "string"
], - "action_blacklist": [
- [
- "string"
]
], - "key_blacklist": [
- "string"
]
}{- "result": "ok"
}Создаёт снимок состояния узла-продюсера. При ошибке возвращает ответ с ошибкой.
{- "head_block_id": "string",
- "head_block_num": 5102,
- "head_block_time": "2020-11-16T00:00:00.000",
- "version": 6,
- "snapshot_name": "/home/me/nodes/node-name/snapshots/snapshot-0000999f99999f9f999f99f99ff9999f999f9fff99ff99ffff9f9f9fff9f9999.bin"
}Запрашивает периодическое создание снимков по заданным параметрам. Пустое тело — немедленное создание снимка. При невозможности принять расписание — ошибка.
| block_spacing | integer Создавать снимок каждые block_spacing блоков |
| start_block_num | integer Номер блока начала расписания |
| end_block_num | integer Номер блока окончания расписания |
| snapshot_description | string Описание снимка / задания |
{- "block_spacing": 0,
- "start_block_num": 5102,
- "end_block_num": 15102,
- "snapshot_description": "Daily snapshot"
}{- "snapshot_request_id": 0,
- "block_spacing": 0,
- "start_block_num": 5102,
- "end_block_num": 15102,
- "snapshot_description": "Daily snapshot"
}Возвращает список запросов на периодические снимки.
{- "snapshot_requests": [
- {
- "snapshot_request_id": 0,
- "block_spacing": 0,
- "start_block_num": 5102,
- "end_block_num": 15102,
- "snapshot_description": "Daily snapshot",
- "pending_snapshots": [
- {
- "head_block_id": "string",
- "head_block_num": 5102,
- "head_block_time": "2020-11-16T00:00:00.000",
- "version": 6,
- "snapshot_name": "/home/me/nodes/node-name/snapshots/snapshot-0000999f99999f9f999f99f99ff9999f999f9fff99ff99ffff9f9f9fff9f9999.bin"
}
]
}
]
}Удаляет запрос на снимки по идентификатору. Ошибка, если такого запроса нет.
| snapshot_request_id | integer Идентификатор запроса на снимки |
{- "snapshot_request_id": 0
}{- "snapshot_request_id": 0,
- "block_spacing": 0,
- "start_block_num": 5102,
- "end_block_num": 15102,
- "snapshot_description": "Daily snapshot"
}Планирует активацию протокольных возможностей на узле-продюсере. Часть возможностей требует предварительной активации. Дубликаты и нарушение порядка предварительной активации дают ошибку.
| protocol_features_to_activate | Array of strings (Хеш SHA-256) [ items^[0-9A-Fa-f]{64}$ ] Список протокольных возможностей для активации |
{- "protocol_features_to_activate": [
- "string"
]
}{- "result": "ok"
}Возвращает поддерживаемые узлом протокольные возможности. Фильтры передаются в теле запроса.
| exclude_disabled | boolean Default: false Исключить отключённые возможности |
| exclude_unactivatable | boolean Default: false Исключить возможности, которые нельзя активировать |
{- "exclude_disabled": false,
- "exclude_unactivatable": false
}[- {
- "feature_digest": "string",
- "subjective_restrictions": {
- "enabled": true,
- "preactivation_required": true,
- "earliest_allowed_activation_time": "1970-01-01T00:00:00.000",
- "description_digest": "string",
- "dependencies": [
- "string"
], - "protocol_feature_type": "builtin",
- "specification": [
- {
- "name": "string",
- "value": "string"
}
]
}
}
]Возвращает учётные записи с корректировками RAM.
| lower_bound | integer Нижняя граница ключа аккаунта |
| upper_bound | integer Верхняя граница ключа аккаунта |
| limit | integer Default: 10 Число строк для обхода |
| reverse | boolean Default: false Направление обхода |
{- "lower_bound": 0,
- "upper_bound": 0,
- "limit": 10,
- "reverse": false
}{- "rows": [
- "string"
], - "more": [
- "string"
]
}Возвращает транзакции, ожидающие применения (неприменённые).
| limit | integer Default: 100 Максимальное число транзакций в ответе |
| lower_bound | string (Хеш SHA-256) ^[0-9A-Fa-f]{64}$ 64-символьная шестнадцатеричная строка (хеш SHA-256). |
| time_limit_ms | integer Default: "http-max-response-time-ms" Лимит времени ответа (мс); по умолчанию как у http-max-response-time-ms узла |
{- "limit": 100,
- "lower_bound": "string",
- "time_limit_ms": 10
}{- "size": 12428,
- "incoming_size": 4475,
- "trxs": [
- {
- "trx_id": "string",
- "expiration": "2022-09-17T16:30:16",
- "trx_type": "aborted",
- "first_auth": "jkbsg.wam",
- "first_receiver": "m.federation",
- "first_action": "mine",
- "total_actions": 1,
- "billed_cpu_time_us": 504,
- "size": 934
}
], - "more": "string"
}