< 反馈文档问题
API docs by Redocly

ECP-API (1.0.0)

Download OpenAPI specification:Download

account

验证邮箱邀请

query Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

上传头像

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "avatar": "string"
}

设置初始账号名称及初始密码

Request Body schema: application/json
email
required
string
Default: ""
name
required
string
Default: ""
password
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "email": "",
  • "name": "",
  • "password": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

登录

Request Body schema: application/json
password
required
string non-empty
Default: ""
username
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "password": "",
  • "username": ""
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "admin": true,
  • "expiresIn": 0,
  • "refreshExpiresIn": 0,
  • "refreshToken": "string",
  • "tokenType": "string"
}

退出登录

Responses

Response samples

Content type
application/json
{ }

设置密码

Request Body schema: application/json
newPassword
required
string
originPassword
required
string

Responses

Request samples

Content type
application/json
{
  • "newPassword": "string",
  • "originPassword": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

重置密码

Request Body schema: application/json
password
required
string
token
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "token": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

发送密码重置邮件

Request Body schema: application/json
email
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "email": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

验证重置邮件

query Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

个人信息

Responses

Response samples

Content type
application/json
{
  • "admin": true,
  • "avatar": "string",
  • "email": "string",
  • "mobile": "string",
  • "name": "string",
  • "userId": "string"
}

修改个人信息

Request Body schema: application/json
mobile
required
string
name
required
string
Default: ""
newPassword
string
Default: ""
originPassword
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "mobile": "string",
  • "name": "",
  • "newPassword": "",
  • "originPassword": ""
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "mobile": "string",
  • "name": "string"
}

查询用户角色

Responses

Response samples

Content type
application/json
{
  • "orgs": [
    ],
  • "roles": [
    ]
}

设置账号名称及初始密码

Request Body schema: application/json
name
required
string
Default: ""
password
required
string non-empty
Default: ""
token
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "name": "",
  • "password": "",
  • "token": ""
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "admin": true,
  • "expiresIn": 0,
  • "refreshExpiresIn": 0,
  • "refreshToken": "string",
  • "tokenType": "string"
}

刷新token

Request Body schema: application/json
refreshToken
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "refreshToken": ""
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0,
  • "refreshExpiresIn": 0,
  • "refreshToken": "string",
  • "tokenType": "string"
}

alarm

提供给AlertManager调用的Webhook

Request Body schema: application/json
integer <uint64>

Responses

Request samples

Content type
application/json
0
0

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

查询项目告警配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "email": {
    },
  • "enabled": true,
  • "onlyCritical": true,
  • "resolveInterval": 0,
  • "silenceInterval": 0,
  • "stormInterval": 0,
  • "stormMaxAlarms": 0,
  • "webhook": {
    }
}

修改项目告警通知配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
onlyCritical
required
boolean
silenceInterval
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "onlyCritical": true,
  • "silenceInterval": 0
}

Response samples

Content type
application/json
{
  • "email": {
    },
  • "enabled": true,
  • "onlyCritical": true,
  • "resolveInterval": 0,
  • "silenceInterval": 0,
  • "stormInterval": 0,
  • "stormMaxAlarms": 0,
  • "webhook": {
    }
}

修改项目告警通知中邮件的设置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
enabled
required
boolean
receivers
required
Array of strings
Default: ""

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "receivers": ""
}

Response samples

Content type
application/json
{
  • "email": {
    },
  • "enabled": true,
  • "onlyCritical": true,
  • "resolveInterval": 0,
  • "silenceInterval": 0,
  • "stormInterval": 0,
  • "stormMaxAlarms": 0,
  • "webhook": {
    }
}

修改项目告警通知中Webhook的配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
enabled
required
boolean
headers
required
object
url
required
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "headers": {
    },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "email": {
    },
  • "enabled": true,
  • "onlyCritical": true,
  • "resolveInterval": 0,
  • "silenceInterval": 0,
  • "stormInterval": 0,
  • "stormMaxAlarms": 0,
  • "webhook": {
    }
}

预览项目告警Webhook模板

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "template": "string"
}

测试项目告警Webhook URL是否有效

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
headers
required
object
url
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "headers": {
    },
  • "url": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询项目当前告警

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
fuzzyName
required
string
severity
required
integer <int8>
startsAt
required
integer <int64>
endsAt
required
integer <int64>
size
required
integer <int32> [ 1 .. 100 ]
offset
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

查询项目当前告警数量

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

启用/禁用项目告警

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询项目历史告警

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
fuzzyName
required
string
severity
required
integer <int8>
startsAt
required
integer <int64>
endsAt
required
integer <int64>
size
required
integer <int32> [ 1 .. 100 ]
offset
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

查询项目告警状态：启用/禁用

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

assets

Upload

Request Body schema: multipart/form-data
name
required
string
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

File

path Parameters
file
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Delete

path Parameters
file
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

ManifestJSON

Responses

Response samples

Content type
application/json
{
  • "license": {
    },
  • "modules": {
    },
  • "system": {
    },
  • "uiCustomization": {
    },
  • "userManagement": {
    },
  • "version": 0
}

audit

查询操作审计日志

query Parameters
resource
integer <int64>
Default: ""
operation
integer <int64>
Default: ""
operatorId
string
Default: ""
operatorName
string
Default: ""
orgId
string
Default: ""
projectId
string
Default: ""
clusterId
string
Default: ""
edgeServiceId
string
Default: ""
since
required
integer <int64>
until
required
integer <int64>
size
integer <int32> [ 1 .. 100 ]
Default: "10"
offset
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

BatchResult 查询某批量任务执行状态

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
batchId
required
string = 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "failed": 0,
  • "running": 0,
  • "success": 0
}

emqxcluster

用于EMQX集群Agent同步配置信息

Responses

Response samples

Content type
application/json
{
  • "clusterId": "string",
  • "elasticsearch": {
    },
  • "mqtt": {
    },
  • "tunnel": {
    }
}

注册EMQX集群Agent

Request Body schema: application/json
nodeId
required
string
Default: ""
registrationToken
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "nodeId": "",
  • "registrationToken": ""
}

Response samples

Content type
application/json
{
  • "token": "string"
}

上报EMQX集群Agent信息

Request Body schema: application/json
agentVersion
required
string
Default: ""
clusterFetchError
required
string
required
Array of objects (EMQXEENode)
dashboardEnabled
required
boolean
logsFetchError
required
string
metricsFetchError
required
string
mqttConnectError
required
string
nodeConnectError
required
string
nodeId
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "agentVersion": "",
  • "clusterFetchError": "string",
  • "clusterNodes": [
    ],
  • "dashboardEnabled": true,
  • "logsFetchError": "string",
  • "metricsFetchError": "string",
  • "mqttConnectError": "string",
  • "nodeConnectError": "string",
  • "nodeId": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

移除EMQX集群Agent

Responses

Response samples

Content type
application/json
{ }

添加现有集群

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/x-www-form-urlencoded
name
required
string [ 1 .. 200 ] characters

Responses

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "name": "string",
  • "type": 0
}

查询EMQX集群Agents

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

删除EMQX集群Agent

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string >= 8 characters
agentId
required
integer <uint64> >= 1

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

