< 反馈文档问题
API docs by Redocly

ECP API (1.0.0)

Download OpenAPI specification:Download

account

Login

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"
}

Logout

Responses

Refresh 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"
}

org

Create organization

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"
}

Get organizations

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
}

Get organization names

Responses

Response samples

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

Get organization

path Parameters
orgId
required
string >= 8 characters

Responses

Response samples

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

Update organization

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": { }
}

Delete organization

path Parameters
orgId
required
string >= 8 characters

Responses

Response samples

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

project

Create project

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"
}

Get organization projects

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
}

Get project names

path Parameters
orgId
required
string >= 8 characters

Responses

Response samples

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

Get project

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": { }
}

Update project

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": { }
}

Delete project

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

Responses

Response samples

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

Get projects

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
}

emqxcluster

Add existing EMQX cluster

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
}

Get a cluster

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": {
    }
}

Delete specified EMQX cluster

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": {
    }
}

Get clusters

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
}

edgeservice

Get edge services

path Parameters
orgId
required
string >= 8 characters

orgID

projectId
required
string >= 8 characters

projectID

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

Page number

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

Pagination offset

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: ""

Multi-field fuzzy search, including name, endpoint, version, desc, without returning the normal count at this time

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

When toClone = true is valid, and isPartial = true, eKuipter version >= 1.9.0, neuron does not currently support it

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

Responses

Response samples

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

Create managed edge service

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"

Authentication type (0: None; 1: Basic; 2: JWT)

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

Service category(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"

Node type(3:proxy; 4:direct)

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

Encrypt using AES-CBC and then encode with 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"
}

Get edge service names

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

Responses

Response samples

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

Get service

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": {
    }
}

Delete managed edge service

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"
}

user

Get users

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
}

Create user

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"
}

Invite new users via email

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"
}

Get user

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
}

Update user

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": { }
}

Delete user

path Parameters
userId
required
string non-empty

Responses

Response samples

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