Использование API для счетчиков
Клиент CMS позволяет работать со счетчиками с помощью описанных ниже методов:
-
Создание счетчиков, не привязанных к сущностям;
-
Управление состояниями счетчиков: запуск, остановка и продолжение работы.
Управлять счетчиками можно также с помощью модуля builtinopв плейбуке.
Описания и примеры приведены для TypeScript (среда выполнения Deno).
| Чтобы работать со счетчиками через пакет SDK, импортируйте его. |
Создание счетчика (create_counter)
Метод используется для создания счетчика.
create_counter({
domainId: <domain_id>, // string
payload: <payload>, // Map<string, any>
})Параметры метода включают в себя:
-
<domain_id>: идентификатор домена (строка); -
<payload>: полезная нагрузка (коллекция Map).
Запуск счетчика (start_counter)
Метод используется для запуска счетчика.
start_counter({
domainId: <domain_id>, // string
counterId: <counter_id>, // string
duration: <duration>, // number
})Параметры метода включают в себя:
-
<domain_id>: идентификатор домена (строка); -
<counter_id>: идентификатор счетчика (строка); -
<duration>: интервал времени до срабатывания счетчика в миллисекундах (число).
Остановка счетчика (pause_counter)
Метод используется для остановки запущенного счетчика.
pause_counter({
domainId: <domain_id>, // string
counterId: <counter_id>, // string
})Параметры метода включают в себя:
-
<domain_id>: идентификатор домена (строка); -
<counter_id>: идентификатор счетчика (строка).
Продолжение работы счетчика (resume_counter)
Метод используется для продолжения работы остановленного счетчика.
resume_counter({
domainId: <domain_id>, // string
counterId: <counter_id>, // string
})Параметры метода включают в себя:
-
<domain_id>: идентификатор домена (строка); -
<counter_id>: идентификатор счетчика (строка).
Пример скрипта для управления счетчиком
id: "test.script.example"
name: "Тут будет название скрипта"
version: 0.0.24
type: script
source: !deno |
import * as sdk from "@playbooks/sdk";
export async function main() {
// Идентификатор домена.
const domainId = "test.quick.filters";
// Создать счетчик.
const result = await sdk.cms.create_counter({domainId, payload: {"test": "test test"}});
// Создание счетчика возвращает UUID счетчика.
const counterId = result.counter_id;
// Запустить счетчикю
await sdk.cms.start_counter({domainId, counterId, duration: 10000});
// Остановить счетчик.
await sdk.cms.pause_counter({domainId, counterId});
// Продолжить работу счетчика.
await sdk.cms.resume_counter({domainId, counterId});
}Была ли полезна эта страница?