获取EMQX集群Agent安装向导信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string >= 8 characters
query Parameters
platform
required
string

Responses

Response samples

Content type
application/json
{
  • "architectures": [
    ]
}

转移集群

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string non-empty
Request Body schema: application/json
projectId
required
string >= 8 characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "projectId": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

configuration

查询告警配置

Responses

Response samples

Content type
application/json
{
  • "webhook": {
    }
}

更新告警配置

Request Body schema: application/json
required
object (GlobalAlarmConfigWebhookData)

Responses

Request samples

Content type
application/json
{
  • "webhook": {
    }
}

Response samples

Content type
application/json
{
  • "webhook": {
    }
}

查询全局配置

path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "level": 0,
  • "name": "string"
}

创建全局配置

path Parameters
name
required
string
Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

删除全局配置

path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询组织配置

path Parameters
name
required
string
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "level": 0,
  • "name": "string"
}

创建组织配置

path Parameters
name
required
string
orgId
required
string
Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

删除组织配置

path Parameters
name
required
string
orgId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询项目配置

path Parameters
name
required
string
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "level": 0,
  • "name": "string"
}

创建项目配置

path Parameters
name
required
string
orgId
required
string
projectId
required
string
Request Body schema: application/json
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

删除项目配置

path Parameters
name
required
string
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询Docker 节点配置

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

更新Docker 节点配置

Request Body schema: application/x-www-form-urlencoded
port
required
integer <int64> [ 1 .. 65535 ]
tls
boolean
Default: "false"
cacertFile
string >= 0 characters
Default: ""

cacertPath, certPath, keyPath

certFile
string >= 0 characters
Default: ""
keyFile
string >= 0 characters
Default: ""

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

QueryGlobalConfigEdgeserviceDefaultConfig 查询边缘服务 Docker 部署的默认配置信息

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

CreateGlobalConfigEdgeserviceDefaultConfig 更新边缘服务 Docker 部署的默认配置信息

Request Body schema: application/json
Array
catagory
required
integer <uint8>
Default: ""
environments
Array of strings
Default: ""
ports
object
Default: ""
volumes
object
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

GetEdgeServiceLicConfig

Responses

Response samples

Content type
application/json
{
  • "maxUnmanagedDays": "7"
}

UpdateEdgeServiceLicConfig

Request Body schema: application/json
maxUnmanagedDays
integer <int64>
Default: "7"

Responses

Request samples

