API docs by Redocly

Download OpenAPI specification:Download

USER

三方鉴权

path Parameters
oauth
required
any (oauth)
state
required
any (state)
error
required
any (error)
error_description
required
any (error_description)
code
required
any (code)

Responses

用户登陆

用户列表

用户详情

用户退出

修改密码

path Parameters
uid
required
any (uid)

ALARM

告警列表

path Parameters
name
required
any (name)
iid
required
any (iid)
tid
required
any (tid)
did
required
any (did)
alarmId
required
any (alarmId)
status
required
any (status)
isReload
required
any (isReload)

告警创建

告警渠道列表

告警渠道创建

告警渠道测试

告警渠道删除

path Parameters
id
required
any (id)

告警渠道详情

path Parameters
id
required
any (id)

告警渠道更新

path Parameters
id
required
any (id)

告警推送记录

告警推送详情

path Parameters
id
required
any (id)

告警删除

path Parameters
id
required
any (id)

告警详情

path Parameters
id
required
any (id)

告警更新

path Parameters
id
required
any (id)

告警推送 Webhook

godoc

{"version":"4","groupKey":"{}:{alertname=\"e6e85281_6e22_4159_90e8_38943e75fb3f_194\"}","status":"firing","receiver":"webhook","groupLabels":{"alertname":"e6e85281_6e22_4159_90e8_38943e75fb3f_194"},"commonLabels":{"alertname":"e6e85281_6e22_4159_90e8_38943e75fb3f_194","filterId":"194","severity":"warning","uuid":"e6e85281-6e22-4159-90e8-38943e75fb3f"},"commonAnnotations":{"description":" (当前值: 1)","summary":"告警 "},"externalURL":"http://duminxiangdeMacBook-Pro.local:9093","alerts":[{"labels":{"alertname":"e6e85281_6e22_4159_90e8_38943e75fb3f_194","filterId":"194","severity":"warning","uuid":"e6e85281-6e22-4159-90e8-38943e75fb3f"},"annotations":{"description":" (当前值: 1)","summary":"告警 "},"startsAt":"2022-11-07T09:23:17.6Z","endsAt":"0001-01-01T00:00:00Z"}]}

Create metrics.samples table

告警配置列表

告警配置详情

path Parameters
instance-id
required
any (instance-id)

告警配置更新

path Parameters
instance-id
required
any (instance-id)

BIGDATA

bigdata.FolderCreate

bigdata.FolderDelete

path Parameters
id
required
any (id)

bigdata.FolderInfo

path Parameters
id
required
any (id)

bigdata.FolderUpdate

path Parameters
id
required
any (id)

bigdata.InstanceColumnList

path Parameters
id
required
any (id)

bigdata.InstanceDatabaseList

path Parameters
id
required
any (id)

bigdata.InstanceTableList

path Parameters
id
required
any (id)

mining.CrontabInfo

path Parameters
id
required
any (id)

bigdata.SourceColumnList

path Parameters
id
required
any (id)

bigdata.SourceDatabaseList

path Parameters
id
required
any (id)

bigdata.SourceTableList

path Parameters
id
required
any (id)

mining.WorkflowList

mining.WorkflowCreate

mining.WorkflowDelete

path Parameters
id
required
any (id)

mining.WorkflowInfo

path Parameters
id
required
any (id)

mining.WorkflowUpdate

path Parameters
id
required
any (id)

bigdata.NodeList

bigdata.NodeCreate

bigdata.NodeDelete

path Parameters
id
required
any (id)

bigdata.NodeInfo

path Parameters
id
required
any (id)

bigdata.NodeUpdate

path Parameters
id
required
any (id)

bigdata.NodeHistoryListPage

path Parameters
id
required
any (id)

bigdata.NodeHistoryInfo

path Parameters
uuid
required
any (uuid)

bigdata.NodeLock

path Parameters
id
required
any (id)

bigdata.NodeResultInfo

path Parameters
rid
required
any (rid)

bigdata.NodeRun

path Parameters
id
required
any (id)

bigdata.NodeStop

path Parameters
id
required
any (id)

bigdata.NodeUnlock

path Parameters
id
required
any (id)

bigdata.SourceList

bigdata.SourceCreate

bigdata.SourceDelete

path Parameters
id
required
any (id)

bigdata.SourceInfo

path Parameters
id
required
any (id)

bigdata.SourceUpdate

path Parameters
id
required
any (id)

table create sql

godoc

table create sql

path Parameters
instance-id
required
any (instance-id)
database
required
any (database)
table
required
any (table)

表依赖解析

path Parameters
instance-id
required
any (instance-id)

更新节点执行结果

path Parameters
result-id
required
any (result-id)

节点任务更新

path Parameters
node-id
required
any (node-id)

创建节点任务

path Parameters
node-id
required
any (node-id)

Force the file edit lock to be acquired

godoc

Force the file edit lock to be acquired

path Parameters
node-id
required
any (node-id)

节点执行结果列表

path Parameters
node-id
required
any (node-id)

Data field mapping transformation

godoc

source: mysql

target: clickhouse

定时任务执行结果列表

Kanban Dashboard

LOGSTORE

mining.CrontabDelete

path Parameters
id
required
any (id)

日志库列表

path Parameters
did
required
any (did)

base.DatabaseDelete

path Parameters
id
required
any (id)

base.DatabaseUpdate

path Parameters
id
required
any (id)

base.HiddenList

path Parameters
tid
required
any (tid)

base.HiddenUpsert

path Parameters
tid
required
any (tid)

