Download OpenAPI specification:Download
password required | string non-empty Default: "" |
username required | string non-empty Default: "" |
{- "password": "",
- "username": ""
}
{- "accessToken": "string",
- "admin": true,
- "expiresIn": 0,
- "refreshExpiresIn": 0,
- "refreshToken": "string",
- "tokenType": "string"
}
refreshToken required | string non-empty Default: "" |
{- "refreshToken": ""
}
{- "accessToken": "string",
- "expiresIn": 0,
- "refreshExpiresIn": 0,
- "refreshToken": "string",
- "tokenType": "string"
}
required | Array of objects (OrgMember) |
name required | string Default: "" |
{- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": ""
}
{- "createdAt": { },
- "id": "string",
- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": "string"
}
name required | string |
size | integer <int32> [ 1 .. 100 ] Default: "10" |
offset required | integer <int32> >= 0 |
{- "data": [
- {
- "createdAt": { },
- "id": "string",
- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": "string",
- "projects": [
- "string"
], - "updatedAt": { }
}
], - "total": 0
}
orgId required | string >= 8 characters |
required | Array of objects (OrgMember) |
name required | string Default: "" |
{- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": ""
}
{- "createdAt": { },
- "id": "string",
- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": "string",
- "updatedAt": { }
}
orgId required | string >= 8 characters |
required | Array of objects (ProjectMember) |
name required | string Default: "" |
{- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": ""
}
{- "createdAt": { },
- "id": "string",
- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": "string"
}
orgId required | string >= 8 characters |
name required | string |
size | integer <int32> [ 1 .. 100 ] Default: "10" |
offset | integer <int32> >= 0 Default: "0" |
{- "data": [
- {
- "clusterCount": 0,
- "createdAt": { },
- "id": "string",
- "members": [
- {
- "email": "string",
- "enabled": true,
- "name": "string",
- "roleIds": [
- 0
], - "userId": "string"
}
], - "name": "string",
- "updatedAt": { }
}
], - "total": 0
}
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
required | Array of objects (ProjectMember) |
name required | string Default: "" |
{- "members": [
- {
- "roleIds": [
- 0
], - "userId": ""
}
], - "name": ""
}
{- "createdAt": { },
- "id": "string",
- "members": [
- "string"
], - "name": "string",
- "updatedAt": { }
}
name required | string |
orgId required | string |
size | integer <int32> [ 1 .. 50 ] Default: "10" |
offset | integer <int32> >= 0 Default: "0" |
{- "data": [
- {
- "clusterCount": 0,
- "createdAt": { },
- "id": "string",
- "members": [
- {
- "email": "string",
- "enabled": true,
- "name": "string",
- "roleIds": [
- 0
], - "userId": "string"
}
], - "name": "string",
- "orgId": "string",
- "orgName": "string",
- "updatedAt": { }
}
], - "total": 0
}
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
name required | string [ 1 .. 200 ] characters |
{- "createdAt": { },
- "id": "string",
- "name": "string",
- "type": 0
}
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
clusterId required | string non-empty |
{- "data": {
- "connectLimit": 0,
- "createdAt": { },
- "creator": "string",
- "dashboardEnabled": true,
- "deployName": "string",
- "desc": "string",
- "expectReplicas": 0,
- "id": "string",
- "image": "string",
- "namespace": "string",
- "network": "string",
- "orgId": "string",
- "projectId": "string",
- "registrationToken": "string",
- "replicas": 0,
- "resourceLimit": "string",
- "status": 0,
- "taskId": "string",
- "type": 0,
- "upTime": { },
- "updatedAt": { },
- "version": "string"
}
}
clusterId required | string non-empty |
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
name required | string |
{- "name": "string"
}
{- "data": {
- "taskId": "string"
}
}
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
size | integer <int32> [ 1 .. 100 ] Default: "100" |
offset | integer <int32> >= 0 Default: "0" |
sort | string Default: "" 字段名 |
order | string Default: "desc" asc/desc |
{- "offset": 0,
- "size": 0,
- "total": 0,
- "clusterCount": 0,
- "instance": [
- {
- "agent": {
- "activeCount": 0,
- "totalCount": 0
}, - "connectCount": 0,
- "connectQuota": 0,
- "createdAt": { },
- "expectReplicas": 0,
- "id": "string",
- "image": "string",
- "in": 0,
- "name": "string",
- "network": "string",
- "nodeCount": 0,
- "out": 0,
- "progress": "string",
- "resourceLimit": "string",
- "status": 0,
- "topicCount": 0,
- "type": 0,
- "upTime": { },
- "version": "string"
}
], - "userCount": 0
}
orgId required | string >= 8 characters orgID |
projectId required | string >= 8 characters projectID |
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: "" |
{- "data": {
- "list": [
- {
- "agentId": "string",
- "allocatedTag": 0,
- "apiVersion": "string",
- "auth": 0,
- "autoRecover": 0,
- "autoStart": 0,
- "broker": "string",
- "category": 0,
- "createdAt": { },
- "desc": "string",
- "dockerDeployId": 0,
- "edgeInfoId": "string",
- "endpoint": "string",
- "key": "string",
- "name": "string",
- "nodeType": 0,
- "orgId": "string",
- "projectId": "string",
- "scheme": "string",
- "secret": "string",
- "serviceId": "string",
- "status": 0,
- "updatedAt": { },
- "tags": [
- "string"
]
}
], - "total": 0
}
}
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
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 |
{- "agentId": "",
- "auth": "0",
- "broker": "",
- "category": 0,
- "desc": "",
- "endpoint": "string",
- "key": "",
- "name": "",
- "nodeType": "4",
- "scheme": "http",
- "secret": "",
- "tag": "string"
}
{- "data": {
- "agentId": "string",
- "allocatedTag": 0,
- "apiVersion": "string",
- "auth": 0,
- "autoRecover": 0,
- "autoStart": 0,
- "broker": "string",
- "category": 0,
- "createdAt": { },
- "desc": "string",
- "dockerDeployId": 0,
- "edgeInfoId": "string",
- "endpoint": "string",
- "key": "string",
- "name": "string",
- "nodeType": 0,
- "orgId": "string",
- "projectId": "string",
- "scheme": "string",
- "secret": "string",
- "serviceId": "string",
- "status": 0,
- "updatedAt": { }
}, - "tip": "string"
}
orgId required | string >= 8 characters |
projectId required | string >= 8 characters |
edgeServiceId required | string non-empty |
{- "data": {
- "agentId": "string",
- "allocatedTag": 0,
- "apiVersion": "string",
- "auth": 0,
- "autoRecover": 0,
- "autoStart": 0,
- "broker": "string",
- "category": 0,
- "createdAt": { },
- "desc": "string",
- "dockerDeployId": 0,
- "edgeInfoId": "string",
- "endpoint": "string",
- "key": "string",
- "name": "string",
- "nodeType": 0,
- "orgId": "string",
- "projectId": "string",
- "scheme": "string",
- "secret": "string",
- "serviceId": "string",
- "status": 0,
- "updatedAt": { },
- "tags": [
- "string"
]
}
}
nameOrEmail | string [ 0 .. 200 ] characters Default: "" |
orgId | string Default: "" |
admin | boolean Default: "" |
size | integer <int32> [ 1 .. 50 ] Default: "10" |
offset | integer <int32> Default: "0" |
{- "data": [
- {
- "admin": true,
- "createdAt": { },
- "email": "string",
- "enabled": true,
- "lastLoginTime": { },
- "mobile": "string",
- "name": "string",
- "userId": "string",
- "verified": true
}
], - "total": 0
}
admin required | boolean |
email required | string |
name required | string |
password required | string |
{- "admin": true,
- "email": "string",
- "name": "string",
- "password": "string"
}
{- "admin": true,
- "createdAt": { },
- "email": "string",
- "id": "string",
- "name": "string"
}
userId required | string [ 1 .. 40 ] characters |
admin required | boolean |
email required | string |
name required | string |
{- "admin": true,
- "email": "string",
- "name": "string"
}
{- "admin": true,
- "createdAt": { },
- "email": "string",
- "id": "string",
- "name": "string",
- "updatedAt": { }
}