Content type
application/json
{
  • "maxUnmanagedDays": "7"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询边缘服务配额配置

Responses

Response samples

Content type
application/json
{
  • "quota": {
    },
  • "storageClass": [
    ]
}

更新边缘服务配额配置

Request Body schema: application/json
kuiperCPULimit
string
Default: ""
kuiperCPURequest
required
string
kuiperMEMLimit
string
Default: ""
kuiperMEMRequest
required
string
neuronCPULimit
string
Default: ""
neuronCPURequest
required
string
neuronMEMLimit
string
Default: ""
neuronMEMRequest
required
string

Responses

Request samples

Content type
application/json
{
  • "kuiperCPULimit": "",
  • "kuiperCPURequest": "string",
  • "kuiperMEMLimit": "",
  • "kuiperMEMRequest": "string",
  • "neuronCPULimit": "",
  • "neuronCPURequest": "string",
  • "neuronMEMLimit": "",
  • "neuronMEMRequest": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询EMQX集群配额配置

Responses

Response samples

Content type
application/json
{
  • "quotas": [
    ],
  • "storage_class_name": "string",
  • "storage_class_size": "2048"
}

更新EMQX配额配置

Request Body schema: application/json
required
Array of objects (EmqxQuotas)
required
Array of objects (StorageClass)

Responses

Request samples

Content type
application/json
{
  • "quotas": [
    ],
  • "storageClass": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询EMQX总配额配置

Responses

Response samples

Content type
application/json
{
  • "total_cpu_quota": 0,
  • "total_memory_quota": 0
}

更新EMQX总配额配置

Request Body schema: application/json
total_cpu_quota
required
integer <uint64>
total_memory_quota
required
integer <uint64>

Responses

Request samples

Content type
application/json
{
  • "total_cpu_quota": 0,
  • "total_memory_quota": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询ES配置

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新ES配置

Request Body schema: application/json
Array
password
string
Default: ""

Index string json:"index"

type
string
Default: "internal"

Type value: "external" or "internal", internal equals close this function.

url
string
Default: ""
username
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询镜像服务配置

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新镜像服务配置

Request Body schema: application/json
Array
password
required
string
url
required
string
username
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

CheckImageRegistry 测试容器镜像库连通性

Request Body schema: application/json
Array
password
required
string
url
required
string
username
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询EMQX镜像

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新EMQX镜像

Request Body schema: application/json
Array
default
boolean
Default: "false"
image
required
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

更新eKuiper配额配置

Request Body schema: application/json
kuiperCPULimit
string
Default: ""
kuiperCPURequest
required
string
kuiperMEMLimit
string
Default: ""
kuiperMEMRequest
required
string
required
Array of objects (StorageClass)

Responses

Request samples

Content type
application/json
{
  • "kuiperCPULimit": "",
  • "kuiperCPURequest": "string",
  • "kuiperMEMLimit": "",
  • "kuiperMEMRequest": "string",
  • "storageClass": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询eKuiper镜像配置

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新eKuiper镜像配置

Request Body schema: application/json
Array
default
boolean
Default: "false"
image
required
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

更新系统语言

Request Body schema: application/json
language
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "language": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询支持的语言列表

Responses

Response samples

Content type
application/json
{
  • "languages": [
    ]
}

查询负载均衡注解配置

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新负载均衡注解配置

Request Body schema: application/json
Array
annotations
string
Default: "{}"
desc
string
Default: ""
is_enabled
boolean
Default: "false"
max_connection
required
integer <uint64>
min_connection
integer <uint64>
Default: "1"
name
required
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

QueryGlobalConfigMetricGateway 查询指标网关

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateGlobalConfigMetricGateway 配置指标网关

Request Body schema: application/json
Array
password
required
string
type
string
Default: "bc"
url
required
string
username
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询监控配置

Responses

Response samples

Content type
application/json
{
  • "ekuiper": {
    },
  • "ekuiperProxy": {
    },
  • "emqx": {
    },
  • "healthCheckInterval": 0,
  • "neuron": {
    },
  • "neuronProxy": {
    }
}

更新监控配置

Request Body schema: application/json
required
object (ScraperConfig)
required
object (ScraperConfig)
required
object (ScraperConfig)
healthCheckInterval
required
integer <int64>
required
object (ScraperConfig)
required
object (ScraperConfig)

Responses

Request samples

Content type
application/json
{
  • "ekuiper": {
    },
  • "ekuiperProxy": {
    },
  • "emqx": {
    },
  • "healthCheckInterval": 0,
  • "neuron": {
    },
  • "neuronProxy": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

更新Neuron配额配置

Request Body schema: application/json
neuronCPULimit
string
Default: ""
neuronCPURequest
required
string
neuronMEMLimit
string
Default: ""
neuronMEMRequest
required
string
required
Array of objects (StorageClass)

Responses

Request samples

Content type
application/json
{
  • "neuronCPULimit": "",
  • "neuronCPURequest": "string",
  • "neuronMEMLimit": "",
  • "neuronMEMRequest": "string",
  • "storageClass": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询Neuron版本配置

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新Neuron版本配置

Request Body schema: application/json
Array
default
boolean
Default: "false"
image
required
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询NeuronEX版本配置

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新NeuronEX版本配置

Request Body schema: application/json
Array
default
boolean
Default: "false"
image
required
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询 emqx 的 reloader 镜像

Responses

Response samples

Content type
application/json
{
  • "image": ""
}

更新 emqx 的 reloader 镜像

Request Body schema: application/json
image
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "image": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询访问域名配置

Responses

Response samples

Content type
application/json
{
  • "scheme": "string",
  • "server_name": "string"
}

更新访问域名配置

Request Body schema: application/json
scheme
required
string
server_name
required
string

Responses

Request samples

Content type
application/json
{
  • "scheme": "string",
  • "server_name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

测试访问域名

Request Body schema: application/json
scheme
required
string
server_name
required
string

Responses

Request samples

Content type
application/json
{
  • "scheme": "string",
  • "server_name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询邮件配置

Responses

Response samples

Content type
application/json
{
  • "encryption": "tls",
  • "host": "string",
  • "password": "string",
  • "port": "25",
  • "username": "string"
}

更新邮件配置

Request Body schema: application/json
encryption
string
Default: "tls"

tls(default) / starttls

host
required
string
password
required
string
port
integer <uint16>
Default: "25"
username
required
string

From string json:"from"

Responses

Request samples

Content type
application/json
{
  • "encryption": "tls",
  • "host": "string",
  • "password": "string",
  • "port": "25",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

测试邮件配置

Request Body schema: application/json
encryption
string
Default: "tls"

tls(default) / starttls

host
required
string
password
required
string
port
integer <uint16>
Default: "25"
username
required
string

From string json:"from"

Responses

Request samples

Content type
application/json
{
  • "encryption": "tls",
  • "host": "string",
  • "password": "string",
  • "port": "25",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询EMQX集群存储类名

Responses

Response samples

Content type
application/json
[
  • {
    }
]

更新EMQX集群存储类名

Request Body schema: application/json
Array
storage_class_name
required
string
storage_class_size
string
Default: "1024Mi"

StorageClassPVSize 默认单位 Mi

type
integer <uint8>
Default: "1"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

QueryGlobalConfigSyslogInfo query syslog server configration

Responses

Response samples

Content type
application/json
{
  • "addr": "",
  • "enabled": "false",
  • "network": "",
  • "priority": "3",
  • "tag": ""
}

CreateGlobalConfigSyslogInfo update syslog server configration

Request Body schema: application/json
addr
string
Default: ""
enabled
boolean
Default: "false"
network
string
Default: ""
priority
integer <int64>
Default: "3"
tag
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "addr": "",
  • "enabled": "false",
  • "network": "",
  • "priority": "3",
  • "tag": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

CheckSyslogServer check the syslog server is right

Request Body schema: application/json
addr
string
Default: ""
enabled
boolean
Default: "false"
network
string
Default: ""
priority
integer <int64>
Default: "3"
tag
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "addr": "",
  • "enabled": "false",
  • "network": "",
  • "priority": "3",
  • "tag": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询Telegraf镜像配置

Responses

Response samples

Content type
application/json
{
  • "image": "string"
}

更新Telegraf镜像配置

Request Body schema: application/json
image
required
string

Responses

Request samples

Content type
application/json
{
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

更新自定义页面配置

Request Body schema: multipart/form-data
name
required
string
logo
required
string <binary>
loginBg
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "loginBg": "string",
  • "logo": "string",
  • "name": "string"
}

查询用户管理配置

Responses

Response samples

Content type
application/json
{
  • "token": {
    },
  • "verification": {
    }
}

更新用户管理配置

Request Body schema: application/json
required
object (AuthTokenConfig)
required
object (UserManagementVerificationConfig)

Responses

Request samples

Content type
application/json
{
  • "token": {
    },
  • "verification": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

es

GetAggregatedList 获取聚合日志列表

query Parameters
start
required
integer <int64>

timestamp，秒

end
required
integer <int64>

timestamp，秒

level
required
string
msg
required
string
size
integer <int32> [ 1 .. 100 ]
Default: "100"
offset
integer <int32> >= 0
Default: "0"
sort
string
Default: ""

字段名

order
string
Default: "desc"

asc/desc

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "data": [
    ]
}

GetAntaresLogList 获取ECP日志列表

query Parameters
start
required
integer <int64>

timestamp，秒

end
required
integer <int64>

timestamp，秒

level
required
string
msg
required
string
size
integer <int32> [ 1 .. 100 ]
Default: "100"
offset
integer <int32> >= 0
Default: "0"
sort
string
Default: ""

字段名

order
string
Default: "desc"

asc/desc

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "data": [
    ]
}

GetNameIdMap 查询当前用户有权限的组织、项目下的服务列表

query Parameters
serviceType
required
integer <uint8>

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

GetEdgeLogList 获取边缘服务日志列表

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
edgeId
string
Default: ""
category
integer <int8>
Default: "2"

服务类别(1:kuiper；2:neuron; 3:edge; 4:other; 99:customize)

start
required
integer <int64>

timestamp，秒

end
required
integer <int64>

timestamp，秒

level
required
string
node
required
string
msg
required
string
size
integer <int32> [ 1 .. 100 ]
Default: "100"
offset
integer <int32> >= 0
Default: "0"
sort
string
Default: ""

字段名

order
string
Default: "desc"

asc/desc

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "data": [
    ]
}

GetLogList 获取EMQX日志列表

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
clusterId
string
Default: ""
start
required
integer <int64>

timestamp，秒

end
required
integer <int64>

timestamp，秒

level
required
string
msg
required
string
size
integer <int32> [ 1 .. 100 ]
Default: "100"
offset
integer <int32> >= 0
Default: "0"
sort
string
Default: ""

字段名

order
string
Default: "desc"

asc/desc

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "data": [
    ]
}

TestESConnectivity 测试ES连通性

Request Body schema: application/json
password
required
string
url
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "url": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

identityprovider

获取认证服务列表

query Parameters
size
integer <uint32> [ 1 .. 50 ]
Default: "10"
offset
integer <uint32> >= 0
Default: "0"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

创建认证服务

Request Body schema: application/json
enabled
required
boolean
forceAuthn
required
boolean
idPSsoUrl
required
string
Default: ""

saml config

idpSloUrl
required
string
Default: ""
name
required
string [ 1 .. 50 ] characters
Default: ""
signAuthn
required
boolean
spAcsUrl
required
string
Default: ""
spEntityId
required
string
spSloUrl
required
string
Default: ""
type
required
string non-empty
Default: ""
validateSignature
required
boolean
validatingCertificate
required
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "forceAuthn": true,
  • "idPSsoUrl": "",
  • "idpSloUrl": "",
  • "name": "",
  • "signAuthn": true,
  • "spAcsUrl": "",
  • "spEntityId": "string",
  • "spSloUrl": "",
  • "type": "",
  • "validateSignature": true,
  • "validatingCertificate": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "type": "string"
}

获取认证服务信息

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "enabled": true,
  • "forceAuthn": true,
  • "id": "string",
  • "idpSloUrl": "string",
  • "idpSsoUrl": "string",
  • "name": "string",
  • "signAuthn": true,
  • "spAcsUrl": "string",
  • "spEntityId": "string",
  • "spSloUrl": "string",
  • "type": "string",
  • "updatedAt": { },
  • "validateSignature": true,
  • "validatingCertificate": "string"
}

更新认证服务

path Parameters
id
required
string non-empty
Request Body schema: application/json
enabled
required
boolean
forceAuthn
required
boolean
idPSsoUrl
required
string
Default: ""

saml config

idpSloUrl
required
string
Default: ""
name
required
string [ 1 .. 50 ] characters
Default: ""
signAuthn
required
boolean
spAcsUrl
required
string
Default: ""
spEntityId
required
string
spSloUrl
required
string
Default: ""
type
required
string non-empty
Default: ""
validateSignature
required
boolean
validatingCertificate
required
string

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "forceAuthn": true,
  • "idPSsoUrl": "",
  • "idpSloUrl": "",
  • "name": "",
  • "signAuthn": true,
  • "spAcsUrl": "",
  • "spEntityId": "string",
  • "spSloUrl": "",
  • "type": "",
  • "validateSignature": true,
  • "validatingCertificate": "string"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "type": "string"
}

删除认证服务

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

edgedeploy

DownloadJwtPublicKey 下载边缘服务 jwt 鉴权需要的jwt公钥

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "keyFileName": "string"
}

List 托管边缘服务列表接口

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
limit
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

edgeName
string >= 0 characters
Default: ""

部署名

creator
string >= 0 characters
Default: ""

部署创建人

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update 更新某个边缘服务的版本

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
edgeId
required
string
kuiperImage
string
Default: ""
neuronImage
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "edgeId": "string",
  • "kuiperImage": "",
  • "neuronImage": ""
}

Response samples

Content type
application/json
{
  • "taskId": "string"
}

Create 创建一个托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
desc
string
Default: ""
disableAuth
boolean
Default: "false"
edgeName
required
string
Default: ""
kuiperImage
string
Default: ""
neuronImage
string
Default: ""
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "desc": "",
  • "disableAuth": "false",
  • "edgeName": "",
  • "kuiperImage": "",
  • "neuronImage": "",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "batchId": "string",
  • "errMap": {
    }
}

BatchCreate 批量创建托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
desc
string
Default: ""
disableAuth
boolean
Default: "false"
edgeName
required
string
Default: ""
kuiperImage
string
Default: ""
neuronImage
string
Default: ""
tag
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "batchId": "string",
  • "errMap": {
    }
}

BatchInfo 查询某批量（除更新之外）、或者指定edgeIds的任务执行状态

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
batchId
string
Default: ""

查询某批次，就只填 batchId

edgeIds
Array of strings
Default: ""

查询指定EdgeId的安装信息， 就将其填入 edgeIds 列表中

Responses

Request samples

Content type
application/json
{
  • "batchId": "",
  • "edgeIds": ""
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "failed": 0,
  • "running": 0,
  • "success": 0
}

BatchDelete 批量删除边缘服务， 包括托管的和纳管的

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "batchId": "string"
}