接入已有日志库

path Parameters
iid
required
any (iid)

执行SQL请求

path Parameters
iid
required
any (iid)

base.DatabaseList

path Parameters
iid
required
any (iid)

base.DatabaseCreate

path Parameters
iid
required
any (iid)

base.DatabaseExistList

path Parameters
iid
required
any (iid)

日志库依赖分析

path Parameters
iid
required
any (iid)
dn
required
any (dn)
tn
required
any (tn)

接入已有日志库

path Parameters
iid
required
any (iid)

批量接入已有日志库

path Parameters
iid
required
any (iid)

日志库ID获取

日志库删除

path Parameters
id
required
any (id)

日志库详情

path Parameters
id
required
any (id)

日志库配置更新

path Parameters
id
required
any (id)

日志趋势图

path Parameters
id
required
any (id)

分析字段列表

path Parameters
id
required
any (id)

分析字段更新

path Parameters
id
required
any (id)

分析字段列表

path Parameters
id
required
any (id)
idx
required
any (idx)

日志搜索

path Parameters
id
required
any (id)

base.ViewList

path Parameters
id
required
any (id)

base.ViewCreate

path Parameters
id
required
any (id)

删除视图

path Parameters
id
required
any (id)

base.ViewInfo

path Parameters
id
required
any (id)

base.ViewUpdate

path Parameters
id
required
any (id)

Gets all instance database and table data filtered by permissions test

godoc

gets all instances, databases, and table nested data

Create short links

godoc

Create short links

获取短链接

path Parameters
s-code
required
any (s-code)

Responses

Creating a log library

godoc

Creating a log library

List Collect

godoc

List Collect

Create Collect

godoc

CollectType

Delete Collect

godoc

Delete Collect

path Parameters
collect-id
required
any (collect-id)

Update collect

godoc

Update collect

path Parameters
collect-id
required
any (collect-id)

Kafka JSON field mapping

godoc

Kafka JSON field mapping

trace storage list

godoc

trace storage list

iStorage update

godoc

iStorage update

path Parameters
storage-id
required
any (storage-id)

iStorage analysis field list

godoc

iStorage analysis field list

path Parameters
storage-id
required
any (storage-id)

Get storage columns

godoc

Get storage columns

path Parameters
storage-id
required
any (storage-id)

iStorage related trace info update

godoc

iStorage related trace info update

path Parameters
storage-id
required
any (storage-id)

Get trace graph

godoc

Get trace graph

path Parameters
storage-id
required
any (storage-id)

Create storage by template

godoc

Create storage by template

path Parameters
template
required
any (template)

KUBE

根据分页获取Cluster列表

根据分页获取Cluster列表

Get configmap by name

Get configmap by name

path Parameters
clusterId
required
any (clusterId)

Get configmap by name

Get configmap by name

path Parameters
clusterId
required
any (clusterId)

Get configmap by name

Get configmap by name

path Parameters
clusterId
required
any (clusterId)
namespace
required
any (namespace)
name
required
any (name)

CONFIGURE

配置文件列表

配置文件列表

..

..

..

..

path Parameters
id
required
any (id)

..

..

path Parameters
id
required
any (id)

..

..

path Parameters
id
required
any (id)

..

..

path Parameters
id
required
any (id)

..

..

path Parameters
id
required
any (id)

..

..

path Parameters
id
required
any (id)
version
required
any (version)

configure.Lock

path Parameters
id
required
any (id)

..

..

path Parameters
id
required
any (id)

Synchronize the configmap configuration if id is 0 means all configurations need to be synchronized not support update operator

Synchronize the configmap configuration

if id is 0 means all configurations need to be synchronized

not support update operator

path Parameters
id
required
any (id)

configure.Unlock

path Parameters
id
required
any (id)

EVENT

event.GetAllEnums

event.GetEnumsOfSource

path Parameters
name
required
any (name)

event.ListPage

INSTILL

Determine whether the installation process is required

Determine whether the installation process is required

Perform the installation process

Perform the installation process

initialize.Migration

PREMISSION

permission.MenuList

permission.CheckPermission

permission.GetPmsCommonInfo

permission.GetInstancePmsRolesGrant

path Parameters
iid
required
any (iid)

permission.UpdateInstancePmsRolesGrant

path Parameters
iid
required
any (iid)

permission.PmsRoleList

permission.CreatePmsRole

permission.DeletePmsRole

path Parameters
id
required
any (id)

permission.PmsRoleInfo

path Parameters
id
required
any (id)

permission.UpdatePmsRole

path Parameters
id
required
any (id)

permission.GrantRootUids

permission.GetRootUids

SYSTEM

根据分页获取Cluster列表

根据分页获取Cluster列表

path Parameters
name
required
any (name)

创建集群

...

删除数据

删除数据

path Parameters
id
required
any (id)

集群信息

集群信息

path Parameters
id
required
any (id)

更新Cluster数据

更新Cluster数据

path Parameters
id
required
any (id)

ClickHouse 列表

ClickHouse 创建

ClickHouse/Databend DSN 测试

ClickHouse 删除

path Parameters
id
required
any (id)

ClickHouse 详情

path Parameters
id
required
any (id)

ClickHouse 更新

path Parameters
id
required
any (id)

User

Get user list

Get user list

godoc

godoc

godoc

godoc

path Parameters
user-id
required
any (user-id)

base.UpdateUser

path Parameters
user-id
required
any (user-id)

godoc

godoc

path Parameters
user-id
required
any (user-id)