BatchRestart 批量重启托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "batchId": "string"
}

BatchStart 批量启动托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "batchId": "string"
}

BatchStop 批量停止托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "batchId": "string"
}

BatchUpdate 批量更新托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
parallel
boolean
Default: "false"
Request Body schema: application/json
Array
edgeId
required
string
kuiperImage
string
Default: ""
neuronImage
string
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "batchId": "string"
}

BatchUpdateInfo 查询某批量更新任务的状态

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
batchId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "failed": 0,
  • "running": 0,
  • "success": 0
}

Get 查询指定的某个边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete 删除一个托管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeId
required
string

Responses

Response samples

Content type
application/json
{
  • "taskId": "string"
}

Status 查询某个边缘服务的状态

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "msg": "string",
  • "status": 0
}

license

查询许可证信息

Responses

Response samples

Content type
application/json
{
  • "customerContact": "string",
  • "customerName": "string",
  • "expired": true,
  • "expiredDate": "string",
  • "maxEdgeServiceCount": 0,
  • "maxEmqxClusterCount": 0,
  • "maxSingleClusterConnectionCount": 0,
  • "maxTagCount": 0,
  • "startDate": "string",
  • "totalClusterConnectionCount": 0,
  • "type": "string"
}

更新上传许可证

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "customerContact": "string",
  • "customerName": "string",
  • "expired": true,
  • "expiredDate": "string",
  • "maxEdgeServiceCount": 0,
  • "maxEmqxClusterCount": 0,
  • "maxSingleClusterConnectionCount": 0,
  • "maxTagCount": 0,
  • "startDate": "string",
  • "totalClusterConnectionCount": 0,
  • "type": "string"
}

monitor

GetDeployMonitorData 内部接口

path Parameters
clusterId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "connectCount": 0,
  • "connectQuota": 0,
  • "expectReplicas": 0,
  • "image": "string",
  • "in": 0,
  • "nodeCount": 0,
  • "out": 0,
  • "progress": "string",
  • "resourceLimit": "string",
  • "status": 0,
  • "topicCount": 0,
  • "version": "string"
}

GetLicenseMonitorData 内部接口

Responses

Response samples

Content type
application/json
{
  • "clusterConsumptions": 0,
  • "clusterQuota": 0,
  • "connectionConsumption": 0,
  • "connectionQuota": 0,
  • "edgeServiceConsumption": 0,
  • "edgeServiceQuota": 0,
  • "maxSingleClusterConnectionCount": 0,
  • "tagConsumption": 0,
  • "tagQuota": 0
}

GetClusterLicenseMonitorData

query Parameters
orgId
required
string

orgID

projectId
required
string

projectID

size
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

GetEdgeLicenseMonitorData

query Parameters
orgId
required
string

orgID

projectId
required
string

projectID

size
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

tagIds
required
Array of integers <uint64> [ items <uint64 > ]
noTags
required
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

QueryAbnormalEkuipers 内部接口

path Parameters
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

QueryAbnormalNeurons 内部接口

path Parameters
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

QueryEdgeStats 内部接口

path Parameters
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "ekuiper": {
    },
  • "neuron": {
    }
}

QueryEkuiperStats 内部接口

path Parameters
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "in": {
    },
  • "out": {
    },
  • "rules": 0,
  • "total": 0,
  • "watched": 0
}

QuerySingleEkuiperStats 内部接口

path Parameters
orgId
required
string
projectId
required
string
serviceId
required
string

Responses

Response samples

Content type
application/json
{
  • "arch": "string",
  • "in": {
    },
  • "os": "string",
  • "out": {
    },
  • "rules": 0,
  • "status": 0,
  • "uptime": 0,
  • "version": "string"
}

QueryNeuronStats 内部接口

path Parameters
orgId
required
string
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "north": {
    },
  • "south": {
    },
  • "total": 0,
  • "watched": 0
}

QuerySingleNeuronStats 内部接口

path Parameters
orgId
required
string
projectId
required
string
serviceId
required
string

Responses

Response samples

Content type
application/json
{
  • "buildDate": "string",
  • "hardware": "string",
  • "memTotal": 0,
  • "memUsed": 0,
  • "north": {
    },
  • "south": {
    },
  • "status": 0,
  • "uptime": 0,
  • "version": "string"
}

GetProjectMonitorData 内部接口

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
size
integer <int32> [ 1 .. 100 ]
Default: "100"
offset
integer <int32> >= 0
Default: "0"
sort
string
Default: ""

字段名

order
string
Default: "desc"

asc/desc

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "clusterCount": 0,
  • "instance": [
    ],
  • "userCount": 0
}

QueryHttpSD 内部接口

path Parameters
category
required
integer <int8>
nodetype
required
integer <int8>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TestAntaresConnectivity 测试ECP连通性

Request Body schema: application/json
password
required
string
url
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "url": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

org

查询组织列表

query Parameters
name
required
string
size
integer <int32> [ 1 .. 100 ]
Default: "10"
offset
required
integer <int32> >= 0

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

创建组织

Request Body schema: application/json
required
Array of objects (OrgMember)
name
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "members": [
    ],
  • "name": ""
}

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "members": [
    ],
  • "name": "string"
}

查询组织名称

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

查询组织

path Parameters
orgId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "members": [
    ],
  • "name": "string",
  • "updatedAt": { }
}

更新组织信息

path Parameters
orgId
required
string >= 8 characters
Request Body schema: application/json
required
Array of objects (OrgMember)
name
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "members": [
    ],
  • "name": ""
}

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "members": [
    ],
  • "name": "string",
  • "updatedAt": { }
}

删除组织

path Parameters
orgId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

project

查询组织项目列表

path Parameters
orgId
required
string >= 8 characters
query Parameters
name
required
string
size
integer <int32> [ 1 .. 100 ]
Default: "10"
offset
integer <int32> >= 0
Default: "0"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

创建项目

path Parameters
orgId
required
string >= 8 characters
Request Body schema: application/json
required
Array of objects (ProjectMember)
name
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "members": [
    ],
  • "name": ""
}

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "members": [
    ],
  • "name": "string"
}

查询项目名称

path Parameters
orgId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

查询项目

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "creator": "string",
  • "id": "string",
  • "members": [
    ],
  • "name": "string",
  • "updatedAt": { }
}

更新项目

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
required
Array of objects (ProjectMember)
name
required
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "members": [
    ],
  • "name": ""
}

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "members": [
    ],
  • "name": "string",
  • "updatedAt": { }
}

删除项目

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询项目列表

query Parameters
name
required
string
orgId
required
string
size
integer <int32> [ 1 .. 50 ]
Default: "10"
offset
integer <int32> >= 0
Default: "0"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

backup

BackupFileUpload 上传备份文件， 并使用该备份文件来恢复集群

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
deployId
required
string non-empty
Request Body schema: application/json
file
required
string
filename
required
string

Responses

Request samples

Content type
application/json
{
  • "file": "string",
  • "filename": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string"
}

BackupDelete 删除指定备份

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string non-empty
filename
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

BackupList 查询一个或多个集群的备份列表

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
deploy_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "deploy_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "deploy_id_name_map": {
    },
  • "errors": [
    ]
}

BackupTaskList 查询指定 Org+Project下所有备份任务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "deploy_id_name_map": {
    }
}

CreateBackupTask 创建备份任务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
deploy_id_list
required
Array of strings
schedule_type
integer <uint8>
Default: "0"
status
integer <uint8>
Default: "0"
type
integer <uint8>
Default: "0"
up_time
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "deploy_id_list": [
    ],
  • "schedule_type": "0",
  • "status": "0",
  • "type": "0",
  • "up_time": 0
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

DeleteBackupTask 删除备份任务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
task_id
required
integer <uint64> >= 1

Responses

Response samples

Content type
application/json
{
  • "errors": "string"
}

BackupImmediately 对指定集群立即备份

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "msg": "string"
}

BackupDownload 下载指定备份文件

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string non-empty
filename
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

BackupImport 使用指定备份来恢复集群

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string non-empty
Request Body schema: application/json
filename
required
string
node
required
string

Responses

Request samples

Content type
application/json
{
  • "filename": "string",
  • "node": "string"
}

Response samples

Content type
application/json
{
  • "msg": "string"
}

deploy

GetDeployList 获取部署列表

path Parameters
orgId
required
string >= 8 characters

orgID

projectId
required
string >= 8 characters

projectID

query Parameters
limit
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

deployName
string >= 0 characters
Default: ""

部署名

creator
string >= 0 characters
Default: ""

部署创建人

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxCreate 创建部署

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/x-www-form-urlencoded
deployName
required
string
desc
string [ 0 .. 500 ] characters
Default: ""
image
string
Default: ""
replicas
integer <int32> [ 1 .. 7 ]
Default: "3"
nodeSelector
string
Default: ""

format: format: json string

nodeAntiAffinity
boolean
Default: ""
resourceLimit
string
Default: ""

resource_limit: global config EmqxQuota.Name

labels
string
Default: ""
env
string
Default: ""

format: format: json string

networkType
string
Default: "ClusterIP"

StorageClassPVSize 默认单位 Mi StorageClassSize int32 json:"storageClassSize" default:"0" in:"formData" value is one of: ClusterIP, LoadBalancer, NodePort

networkConfig
string
Default: ""

network_config format: json string; All field Not must example:

{
    "external_port": {
        "mqtt": 1883,
        "mqtts": 8883,
        "ws": 8083,
        "wss": 8084,
        "dashboard": 18083,
        "api": 8081
    },
    "service_port": {
        "mqtt": 1883,
        "mqtts": 8883,
        "ws": 8083,
        "wss": 8084,
        "dashboard": 18083,
        "api": 8081
    },
    "annotations": {
        "service.beta.kubernetes.io/alibaba-cloud-loadbalancer-resource-group-id": "rg-acfnsek6c4hoiea",
        "service.beta.kubernetes.io/alibaba-cloud-loadbalancer-spec": "slb.s2.small",
        "service.beta.kubernetes.io/alicloud-loadbalancer-address-type": "internet"
    }
}
logType
string
Default: "internal"
crtType
integer <int8>
Default: "0"

EMQX 证书类型 0: 默认值都为空 1: wss和mqtts都用 WssCaCrt 2: wss和mqtts都用 MqttsCaCrt 3: wss和mqtts都用 WssTlsCrt 4: wss和mqtts都用 MqttsTlsCrt 5: WssCaCrt + MqttsCaCrt 同时使用 6: WssTlsCrt + MqttsTlsCrt 同时使用 7: WssCaCrt + MqttsTlsCrt 同时使用 8: WssTlsCrt + MqttsCaCrt 同时使用

wssCaCrt
string >= 0 characters
Default: ""

wss WssCaCrt 文件

wssTlsCrt
string >= 0 characters
Default: ""

wss WssTlsCrt 文件

wssTlsKey
string >= 0 characters
Default: ""

wss WssTlsKey 文件

mqttsCaCrt
string >= 0 characters
Default: ""

mqtts MqttsCaCrt 文件

mqttsTlsCrt
string >= 0 characters
Default: ""

mqtts MqttsTlsCrt 文件

mqttsTlsKey
string >= 0 characters
Default: ""

mqtts MqttsTlsKey 文件

license
string >= 0 characters
Default: ""

emqx License 文件

connectLimit
integer <int32> >= 1
Default: "10"
backupFilename
string
Default: ""

backup init parameters

backupDeployId
string
Default: ""
backupFile
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

GetDeployInfoById 根据 deployID、orgID、projectID 获取部署详细信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
clusterId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxDelete 删除指定部署

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxCrtUpdate 更新部署的证书，包括 WSS, MQTTS 的证书

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/x-www-form-urlencoded
crtType
integer <int8>
Default: "0"

EMQX 证书类型 0: 默认值都为空 1: wss和mqtts都用 WssCaCrt 2: wss和mqtts都用 MqttsCaCrt 3: wss和mqtts都用 WssTlsCrt 4: wss和mqtts都用 MqttsTlsCrt 5: WssCaCrt + MqttsCaCrt 同时使用 6: WssTlsCrt + MqttsTlsCrt 同时使用 7: WssCaCrt + MqttsTlsCrt 同时使用 8: WssTlsCrt + MqttsCaCrt 同时使用

wssCaCrt
string >= 0 characters
Default: ""

wss WssCaCrt 文件

wssTlsCrt
string >= 0 characters
Default: ""

wss WssTlsCrt 文件

wssTlsKey
string >= 0 characters
Default: ""

wss WssTlsKey 文件

mqttsCaCrt
string >= 0 characters
Default: ""

mqtts MqttsCaCrt 文件

mqttsTlsCrt
string >= 0 characters
Default: ""

mqtts MqttsTlsCrt 文件

mqttsTlsKey
string >= 0 characters
Default: ""

mqtts MqttsTlsKey 文件

license
string >= 0 characters
Default: ""

emqx License 文件

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EMQX 集群动态License更新

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
connectLimit
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "connectLimit": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

EMQX 集群镜像版本更新

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
image
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "image": ""
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxLicUpdate 更新部署的 License

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/x-www-form-urlencoded
crtType
integer <int8>
Default: "0"

EMQX 证书类型 0: 默认值都为空 1: wss和mqtts都用 WssCaCrt 2: wss和mqtts都用 MqttsCaCrt 3: wss和mqtts都用 WssTlsCrt 4: wss和mqtts都用 MqttsTlsCrt 5: WssCaCrt + MqttsCaCrt 同时使用 6: WssTlsCrt + MqttsTlsCrt 同时使用 7: WssCaCrt + MqttsTlsCrt 同时使用 8: WssTlsCrt + MqttsCaCrt 同时使用

wssCaCrt
string >= 0 characters
Default: ""

wss WssCaCrt 文件

wssTlsCrt
string >= 0 characters
Default: ""

wss WssTlsCrt 文件

wssTlsKey
string >= 0 characters
Default: ""

wss WssTlsKey 文件

mqttsCaCrt
string >= 0 characters
Default: ""

mqtts MqttsCaCrt 文件

mqttsTlsCrt
string >= 0 characters
Default: ""

mqtts MqttsTlsCrt 文件

mqttsTlsKey
string >= 0 characters
Default: ""

mqtts MqttsTlsKey 文件

license
string >= 0 characters
Default: ""

emqx License 文件

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxNetUpdate 更新部署的 network

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
annotations
required
object
load_balancer_class
required
string
required
Array of objects (PortInfo)
type
required
string

Responses

Request samples

Content type
application/json
{
  • "annotations": {
    },
  • "load_balancer_class": "string",
  • "ports": [
    ],
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxProxy 先检查该 deployid是否真的存在， 并开启代理通道

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
endPoint
required
string non-empty
Default: ""
timeout
integer <int64> >= 1
Default: "300"

Responses

Request samples

Content type
application/json
{
  • "endPoint": "",
  • "timeout": "300"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxRepair 修复指定已经异常的集群

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxScale 水平伸缩指定部署

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
replicas
required
integer <int32> [ 1 .. 7 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxStart 启动指定部署

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

EmqxStatus 查询部署状态

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

停止指定部署的服务

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

更新指定部署的信息

path Parameters
orgId
required
string >= 8 characters

orgID

projectId
required
string >= 8 characters

projectID

clusterId
required
string non-empty

deployID

Request Body schema: application/json
deployName
string
Default: ""
desc
string [ 0 .. 500 ] characters
Default: ""

Responses

Request samples

Content type
application/json
{
  • "deployName": "",
  • "desc": ""
}

Response samples

Content type
application/json
{ }

EmqxVerticalScale 垂直伸缩指定部署

path Parameters
clusterId
required
string non-empty
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
resourceLimit
required
string non-empty

resource_limit: global config EmqxQuota.Name

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

dockerdeploy

Update 批量更新部署在 docker 上的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
image
required
string
serviceId
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Create 批量部署 docker 上的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
category
required
integer <uint8>

edge service properties (1:kuiper；2:neuron; 3:edge; 4:neuronex; 99:customize)

cmd
string
Default: ""

CMD & Entrypoint

containerName
required
string
desc
string [ 0 .. 500 ] characters
Default: ""
disableAuth
required
boolean
dockerIaasId
required
integer <uint64>

Docker iaas info

entrypoint
string
Default: ""
environments
Array of strings
Default: ""

RestartPolicy string json:"restartPolicy,omitempty" Environment

image
required
string

image pull secret

ports
object
Default: ""

port

registryPassword
string
Default: ""
registryUsername
string
Default: ""
serviceName
required
string
shell
Array of strings
Default: ""
tag
string
Default: ""
volumes
object
Default: ""

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "batchId": "string"
}

Delete 批量删除部署在 docker 上的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
Array
serviceId
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

CreateNode 创建 docker 节点信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
desc
string
Default: ""
dockerHost
required
string

Tls bool json:"tls" default:"false" //cacertPath, certPath, keyPath CacertPath string json:"cacertPath" default:"" CertPath string json:"certPath" default:"" KeyPath string json:"keyPath" default:""

name
required
string

Responses

Request samples

Content type
application/json
{
  • "desc": "",
  • "dockerHost": "string",
  • "name": "string"
}

Response samples

Content type
application/json
0
0

ListNode 列表查询 docker 节点信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
name
string
Default: ""
limit
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

GetNode 查询 docker 节点信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
id
required
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "created_at": { },
  • "id": 0,
  • "updated_at": { },
  • "desc": "string",
  • "dockerHost": "string",
  • "name": "string",
  • "orgId": "string",
  • "projectId": "string"
}

UpdateNode 更新 docker 节点信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
id
required
integer <uint64> >= 0
Request Body schema: application/json
cacertPath
string
Default: ""

cacertPath, certPath, keyPath

certPath
string
Default: ""
desc
string
Default: ""
keyPath
string
Default: ""
name
required
string
tls
boolean
Default: "false"

DockerHost string json:"dockerHost"

Responses

Request samples

Content type
application/json
{
  • "cacertPath": "",
  • "certPath": "",
  • "desc": "",
  • "keyPath": "",
  • "name": "string",
  • "tls": "false"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

DeleteNode 删除 docker 节点信息

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
id
required
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

GetNodeServices 查询 docker 节点上的边缘服务列表

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
id
required
integer <uint64> >= 0
query Parameters
limit
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

edgeagent

List 获取边缘网关列表

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
agentId
required
string
name
required
string
type
required
integer <int64>
size
integer <int32> [ 1 .. 100 ]
Default: "100"
offset
integer <int32> >= 0
Default: "0"
sort
string
Default: ""

字段名

order
string
Default: "desc"

asc/desc

Responses

Response samples

Content type
application/json
{
  • "offset": 0,
  • "size": 0,
  • "total": 0,
  • "agents": [
    ]
}

Create 创建边缘网关

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
agentId
required
string
desc
string
Default: ""
name
required
string

Responses

Request samples

Content type
application/json
{
  • "agentId": "string",
  • "desc": "",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Transfer 转移边缘网关

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
agentIds
required
Array of strings
targetOrgId
required
string
targetProjectId
required
string

Responses

Request samples

Content type
application/json
{
  • "agentIds": [
    ],
  • "targetOrgId": "string",
  • "targetProjectId": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Update 更新边缘网关

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
agentId
required
string
Request Body schema: application/json
desc
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "desc": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Delete 删除边缘网关

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
agentId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

edgeservice

ListServices 获取边缘服务列表

path Parameters
orgId
required
string >= 8 characters

orgID

projectId
required
string >= 8 characters

projectID

query Parameters
size
integer <int64> [ -1 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

type
integer <int64>
Default: "0"

0-all, 1-online, 2-offline

category
required
Array of integers <int8> [ items <int8 > ]

1-ekuiper, 2-neuron, 3-nanomq

nodeType
integer <int8>
Default: "0"

0-all, 3-proxy, 4-direct

name
string
Default: ""
agentName
string
Default: ""
unionFuzzy
string
Default: ""

多字段联合模糊搜索，包含name、endpoint、version、desc，此时不返回normal数量

noTags
required
boolean
tagIds
required
Array of integers <uint64> [ items <uint64 > ]
toClone
required
boolean

toClone = true 时，ekuiper version >= 1.8.0，neuron version >= 2.4.0

isPartial
required
boolean

toClone = true 时有效，isPartial = true 时，ekuiper version >= 1.9.0, neuron 暂不支持

isEcpInstalled
boolean
Default: "false"
dockerName
string
Default: ""

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create 纳管边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
agentId
string
Default: ""
auth
integer <int8>
Default: "0"

认证类型(0:无认证; 1:basic; 2:jwt)

broker
string [ 0 .. 100 ] characters
Default: ""
category
required
integer <int8>

服务类别(1:ekuiper；2:neuron; 3:nanomq; 4:neuronex 99:customize)

desc
string [ 0 .. 500 ] characters
Default: ""
endpoint
required
string
key
string [ 0 .. 500 ] characters
Default: ""
name
required
string
Default: ""
nodeType
integer <int8>
Default: "4"

节点类型(3:proxy; 4:direct)

scheme
string
Default: "http"
secret
string [ 0 .. 500 ] characters
Default: ""

经aes-cbc及base64加密

tag
required
string

Responses

Request samples

Content type
application/json
{
  • "agentId": "",
  • "auth": "0",
  • "broker": "",
  • "category": 0,
  • "desc": "",
  • "endpoint": "string",
  • "key": "",
  • "name": "",
  • "nodeType": "4",
  • "scheme": "http",
  • "secret": "",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "tip": "string"
}

Export 导出纳管的边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
query Parameters
serviceIds
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Import 导入纳管边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "fails": [
    ]
}

GetEdgeServiceNames 获取项目下边缘服务名称

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

BatchTag 为多个边缘服务添加标签

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
Request Body schema: application/json
serviceIds
required
Array of strings
Default: ""
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "serviceIds": "",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "failedServiceNames": [
    ]
}

GetService

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeServiceId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update 更新边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeServiceId
required
string non-empty
Request Body schema: application/json
agentId
string
Default: ""
auth
integer <int8>
Default: "0"

认证类型(0:无认证; 1:basic; 2:jwt)

broker
string
Default: ""
category
required
integer <int8>

服务类别(1:ekuiper；2:neuron; 3:nanomq)

desc
string [ 0 .. 500 ] characters
Default: ""
endpoint
required
string
key
string
Default: ""
name
required
string
Default: ""
nodeType
integer <int8>
Default: "4"

节点类型(3:proxy; 4:direct)

scheme
string
Default: "http"
secret
string
Default: ""

Responses

Request samples

Content type
application/json
{
  • "agentId": "",
  • "auth": "0",
  • "broker": "",
  • "category": 0,
  • "desc": "",
  • "endpoint": "string",
  • "key": "",
  • "name": "",
  • "nodeType": "4",
  • "scheme": "http",
  • "secret": ""
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "tip": "string"
}

Delete 解除纳管边缘服务

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeServiceId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

AddTag 为单个边缘服务添加标签

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeServiceId
required
string non-empty
Request Body schema: application/json
tag
required
string

Responses

Request samples

Content type
application/json
{
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

allocate tag to NeuronEX

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeServiceId
required
string non-empty
Request Body schema: application/json
tagLimit
required
integer <int64>

use pointer to avoid value 0 being treated as if the field not present

Responses

Request samples

Content type
application/json
{
  • "tagLimit": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

get used tag from NeuronEX

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
edgeServiceId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "tagUsed": 0
}

edgetemplate

Deliver 下发边缘服务配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
Request Body schema: application/json
defaultValue
required
Array of strings
function
required
integer <int64>

1-ekuiper,2-neuron

title
required
Array of strings
type
required
integer <int64>

0-all,1-partial

value
required
Array of strings[ items ]

Responses

Request samples

Content type
application/json
{
  • "defaultValue": [
    ],
  • "function": 0,
  • "title": [
    ],
  • "type": 0,
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

DeliverResult 获取边缘服务配置下发结果

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "failureCount": 0,
  • "successCount": 0
}

Export 导出边缘服务配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
query Parameters
file
required
boolean
ids
required
Array of strings

only related to export from edge directly, ekuiper version >= 1.9.0, neuron 暂不支持

function
required
integer <int64>

1-ekuiper,2-neuron

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

ExportParam 导出边缘服务配置模版中的参数

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
query Parameters
serviceIds
required
Array of strings
data
required
boolean

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Import 导入边缘服务配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
query Parameters
type
required
integer <int64>

0-all,1-partial

function
required
integer <int64>

1-ekuiper,2-neuron

Request Body schema: application/json
template
required
string

Responses

Request samples

Content type
application/json
{
  • "template": "string"
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ImportParam 导入边缘服务配置模版参数对应的值

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Validate 校验边缘服务配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
Request Body schema: application/json
serviceNames
required
Array of strings
title
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "serviceNames": [
    ],
  • "title": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

View 预览边缘服务配置

path Parameters
orgId
required
string >= 8 characters
projectId
required
string >= 8 characters
serviceId
required
string
Request Body schema: application/json
defaultValue
required
Array of strings
title
required
Array of strings
value
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "defaultValue": [
    ],
  • "title": [
    ],
  • "value": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

tag

查询项目标签列表

path Parameters
orgId
required
string
projectId
required
string
query Parameters
name
required
string
size
required
integer <int32> [ 0 .. 100 ]
offset
required
integer <int32> >= 0

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

创建项目标签

path Parameters
orgId
required
string
projectId
required
string
Request Body schema: application/json
name
required
string
serviceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "failedServiceNames": [
    ],
  • "id": 0,
  • "name": "string",
  • "tagged": 0
}

更新项目标签

path Parameters
orgId
required
string
projectId
required
string
tagId
required
integer <uint64>
Request Body schema: application/json
name
required
string
serviceIDs
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "serviceIDs": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "failedServiceNames": [
    ],
  • "id": 0,
  • "name": "string",
  • "tagged": 0,
  • "updatedAt": { }
}

删除项目标签

path Parameters
orgId
required
string
projectId
required
string
tagId
required
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

查询项目标签下的边缘服务

path Parameters
orgId
required
string
projectId
required
string
tagId
required
integer <uint64>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

sso

单点登录激活账号

Request Body schema: application/json
email
required
string
Default: ""
name
required
string [ 1 .. 50 ] characters
Default: ""
password
required
string non-empty
Default: ""
token
required
string non-empty
Default: ""

Responses

Request samples

Content type
application/json
{
  • "email": "",
  • "name": "",
  • "password": "",
  • "token": ""
}

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "admin": true,
  • "expiresIn": 0,
  • "refreshExpiresIn": 0,
  • "refreshToken": "string",
  • "tokenType": "string"
}

获取单点登录服务

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

提供给认证服务的SAML SLO接口

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

提供给认证服务的SAML SLO接口

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

提供给认证服务的SAML ACS接口

path Parameters
id
required
string non-empty
Request Body schema: application/x-www-form-urlencoded
RelayState
required
string
SAMLResponse
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

用于单点登录请求

path Parameters
id
required
string non-empty
query Parameters
relayState
required
string

Responses

Response samples

Content type
application/json
{
  • "data": "string",
  • "method": "string"
}

下载SP元数据XML

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

task

CreateTask 创建一个任务

Request Body schema: application/json
deploy_id
required
string
type
required
integer <uint8>
user_id
required
string

Responses

Request samples

Content type
application/json
{
  • "deploy_id": "string",
  • "type": 0,
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "task_id": "string"
}

GetTaskByTaskID 查询指定的任务

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createdAt": { },
  • "id": "string",
  • "updatedAt": { },
  • "deploy_id": "string",
  • "progress": "string",
  • "status": 0,
  • "type": 0,
  • "user_id": "string"
}

UpdateTask 修改某个任务

path Parameters
id
required
string
Request Body schema: application/json
progress
required
string
status
required
integer <uint8>

Responses

Request samples

Content type
application/json
{
  • "progress": "string",
  • "status": 0
}

Response samples

Content type
application/json
{
  • "task_id": "string"
}

user

查询用户列表

query Parameters
nameOrEmail
string [ 0 .. 200 ] characters
Default: ""
orgId
string
Default: ""
admin
boolean
Default: ""
size
integer <int32> [ 1 .. 50 ]
Default: "10"
offset
integer <int32>
Default: "0"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

创建用户

Request Body schema: application/json
admin
required
boolean
email
required
string
name
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "admin": true,
  • "email": "string",
  • "name": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "admin": true,
  • "createdAt": { },
  • "email": "string",
  • "id": "string",
  • "name": "string"
}

通过邮箱邀请新用户

Request Body schema: application/json
admin
required
boolean
emails
required
Array of strings
Default: ""

Responses

Request samples

Content type
application/json
{
  • "admin": true,
  • "emails": ""
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

邮箱是否已邀请

query Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "invited": true
}

通过姓名搜索用户

query Parameters
name
string
Default: ""
orgId
string
Default: ""
verified
boolean
Default: ""
enabled
boolean
Default: ""
size
integer <int32> [ -1 .. 100 ]
Default: "10"
offset
integer <int32>
Default: "0"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

查询用户信息

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "admin": true,
  • "email": "string",
  • "enabled": true,
  • "mobile": "string",
  • "name": "string",
  • "userId": "string",
  • "verified": true
}

更新用户

path Parameters
userId
required
string [ 1 .. 40 ] characters
Request Body schema: application/json
admin
required
boolean
email
required
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "admin": true,
  • "email": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "admin": true,
  • "createdAt": { },
  • "email": "string",
  • "id": "string",
  • "name": "string",
  • "updatedAt": { }
}

删除用户

path Parameters
userId
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

将用户添加到组织

path Parameters
userId
required
string [ 1 .. 40 ] characters
Request Body schema: application/json
orgIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "orgIds": [
    ]
}

Response samples

Content type
application/json
{
  • "orgIds": [
    ]
}

启用/禁用用户

path Parameters
userId
required
string [ 1 .. 40 ] characters
Request Body schema: application/json
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "user": "string"
}

重置用户密码

path Parameters
userId
required
string [ 1 .. 40 ] characters
Request Body schema: application/json
password
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

重新发送邀请邮件

path Parameters
userId
required
string [ 1 .. 40 ] characters

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

iaas

查询 k8s 连接信息列表

query Parameters
size
integer <int64> [ 0 .. 50 ]
Default: "10"

分页数

offset
integer <int64> >= 0
Default: "0"

分页偏移

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total": 0
}

新建 k8s 连接信息

Request Body schema: multipart/form-data
kubeConfig
required
string <binary>

Config: kube-config 文件

name
required
string

Name: 给 kube-config 取个名字

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

查询指定的 k8s 连接信息

path Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

删除指定的 k8s 连接信息

path Parameters
name
required
string non-empty

Responses

Response samples

Content type
application/json
{ }

version

查询版本信息

Responses

Response samples

Content type
application/json
{
  • "commit": "string",
  • "created": "string",
  • "version": "string"
}

trace

查询链路追踪配置信息

Responses

Response samples

Content type
application/json
{
  • "grpc": "string",
  • "http": "string"
}

查询链路追踪列表记录

query Parameters
offset
string
Example: offset=0

分页开始位置

size
string
Example: size=30

每页数量

service_name_like
string
Example: service_name_like=demo

模糊查询服务名称

span_name_like
string
Example: span_name_like=driver

模糊查询 Span名称

attribute_like
string
Example: attribute_like=nam

模糊查询 Attribute 名称

start
string
Example: start=2024-10-15%2003%3A02%3A06.172

开始时间 （utc）

end
string
Example: end=2024-10-16%2003%3A02%3A06.172

结束时间 （utc）

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

查询链路详情

path Parameters
traceId
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}