OMC/build.ems
1
0
Fork 0
Code Issues Activity
Files
ec756261be6a924879435b009b9f50ced69659eb
build.ems/docs/08-interfaces/08-OMC HTTP RESTful API Interfaces v1.10.md

15814 lines
590 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# OMC HTTP RESTful API Interfaces
# Authentication
## GET Query user info
GET /getInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": {
"permissions": [
"*:*:*"
],
"roles": [
"admin"
],
"user": {
"roles": [
{
"roleId": "1",
"roleName": "admin",
"roleKey": "admin",
"roleSort": 1,
"dataScope": "1",
"status": "1"
}
],
"userId": "1",
"deptId": "103",
"userName": "manager",
"nickName": "manager",
"userType": "sys",
"email": "",
"avatar": "",
"phonenumber": "",
"sex": "1",
"status": "1",
"delFlag": "0",
"loginIp": "127.0.0.1",
"loginDate": "1683968355811",
"createBy": "maskAdmin",
"createTime": "1682264526306",
"remark": "manager",
"dept": {
"deptId": "103",
"parentId": "101",
"ancestors": "0,100,101",
"deptName": "R&D",
"orderNum": 1,
"leader": "",
"status": "1"
}
}
}
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------ | -------- | -------- | ------------ | ---------------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» permissions | [string] | true | none | Permissions list |
| »» roles | [string] | true | none | Roles list |
| »» user | object | true | none | none |
| »»» roles | [object] | true | none | none |
| »»»» roleId | string | false | none | none |
| »»»» roleName | string | false | none | none |
| »»»» roleKey | string | false | none | none |
| »»»» roleSort | integer | false | none | none |
| »»»» dataScope | string | false | none | none |
| »»»» status | string | false | none | none |
| »»» userId | string | true | none | none |
| »»» deptId | string | true | none | none |
| »»» userName | string | true | none | none |
| »»» nickName | string | true | none | none |
| »»» userType | string | true | none | none |
| »»» email | string | true | none | none |
| »»» avatar | string | true | none | none |
| »»» phonenumber | string | true | none | none |
| »»» sex | string | true | none | none |
| »»» status | string | true | none | none |
| »»» delFlag | string | true | none | none |
| »»» loginIp | string | true | none | none |
| »»» loginDate | string | true | none | none |
| »»» createBy | string | true | none | none |
| »»» createTime | string | true | none | none |
| »»» remark | string | true | none | none |
| »»» dept | object | false | none | none |
| »»»» deptId | string | true | none | none |
| »»»» parentId | string | true | none | none |
| »»»» ancestors | string | true | none | none |
| »»»» deptName | string | true | none | none |
| »»»» orderNum | integer | true | none | none |
| »»»» leader | string | true | none | none |
| »»»» status | string | true | none | none |
## GET Query route info
GET /getRouters
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": [
{
"name": "System",
"path": "/system",
"component": "BasicLayout",
"meta": {
"icon": "icon-pcduan",
"title": "System Management",
"hide": false,
"cache": true,
"target": null
},
"redirect": "/system/user",
"children": [
{
"name": "User",
"path": "user",
"component": "system/user/index",
"meta": {
"icon": "icon-pcduan",
"title": "User Management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Role",
"path": "role",
"component": "system/role/index",
"meta": {
"icon": "icon-pcduan",
"title": "Role Management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "RoleinlineauthuserroleId",
"path": "role/inline/auth-user/:roleId",
"component": "system/role/auth-user",
"meta": {
"icon": "icon-pcduan",
"title": "Role assign to user",
"hide": true,
"cache": false,
"target": null
}
},
{
"name": "Menu",
"path": "menu",
"component": "system/menu/index",
"meta": {
"icon": "icon-pcduan",
"title": "Menu management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Dept",
"path": "dept",
"component": "system/dept/index",
"meta": {
"icon": "icon-pcduan",
"title": "Department management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Post",
"path": "post",
"component": "system/post/index",
"meta": {
"icon": "icon-pcduan",
"title": "Postion management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Dict",
"path": "dict",
"component": "system/dict/index",
"meta": {
"icon": "icon-pcduan",
"title": "Dictionary management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "DictinlinedatadictId",
"path": "dict/inline/data/:dictId",
"component": "system/dict/data",
"meta": {
"icon": "icon-pcduan",
"title": "Dictionary data",
"hide": true,
"cache": false,
"target": null
}
},
{
"name": "Log",
"path": "log",
"component": "BlankLayout",
"meta": {
"icon": "icon-pcduan",
"title": "Log management",
"hide": false,
"cache": true,
"target": null
},
"redirect": "/system/log/operlog",
"children": [
{
"name": "Operlog",
"path": "operlog",
"component": "monitor/operlog/index",
"meta": {
"icon": "icon-pcduan",
"title": "Operation log",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Logininfor",
"path": "logininfor",
"component": "monitor/logininfor/index",
"meta": {
"icon": "icon-pcduan",
"title": "Security log",
"hide": false,
"cache": true,
"target": null
}
}
]
}
]
},
{
"name": "Monitor",
"path": "/monitor",
"component": "BasicLayout",
"meta": {
"icon": "icon-pcduan",
"title": "System monitor",
"hide": false,
"cache": true,
"target": null
},
"redirect": "/monitor/server",
"children": [
{
"name": "Server",
"path": "server",
"component": "monitor/server/index",
"meta": {
"icon": "icon-pcduan",
"title": "Server monitor",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Cache",
"path": "cache",
"component": "monitor/cache/index",
"meta": {
"icon": "icon-pcduan",
"title": "Cache monitor",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "CacheList",
"path": "cacheList",
"component": "monitor/cache/list",
"meta": {
"icon": "icon-pcduan",
"title": "Cache list",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Online",
"path": "online",
"component": "monitor/online/index",
"meta": {
"icon": "icon-pcduan",
"title": "Online users",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Job",
"path": "job",
"component": "monitor/job/index",
"meta": {
"icon": "icon-pcduan",
"title": "Scheduling tasks",
"hide": false,
"cache": true,
"target": null
}
}
]
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------- | ------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» name | string | true | none | none |
| »» path | string | true | none | none |
| »» component | string | true | none | Basic layout component identification menu type - Menu D - Blank Layout - Blank Layout component identification menu type - Menu M - Link Layout - Inner link layout component identification menu type - Menu M - Button menu type - Menu B will not be read into the route |
| »» meta | object | true | none | none |
| »»» icon | string | true | none | none |
| »»» title | string | true | none | none |
| »»» hide | boolean | true | none | Default Value: false |
| »»» cache | boolean | true | none | Default Value: false |
| »»» target | string¦null | true | none | -Non link null - internal jump _self - external jump _blank |
| »» redirect | string | false | none | none |
| »» children | [object] | false | none | none |
| »»» name | string | true | none | none |
| »»» path | string | true | none | none |
| »»» component | string | true | none | none |
| »»» meta | object | true | none | none |
| »»»» icon | string | true | none | none |
| »»»» title | string | true | none | none |
| »»»» hide | boolean | true | none | none |
| »»»» cache | boolean | true | none | none |
| »»»» target | string¦null | true | none | none |
## POST Login
POST /login
> Body Parameters
```json
{
"username": "admin",
"password": "rootaa",
"code": "{{code-text}}",
"uuid": "{{code-uuid}}"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | -------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » username | body | string | yes | User Name |
| » password | body | string | yes | Password |
| » code | body | string | no | Captcha code |
| » uuid | body | string | no | UUID of captcha code |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo"
}
}
```
```json
{
"code": 0,
"msg": "Verification code has expired"
}
```
```json
{
"code": 0,
"msg": "Verification code error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | false | none | none |
| »» access_token | string | true | none | none |
## POST Logout
POST /logout
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------ |
| Authorization | header | string | no | Access token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Success"
}
```
```json
{
"code": 0,
"msg": "The request is too frequent, please try again later."
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# Monitor & Alarm
## GET Get OMC Local Time
GET /api/rest/systemManagement/v1/elementType/OMC/objectType/time
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Monitor & Alarm/NE State
## GET Get ALL NEs System State
GET /api/rest/systemManagement/v1/elementType/ALL/objectType/systemState
Get ALL NEs system state
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 0 Response
```json
{}
```
> OK
```json
{
"data": [
{
"SMF/001": {
"ipAddress": "192.168.14.13",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 24,
"sysCpuUsage": 9
},
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 50138,
"used": 13601
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
}
],
"partitionNum": 6
},
"expiryDate": "2024-12-31",
"memUsage": {
"nfUsedMem": 90620,
"sysMemUsage": 436,
"totalMem": 8167360
},
"serialNum": "20230905",
"version": "1.6.1"
}
}
},
{
"AMF/001": {
"ipAddress": "192.168.14.12",
"systemState": {
"capability": 100000,
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 10
},
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 50138,
"used": 13601
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
}
],
"partitionNum": 6
},
"expiryDate": "2024-12-31",
"memUsage": {
"nfUsedMem": 23844,
"sysMemUsage": 436,
"totalMem": 8167360
},
"serialNum": "20230905",
"version": "1.6.1"
}
}
},
{
"UPF/001": {
"ipAddress": "192.168.1.159",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 3474,
"sysCpuUsage": 2984
},
"diskSpace": {
"partitionInfo": [
{
"total": 7998,
"used": 0
},
{
"total": 1603,
"used": 0
},
{
"total": 100278,
"used": 12041
},
{
"total": 8019,
"used": 1
},
{
"total": 5,
"used": 0
},
{
"total": 8019,
"used": 0
},
{
"total": 1603,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-12-31",
"memUsage": {
"nfUsedMem": 114940,
"sysMemUsage": 948,
"totalMem": 16424904
},
"serialNum": "13740272",
"version": "2.2311.8"
}
}
},
{
"AUSF/001": {
"ipAddress": "192.168.1.186",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 564
},
"dbInfo": "adb v1.0.1",
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-12-31",
"hardwareInfo": {
"cpus": 8,
"memory": 8167360
},
"hostName": "5GC",
"ipAddr": [
"192.168.1.186"
],
"memUsage": {
"nfUsedMem": 30580,
"sysMemUsage": 899,
"totalMem": 8167360
},
"neId": "001",
"neName": "AUSF_001",
"neType": "AUSF",
"osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux",
"port": 3030,
"province": "GD",
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"UDM/001": {
"ipAddress": "192.168.1.187",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 14,
"sysCpuUsage": 194
},
"dbInfo": "adb v1.0.1",
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-12-31",
"hardwareInfo": {
"cpus": 8,
"memory": 8167360
},
"hostName": "5GC",
"ipAddr": [
"192.168.1.187"
],
"memUsage": {
"nfUsedMem": 29760,
"sysMemUsage": 899,
"totalMem": 8167360
},
"neId": "001",
"neName": "UDM_001",
"neType": "UDM",
"osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux",
"port": 3030,
"province": "GD",
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"AMF/002": {
"ipAddress": "192.168.1.172",
"systemState": {
"capability": 100000,
"cpuUsage": {
"nfCpuUsage": 24,
"sysCpuUsage": 299
},
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2023-12-31",
"memUsage": {
"nfUsedMem": 28092,
"sysMemUsage": 899,
"totalMem": 8167360
},
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"IMS/001": {
"ipAddress": "192.168.13.103",
"systemState": {
"capability": 100000,
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 112
},
"diskSpace": {
"partitionInfo": [
{
"Total": 2948,
"Used": 0
},
{
"Total": 596,
"Used": 1
},
{
"Total": 24062,
"Used": 14220
},
{
"Total": 2980,
"Used": 0
},
{
"Total": 5,
"Used": 0
},
{
"Total": 2980,
"Used": 0
},
{
"Total": 596,
"Used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-10-31",
"memUsage": {
"nfUsedMem": 23424,
"sysMemUsage": 3738,
"totalMem": 6103292
},
"serialNum": "00000001",
"version": "1.6.2"
}
}
},
{
"SMF/002": {
"ipAddress": "192.168.1.173",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 25,
"sysCpuUsage": 308
},
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2023-12-31",
"memUsage": {
"nfUsedMem": 189188,
"sysMemUsage": 899,
"totalMem": 8167360
},
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"NSSF/001": {
"ipAddress": "192.168.1.139",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 244,
"sysCpuUsage": 507
},
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-12-31",
"memUsage": {
"nfUsedMem": 51104,
"sysMemUsage": 899,
"totalMem": 8167360
},
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"NRF/001": {
"ipAddress": "192.168.1.138",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 523
},
"dbInfo": "adb v1.0.1",
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-12-31",
"hardwareInfo": {
"cpus": 8,
"memory": 8167360
},
"hostName": "5GC",
"ipAddr": [
"192.168.1.138"
],
"memUsage": {
"nfUsedMem": 26856,
"sysMemUsage": 899,
"totalMem": 8167360
},
"neId": "001",
"neName": "NRF_001",
"neType": "AUSF",
"osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux",
"port": 3030,
"province": "GD",
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"PCF/001": {
"ipAddress": "192.168.1.174",
"systemState": {
"capability": 50000,
"cpuUsage": {
"nfCpuUsage": 51,
"sysCpuUsage": 311
},
"dbInfo": "adb v1.0.1",
"diskSpace": {
"partitionInfo": [
{
"total": 3966,
"used": 0
},
{
"total": 797,
"used": 0
},
{
"total": 1559,
"used": 17000
},
{
"total": 3987,
"used": 0
},
{
"total": 5,
"used": 0
},
{
"total": 3987,
"used": 0
},
{
"total": 797,
"used": 0
}
],
"partitionNum": 7
},
"expiryDate": "2024-12-31",
"hardwareInfo": {
"cpus": 8,
"memory": 8167360
},
"hostName": "5GC",
"ipAddr": [
"192.168.1.174"
],
"memUsage": {
"nfUsedMem": 35692,
"sysMemUsage": 899,
"totalMem": 8167360
},
"neId": "001",
"neName": "PCF_001",
"neType": "AUSF",
"osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux",
"port": 3030,
"province": "GD",
"serialNum": "13740272",
"version": "2.2311.7"
}
}
},
{
"OMC/001": {
"ipAddress": "192.168.2.219",
"systemState": {
"hostName": "simonzhangsz",
"osInfo": "Widnows 602931718",
"dbInfo": "mysql Ver 15.1 Distrib 10.3.35-MariaDB, for Linux (aarch64) using readline 5.1",
"version": "2.2311.8",
"ipAddr": [
"192.168.2.219"
],
"port": 3030,
"capability": 9999999,
"serialNum": "13750650",
"expiryDate": "-",
"hardwareInfo": {
"cpus": 1,
"memory": 34029125632
},
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 542
},
"memUsage": {
"totalMem": 33231568,
"nfUsedMem": 106120,
"sysMemUsage": 6400
},
"diskSpace": {
"partitionNum": 8,
"partitionInfo": [
{
"total": 460605,
"used": 175411
},
{
"total": 513034,
"used": 38767
},
{
"total": 29053,
"used": 23406
},
{
"total": 29053,
"used": 23406
},
{
"total": 23486,
"used": 23458
},
{
"total": 59181,
"used": 24273
},
{
"total": 30064,
"used": 11191
},
{
"total": 39476,
"used": 37532
}
]
}
}
}
},
{
"N3IWF/001": {
"ipAddress": "192.168.9.214",
"systemState": {
"capability": 100000,
"cpuUsage": {
"nfCpuUsage": 0,
"sysCpuUsage": 37
},
"diskSpace": {
"partitionInfo": [
{
"Total": 1899,
"Used": 0
},
{
"Total": 391,
"Used": 1
},
{
"Total": 64196,
"Used": 7980
},
{
"Total": 1955,
"Used": 0
},
{
"Total": 5,
"Used": 0
},
{
"Total": 112,
"Used": 112
},
{
"Total": 63,
"Used": 63
},
{
"Total": 63,
"Used": 63
},
{
"Total": 53,
"Used": 53
},
{
"Total": 40,
"Used": 40
},
{
"Total": 391,
"Used": 1
},
{
"Total": 391,
"Used": 0
}
],
"partitionNum": 12
},
"expiryDate": "2024-12-31",
"memUsage": {
"nfUsedMem": 23392,
"sysMemUsage": 706,
"totalMem": 4005412
},
"serialNum": "13990001",
"version": "2.2311.7"
}
}
},
{
"MME/001": {
"error": {
"errorCode": "1",
"errorInfo": "Internal server error, NF connnect refused"
},
"ipAddress": "192.168.1.179"
}
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ----------------------------------------------------------------------- | ------------------- | ----------- |
| 0 | Unknown | ALL NEs systemState | Inline |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
| 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | Unauthorized | Inline |
| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | Server Error | Inline |
### Responses Data Schema
## GET Get All UDM System State
GET /api/rest/systemManagement/v1/elementType/udm/objectType/systemState
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------------- |
| ne_id | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | Use the specified declared Referer |
| User-Agent | header | string | yes | User agent |
| Accept-Language | header | string | yes | zh_CN;q=0.9 en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET Get OMC System State
GET /api/rest/systemManagement/v1/elementType/omc/objectType/systemState
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Monitor & Alarm/Alarm
## GET Get Alarm from NF
GET /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms
Sync alarms from NF
> Body Parameters
```json
[
{
"neType": "SMF",
"neId": "SZ_01",
"alarmId": "SMF0113",
"alarmTitle": "test",
"eventTime": "2023-03-29 15:56:09",
"alarmCode": 10,
"alarmType": "EquipmentAlarm",
"origSeverity": "Critical",
"alarmStatus": 0,
"specificProblem": "string",
"addInfo": "string",
"locationInfo": "test"
}
]
```
### Params
| Name | Location | Type | Required | Description |
| ---------------- | -------- | ------------- | -------- | ------------------- |
| elementTypeValue | path | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | array[object] | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Get Alarm from NF
POST /api/rest/faultManagement/v1/elementType/smf/objectType/alarms
> Body Parameters
```json
{
"objectId": "SMF_0",
"alarmTitle": "test",
"eventTime": "2023-03-29 15:52:09",
"alarmCode": 10,
"alarmType": "EquipmentAlarm",
"perceivedSeverity": 3,
"alarmStatus": 1,
"specificProblem": "string",
"additionalText": "string",
"alarmSource": "test"
}
```
### Params
| Name | Location | Type | Required | Description |
| -------------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » objectId | body | string | yes | none |
| » alarmTitle | body | string | yes | none |
| » eventTime | body | string | yes | none |
| » alarmCode | body | integer | yes | none |
| » alarmType | body | string | yes | none |
| » perceivedSeverity | body | integer | yes | none |
| » alarmStatus | body | integer | yes | none |
| » specificProblem | body | string | yes | none |
| » additionalText | body | string | yes | none |
| » alarmSource | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post Alarm from AMF
POST /api/rest/faultManagement/v1/elementType/amf/objectType/alarms
> Body Parameters
```json
{
"objectId": "AMF_0",
"alarmTitle": "test",
"eventTime": "2023-03-29 15:52:09",
"alarmCode": 6,
"alarmType": "EquipmentAlarm",
"perceivedSeverity": 3,
"alarmStatus": 1,
"specificProblem": "string",
"additionalText": "string",
"alarmSource": "test"
}
```
### Params
| Name | Location | Type | Required | Description |
| -------------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » objectId | body | string | yes | none |
| » alarmTitle | body | string | yes | none |
| » eventTime | body | string | yes | none |
| » alarmCode | body | integer | yes | none |
| » alarmType | body | string | yes | none |
| » perceivedSeverity | body | integer | yes | none |
| » alarmStatus | body | integer | yes | none |
| » specificProblem | body | string | yes | none |
| » additionalText | body | string | yes | none |
| » alarmSource | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Monitor & Alarm/UE Event
## POST UE Detach from AMF
POST /upload-ue/v1/detach
> Body Parameters
```json
{
"imsi": "4600212141",
"detachTime": "2023-01-16 07:28:11",
"detachResult": 1
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » detachTime | body | string | yes | none |
| » detachResult | body | integer | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST UE CM State from AMF
POST /upload-ue/v1/cm-state
> Body Parameters
```json
{
"imsi": "4600212141",
"onlineNumber": 11,
"changeTime": "2023-01-16 07:28:11",
"status": 1
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » onlineNumber | body | integer | yes | none |
| » changeTime | body | string | yes | none |
| » status | body | integer | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST UE Auth Result from AMF
POST /upload-ue/v1/auth-result
> Body Parameters
```json
{
"imsi": "4600212141",
"imei": "2146002121413",
"tacID": "98",
"gNBID": "31",
"cellID": "17",
"onlineNumber": 11,
"authCode": "50",
"authMessage": "test",
"authTime": "2023-01-16 07:28:11"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » imei | body | string | yes | none |
| » tacID | body | string | yes | none |
| » gNBID | body | string | yes | none |
| » cellID | body | string | yes | none |
| » onlineNumber | body | integer | yes | none |
| » authCode | body | string | yes | none |
| » authMessage | body | string | yes | none |
| » authTime | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Monitor & Alarm/CDR Event
## POST CDR Event from IMS
POST /api/rest/cdrManagement/v1/elementType/ims/objectType/cdrEvent
> Body Parameters
```json
{
"neType": "IMS",
"neName": "IMS_001",
"rmUID": "4400HX1IMS001",
"timestamp": 1705542378,
"CDR": {
"recordType": "CALL",
"seqNumber": 1,
"callReference": "X1gcbQ8zT@10.10.91.252",
"callerParty": "12307551241",
"calledParty": "12307550064",
"serviceResult": "ok",
"seizureTime": 1705542348,
"answerTime": 1705542356,
"releaseTime": 1705542378,
"callDuration": 22
}
}
```
### Params
| Name | Location | Type | Required | Description |
| ------------------ | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » neType | body | string | yes | none |
| » neName | body | string | yes | none |
| » rmUID | body | string | yes | none |
| » timestamp | body | integer | yes | none |
| » CDR | body | object | yes | none |
| »» recordType | body | string | yes | none |
| »» seqNumber | body | integer | yes | none |
| »» callReference | body | string | yes | none |
| »» callerParty | body | string | yes | none |
| »» calledParty | body | string | yes | none |
| »» serviceResult | body | string | yes | none |
| »» seizureTime | body | integer | yes | none |
| »» answerTime | body | integer | yes | none |
| »» releaseTime | body | integer | yes | none |
| »» callDuration | body | integer | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET CDR File from IMS
GET /api/rest/cdrManagement/v1/elementType/ims/objectType/cdrFile
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | -------------------------- |
| type | query | string | no | CDR file type: failed/full |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Performance
## PATCH Patch Measure Task
PATCH /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| taskId | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post Measure Task
POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask
> Body Parameters
```json
{}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| id | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Performance/Performance Statistics
## GET Statistical title
GET /ne/kpi/title
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | -------------------- |
| neType | query | string | yes | Network element type |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"id": "28",
"neType": "UDM",
"kpiId": "UDM.01",
"titleJson": "{\"en\": \"UDR.5gActSub\"}",
"enTitle": "UDR.5gActSub"
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | [object] | true | none | none |
| »» cn_title | string | true | none | none |
| »» en_title | string | true | none | none |
| »» id | integer | true | none | none |
| »» kpi_id | string | true | none | none |
| »» ne_type | string | true | none | none |
| »» title_json | string | true | none | none |
| » msg | string | true | none | none |
## GET Statistical data
GET /ne/kpi/data
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------ |
| neType | query | string | yes | Network element type |
| neId | query | string | yes | Network element ID |
| startTime | query | string | yes | Starting time |
| endTime | query | string | yes | end time |
| interval | query | number | yes | Particle size/average sampling value |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"SMF.01": "1594",
"SMF.02": "1594",
"SMF.03": "1594",
"SMF.04": "1594",
"SMF.05": "1594",
"SMF.06": "1594",
"SMF.07": "1594",
"SMF.08": "1594",
"SMF.09": "1594",
"SMF.10": "1594",
"SMF.11": "1594",
"SMF.12": "1594",
"SMF.13": "1594",
"SMF.14": "797",
"neName": "0",
"startIndex": 0,
"timeGroup": "2023-09-25 00:00"
},
{
"SMF.01": "0",
"SMF.02": "0",
"SMF.03": "0",
"SMF.04": "0",
"SMF.05": "0",
"SMF.06": "0",
"SMF.07": "0",
"SMF.08": "0",
"SMF.09": "0",
"SMF.10": "0",
"SMF.11": "0",
"SMF.12": "0",
"SMF.13": "0",
"SMF.14": "0",
"neName": "0",
"startIndex": 15,
"timeGroup": "2023-09-25 00:15"
},
{
"SMF.01": "0",
"SMF.02": "0",
"SMF.03": "0",
"SMF.04": "0",
"SMF.05": "0",
"SMF.06": "0",
"SMF.07": "0",
"SMF.08": "0",
"SMF.09": "0",
"SMF.10": "0",
"SMF.11": "0",
"SMF.12": "0",
"SMF.13": "0",
"SMF.14": "0",
"neName": "0",
"startIndex": 30,
"timeGroup": "2023-09-25 00:30"
},
{
"SMF.01": "0",
"SMF.02": "0",
"SMF.03": "0",
"SMF.04": "0",
"SMF.05": "0",
"SMF.06": "0",
"SMF.07": "0",
"SMF.08": "0",
"SMF.09": "0",
"SMF.10": "0",
"SMF.11": "0",
"SMF.12": "0",
"SMF.13": "0",
"SMF.14": "0",
"neName": "0",
"startIndex": 45,
"timeGroup": "2023-09-25 00:45"
},
{
"SMF.01": "0",
"SMF.02": "0",
"SMF.03": "0",
"SMF.04": "0",
"SMF.05": "0",
"SMF.06": "0",
"SMF.07": "0",
"SMF.08": "0",
"SMF.09": "0",
"SMF.10": "0",
"SMF.11": "0",
"SMF.12": "0",
"SMF.13": "0",
"SMF.14": "0",
"neName": "0",
"startIndex": 93,
"timeGroup": "2023-09-25 01:30"
},
{
"SMF.01": "0",
"SMF.02": "0",
"SMF.03": "0",
"SMF.04": "0",
"SMF.05": "0",
"SMF.06": "0",
"SMF.07": "0",
"SMF.08": "0",
"SMF.09": "0",
"SMF.10": "0",
"SMF.11": "0",
"SMF.12": "0",
"SMF.13": "0",
"SMF.14": "0",
"neName": "0",
"startIndex": 105,
"timeGroup": "2023-09-25 01:45"
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | [object] | true | none | none |
| »» SMF.01 | string | true | none | none |
| »» SMF.02 | string | true | none | none |
| »» SMF.03 | string | true | none | none |
| »» SMF.04 | string | true | none | none |
| »» SMF.05 | string | true | none | none |
| »» SMF.06 | string | true | none | none |
| »» SMF.07 | string | true | none | none |
| »» SMF.08 | string | true | none | none |
| »» SMF.09 | string | true | none | none |
| »» SMF.10 | string | true | none | none |
| »» SMF.11 | string | true | none | none |
| »» SMF.12 | string | true | none | none |
| »» SMF.13 | string | true | none | none |
| »» SMF.14 | string | true | none | none |
| »» neName | string | true | none | none |
| »» startIndex | integer | true | none | none |
| »» timeGroup | string | true | none | none |
| » msg | string | true | none | none |
# Trace
## DELETE Patch Measure Task
DELETE /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| taskId | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post Trace Task No NeType
POST /api/rest/traceManagement/v1/subscriptions
> Body Parameters
```json
{
"traceType": "Interface",
"startTime": "2023-07-04 13:00:00",
"endTime": "2023-07-04 19:00:00",
"neType": "",
"neId": "",
"interfaces": [
"N8",
"N10"
]
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » traceType | body | string | yes | none |
| » startTime | body | string | yes | none |
| » endTime | body | string | yes | none |
| » neType | body | string | yes | none |
| » neId | body | string | yes | none |
| » interfaces | body | [string] | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## PUT Put Trace Task No NeType
PUT /api/rest/traceManagement/v1/subscriptions
> Body Parameters
```json
{
"id": 3,
"traceType": "Interface",
"startTime": "2023-07-04 13:00:00",
"endTime": "2023-07-04 19:00:00",
"neType": "",
"neId": "",
"srcIp": "192.168.2.199",
"signalPort": 3030,
"interfaces": [
"N8",
"N10",
"N11"
]
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » id | body | integer | yes | none |
| » traceType | body | string | yes | none |
| » startTime | body | string | yes | none |
| » endTime | body | string | yes | none |
| » neType | body | string | yes | none |
| » neId | body | string | yes | none |
| » srcIp | body | string | yes | none |
| » signalPort | body | integer | yes | none |
| » interfaces | body | [string] | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## DELETE Delete Trace Task No NeType
DELETE /api/rest/traceManagement/v1/subscriptions
> Body Parameters
```json
{}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------------- | -------- | ------------------- |
| id | query | array[string] | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post AMF Measure Task
POST /api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask
> Body Parameters
```json
{}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| id | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post Measure Report
POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport
> Body Parameters
```json
{
"id": 1,
"NeType": "SMF"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » id | body | integer | yes | none |
| » NeType | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Captuer NE's PACP(exclude UPF)
POST /tcpdump/ne
> Body Parameters
```json
{
"neType": "string",
"neId": "string",
"timeout": 0,
"cmd": "string",
"timestamp": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » neType | body | string | yes | none |
| » neId | body | string | yes | none |
| » timeout | body | number | yes | none |
| » cmd | body | string | yes | none |
| » timestamp | body | string | yes | timestamp of file |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"cmd": "cd /tmp \nsudo timeout 10 tcpdump -i any sctp or tcp port 3030 or 8088 -s0 -w timestamp_UDM_001.pcap",
"fileName": "timestamp_UDM_001.pcap",
"msg": "tcpdump: listening on any, link-type LINUX_SLL (Linux cooked), capture size 262144 bytes\n10 packets captured\n10 packets received by filter\n0 packets dropped by kernel\n"
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» cmd | string | true | none | none |
| »» fileName | string | true | none | none |
| »» msg | string | true | none | none |
| » msg | string | true | none | none |
## POST Get Measurement
POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measurement
> Body Parameters
```json
{
"Index": 2,
"NeName": "SMFRJBJJC01",
"RmUID": "1101AGTHXSMF0000015704000100",
"NeType": "SMF",
"PmVersion": "5GC16.1.1",
"Dn": "RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456",
"Period": "15",
"TimeZone": "UTC+8",
"StartTime": "2023-05-23 22:26:28",
"Datas": [
{
"ObjectType": "SmfFunction",
"KPIs": [
{
"KPIID": "SMF.AttCreatePduSession._Dnn",
"KPIValues": [
{
"Name": "cmnet",
"Value": 1
},
{
"Name": "ims",
"Value": 0
}
]
}
]
},
{
"ObjectType": "AddrPool",
"KPIs": [
{
"KPIID": "SMF.MeanAllcAddr",
"KPIValues": [
{
"Name": "Total",
"Value": 1
}
]
},
{
"KPIID": "SMF.MeanAllcAddr._Ns",
"KPIValues": [
{
"Name": "1001",
"Value": 2
},
{
"Name": "1002",
"Value": 1
}
]
}
]
}
]
}
```
### Params
| Name | Location | Type | Required | Description |
| ---------------- | -------- | -------- | -------- | ------------------- |
| Content-Type | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » Index | body | integer | yes | none |
| » NeName | body | string | yes | none |
| » RmUID | body | string | yes | none |
| » NeType | body | string | yes | none |
| » PmVersion | body | string | yes | none |
| » Dn | body | string | yes | none |
| » Period | body | string | yes | none |
| » TimeZone | body | string | yes | none |
| » StartTime | body | string | yes | none |
| » Datas | body | [object] | yes | none |
| »» ObjectType | body | string | yes | none |
| »» KPIs | body | [object] | yes | none |
| »»» KPIID | body | string | yes | none |
| »»» KPIValues | body | [object] | yes | none |
| »»»» Name | body | string | yes | none |
| »»»» Value | body | integer | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST UPF capture PACP
POST /tcpdump/neUPF
> Body Parameters
```json
{
"neType": "string",
"neId": "string",
"runType": "string",
"cmd": "string",
"timestamp": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » neType | body | string | yes | none |
| » neId | body | string | yes | none |
| » runType | body | string | yes | Execute start or stop to start telnetstart_telnet/stop_telnet script string start_str/stop_str |
| » cmd | body | string | yes | Method 1: Suitable for situations where other network elements have anomalies and UPF cooperates with packet capture. The package file is relatively small. After entering the command line: 1) Start capturing pcap trace rx tx max 100000 intfc any file upf_test. pcap 2) Stop capturing pcap trace rx tx off method 2: Suitable for situations where UPF exceptions require packet capture analysis. The package file is relatively large. After entering the command line: 1) Start capturing pcap patch trace on max 100000 file upf_test. pcap 2) Stop capturing pcap patch trace off |
| » timestamp | body | string | yes | timestamp of dump file |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET PACP file download
GET /tcpdump/download
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neType | query | string | yes | none |
| neId | query | string | yes | none |
| fileName | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Configuration/NE Management
## PUT Put NE Info
PUT /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo
> Body Parameters
```json
{
"pvFlag": "VNF",
"province": "GD",
"vendorName": "AGT",
"dn": "cmjicai"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » pvFlag | body | string | yes | none |
| » province | body | string | yes | none |
| » vendorName | body | string | yes | none |
| » dn | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post NE Info
POST /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo
> Body Parameters
```json
{
"neType": "UDM",
"neId": "SZ_02",
"neName": "UDM_SZ_01",
"ip": "192.168.1.187",
"port": "8080",
"pvFlag": "VNF",
"province": "GD",
"vendorName": "AGT",
"dn": "cmjicai"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Scheme | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » neType | body | string | yes | none |
| » neId | body | string | yes | none |
| » neName | body | string | yes | none |
| » ip | body | string | yes | none |
| » port | body | string | yes | none |
| » pvFlag | body | string | yes | none |
| » province | body | string | yes | none |
| » vendorName | body | string | yes | none |
| » dn | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## DELETE Delete NE info
DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo
> Body Parameters
```
string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | string | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Configuration/Export/Import NE
## GET Get Software from OMC
GET /api/rest/systemManagement/v1/AMF/software/123
> Body Parameters
```yaml
string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------- |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | string(binary) | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Upload Software To OMC
POST /api/rest/systemManagement/v1/AMF/software/123
> Body Parameters
```yaml
file: string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------- |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET Export CM From NF
GET /api/rest/systemManagement/v1/elementType/udm/objectType/cm
> Body Parameters
```yaml
string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------- |
| ne_id | query | string | yes | none |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | string(binary) | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Import CM to NF
POST /api/rest/systemManagement/v1/elementType/udm/objectType/cm
> Body Parameters
```json
{
"fileName": "udm-sz_01-etc-20230627002725.zip"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » fileName | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## DELETE Delete Software from OMC
DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/cm
> Body Parameters
```json
{
"fileName": "udm-sz_01-etc-20230615171608.zip"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » fileName | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## PUT Active Software To NF
PUT /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01
> Body Parameters
```json
{}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## PATCH Rollback Software To NF
PATCH /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01
> Body Parameters
```yaml
file: string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------- |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Distribute Software To NF
POST /api/rest/systemManagement/v1/EMS/software/2.2311.8/001
> Body Parameters
```yaml
file: string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------- |
| accessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# Configuration/Parameter config
## GET Get System Parameter from UDM
GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/system
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| ne_id | query | string | yes | none |
| loc | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## PUT Put System Parameter to UDM
PUT /api/rest/systemManagement/v1/elementType/udm/objectType/config/system
> Body Parameters
```json
{
"capacity": 1000,
"priority": 2
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| subsys_no | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » capacity | body | integer | yes | none |
| » priority | body | integer | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## POST Post System Parameter to UDM
POST /api/rest/systemManagement/v1/elementType/udm/objectType/config/system
> Body Parameters
```json
{
"capacity": 1000,
"priority": 2
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| subsys_no | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » capacity | body | integer | yes | none |
| » priority | body | integer | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## DELETE Delete System Parameter to UDM
DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/config/system
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| subsys_no | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET Get subsUEAmbr Parameter from UDM
GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET Get UDM smfSelection
GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## GET Get IMS system param
GET /api/rest/systemManagement/v1/elementType/amf/objectType/config/guami
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
# UE Management/UDM Subscirber Data
## GET Subscriber Info
GET /ne/udm/sub/{neId}/{imsi}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| imsi | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": {
"AMBR": "def_ambr",
"ActiveTime": "1000",
"AreaForbidden": "def_arfb",
"CNType": "0x03(EPC|5GC)",
"EPS-Data": "1,64,24,65,def_eps,1,2,010200000000,-",
"MICO": "0",
"MME_id": "-",
"MSISDN": "13407550193",
"NSSAI": "def_nssai",
"ODB_PS": "1",
"RAT": "0x00(VIRTUAL|WLAN|EUTRA|NR)",
"RegTimer": "12000",
"RfspIndex": "1",
"SM-Data(snssai+dnn[1..n])": "1-000001&cmnet&ims&3gnet",
"ServiceAreaRestriction": "def_sar",
"Smf-Selection": "def_snssai",
"UEUsageType": "1",
"kdc_flag": "0"
},
"msg": "success"
}
```
```json
{
"code": 1,
"data": {
"id": "137028",
"msisdn": "86123075529295",
"imsi": "460000100029295",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "3",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,2,010200000000,-",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "010200000000",
"staticIp": "-"
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» id | string | true | none | none |
| »» msisdn | string | true | none | none |
| »» imsi | string | true | none | none |
| »» ambr | string | true | none | none |
| »» nssai | string | true | none | none |
| »» rat | string | true | none | none |
| »» arfb | string | true | none | none |
| »» sar | string | true | none | none |
| »» cn | string | true | none | none |
| »» smData | string | true | none | none |
| »» smfSel | string | true | none | none |
| »» epsDat | string | true | none | none |
| »» neId | string | true | none | none |
| »» epsFlag | string | true | none | none |
| »» epsOdb | string | true | none | none |
| »» hplmnOdb | string | true | none | none |
| »» ard | string | true | none | none |
| »» epstpl | string | true | none | none |
| »» contextId | string | true | none | none |
| »» apnContext | string | true | none | none |
| »» staticIp | string | true | none | none |
| » msg | string | true | none | none |
## DELETE Subscriber
DELETE /ne/udm/sub/{neId}/{imsi}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| imsi | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## POST Subscriber
POST /ne/udm/sub/{neId}
This API can add 4/5G subscribers at the same time
> Body Parameters
```json
{
"msisdn": "string",
"imsi": "string",
"ambr": "string",
"nssai": "string",
"rat": "string",
"arfb": "string",
"sar": "string",
"cn": "string",
"smData": "string",
"smfSel": "string",
"epsDat": "string",
"epsFlag": "string",
"epsOdb": "string",
"hplmnOdb": "string",
"ard": "string",
"epstpl": "string",
"contextId": "string",
"apnContext": "string",
"staticIp": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------------------------ |
| neId | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » msisdn | body | string | yes | none |
| » imsi | body | string | yes | none |
| » ambr | body | string | yes | none |
| » nssai | body | string | yes | none |
| » rat | body | string | yes | none |
| » arfb | body | string | yes | none |
| » sar | body | string | yes | none |
| » cn | body | string | yes | none |
| » smData | body | string | yes | none |
| » smfSel | body | string | yes | none |
| » epsDat | body | string | yes | none |
| » epsFlag | body | string | yes | none |
| » epsOdb | body | string | yes | none |
| » hplmnOdb | body | string | yes | none |
| » ard | body | string | yes | none |
| » epstpl | body | string | yes | none |
| » contextId | body | string | yes | none |
| » apnContext | body | string | yes | none |
| » staticIp | body | string | yes | The static IP refers to the static IP assigned to the 4G UE. It can be omitted if not available. |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | string | true | none | none |
| » msg | string | true | none | none |
## PUT Subscriber
PUT /ne/udm/sub/{neId}
> Body Parameters
```json
{
"msisdn": "string",
"imsi": "string",
"ambr": "string",
"nssai": "string",
"rat": "string",
"arfb": "string",
"sar": "string",
"cn": "string",
"smData": "string",
"smfSel": "string",
"epsDat": "string",
"epsFlag": "string",
"epsOdb": "string",
"hplmnOdb": "string",
"ard": "string",
"epstpl": "string",
"contextId": "string",
"apnContext": "string",
"staticIp": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------------------------ |
| neId | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » msisdn | body | string | yes | none |
| » imsi | body | string | yes | none |
| » ambr | body | string | yes | none |
| » nssai | body | string | yes | none |
| » rat | body | string | yes | none |
| » arfb | body | string | yes | none |
| » sar | body | string | yes | none |
| » cn | body | string | yes | none |
| » smData | body | string | yes | none |
| » smfSel | body | string | yes | none |
| » epsDat | body | string | yes | none |
| » epsFlag | body | string | yes | none |
| » epsOdb | body | string | yes | none |
| » hplmnOdb | body | string | yes | none |
| » ard | body | string | yes | none |
| » epstpl | body | string | yes | none |
| » contextId | body | string | yes | none |
| » apnContext | body | string | yes | none |
| » staticIp | body | string | yes | The static IP refers to the static IP assigned to the 4G UE. It can be omitted if not available. |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## POST Batch Add Subscribers
POST /ne/udm/sub/{neId}/{num}
> Body Parameters
```json
{
"msisdn": "string",
"imsi": "string",
"ambr": "string",
"nssai": "string",
"rat": "string",
"arfb": "string",
"sar": "string",
"cn": "string",
"smData": "string",
"smfSel": "string",
"epsDat": "string",
"epsFlag": "string",
"epsOdb": "string",
"hplmnOdb": "string",
"ard": "string",
"epstpl": "string",
"contextId": "string",
"apnContext": "string",
"staticIp": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------------------------ |
| neId | path | string | yes | none |
| num | path | string | yes | Subscriber number |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » msisdn | body | string | yes | none |
| » imsi | body | string | yes | none |
| » ambr | body | string | yes | none |
| » nssai | body | string | yes | none |
| » rat | body | string | yes | none |
| » arfb | body | string | yes | none |
| » sar | body | string | yes | none |
| » cn | body | string | yes | none |
| » smData | body | string | yes | none |
| » smfSel | body | string | yes | none |
| » epsDat | body | string | yes | none |
| » epsFlag | body | string | yes | none |
| » epsOdb | body | string | yes | none |
| » hplmnOdb | body | string | yes | none |
| » ard | body | string | yes | none |
| » epstpl | body | string | yes | none |
| » contextId | body | string | yes | none |
| » apnContext | body | string | yes | none |
| » staticIp | body | string | yes | The static IP refers to the static IP assigned to the 4G UE. It can be omitted if not available. |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## DELETE Batch Delete Subscriber
DELETE /ne/udm/sub/{neId}/{imsi}/{num}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| imsi | path | string | yes | none |
| num | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
```json
{
"code": 1,
"data": "command ok",
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | string | true | none | none |
| » msg | string | true | none | none |
## POST Export Subscriber
POST /ne/udm/sub/export
> Body Parameters
```json
{
"neId": "string",
"type": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » neId | body | string | yes | none |
| » type | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## PUT Reload data for Redis
PUT /ne/udm/sub/resetData/{neId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success",
"data": [
{
"name": "System",
"path": "/system",
"component": "BasicLayout",
"meta": {
"icon": "icon-pcduan",
"title": "System Management",
"hide": false,
"cache": true,
"target": null
},
"redirect": "/system/user",
"children": [
{
"name": "User",
"path": "user",
"component": "system/user/index",
"meta": {
"icon": "icon-pcduan",
"title": "User Management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Role",
"path": "role",
"component": "system/role/index",
"meta": {
"icon": "icon-pcduan",
"title": "Role Management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "RoleinlineauthuserroleId",
"path": "role/inline/auth-user/:roleId",
"component": "system/role/auth-user",
"meta": {
"icon": "icon-pcduan",
"title": "Role assign to user",
"hide": true,
"cache": false,
"target": null
}
},
{
"name": "Menu",
"path": "menu",
"component": "system/menu/index",
"meta": {
"icon": "icon-pcduan",
"title": "Menu management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Dept",
"path": "dept",
"component": "system/dept/index",
"meta": {
"icon": "icon-pcduan",
"title": "Department management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Post",
"path": "post",
"component": "system/post/index",
"meta": {
"icon": "icon-pcduan",
"title": "Postion management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Dict",
"path": "dict",
"component": "system/dict/index",
"meta": {
"icon": "icon-pcduan",
"title": "Dictionary management",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "DictinlinedatadictId",
"path": "dict/inline/data/:dictId",
"component": "system/dict/data",
"meta": {
"icon": "icon-pcduan",
"title": "Dictionary data",
"hide": true,
"cache": false,
"target": null
}
},
{
"name": "Log",
"path": "log",
"component": "BlankLayout",
"meta": {
"icon": "icon-pcduan",
"title": "Log management",
"hide": false,
"cache": true,
"target": null
},
"redirect": "/system/log/operlog",
"children": [
{
"name": "Operlog",
"path": "operlog",
"component": "monitor/operlog/index",
"meta": {
"icon": "icon-pcduan",
"title": "Operation log",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Logininfor",
"path": "logininfor",
"component": "monitor/logininfor/index",
"meta": {
"icon": "icon-pcduan",
"title": "Security log",
"hide": false,
"cache": true,
"target": null
}
}
]
}
]
},
{
"name": "Monitor",
"path": "/monitor",
"component": "BasicLayout",
"meta": {
"icon": "icon-pcduan",
"title": "System monitor",
"hide": false,
"cache": true,
"target": null
},
"redirect": "/monitor/server",
"children": [
{
"name": "Server",
"path": "server",
"component": "monitor/server/index",
"meta": {
"icon": "icon-pcduan",
"title": "Server monitor",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Cache",
"path": "cache",
"component": "monitor/cache/index",
"meta": {
"icon": "icon-pcduan",
"title": "Cache monitor",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "CacheList",
"path": "cacheList",
"component": "monitor/cache/list",
"meta": {
"icon": "icon-pcduan",
"title": "Cache list",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Online",
"path": "online",
"component": "monitor/online/index",
"meta": {
"icon": "icon-pcduan",
"title": "Online users",
"hide": false,
"cache": true,
"target": null
}
},
{
"name": "Job",
"path": "job",
"component": "monitor/job/index",
"meta": {
"icon": "icon-pcduan",
"title": "Scheduling tasks",
"hide": false,
"cache": true,
"target": null
}
}
]
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» name | string | true | none | none |
| »» path | string | true | none | none |
| »» component | string | true | none | |
| »» meta | object | true | none | none |
| »»» icon | string | true | none | none |
| »»» title | string | true | none | none |
| »»» hide | boolean | true | none | none |
| »»» cache | boolean | true | none | none |
| »»» target | string¦null | true | none | none |
| »» redirect | string | false | none | none |
| »» children | [object] | false | none | none |
| »»» name | string | true | none | none |
| »»» path | string | true | none | none |
| »»» component | string | true | none | none |
| »»» meta | object | true | none | none |
| »»»» icon | string | true | none | none |
| »»»» title | string | true | none | none |
| »»»» hide | boolean | true | none | none |
| »»»» cache | boolean | true | none | none |
| »»»» target | string¦null | true | none | none |
## POST Import subscriber list
POST /ne/udm/sub/import
> Body Parameters
```yaml
neId: "002"
file: string
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » neId | body | string | yes | none |
| » file | body | string(binary) | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## GET Aquire subscriber list
GET /ne/udm/sub/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| msisdn | query | string | no | none |
| imsi | query | string | no | none |
| neId | query | string | no | none |
| sortField | query | string | no | none |
| sortOrder | query | string | no | none |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"id": "340065",
"msisdn": "12399999100",
"imsi": "460009999999100",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "342252",
"msisdn": "12399999099",
"imsi": "460009999999099",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "344385",
"msisdn": "12399999098",
"imsi": "460009999999098",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "344268",
"msisdn": "12399999097",
"imsi": "460009999999097",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "339149",
"msisdn": "12399999096",
"imsi": "460009999999096",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "342539",
"msisdn": "12399999095",
"imsi": "460009999999095",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "339650",
"msisdn": "12399999094",
"imsi": "460009999999094",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "342061",
"msisdn": "12399999093",
"imsi": "460009999999093",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "342845",
"msisdn": "12399999092",
"imsi": "460009999999092",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
},
{
"id": "339595",
"msisdn": "12399999091",
"imsi": "460009999999091",
"ambr": "def_ambr",
"nssai": "def_nssai",
"rat": "0",
"arfb": "def_arfb",
"sar": "def_sar",
"cn": "3",
"smData": "1-000001&cmnet&ims",
"smfSel": "def_snssai",
"epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000",
"neId": "",
"epsFlag": "0",
"epsOdb": "64",
"hplmnOdb": "24",
"ard": "65",
"epstpl": "def_eps",
"contextId": "1",
"apnContext": "200000000000",
"staticIp": "010200000000"
}
],
"total": 37094
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » rows | [object] | true | none | none |
| »» id | string | true | none | none |
| »» msisdn | string | true | none | none |
| »» imsi | string | true | none | none |
| »» ambr | string | true | none | none |
| »» nssai | string | true | none | none |
| »» rat | string | true | none | none |
| »» arfb | string | true | none | none |
| »» sar | string | true | none | none |
| »» cn | string | true | none | none |
| »» smData | string | true | none | none |
| »» smfSel | string | true | none | none |
| »» epsDat | string | true | none | none |
| »» neId | string | true | none | none |
| »» epsFlag | string | true | none | none |
| »» epsOdb | string | true | none | none |
| »» hplmnOdb | string | true | none | none |
| »» ard | string | true | none | none |
| »» epstpl | string | true | none | none |
| »» contextId | string | true | none | none |
| »» apnContext | string | true | none | none |
| »» staticIp | string | true | none | none |
| » total | integer | true | none | none |
# UE Management/UDM Authentication Data
## GET Authentication data list
GET /ne/udm/auth/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| neId | query | string | no | none |
| imsi | query | string | no | none |
| msisdn | query | string | no | none |
| sortField | query | string | no | none |
| sortOrder | query | string | no | none |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": {
"rows": [
{
"id": "1",
"imsi": "460000100023631",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
{
"id": "2",
"imsi": "460009999996296",
"amf": "8000",
"status": "0",
"ki": "12345678901234567890123456789012",
"algoIndex": "0",
"opc": "212E3B94279CB0F8095A55E8EF5569F7",
"neId": ""
},
{
"id": "3",
"imsi": "460001100000793",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
{
"id": "4",
"imsi": "460000100018255",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
{
"id": "5",
"imsi": "460000100008970",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
{
"id": "6",
"imsi": "460000100019859",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
{
"id": "7",
"imsi": "460000100015591",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
{
"id": "8",
"imsi": "460119999999587",
"amf": "8000",
"status": "0",
"ki": "12345678901234567890123456789012",
"algoIndex": "0",
"opc": "212E3B94279CB0F8095A55E8EF5569F7",
"neId": ""
},
{
"id": "9",
"imsi": "460009999992973",
"amf": "8000",
"status": "0",
"ki": "12345678901234567890123456789012",
"algoIndex": "0",
"opc": "212E3B94279CB0F8095A55E8EF5569F7",
"neId": ""
},
{
"id": "10",
"imsi": "460000100027485",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
}
],
"total": 37981
},
"msg": "success"
}
```
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"id": "20232",
"msisdn": "12346001956",
"imsi": "460001100001956",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": "001"
},
{
"id": "20233",
"msisdn": "13407550852",
"imsi": "460000200000852",
"amf": "8000",
"status": "1",
"ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66",
"algoIndex": "0",
"opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66",
"neId": "001"
},
{
"id": "20234",
"msisdn": "12346001008",
"imsi": "460001100001008",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": "001"
},
{
"id": "20235",
"msisdn": "13407550581",
"imsi": "460000200000581",
"amf": "8000",
"status": "1",
"ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66",
"algoIndex": "0",
"opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66",
"neId": "001"
},
{
"id": "20236",
"msisdn": "12346001144",
"imsi": "460001100001144",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": "001"
},
{
"id": "20237",
"msisdn": "13407550473",
"imsi": "460000200000473",
"amf": "8000",
"status": "1",
"ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66",
"algoIndex": "0",
"opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66",
"neId": "001"
},
{
"id": "20238",
"msisdn": "13407550135",
"imsi": "460000200000135",
"amf": "8000",
"status": "1",
"ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66",
"algoIndex": "0",
"opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66",
"neId": "001"
},
{
"id": "20239",
"msisdn": "12346001321",
"imsi": "460001100001321",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": "001"
},
{
"id": "20240",
"msisdn": "12346001754",
"imsi": "460001100001754",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": "001"
},
{
"id": "20241",
"msisdn": "12346001360",
"imsi": "460001100001360",
"amf": "8000",
"status": "0",
"ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66",
"algoIndex": "0",
"opc": "-",
"neId": "001"
}
],
"total": 2019
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| -------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » rows | [object] | true | none | none |
| »» id | string | true | none | none |
| »» imsi | string | true | none | none |
| »» amf | string | true | none | none |
| »» status | string | true | none | none |
| »» ki | string | true | none | none |
| »» algoIndex | string | true | none | none |
| »» opc | string | true | none | none |
| »» neId | string | true | none | none |
| » total | integer | true | none | none |
## GET Auth data
GET /ne/udm/auth/{neId}/{imsi}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| neId | path | string | yes | none |
| imsi | path | string | yes | none |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": {
"id": "",
"msisdn": "",
"imsi": "460001100001071",
"amf": "8000",
"status": "",
"ki": "*",
"algoIndex": "0",
"opc": "*",
"neId": ""
},
"msg": "success"
}
```
```json
{
"code": 1,
"data": {
"id": "1",
"imsi": "460000100023631",
"amf": "8000",
"status": "0",
"ki": "805DADC6E8A54A0D59D622C7A04D08E0",
"algoIndex": "0",
"opc": "-",
"neId": ""
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| -------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» id | string | true | none | none |
| »» imsi | string | true | none | none |
| »» amf | string | true | none | none |
| »» status | string | true | none | none |
| »» ki | string | true | none | none |
| »» algoIndex | string | true | none | none |
| »» opc | string | true | none | none |
| »» neId | string | true | none | none |
| » msg | string | true | none | none |
## DELETE Delete auth data
DELETE /ne/udm/auth/{neId}/{imsi}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| imsi | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## PUT Reload data from Redis
PUT /ne/udm/auth/resetData/{neId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | integer | true | none | none |
| » msg | string | true | none | none |
## POST Add auth data
POST /ne/udm/auth/{neId}
> Body Parameters
```json
{
"algoIndex": "string",
"amf": "string",
"imsi": "string",
"ki": "string",
"opc": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » algoIndex | body | string | yes | none |
| » amf | body | string | yes | none |
| » imsi | body | string | yes | none |
| » ki | body | string | yes | none |
| » opc | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | string | true | none | none |
| » msg | string | true | none | none |
## PUT Modify auth data
PUT /ne/udm/auth/{neId}
> Body Parameters
```json
{
"algoIndex": "string",
"amf": "string",
"imsi": "string",
"ki": "string",
"opc": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » algoIndex | body | string | yes | none |
| » amf | body | string | yes | none |
| » imsi | body | string | yes | none |
| » ki | body | string | yes | none |
| » opc | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------- | ------- | -------- | ------------ | ----- | ----------- |
| » code | integer | true | none | | none |
| » msg | string | true | none | | none |
| » data | integer | true | none | | none |
## POST Batch add auth data
POST /ne/udm/auth/{neId}/{num}
> Body Parameters
```json
{
"algoIndex": "string",
"amf": "string",
"imsi": "string",
"ki": "string",
"opc": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| num | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » algoIndex | body | string | yes | none |
| » amf | body | string | yes | none |
| » imsi | body | string | yes | none |
| » ki | body | string | yes | none |
| » opc | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------- | ------- | -------- | ------------ | ----- | ----------- |
| » code | integer | true | none | | none |
| » data | string | true | none | | none |
| » msg | string | true | none | | none |
## DELETE Batch delete auth data
DELETE /ne/udm/auth/{neId}/{imsi}/{num}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | path | string | yes | none |
| imsi | path | string | yes | none |
| num | path | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------- | ------- | -------- | ------------ | ----- | ----------- |
| » code | integer | true | none | | none |
| » msg | string | true | none | | none |
| » data | integer | true | none | | none |
## POST Export auth data
POST /ne/udm/auth/export
> Body Parameters
```json
{
"neId": "string",
"type": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » neId | body | string | yes | none |
| » type | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | integer | true | none | none |
## POST Import auth data
POST /ne/udm/auth/import
> Body Parameters
```yaml
neId: "002"
file: string
```
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | -------------- | -------- | ----- | ------------------- |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
| AccessToken | header | string | no | | Access token |
| body | body | object | no | | none |
| » neId | body | string | yes | | none |
| » file | body | string(binary) | yes | | none |
> Response Examples
> Success
```json
{
"code": 1,
"data": 2021,
"msg": "success"
}
```
```json
{
"code": 1,
"msg": "import ok, succ num: 36891, fail num: 1092."
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# UE Management/PCF User PCC Rules
## GET Query PCF UE Info
GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| imsi | query | string | no | none |
| msisdn | query | string | no | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> Success
```json
{
"data": [
{
"msisdn": "12307550237",
"pccRules": "internet",
"rfsp": 0,
"sessRules": "internet"
},
{
"msisdn": "12307550238",
"pccRules": "internet|ims_sig",
"rfsp": 0,
"sessRules": "internet|ims_sig"
}
]
}
```
```json
{
"data": [
{
"msisdn": "12307550237",
"pccRules": "internet",
"rfsp": 0,
"sessRules": "internet"
},
{
"msisdn": "12307550238",
"pccRules": "internet|ims_sig",
"rfsp": 0,
"sessRules": "internet|ims_sig"
}
]
}
```
```json
{
"data": [
{
"hdrEnrich": "dnn",
"imsi": "460990100000006",
"msisdn": "86755900001",
"pccRules": "internet|ims_sig",
"qosAudio": "qos_audio",
"qosVideo": "qos_video",
"rfsp": 1,
"sar": "def_sar",
"sessRules": "internet|ims_sig",
"uePolicy": "uep_001"
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## POST Add PCF UE Info
POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
> Body Parameters
```json
{
"imsi": "460990100000002",
"msisdn": "86755900001",
"qosAudio": "qos_audio",
"pccRules": "internet|ims_sig",
"rfsp": 1,
"uePolicy": "uep_001",
"sessRules": "internet|ims_sig",
"sar": "def_sar",
"hdrEnrich": "dnn",
"qosVideo": "qos_video"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| neId | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » msisdn | body | string | yes | none |
| » rfsp | body | integer | no | none |
| » sar | body | string | no | none |
| » pccRules | body | string | no | none |
| » sessRules | body | string | no | none |
| » uePolicy | body | string | no | none |
| » qosAudio | body | string | no | none |
| » qosVideo | body | string | no | none |
| » hdrEnrich | body | string | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## PUT Modify PCF UE Info
PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
> Body Parameters
```json
{
"imsi": "000510200000001",
"msisdn": "1350000001",
"rfsp": "omitempty",
"sar": "",
"pccRules": "",
"sessRules": "",
"uePolicy": "",
"qosAudio": "",
"qosVideo": "",
"hdrEnrich": ""
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| imsi | query | string | no | none |
| msisdn | query | string | no | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » msisdn | body | string | no | none |
| » rfsp | body | integer | no | none |
| » sar | body | string | no | none |
| » pccRules | body | string | no | none |
| » sessRules | body | string | no | none |
| » uePolicy | body | string | no | none |
| » qosAudio | body | string | no | none |
| » qosVideo | body | string | no | none |
| » hdrEnrich | body | string | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## DELETE Delete PCF UE Info
DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| imsi | query | string | yes | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> Record Not Found
```json
{
"cause": "DATA_NOT_FOUND",
"status": 404
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ----------------------------------------------------------- | ---------------- | ----------- |
| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Record Not Found | Inline |
### Responses Data Schema
HTTP Status Code **404**
| Name | Type | Required | Restrictions | description |
| --------- | ------- | -------- | ------------ | ----------- |
| » cause | string | true | none | none |
| » status | integer | true | none | none |
## POST Batch Add PCF UE Info
POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}
> Body Parameters
```json
{
"num": 11,
"imsi": "260990100000001",
"msisdn": "86755900001",
"qosAudio": "qos_audio",
"pccRules": "internet|ims_sig",
"rfsp": 1,
"uePolicy": "uep_001",
"sessRules": "internet|ims_sig",
"sar": "def_sar",
"hdrEnrich": "dnn",
"qosVideo": "qos_video",
"neId": "001"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| number | path | string | yes | none |
| neId | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » msisdn | body | string | yes | none |
| » rfsp | body | integer | no | none |
| » sar | body | string | no | none |
| » pccRules | body | string | no | none |
| » sessRules | body | string | no | none |
| » uePolicy | body | string | no | none |
| » qosAudio | body | string | no | none |
| » qosVideo | body | string | no | none |
| » hdrEnrich | body | string | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## PUT Batch Modify PCF UE Info
PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}
> Body Parameters
```json
{
"imsi": "000510200000001",
"msisdn": "1350000001",
"rfsp": "omitempty",
"sar": "",
"pccRules": "",
"sessRules": "",
"uePolicy": "",
"qosAudio": "",
"qosVideo": "",
"hdrEnrich": ""
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| number | path | string | yes | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » msisdn | body | string | yes | none |
| » rfsp | body | integer | yes | none |
| » sar | body | string | yes | none |
| » pccRules | body | string | yes | none |
| » sessRules | body | string | yes | none |
| » uePolicy | body | string | yes | none |
| » qosAudio | body | string | yes | none |
| » qosVideo | body | string | yes | none |
| » hdrEnrich | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## DELETE Batch Delete PCF UE Info
DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| number | path | string | yes | none |
| neId | query | string | yes | none |
| imsi | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"cause": "no imsi",
"status": 400
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## GET Export PCF UE Info
GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/export
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | query | string | yes | none |
| fileType | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## PUT Import PCF UE Info
PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/import
> Body Parameters
```json
{
"neId": "001",
"type": "txt",
"filePath": "xxx.txt"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| neId | query | string | yes | none |
| filePath | query | string | yes | none |
| fileType | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » imsi | body | string | yes | none |
| » msisdn | body | string | yes | none |
| » rfsp | body | integer | yes | none |
| » sar | body | string | yes | none |
| » pccRules | body | string | yes | none |
| » sessRules | body | string | yes | none |
| » uePolicy | body | string | yes | none |
| » qosAudio | body | string | yes | none |
| » qosVideo | body | string | yes | none |
| » hdrEnrich | body | string | yes | none |
> Response Examples
> Success
```json
{
"detail": "[Request Body] unexpected end of JSON input",
"status": 400,
"title": "Malformed request syntax"
}
```
```json
{
"neId": "001",
"fileType": "txt",
"filePath": "/home/agtuser/PCF_001_1701420431873_zsda89.txt"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------- | ------ | -------- | ------------ | ----------- |
| » neId | string | true | none | none |
| » fileType | string | true | none | none |
| » filePath | string | true | none | none |
# UE Management/N3IWF Online User
## GET Query N3IWF UE Info
GET /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| imsi | query | string | no | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> OK
```json
{
"data": [
{
"activeTime": "2023-11-29 06:35:43",
"imsi": "460302072701181",
"nai": "0460302072701181@nai.epc.mnc030.mcc460.3gppnetwork.org",
"regState": 1
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » data | [object] | true | none | none |
| »» activeTime | string | false | none | none |
| »» imsi | string | false | none | none |
| »» nai | string | false | none | none |
| »» regState | integer | false | none | none |
# UE Management/NodeB Information
## GET Get NB Info from AMF
GET /api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| nbId | query | string | yes | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# UE Management/IMS Online User
## GET Get UE Info from IMS
GET /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| imsi | query | string | yes | none |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# UE Management/SMF Online User
## GET Get UE Info from SMF
GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------- |
| neId | query | string | yes | Only required sent to OMC |
| imsi | query | string | no | none |
| msisdn | query | string | no | none |
| upstate | query | string | no | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## GET Get UE Number from SMF
GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neId | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# UE Management/General APIs
## GET Aquire NE info by neType neID
GET /ne/info
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| neType | query | string | yes | none |
| neId | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## POST Send files to the network element.
POST /ne/action/pushFile
> Body Parameters
```json
{
"uploadPath": "string",
"neType": "string",
"neId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------ |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » uploadPath | body | string | yes | Upload a file through the general interface to obtain the address. |
| » neType | body | string | yes | NE type |
| » neId | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"data": "/home/agtuser/5GC.pdf",
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | string | true | none | none |
| » msg | string | true | none | none |
# MML
## POST Post UDM subscriber MML
POST /api/rest/operationManagement/v1/elementType/udm/objectType/mml
> Body Parameters
```json
{
"mml": [
"date",
"dsp authdat:imsi=460000100000030"
]
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | ------------------- |
| ne_id | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » mml | body | [string] | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## POST Post OMC MMLs
POST /api/rest/operationManagement/v1/elementType/omc/objectType/mml
> Body Parameters
```json
{
"mml": [
"date",
"date"
]
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | ------------------- |
| ne_id | query | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » mml | body | [string] | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# Security/Department Management
## GET Department List
GET /system/dept/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| status | query | string | no | Status (0 Inactive 1Active） |
| deptName | query | string | no | Department name |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"deptId": "100",
"parentId": "0",
"ancestors": "0",
"deptName": "System Maintenance Department",
"orderNum": 0,
"leader": "supervisor",
"phone": "",
"email": "",
"status": "1",
"delFlag": "0",
"createBy": "supervisor",
"createTime": 1699348237468,
"updateBy": "",
"updateTime": 0
},
{
"deptId": "101",
"parentId": "100",
"ancestors": "0,100",
"deptName": "Operation and Maintenance Department One",
"orderNum": 1,
"leader": "supervisor",
"phone": "",
"email": "",
"status": "1",
"delFlag": "0",
"createBy": "supervisor",
"createTime": 1699348237468,
"updateBy": "",
"updateTime": 0
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | [object] | true | none | none |
| »» deptId | string | true | none | none |
| »» parentId | string | true | none | none |
| »» ancestors | string | true | none | none |
| »» deptName | string | true | none | none |
| »» orderNum | integer | true | none | none |
| »» leader | string | true | none | none |
| »» phone | string | true | none | none |
| »» email | string | true | none | none |
| »» status | string | true | none | 0 1 |
| »» delFlag | string | true | none | 0 1 |
| »» createBy | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | integer | true | none | none |
| » msg | string | true | none | none |
## GET Department List (Excluding)
GET /system/dept/list/exclude/{deptId}
When performing update operations, optional superiors should exclude all nodes under the current department
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| deptId | path | string | yes | Department ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"deptId": "100",
"parentId": "0",
"ancestors": "0",
"deptName": "System Maintenance Department",
"orderNum": 0,
"leader": "supervisor",
"phone": "",
"email": "",
"status": "1",
"delFlag": "0",
"createBy": "supervisor",
"createTime": 1699348237468,
"updateBy": "",
"updateTime": 0
},
{
"deptId": "101",
"parentId": "100",
"ancestors": "0,100",
"deptName": "Operation and Maintenance Department One",
"orderNum": 1,
"leader": "supervisor",
"phone": "",
"email": "",
"status": "1",
"delFlag": "0",
"createBy": "supervisor",
"createTime": 1699348237468,
"updateBy": "",
"updateTime": 0
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | [object] | true | none | none |
| »» deptId | string | true | none | none |
| »» parentId | string | true | none | none |
| »» ancestors | string | true | none | none |
| »» deptName | string | true | none | none |
| »» orderNum | integer | true | none | none |
| »» leader | string | true | none | none |
| »» phone | string | true | none | none |
| »» email | string | true | none | none |
| »» status | string | true | none | none |
| »» delFlag | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | integer | true | none | none |
| » msg | string | true | none | none |
## GET Department Tree List
GET /system/dept/treeSelect
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------- |
| status | query | string | no | Status (0 Inactive 1 Active) |
| deptName | query | string | no | Department Name |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"id": "100",
"label": "System Maintenance Department",
"children": [
{
"id": "101",
"label": "Operation and Maintenance Department One",
"children": []
}
]
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | [object] | true | none | none |
| »» id | string | false | none | none |
| »» label | string | false | none | none |
| »» children | [object] | false | none | none |
| »»» id | string | false | none | none |
| »»» label | string | false | none | none |
| »»» children | [string] | false | none | none |
| » msg | string | true | none | none |
## GET Department Tree List (specified roles)
GET /system/dept/roleDeptTreeSelect/{roleId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| roleId | path | string | yes | Role ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"checkedKeys": [],
"depts": [
{
"id": "100",
"label": "System Maintenance Department",
"children": [
{
"id": "101",
"label": "Operation and Maintenance Department One",
"children": []
}
]
}
]
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» checkedKeys | [string] | true | none | none |
| »» depts | [object] | true | none | none |
| »»» id | string | false | none | none |
| »»» label | string | false | none | none |
| »»» children | [object] | false | none | none |
| »»»» id | string | false | none | none |
| »»»» label | string | false | none | none |
| »»»» children | [string] | false | none | none |
| » msg | string | true | none | none |
## POST New Departmnt
POST /system/dept
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible department data!"
}
```
```json
{
"code": 0,
"msg": "Manipulate department [Jcmgc Qinimfn Axrfrd Xbjdczfoe] failed, department name already exists!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT Department Modification
PUT /system/dept
> Body Parameters
```json
{
"orderNum": 0,
"deptName": "string",
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"parentId": "string",
"parentName": "string",
"deptId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » orderNum | body | integer | yes | none |
| » deptName | body | string | yes | none |
| » leader | body | string | yes | none |
| » phone | body | string | yes | none |
| » email | body | string | yes | none |
| » status | body | string | yes | 0 Inactive 1 Active |
| » parentId | body | string | yes | none |
| » parentName | body | string | no | none |
| » deptId | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible department data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE Department Deletion
DELETE /system/dept/{deptId}
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| deptId | path | string | yes | | Department ID |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
| AccessToken | header | string | no | | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Deleted successfully: 1"
}
```
```json
{
"code": 0,
"msg": "There is no accessible department data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET Department Info
GET /system/dept/{deptId}
### Params
| Name | Location | Type | Required | Title | Description |
| --------------- | -------- | ------ | -------- | ----- | ------------------- |
| deptId | path | string | yes | | Department ID |
| Authorization | header | string | yes | | Authoirzation token |
| Referer | header | string | yes | | User Referer |
| User-Agent | header | string | yes | | User Agent |
| Accept-Language | header | string | yes | | en_US;q=0.9 |
| AccessToken | header | string | no | | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"deptId": "107",
"parentId": "0",
"ancestors": "0",
"deptName": "Jcmgc Qinimfn Axrfrd Xbjdczfoe",
"orderNum": 516,
"leader": "Kimberly Lewis",
"phone": "19845657348",
"email": "h.cwijngubul@pijpufk.sr",
"status": "0",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» deptId | string | true | none | none |
| »» parentId | string | true | none | none |
| »» ancestors | string | true | none | none |
| »» deptName | string | true | none | none |
| »» orderNum | integer | true | none | none |
| »» leader | string | true | none | none |
| »» phone | string | true | none | none |
| »» email | string | true | none | none |
| »» status | string | true | none | 0 1 |
| »» parentName | string | true | none | none |
# Security/Menu Management
## GET Menu List
GET /system/menu/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------- |
| menuName | query | string | no | Menu Name |
| status | query | string | no | Menu status 0 Inactive 1 Active |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"data": [
{
"menuId": "111",
"menuName": "System Log",
"parentId": "1",
"menuSort": 11,
"path": "log",
"component": "",
"isFrame": "1",
"isCache": "1",
"menuType": "D",
"visible": "0",
"status": "0",
"perms": "",
"icon": "#",
"createBy": "",
"createTime": 1700000000000,
"updateBy": "",
"updateTime": 0,
"remark": "System Log Catalog"
},
{
"menuId": "2102",
"menuName": "Performance Reports",
"parentId": "2099",
"menuSort": 3,
"path": "perfReport",
"component": "perfManage/perfReport/index",
"isFrame": "1",
"isCache": "0",
"menuType": "M",
"visible": "0",
"status": "0",
"perms": "perfManage:perfReport:index",
"icon": "icon-gonggaodayi",
"createBy": "",
"createTime": 1700000000000,
"updateBy": "",
"updateTime": 0,
"remark": "Performance Report Menu"
},
{
"menuId": "2105",
"menuName": "Custom Metrics",
"parentId": "2099",
"menuSort": 6,
"path": "customTarget",
"component": "perfManage/customTarget/index",
"isFrame": "1",
"isCache": "1",
"menuType": "M",
"visible": "0",
"status": "0",
"perms": "perfManage:customTarget:index",
"icon": "icon-fanhui1",
"createBy": "",
"createTime": 1700000000000,
"updateBy": "",
"updateTime": 0,
"remark": "Custom Metrics Menu"
},
{
"menuId": "2106",
"menuName": "Performance General Settings",
"parentId": "2099",
"menuSort": 7,
"path": "perfSet",
"component": "perfManage/perfSet/index",
"isFrame": "1",
"isCache": "0",
"menuType": "M",
"visible": "0",
"status": "0",
"perms": "perfManage:perfSet:index",
"icon": "icon-gonggao",
"createBy": "",
"createTime": 1700000000000,
"updateBy": "",
"updateTime": 0,
"remark": "Performance General Settings Menu"
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» menuId | string | true | none | none |
| »» menuName | string | true | none | none |
| »» parentId | string | true | none | none |
| »» menuSort | integer | true | none | none |
| »» path | string | true | none | none |
| »» component | string | true | none | none |
| »» isFrame | string | true | none | none |
| »» isCache | string | true | none | none |
| »» menuType | string | true | none | none |
| »» visible | string | true | none | none |
| »» status | string | true | none | none |
| »» perms | string | true | none | none |
| »» icon | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## GET Menu Info
GET /system/menu/{menuId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| menuId | path | string | yes | Menu ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» menuId | string | true | none | none |
| »» menuName | string | true | none | none |
| »» parentId | string | true | none | none |
| »» menuSort | integer | true | none | none |
| »» path | string | true | none | none |
| »» component | string | true | none | none |
| »» isFrame | string | true | none | none |
| »» isCache | string | true | none | none |
| »» menuType | string | true | none | none |
| »» visible | string | true | none | none |
| »» status | string | true | none | none |
| »» perms | string | true | none | none |
| »» icon | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## DELETE Menu Deletion
DELETE /system/menu/{menuId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| menuId | path | string | yes | Menu ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT Menu Modification
PUT /system/menu
> Body Parameters
```json
{
"menuId": "string",
"parentId": "string",
"menuName": "string",
"menuType": "string",
"menuSort": 0,
"isFrame": "string",
"isCache": "string",
"visible": "string",
"status": "string",
"icon": "string",
"path": "string",
"component": "string",
"perms": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | --------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » menuId | body | string | yes | none |
| » parentId | body | string | yes | none |
| » menuName | body | string | yes | none |
| » menuType | body | string | yes | D Directory M Menu B Button |
| » menuSort | body | integer | yes | Defatult 0 |
| » isFrame | body | string | no | Required by menu and directory, 0 No 1 Yes |
| » isCache | body | string | no | Required by menu and directory, 0 No cache 1 Cached |
| » visible | body | string | no | Required by menu and directory, 0 Hidden 1 Show |
| » status | body | string | no | Required by menu and directory |
| » icon | body | string | no | Required by menu and directory, #No icon |
| » path | body | string | no | Required by menu and directory, |
| » component | body | string | no | Required by menu, |
| » perms | body | string | no | Required by menu and button, |
| » remark | body | string | no | none |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## POST New Menu
POST /system/menu
> Body Parameters
```json
{
"parentId": "string",
"menuName": "string",
"menuType": "string",
"menuSort": 0,
"isFrame": "string",
"isCache": "string",
"visible": "string",
"status": "string",
"icon": "string",
"path": "string",
"component": "string",
"perms": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » parentId | body | string | yes | |
| » menuName | body | string | yes | none |
| » menuType | body | string | yes | |
| » menuSort | body | integer | yes | |
| » isFrame | body | string | no | |
| » isCache | body | string | no | |
| » visible | body | string | no | |
| » status | body | string | no | |
| » icon | body | string | no | |
| » path | body | string | no | |
| » component | body | string | no | |
| » perms | body | string | no | |
| » remark | body | string | no | none |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET Menu Tree List (specifying roles)
GET /system/menu/roleMenuTreeSelect/{roleId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| roleId | path | string | yes | Role ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» menus | [object] | true | none | none |
| »»» id | string | true | none | none |
| »»» label | string | true | none | none |
| »»» children | [object] | true | none | none |
| »»»» id | string | false | none | none |
| »»»» label | string | false | none | none |
| »»»» children | [object] | false | none | none |
| »» checkedKeys | [object] | true | none | none |
## GET Menu Tree List
GET /system/menu/treeSelect
Using the menu permission list in role addition and modification
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------------- |
| menuName | query | string | no | Menu name |
| status | query | string | no | Menu Status (0 Inactive 1 Active) |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» menus | [object] | true | none | none |
| »»» id | string | true | none | none |
| »»» label | string | true | none | none |
| »»» children | [object] | true | none | none |
| »»»» id | string | false | none | none |
| »»»» label | string | false | none | none |
| »»»» children | [object] | false | none | none |
| »» checkedKeys | [object] | true | none | none |
# Security/Position Management
## GET Position List
GET /system/post/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| postCode | query | string | no | Position Code |
| postName | query | string | no | Position Name |
| status | query | string | no | Status (0 Inactive 1 Active) |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» postId | string | true | none | none |
| »» postCode | string | true | none | none |
| »» postName | string | true | none | none |
| »» postSort | integer | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## POST Position List Export
POST /system/post/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=post_export_16_1684133344353.xlsx
content-length: 19438
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"configName": "string",
"postCode": "string",
"status": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » configName | body | string | no | none |
| » postCode | body | string | no | none |
| » status | body | string | no | (0 Inactive 1 Active) |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> Success
```json
{
"code": 0,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET Position Info
GET /system/post/{postId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| postId | path | string | yes | Position ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» postId | string | true | none | none |
| »» postCode | string | true | none | none |
| »» postName | string | true | none | none |
| »» postSort | integer | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## POST New Position
POST /system/post
> Body Parameters
```json
{
"postCode": "string",
"postName": "string",
"postSort": 0,
"phone": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | --------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » postCode | body | string | yes | none |
| » postName | body | string | yes | none |
| » postSort | body | integer | yes | none |
| » phone | body | string | yes | (0 Inactive 1 Active) |
| » remark | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "Success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT Position Modification
PUT /system/post
> Body Parameters
```json
{
"postCode": "string",
"postName": "string",
"postSort": 0,
"phone": "string",
"remark": "string",
"postId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | --------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » postCode | body | string | yes | none |
| » postName | body | string | yes | none |
| » postSort | body | integer | yes | none |
| » phone | body | string | yes | (0 Inactive 1 Active) |
| » remark | body | string | yes | none |
| » postId | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "Success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE Position Deletion
DELETE /system/post/{postIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | -------------------------------- |
| postIds | path | string | yes | Position ID, separated by commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "Success"
}
```
```json
{
"code": 500,
"msg": "No permission to access position data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# Security/User Profile
## GET User profile
GET /system/user/profile
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"postGroup": [],
"roleGroup": [
"Managers"
],
"user": {
"userId": "2",
"deptId": "",
"userName": "admin",
"nickName": "admin",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "",
"avatar": "",
"status": "1",
"delFlag": "0",
"loginIp": "192.168.2.219",
"loginDate": 1712053821001,
"createBy": "admin",
"createTime": 1697091656500,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "",
"parentId": "",
"ancestors": "",
"deptName": "",
"orderNum": 0,
"leader": "",
"phone": "",
"email": "",
"status": "",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": [
{
"roleId": "2",
"roleName": "Managers",
"roleKey": "administrator",
"roleSort": 2,
"dataScope": "1",
"menuCheckStrictly": "",
"deptCheckStrictly": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
]
}
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| -------------------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» postGroup | [string] | true | none | none |
| »» roleGroup | [string] | true | none | none |
| »» user | object | true | none | none |
| »»» userId | string | true | none | none |
| »»» deptId | string | true | none | none |
| »»» userName | string | true | none | none |
| »»» nickName | string | true | none | none |
| »»» userType | string | true | none | none |
| »»» email | string | true | none | none |
| »»» phonenumber | string | true | none | none |
| »»» sex | string | true | none | none |
| »»» avatar | string | true | none | none |
| »»» status | string | true | none | none |
| »»» delFlag | string | true | none | none |
| »»» loginIp | string | true | none | none |
| »»» loginDate | integer | true | none | none |
| »»» createBy | string | true | none | none |
| »»» createTime | integer | true | none | none |
| »»» updateBy | string | true | none | none |
| »»» updateTime | integer | true | none | none |
| »»» remark | string | true | none | none |
| »»» dept | object | true | none | none |
| »»»» deptId | string | true | none | none |
| »»»» parentId | string | true | none | none |
| »»»» ancestors | string | true | none | none |
| »»»» deptName | string | true | none | none |
| »»»» orderNum | integer | true | none | none |
| »»»» leader | string | true | none | none |
| »»»» phone | string | true | none | none |
| »»»» email | string | true | none | none |
| »»»» status | string | true | none | none |
| »»»» delFlag | string | true | none | none |
| »»»» createBy | string | true | none | none |
| »»»» createTime | integer | true | none | none |
| »»»» updateBy | string | true | none | none |
| »»»» updateTime | integer | true | none | none |
| »»» roles | [object] | true | none | none |
| »»»» roleId | string | false | none | none |
| »»»» roleName | string | false | none | none |
| »»»» roleKey | string | false | none | none |
| »»»» roleSort | integer | false | none | none |
| »»»» dataScope | string | false | none | none |
| »»»» menuCheckStrictly | string | false | none | none |
| »»»» deptCheckStrictly | string | false | none | none |
| »»»» status | string | false | none | none |
| »»»» delFlag | string | false | none | none |
| »»»» createBy | string | false | none | none |
| »»»» createTime | integer | false | none | none |
| »»»» updateBy | string | false | none | none |
| »»»» updateTime | integer | false | none | none |
| »»»» remark | string | false | none | none |
| » msg | string | true | none | none |
## PUT Modify user profile
PUT /system/user/profile
> Body Parameters
```json
{
"nickName": "Jack",
"sex": "1",
"phonenumber": "12113313131",
"email": "t.eknevzfl@htejfppo.so"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » nickName | body | string | yes | none |
| » email | body | string | no | none |
| » phonenumber | body | string | no | none |
| » sex | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "Failed to operate user [admin], cell phone number format is wrong."
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## POST modify avatar
POST /system/user/profile/avatar
> Body Parameters
```yaml
file: file://D:\Downloads\lightning1.svg
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ----------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | yes | Please choose a proportionally sized image as your avatar, such as 200x200, 400x400 |
> Response Examples
> OK
```json
{
"code": 1,
"data": "/upload/avatar/2024/04/earth3d-1_yfz5yx.png",
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "the upload file type is not supported, only the following types are supported: .jpg,.jpeg,.png"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | string | true | none | none |
| » msg | string | true | none | none |
## PUT Modify password
PUT /system/user/profile/updatePwd
> Body Parameters
```json
{
"oldPassword": "admin@1234",
"newPassword": "Admin@1234"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » oldPassword | body | string | yes | none |
| » newPassword | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "New password cannot be the same as the old one"
}
```
```json
{
"code": 0,
"msg": "Change password failed, old password is wrong"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# Security/Role Management
## GET Role list
GET /system/role/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------- |
| roleName | query | string | no | role name |
| roleKey | query | string | no | role key |
| status | query | string | no | status 0 Inactive 1 Active |
| beginTime | query | string | no | begin time |
| endTime | query | string | no | end time |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» roleId | string | true | none | none |
| »» roleName | string | true | none | none |
| »» roleKey | string | true | none | none |
| »» roleSort | integer | true | none | none |
| »» dataScope | string | true | none | none |
| »» menuCheckStrictly | string | true | none | none |
| »» deptCheckStrictly | string | true | none | none |
| »» status | string | true | none | none |
| »» delFlag | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## GET user list assigned role
GET /system/role/authUser/allocatedList
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------------------- |
| userName | query | string | no | user name |
| phonenumber | query | string | no | user phone |
| status | query | string | no | user status |
| roleId | query | string | yes | role id |
| allocated | query | string | yes | Has the user been assigned? true/false |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"total": 1,
"rows": [
{
"roles": [],
"userId": "2",
"deptId": "105",
"userName": "user",
"nickName": "general user",
"email": "user@113.sd",
"phonenumber": "13131313",
"status": "1",
"createTime": "1682264526309",
"dept": {
"deptId": "105",
"deptName": "test"
}
}
]
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» status | string | false | none | 0 1 |
| »» createTime | string | false | none | none |
| »» roles | [string] | false | none | none |
| »» userId | string | false | none | none |
| »» deptId | string | false | none | none |
| »» userName | string | false | none | none |
| »» nickName | string | false | none | none |
| »» email | string | false | none | none |
| »» phonenumber | string | false | none | none |
| »» dept | object | false | none | none |
| »»» deptId | string | false | none | none |
| »»» deptName | string | false | none | none |
## GET Role info
GET /system/role/{roleId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| roleId | path | string | yes | rold ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"roleId": "5",
"roleName": "General Users",
"roleKey": "vistor",
"roleSort": 5,
"dataScope": "1",
"menuCheckStrictly": "1",
"deptCheckStrictly": "1",
"status": "1",
"delFlag": "0",
"createBy": "",
"createTime": 1698486975779,
"updateBy": "",
"updateTime": 0,
"remark": "Ordinary users can only see system-related information"
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» roleId | string | true | none | none |
| »» roleName | string | true | none | none |
| »» roleKey | string | true | none | none |
| »» roleSort | integer | true | none | none |
| »» dataScope | string | true | none | none |
| »» menuCheckStrictly | string | true | none | none |
| »» deptCheckStrictly | string | true | none | none |
| »» status | string | true | none | none |
| »» delFlag | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | integer | true | none | none |
| »» remark | string | true | none | none |
| » msg | string | true | none | none |
## PUT modify role
PUT /system/role
> Body Parameters
```json
{
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"status": "string",
"remark": "string",
"dataScope": "string",
"menuCheckStrictly": "string",
"menuIds": [
"string"
],
"roleId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| -------------------- | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » roleName | body | string | yes | Role name |
| » roleKey | body | string | yes | Role Key |
| » roleSort | body | integer | yes | Role sort |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | Remark |
| » dataScope | body | string | yes | 1: All data permissions 2: Custom data permissions 3: Data permissions for this department 4: Data permissions for this department and below 5: Only personal data permissions) |
| » menuCheckStrictly | body | string | yes | 0: Father and son are not related to each other display 1: Father and son are related to each other display |
| » menuIds | body | [string] | yes | Menu ID list |
| » roleId | body | string | yes | Role ID |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible role data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | Title | description |
| ------- | ------- | -------- | ------------ | ----- | ----------- |
| » code | integer | true | none | | none |
| » msg | string | true | none | | none |
## POST add role
POST /system/role
> Body Parameters
```json
{
"roleName": "Khcekcmgb Ewotb Pcy Llsionms Ywolzf Qjin",
"roleKey": "ggggk",
"roleSort": 20,
"status": "0",
"remark": "Rwxr nxs eyxmnydhqq kuuvc tkstmuh lioguto uvfs dcnj egkle ehsvmywb bdmwu nqsncxcwd ofrun wbhnainsl.",
"dataScope": "1",
"menuCheckStrictly": "0",
"menuIds": [
"250"
]
}
```
### Params
| Name | Location | Type | Required | Description |
| -------------------- | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » roleName | body | string | yes | Role name |
| » roleKey | body | string | yes | Role key |
| » roleSort | body | integer | yes | Role sort |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
| » dataScope | body | string | yes | 1: All data permissions 2: Custom data permissions 3: Data permissions for this department 4: Data permissions for this department and below 5: Only personal data permissions) |
| » menuCheckStrictly | body | string | yes | 0: Father and son are not related to each other display 1: Father and son are related to each other display |
| » menuIds | body | [string] | yes | Menu ID list |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## DELETE delete role
DELETE /system/role/{roleIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------------------------------- |
| roleIds | path | string | yes | Role ID, multiple can be separated by English commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "there is no accessible role data"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## PUT modify role status
PUT /system/role/changeStatus
> Body Parameters
```json
{
"roleId": "string",
"status": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » roleId | body | string | yes | none |
| » status | body | string | no | 0 Inactive 1 Active |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible role data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify role data scope
PUT /system/role/dataScope
> Body Parameters
```json
{
"dataScope": "string",
"deptCheckStrictly": "string",
"menuIds": [
"string"
],
"roleId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| -------------------- | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dataScope | body | string | yes | 1: All data permissions 2: Custom data permissions 3: Data permissions for this department 4: Data permissions for this department and below 5: Only personal data permissions) |
| » deptCheckStrictly | body | string | yes | 0: Father and son are not related to each other display 1: Father and son are related to each other display |
| » menuIds | body | [string] | no | Must be passed when selecting data range 2, department ID array |
| » roleId | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible role data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## POST export role data list
POST /system/role/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=role_export_16_1684133344353.xlsx
content-length: 19438
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"roleName": "string",
"roleKey": "string",
"status": "string",
"beginTime": "string",
"endTime": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » roleName | body | string | no | none |
| » roleKey | body | string | no | none |
| » status | body | string | no | 0 Inactive 1 Active |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
> Response Examples
> OK
```json
{
"code": 500,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT Role assignment selection authorization
PUT /system/role/authUser/checked
> Body Parameters
```json
{
"roleId": "string",
"userIds": "string",
"checked": true
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » roleId | body | string | yes | none |
| » userIds | body | string | yes | Multiple can be separated by English commas |
| » checked | body | boolean | yes | true/false(Add/Cancel) |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible role data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# Security/User infomation
## GET user info
GET /system/user/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| userName | query | string | no | name |
| phonenumber | query | string | no | phone number |
| status | query | string | no | status |
| beginTime | query | string | no | begin time |
| endTime | query | string | no | end time |
| deptId | query | string | no | department ID |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"userId": "1",
"deptId": "",
"userName": "supervisor",
"nickName": "supervisor",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "",
"avatar": "",
"status": "1",
"delFlag": "0",
"loginIp": "192.168.2.219",
"loginDate": 1712118084711,
"createBy": "admin",
"createTime": 1697091656500,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "",
"parentId": "",
"ancestors": "",
"deptName": "",
"orderNum": 0,
"leader": "",
"phone": "",
"email": "",
"status": "",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": [
{
"roleId": "1",
"roleName": "Super Administrator",
"roleKey": "supervisor",
"roleSort": 1,
"dataScope": "1",
"menuCheckStrictly": "",
"deptCheckStrictly": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
]
},
{
"userId": "2",
"deptId": "",
"userName": "admin",
"nickName": "Admin",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "",
"avatar": "/upload/avatar/2024/04/lightning1_guoolm.png",
"status": "1",
"delFlag": "0",
"loginIp": "192.168.2.219",
"loginDate": 1712124820223,
"createBy": "admin",
"createTime": 1697091656500,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "",
"parentId": "",
"ancestors": "",
"deptName": "",
"orderNum": 0,
"leader": "",
"phone": "",
"email": "",
"status": "",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": [
{
"roleId": "2",
"roleName": "Managers",
"roleKey": "administrator",
"roleSort": 2,
"dataScope": "1",
"menuCheckStrictly": "",
"deptCheckStrictly": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
]
},
{
"userId": "103",
"deptId": "",
"userName": "manager",
"nickName": "manager",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "",
"avatar": "",
"status": "1",
"delFlag": "0",
"loginIp": "192.168.2.219",
"loginDate": 1701425631740,
"createBy": "admin",
"createTime": 1698661521780,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "",
"parentId": "",
"ancestors": "",
"deptName": "",
"orderNum": 0,
"leader": "",
"phone": "",
"email": "",
"status": "",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": [
{
"roleId": "3",
"roleName": "Operators",
"roleKey": "operator",
"roleSort": 3,
"dataScope": "1",
"menuCheckStrictly": "",
"deptCheckStrictly": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
]
},
{
"userId": "104",
"deptId": "",
"userName": "monitor",
"nickName": "monitor",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "",
"avatar": "",
"status": "1",
"delFlag": "0",
"loginIp": "192.168.2.219",
"loginDate": 1699345510602,
"createBy": "admin",
"createTime": 1698661684898,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "",
"parentId": "",
"ancestors": "",
"deptName": "",
"orderNum": 0,
"leader": "",
"phone": "",
"email": "",
"status": "",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": [
{
"roleId": "4",
"roleName": "Monitor",
"roleKey": "monitor",
"roleSort": 4,
"dataScope": "1",
"menuCheckStrictly": "",
"deptCheckStrictly": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
]
},
{
"userId": "106",
"deptId": "100",
"userName": "admin1",
"nickName": "admin1",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "1",
"avatar": "",
"status": "0",
"delFlag": "0",
"loginIp": "",
"loginDate": 0,
"createBy": "admin",
"createTime": 1701424142061,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "100",
"parentId": "0",
"ancestors": "0",
"deptName": "System Maintenance Department",
"orderNum": 0,
"leader": "supervisor",
"phone": "",
"email": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": []
}
],
"total": 5
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------------ | -------- | -------- | ------------ | ------------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » rows | [object] | true | none | none |
| »» userId | string | true | none | none |
| »» deptId | string | true | none | none |
| »» userName | string | true | none | none |
| »» nickName | string | true | none | none |
| »» userType | string | true | none | none |
| »» email | string | true | none | none |
| »» phonenumber | string | true | none | none |
| »» sex | string | true | none | 1male 2female |
| »» avatar | string | true | none | none |
| »» status | string | true | none | none |
| »» delFlag | string | true | none | none |
| »» loginIp | string | true | none | none |
| »» loginDate | integer | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | integer | true | none | none |
| »» remark | string | true | none | none |
| »» dept | object | true | none | none |
| »»» deptId | string | true | none | none |
| »»» parentId | string | true | none | none |
| »»» ancestors | string | true | none | none |
| »»» deptName | string | true | none | none |
| »»» orderNum | integer | true | none | none |
| »»» leader | string | true | none | none |
| »»» phone | string | true | none | none |
| »»» email | string | true | none | none |
| »»» status | string | true | none | none |
| »»» delFlag | string | true | none | none |
| »»» createBy | string | true | none | none |
| »»» createTime | integer | true | none | none |
| »»» updateBy | string | true | none | none |
| »»» updateTime | integer | true | none | none |
| »» roles | [object] | true | none | none |
| »»» roleId | string | true | none | none |
| »»» roleName | string | true | none | none |
| »»» roleKey | string | true | none | none |
| »»» roleSort | integer | true | none | none |
| »»» dataScope | string | true | none | none |
| »»» menuCheckStrictly | string | true | none | none |
| »»» deptCheckStrictly | string | true | none | none |
| »»» status | string | true | none | none |
| »»» delFlag | string | true | none | none |
| »»» createBy | string | true | none | none |
| »»» createTime | integer | true | none | none |
| »»» updateBy | string | true | none | none |
| »»» updateTime | integer | true | none | none |
| »»» remark | string | true | none | none |
| » total | integer | true | none | none |
## GET user info by id
GET /system/user/{userId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| userId | path | string | yes | User ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"postIds": [],
"posts": [
{
"postId": "1",
"postCode": "administator",
"postName": "Systems",
"postSort": 1,
"status": "1",
"createBy": "supervisor",
"createTime": 1697110106499,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"postId": "2",
"postCode": "operator",
"postName": "Management",
"postSort": 2,
"status": "1",
"createBy": "supervisor",
"createTime": 1697110106499,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"postId": "3",
"postCode": "monitor",
"postName": "Operation & Maintenance",
"postSort": 3,
"status": "1",
"createBy": "supervisor",
"createTime": 1697110106499,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"postId": "4",
"postCode": "visitor",
"postName": "Monitoring",
"postSort": 4,
"status": "1",
"createBy": "supervisor",
"createTime": 1697110106499,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"postId": "5",
"postCode": "111",
"postName": "test1",
"postSort": 7,
"status": "0",
"createBy": "admin",
"createTime": 1701766022383,
"updateBy": "",
"updateTime": 0,
"remark": "remark"
}
],
"roleIds": [
"2"
],
"roles": [
{
"roleId": "2",
"roleName": "Managers",
"roleKey": "administrator",
"roleSort": 2,
"dataScope": "1",
"menuCheckStrictly": "1",
"deptCheckStrictly": "1",
"status": "1",
"delFlag": "0",
"createBy": "",
"createTime": 1698486915894,
"updateBy": "",
"updateTime": 0,
"remark": "Administrators can perform any operation on the device"
},
{
"roleId": "3",
"roleName": "Operators",
"roleKey": "operator",
"roleSort": 3,
"dataScope": "1",
"menuCheckStrictly": "1",
"deptCheckStrictly": "1",
"status": "1",
"delFlag": "0",
"createBy": "",
"createTime": 1698486934900,
"updateBy": "",
"updateTime": 0,
"remark": "Operation and maintenance personnel can read data from the device and configure the device, but cannot perform software upgrade operations on the device."
},
{
"roleId": "4",
"roleName": "Monitor",
"roleKey": "monitor",
"roleSort": 4,
"dataScope": "1",
"menuCheckStrictly": "1",
"deptCheckStrictly": "1",
"status": "1",
"delFlag": "0",
"createBy": "",
"createTime": 1698486950714,
"updateBy": "",
"updateTime": 0,
"remark": "Monitoring personnel Can only read data from the device, but cannot make any settings on the device"
},
{
"roleId": "5",
"roleName": "General Users",
"roleKey": "vistor",
"roleSort": 5,
"dataScope": "1",
"menuCheckStrictly": "1",
"deptCheckStrictly": "1",
"status": "1",
"delFlag": "0",
"createBy": "",
"createTime": 1698486975779,
"updateBy": "",
"updateTime": 0,
"remark": "Ordinary users can only see system-related information"
}
],
"user": {
"userId": "2",
"deptId": "",
"userName": "admin",
"nickName": "Admin",
"userType": "sys",
"email": "",
"phonenumber": "",
"sex": "",
"avatar": "/upload/avatar/2024/04/lightning1_guoolm.png",
"status": "1",
"delFlag": "0",
"loginIp": "192.168.2.219",
"loginDate": 1712124820223,
"createBy": "admin",
"createTime": 1697091656500,
"updateBy": "",
"updateTime": 0,
"remark": "",
"dept": {
"deptId": "",
"parentId": "",
"ancestors": "",
"deptName": "",
"orderNum": 0,
"leader": "",
"phone": "",
"email": "",
"status": "",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0
},
"roles": [
{
"roleId": "2",
"roleName": "Managers",
"roleKey": "administrator",
"roleSort": 2,
"dataScope": "1",
"menuCheckStrictly": "",
"deptCheckStrictly": "",
"status": "1",
"delFlag": "",
"createBy": "",
"createTime": 0,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
]
}
},
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "No accessible user data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------------ | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» user | object | true | none | none |
| »»» roles | [object] | true | none | none |
| »»»» roleId | string | false | none | none |
| »»»» roleName | string | false | none | none |
| »»»» roleKey | string | false | none | none |
| »»»» roleSort | integer | false | none | none |
| »»»» dataScope | string | false | none | none |
| »»»» status | string | false | none | none |
| »»» userId | string | true | none | none |
| »»» deptId | string¦null | true | none | none |
| »»» userName | string | true | none | none |
| »»» nickName | string | true | none | none |
| »»» email | string | true | none | none |
| »»» avatar | string | true | none | none |
| »»» phonenumber | string | true | none | none |
| »»» sex | string | true | none | none |
| »»» status | string | true | none | none |
| »»» delFlag | string | true | none | none |
| »»» loginIp | string | true | none | none |
| »»» loginDate | string | true | none | none |
| »»» createBy | string | true | none | none |
| »»» createTime | string | true | none | none |
| »»» remark | string¦null | true | none | none |
| »»» dept | object | true | none | none |
| »»»» deptId | string | true | none | none |
| »»»» parentId | string | true | none | none |
| »»»» ancestors | string | true | none | none |
| »»»» deptName | string | true | none | none |
| »»»» orderNum | integer | true | none | none |
| »»»» leader | string | true | none | none |
| »»»» status | string | true | none | none |
| »»»» phone | string | false | none | none |
| »»»» email | string | false | none | none |
| »» roleIds | [string] | true | none | none |
| »» postIds | [string] | true | none | none |
| »» roles | [object] | true | none | none |
| »»» roleId | string | true | none | none |
| »»» roleName | string | true | none | none |
| »»» roleKey | string | true | none | none |
| »»» roleSort | integer | true | none | none |
| »»» dataScope | string | true | none | none |
| »»» menuCheckStrictly | string | true | none | none |
| »»» deptCheckStrictly | string | true | none | none |
| »»» status | string | true | none | none |
| »»» delFlag | string | true | none | none |
| »»» createTime | string | true | none | none |
| »»» remark | string | true | none | none |
| »» posts | [object] | true | none | none |
| »»» postId | string | true | none | none |
| »»» postCode | string | true | none | none |
| »»» postName | string | true | none | none |
| »»» postSort | integer | true | none | none |
| »»» status | string | true | none | none |
| »»» createBy | string | true | none | none |
| »»» createTime | string | true | none | none |
| »»» remark | string | true | none | none |
## POST add user
POST /system/user
> Body Parameters
```json
{
"remark": "",
"deptId": 102,
"nickName": "",
"email": "h.vrcjiz@qcfgqedxw.bz",
"phonenumber": "18641692257",
"sex": "0",
"status": "1",
"roleIds": [
2
],
"postIds": [
1,
2,
3,
4
],
"userName": "gijobqebs",
"password": "123456"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | --------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » userName | body | string | yes | user name |
| » password | body | string | yes | user paasword |
| » nickName | body | string | yes | nick name |
| » email | body | string | yes | email address |
| » phonenumber | body | string | yes | phone number |
| » sex | body | string | yes | 0not selected 1male 2female |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | remark |
| » deptId | body | string | yes | department ID |
| » roleIds | body | [string] | yes | role id list |
| » postIds | body | [string] | yes | none |
| » userType | body | string | no | system user |
| » avatar | body | string | no | user avatar |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "Failed to operate user [maskUKolpoeu], login account already exists."
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
## PUT modify user
PUT /system/user
> Body Parameters
```json
{
"remark": "",
"deptId": 80,
"nickName": "",
"email": "x.swtaf@oypeubb.tg",
"phonenumber": "18106129309",
"sex": "1",
"status": "1",
"roleIds": [
2
],
"postIds": [
2
],
"userId": "101",
"userName": "x34bvpi"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | --------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » userId | body | string | yes | none |
| » userName | body | string | yes | none |
| » nickName | body | string | yes | none |
| » email | body | string | yes | none |
| » phonenumber | body | string | yes | none |
| » sex | body | string | yes | 0not selected 1male 2female |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
| » deptId | body | string | yes | none |
| » roleIds | body | [string] | yes | none |
| » postIds | body | [string] | yes | none |
| » userType | body | string | no | system user |
| » avatar | body | string | no | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## POST export user list
POST /system/user/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=user_export_11_1684230271701.xlsx
content-length: 21499
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"userName": "string",
"phonenumber": "string",
"status": "string",
"beginTime": "string",
"endTime": "string",
"deptId": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » userName | body | string | no | none |
| » phonenumber | body | string | no | none |
| » status | body | string | no | 0 Inactive 1 Active |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
| » deptId | body | string | no | none |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> OK
```json
{
"code": 500,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## POST import user data list
POST /system/user/importData
> Body Parameters
```yaml
file: file://D:\Downloads\user_1712127865098.xlsx
updateSupport: "{% mock 'pick' , ['false','true'] %}"
```
### Params
| Name | Location | Type | Required | Description |
| ---------------- | -------- | -------------- | -------- | -------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | no | Support xls/xlsx excel file |
| » updateSupport | body | string | no | Update existing data, default to false |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Congratulations, the data has been imported successfully! There are 1 entries with the following data:<br/>User ID: user001 Import Successful"
}
```
```json
{
"code": 1,
"msg": "Sorry, the import failed! A total of 2 entries were not formatted correctly, the error is below:<br/>User ID: 107 cell phone number 18105438570 Existing<br/>User ID: 108 cell phone number 18178533158 Existing"
}
```
```json
{
"code": 0,
"msg": "the upload file type is not supported, only the following types are supported: .xls,.xlsx"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete user
DELETE /system/user/{userIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------ |
| userIds | path | string | yes | User ID, multiple separated by commas in English |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Deleted successfully: 1"
}
```
```json
{
"code": 0,
"msg": "there is no accessible user data"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT reset user password
PUT /system/user/resetPwd
> Body Parameters
```json
{
"password": "string",
"userId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » password | body | string | yes | none |
| » userId | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "No accessible user data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify user status
PUT /system/user/changeStatus
> Body Parameters
```json
{
"status": "string",
"userId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » status | body | string | yes | 0 Inactive 1 Active |
| » userId | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "The change status is equal to the old value!"
}
```
```json
{
"code": 0,
"msg": "No accessible user data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# Security/Online user information
## GET aquire online user
GET /monitor/online/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------- |
| userName | query | string | no | user name (login user) |
| ipaddr | query | string | no | logiin host ip address |
| Authorization | header | string | yes | none |
| Referer | header | string | yes | Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"tokenId": "yowsej8nqdnb3t8r",
"deptName": "",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"loginTime": 1712457573298
},
{
"tokenId": "o517m9ms5x7m3ohc",
"deptName": "",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Chrome 86.0.4240.198",
"os": "Windows 10",
"loginTime": 1712457614560
}
],
"total": 2
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------ | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » rows | [object] | true | none | none |
| »» tokenId | string | true | none | none |
| »» userName | string | true | none | none |
| »» ipaddr | string | true | none | none |
| »» loginLocation | string | true | none | none |
| »» browser | string | true | none | none |
| »» os | string | true | none | none |
| »» loginTime | integer | true | none | none |
| »» deptName | string | true | none | none |
| » total | integer | true | none | none |
## DELETE force users to log out
DELETE /monitor/online/{tokenId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------- |
| tokenId | path | string | yes | access token ID |
| Authorization | header | string | yes | Authorization |
| Referer | header | string | no | Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Dictionary type information
## GET Dictionary type list
GET /system/dict/type/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------- |
| dictName | query | string | no | Name |
| dictType | query | string | no | Type |
| status | query | string | no | Status（0 Inactive 1 Active） |
| beginTime | query | string | no | Begin time |
| endTime | query | string | no | End time |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"dictId": "1",
"dictName": "User Gender",
"dictType": "sys_user_sex",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "User gender list"
},
{
"dictId": "2",
"dictName": "Menu Status",
"dictType": "sys_show_hide",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Menu Status List"
},
{
"dictId": "3",
"dictName": "System switches",
"dictType": "sys_normal_disable",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "System switch list"
},
{
"dictId": "4",
"dictName": "Task Status",
"dictType": "sys_job_status",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Task Status List"
},
{
"dictId": "5",
"dictName": "Task Grouping",
"dictType": "sys_job_group",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Task Grouping List"
},
{
"dictId": "6",
"dictName": "System or not",
"dictType": "sys_yes_no",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "System whether list"
},
{
"dictId": "9",
"dictName": "Operation Type",
"dictType": "sys_oper_type",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Operation type list"
},
{
"dictId": "10",
"dictName": "System Status",
"dictType": "sys_common_status",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Login Status List"
},
{
"dictId": "100",
"dictName": "Trace Types",
"dictType": "trace_type",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Trace Types"
},
{
"dictId": "101",
"dictName": "Operation Log Type",
"dictType": "operation_log_type",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "Operation log type"
}
],
"total": 31
}
```
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"dictId": "1",
"dictName": "User Gender",
"dictType": "sys_user_sex",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "User gender list"
}
],
"total": 1
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » rows | [object] | true | none | none |
| »» dictId | string | true | none | none |
| »» dictName | string | true | none | none |
| »» dictType | string | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | integer | true | none | none |
| »» remark | string | true | none | none |
| » total | integer | true | none | none |
## GET Dictionary type details
GET /system/dict/type/{dictId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| dictId | path | string | yes | dictonary ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"dictId": "1",
"dictName": "User Gender",
"dictType": "sys_user_sex",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": "User gender list"
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | object | true | none | none |
| »» dictId | string | true | none | none |
| »» dictName | string | true | none | none |
| »» dictType | string | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | integer | true | none | none |
| »» remark | string | true | none | none |
| » msg | string | true | none | none |
## POST Export dictonary type list
POST /system/dict/type/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=dict_type_export_12_1684240671183.xlsx
content-length: 18246
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"dictName": "string",
"dictType": "string",
"status": "string",
"beginTime": "string",
"endTime": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dictName | body | string | no | none |
| » dictType | body | string | no | none |
| » status | body | string | no | 0 Active 1 Inactive |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> Success
```json
{
"code": 500,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## POST Add dictonary type
POST /system/dict/type
> Body Parameters
```json
{
"dictName": "string",
"dictType": "string",
"status": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dictName | body | string | yes | none |
| » dictType | body | string | yes | none |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 500,
"msg": "Failed to add dictionary entry for [xxx], the dictionary name already exists."
}
```
```json
"{\r\n \"code\": 500,\r\n \"msg\": \"Failed to add the dictionary entry for \"xxxx\", as the dictionary type already exists.\"\r\n}"
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT Modify dictonary type
PUT /system/dict/type
> Body Parameters
```json
{
"dictName": "string",
"dictType": "string",
"remark": "string",
"status": "string",
"dictId": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dictName | body | string | yes | none |
| » dictType | body | string | yes | none |
| » remark | body | string | yes | none |
| » status | body | string | yes | 0 Inactive 1 Active |
| » dictId | body | string | no | none |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "Success"
}
```
br
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE Delete dictonary type
DELETE /system/dict/type/{dictIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------------- |
| dictIds | path | string | yes | Dictionary ID, separated by commas. |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 500,
"msg": "Access to dictionary type data is not authorized!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET Dropdown list of dictionary types
GET /system/dict/type/getDictOptionselect
Dropdown selection in dictionary data
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"label": "User Gender",
"value": "sys_user_sex"
},
{
"label": "Menu Status",
"value": "sys_show_hide"
},
{
"label": "System switches",
"value": "sys_normal_disable"
},
{
"label": "Task Status",
"value": "sys_job_status"
},
{
"label": "Task Grouping",
"value": "sys_job_group"
},
{
"label": "System or not",
"value": "sys_yes_no"
},
{
"label": "Operation Type",
"value": "sys_oper_type"
},
{
"label": "System Status",
"value": "sys_common_status"
},
{
"label": "Trace Types",
"value": "trace_type"
},
{
"label": "Operation Log Type",
"value": "operation_log_type"
},
{
"label": "Alarm Log Type",
"value": "alarm_status"
},
{
"label": "Security Log Type",
"value": "security_log_type"
},
{
"label": "Network element software version status",
"value": "ne_version_status"
},
{
"label": "Multi-language - English",
"value": "i18n_en"
},
{
"label": "Multi-language - Chinese",
"value": "i18n_zh"
},
{
"label": "System Role Data Range",
"value": "sys_role_datascope"
},
{
"label": "Event Alarm Types",
"value": "active_alarm_type"
},
{
"label": "Alarm Clearing Types",
"value": "active_clear_type"
},
{
"label": "Alarm Acknowledgement Types",
"value": "active_ack_state"
},
{
"label": "Severity",
"value": "active_alarm_severity"
},
{
"label": "Home Status",
"value": "index_status"
},
{
"label": "CDR SIP Response Code Category Type",
"value": "cdr_sip_code"
},
{
"label": "CDR Call Type",
"value": "cdr_call_type"
},
{
"label": "UE Event Authentication Code Type",
"value": "ue_auth_code"
},
{
"label": "UE Event Type",
"value": "ue_event_type"
},
{
"label": "UE Event CM Status",
"value": "ue_event_cm_state"
},
{
"label": "Network element host connection type",
"value": "ne_host_type"
},
{
"label": "Network element host grouping",
"value": "ne_host_groupId"
},
{
"label": "Network element host authentication mode",
"value": "ne_host_authMode"
},
{
"label": "Network element host command grouping",
"value": "ne_host_cmd_groupId"
},
{
"label": "NE Info State",
"value": "ne_info_status"
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » data | [object] | true | none | none |
| »» label | string | true | none | none |
| »» value | string | true | none | none |
| » msg | string | true | none | none |
## PUT Refresh dictonary type cache
PUT /system/dict/type/refreshCache
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Dictionary data information
## POST Export dictonary data list
POST /system/dict/data/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=dict_data_export_10_1684245668586.xlsx
content-length: 18236
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"dictLabel": "string",
"dictType": "string",
"status": "string",
"beginTime": "string",
"endTime": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dictLabel | body | string | no | none |
| » dictType | body | string | no | none |
| » status | body | string | no | 0 Inactive1 Active |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> OK
```json
{
"code": 500,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET dictonary data list
GET /system/dict/data/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------- |
| dictType | query | string | no | type |
| dictLabel | query | string | no | label |
| status | query | string | no | status（0 Inactive 1 Active） |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"dictCode": "67",
"dictSort": 0,
"dictLabel": "Not cleared",
"dictValue": "0",
"dictType": "active_clear_type",
"tagClass": "",
"tagType": "processing",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "70",
"dictSort": 0,
"dictLabel": "Not Confirm",
"dictValue": "0",
"dictType": "active_ack_state",
"tagClass": "",
"tagType": "processing",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "108",
"dictSort": 0,
"dictLabel": "Other",
"dictValue": "0",
"dictType": "cdr_sip_code",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1706610000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "109",
"dictSort": 0,
"dictLabel": "SSH",
"dictValue": "ssh",
"dictType": "ne_host_type",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1706620000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "111",
"dictSort": 0,
"dictLabel": "Other",
"dictValue": "0",
"dictType": "ne_host_groupId",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1706620000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "114",
"dictSort": 0,
"dictLabel": "Password Authentication",
"dictValue": "0",
"dictType": "ne_host_authMode",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1706620000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "116",
"dictSort": 0,
"dictLabel": "Default",
"dictValue": "0",
"dictType": "ne_host_cmd_groupId",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1706620000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "118",
"dictSort": 0,
"dictLabel": "Online",
"dictValue": "0",
"dictType": "ne_info_status",
"tagClass": "",
"tagType": "processing",
"status": "1",
"createBy": "supervisor",
"createTime": 1706620000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "1",
"dictSort": 1,
"dictLabel": "Not selected",
"dictValue": "0",
"dictType": "sys_user_sex",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "4",
"dictSort": 1,
"dictLabel": "Show",
"dictValue": "1",
"dictType": "sys_show_hide",
"tagClass": "",
"tagType": "success",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
],
"total": 1359
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» dictCode | string | true | none | none |
| »» dictSort | integer | true | none | none |
| »» dictLabel | string | true | none | none |
| »» dictValue | string | true | none | none |
| »» dictType | string | true | none | none |
| »» tagClass | string | true | none | none |
| »» tagType | string | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## GET dictonary data info detail
GET /system/dict/data/{dictCode}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| dictCode | path | string | yes | dictonary code |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"dictCode": "38",
"dictSort": 11,
"dictLabel": "Update",
"dictValue": "UPDATE",
"dictType": "operation_log_type",
"tagClass": "",
"tagType": "magenta",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» dictCode | string | true | none | none |
| »» dictSort | integer | true | none | none |
| »» dictLabel | string | true | none | none |
| »» dictValue | string | true | none | none |
| »» dictType | string | true | none | none |
| »» tagClass | string | true | none | none |
| »» tagType | string | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## GET dictionary data list (specify dictionary type)
GET /system/dict/data/type/{dictType}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------- |
| dictType | path | string | yes | Dictionary type, obtained from the dictionary type list |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": [
{
"dictCode": "1",
"dictSort": 1,
"dictLabel": "Not selected",
"dictValue": "0",
"dictType": "sys_user_sex",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "2",
"dictSort": 2,
"dictLabel": "Male",
"dictValue": "1",
"dictType": "sys_user_sex",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
},
{
"dictCode": "3",
"dictSort": 3,
"dictLabel": "Female",
"dictValue": "2",
"dictType": "sys_user_sex",
"tagClass": "",
"tagType": "",
"status": "1",
"createBy": "supervisor",
"createTime": 1699350000000,
"updateBy": "",
"updateTime": 0,
"remark": ""
}
],
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» dictCode | string | false | none | none |
| »» dictSort | integer | false | none | none |
| »» dictLabel | string | false | none | none |
| »» dictValue | string | false | none | none |
| »» dictType | string | false | none | none |
| »» tagClass | string | false | none | none |
| »» tagType | string | false | none | none |
| »» status | string | false | none | none |
| »» createBy | string | false | none | none |
| »» createTime | string | false | none | none |
| »» remark | string | false | none | none |
## POST add dictonary data
POST /system/dict/data
> Body Parameters
```json
{
"dictType": "string",
"dictLabel": "string",
"dictValue": "string",
"dictSort": 0,
"tagClass": "string",
"tagType": "string",
"status": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------------ |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dictType | body | string | yes | dictonary type |
| » dictLabel | body | string | yes | dictonary label |
| » dictValue | body | string | yes | dictonary value |
| » dictSort | body | integer | yes | dictonary sort |
| » tagClass | body | string | yes | The preset class style |
| » tagType | body | string | yes | default data fixed items |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "dictType.errLabelExists"
}
```
```json
{
"code": 500,
"msg": "【x】，"
}
```
```json
{
"code": 0,
"msg": "There is no accessible dictionary type data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify dictonary data
PUT /system/dict/data
> Body Parameters
```json
{
"dictCode": "string",
"dictType": "string",
"dictLabel": "string",
"dictValue": "string",
"dictSort": 0,
"tagClass": "string",
"tagType": "string",
"status": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ----------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » dictCode | body | string | yes | dictonary code |
| » dictType | body | string | yes | get from dictionary type list |
| » dictLabel | body | string | yes | none |
| » dictValue | body | string | yes | none |
| » dictSort | body | integer | yes | none |
| » tagClass | body | string | yes | the preset class style |
| » tagType | body | string | yes | default data fixed items |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible dictionary type data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete dictonary data
DELETE /system/dict/data/{dictCodes}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | -------------------------------------------------------- |
| dictCodes | path | string | yes | Dictionary code ID, multiple separated by English commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Deleted successfully: 1"
}
```
```json
{
"code": 0,
"msg": "there is no accessible dictionary-encoded data"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Parameter configuration Information
## GET aquire parameter configuration list
GET /system/config/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------------------- |
| configName | query | string | no | configuration name |
| configKey | query | string | no | configuration key |
| configType | query | string | no | Is it built-in in the system-Yes/No:Y/N |
| beginTime | query | string | no | begin time |
| endTime | query | string | no | end time |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» configId | integer | true | none | none |
| »» configName | string | true | none | none |
| »» configKey | string | true | none | none |
| »» configValue | string | true | none | none |
| »» configType | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | string | true | none | none |
| »» remark | string | true | none | none |
## POST export parameter cofniguration list
POST /system/config/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=config_export_10_1684131509100.xlsx
content-length: 18337
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"configName": "string",
"configKey": "string",
"beginTime": "string",
"endTime": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » configName | body | string | no | none |
| » configKey | body | string | no | none |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> OK
```json
{
"code": 0,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET aquire value from parameter config key
GET /system/config/configKey/{configKey}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| configKey | path | string | yes | cofnig key |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": "true"
}
```
```json
{
"code": 0,
"msg": "error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | string | true | none | none |
## GET aquire parameter configuration info
GET /system/config/{configId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| configId | path | string | yes | config ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"configId": "1",
"configName": "User Management-Account Initial Password",
"configKey": "sys.user.initPassword",
"configValue": "Abcd@1234..",
"configType": "Y",
"createBy": "supervisor",
"createTime": 1700000000000,
"updateBy": "",
"updateTime": 0,
"remark": "Import user initialization password 123456"
},
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» configId | integer | true | none | none |
| »» configName | string | true | none | none |
| »» configKey | string | true | none | none |
| »» configValue | string | true | none | none |
| »» configType | string | true | none | Y N |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» updateBy | string | true | none | none |
| »» updateTime | string | true | none | none |
| »» remark | string | true | none | none |
## POST add parameter configuration
POST /system/config
> Body Parameters
```json
{
"configName": "string",
"configKey": "string",
"configValue": "string",
"configType": "string",
"remark": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » configName | body | string | yes | config name |
| » configKey | body | string | yes | config key |
| » configValue | body | string | yes | config value |
| » configType | body | string | yes | Y/N: yes/no |
| » remark | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "Failed to manipulate parameter configuration [sys.user.initPassword], parameter key name already exists!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify parameter configuration
PUT /system/config
> Body Parameters
```json
{
"configName": "string",
"configKey": "string",
"configValue": "string",
"configType": "string",
"remark": "string",
"configId": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------- | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » configName | body | string | yes | none |
| » configKey | body | string | yes | none |
| » configValue | body | string | yes | none |
| » configType | body | string | yes | Y/N: yes/no |
| » remark | body | string | yes | none |
| » configId | body | integer | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "No permission to access parameter configuration data！"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify parameter value by config key
PUT /system/config/changeValue
> Body Parameters
```json
{
"key": "sys.logo.filePathIcon",
"value": ""
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » key | body | string | yes | none |
| » value | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "Failed to manipulate parameter configuration [sys.user.initPassword], parameter key name already exists!"
}
```
```json
{
"code": 0,
"msg": "！"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete parameter configuration
DELETE /system/config/{configIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------------------------------------- |
| configIds | path | string | yes | Configuration ID, multiple separated by commas in English |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "The built-in parameter [xxx] cannot be deleted"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT refresh parameter configuration cache
PUT /system/config/refreshCache
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Cache information
## GET cache monitor information
GET /monitor/cache
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"commandStats": [
{
"name": "exists",
"value": "5559"
},
{
"name": "set",
"value": "637154"
},
{
"name": "select",
"value": "474"
},
{
"name": "mget",
"value": "3"
},
{
"name": "hello",
"value": "572"
},
{
"name": "dbsize",
"value": "2"
},
{
"name": "expire",
"value": "1"
},
{
"name": "evalsha",
"value": "2"
},
{
"name": "ping",
"value": "190"
},
{
"name": "info",
"value": "3"
},
{
"name": "del",
"value": "3341"
},
{
"name": "eval",
"value": "1"
},
{
"name": "ttl",
"value": "383"
},
{
"name": "incr",
"value": "2"
},
{
"name": "scan",
"value": "386"
},
{
"name": "get",
"value": "672017"
}
],
"dbSize": 66,
"info": {
"clients": {
"blocked_clients": "0",
"client_recent_max_input_buffer": "20480",
"client_recent_max_output_buffer": "0",
"clients_in_timeout_table": "0",
"cluster_connections": "0",
"connected_clients": "4",
"maxclients": "10000",
"total_blocking_keys": "0",
"total_blocking_keys_on_nokey": "0",
"tracking_clients": "0"
},
"cluster": {
"cluster_enabled": "0"
},
"cpu": {
"used_cpu_sys": "568.391106",
"used_cpu_sys_children": "1.305536",
"used_cpu_sys_main_thread": "568.376221",
"used_cpu_user": "671.263046",
"used_cpu_user_children": "6.089575",
"used_cpu_user_main_thread": "671.221030"
},
"errorstats": {
"errorstat_NOSCRIPT": "count=1"
},
"keyspace": {
"db10": "keys=66,expires=2,avg_ttl=1739604",
"db11": "keys=50,expires=0,avg_ttl=0"
},
"memory": {
"active_defrag_running": "0",
"allocator_active": "2736128",
"allocator_allocated": "2434312",
"allocator_frag_bytes": "301816",
"allocator_frag_ratio": "1.12",
"allocator_resident": "8257536",
"allocator_rss_bytes": "5521408",
"allocator_rss_ratio": "3.02",
"lazyfree_pending_objects": "0",
"lazyfreed_objects": "0",
"maxmemory": "0",
"maxmemory_human": "0B",
"maxmemory_policy": "noeviction",
"mem_allocator": "jemalloc-5.3.0",
"mem_aof_buffer": "0",
"mem_clients_normal": "7712",
"mem_clients_slaves": "0",
"mem_cluster_links": "0",
"mem_fragmentation_bytes": "14006312",
"mem_fragmentation_ratio": "7.74",
"mem_not_counted_for_evict": "0",
"mem_replication_backlog": "0",
"mem_total_replication_buffers": "0",
"number_of_cached_scripts": "1",
"number_of_functions": "0",
"number_of_libraries": "0",
"rss_overhead_bytes": "7827456",
"rss_overhead_ratio": "1.95",
"total_system_memory": "16607678464",
"total_system_memory_human": "15.47G",
"used_memory": "2100976",
"used_memory_dataset": "1220328",
"used_memory_dataset_perc": "98.81%",
"used_memory_functions": "184",
"used_memory_human": "2.00M",
"used_memory_lua": "34816",
"used_memory_lua_human": "34.00K",
"used_memory_overhead": "880648",
"used_memory_peak": "2549640",
"used_memory_peak_human": "2.43M",
"used_memory_peak_perc": "82.40%",
"used_memory_rss": "16084992",
"used_memory_rss_human": "15.34M",
"used_memory_scripts": "688",
"used_memory_scripts_eval": "504",
"used_memory_scripts_human": "688B",
"used_memory_startup": "865928",
"used_memory_vm_eval": "34816",
"used_memory_vm_functions": "32768",
"used_memory_vm_total": "67584",
"used_memory_vm_total_human": "66.00K"
},
"modules": {},
"persistence": {
"aof_current_rewrite_time_sec": "-1",
"aof_enabled": "0",
"aof_last_bgrewrite_status": "ok",
"aof_last_cow_size": "0",
"aof_last_rewrite_time_sec": "-1",
"aof_last_write_status": "ok",
"aof_rewrite_in_progress": "0",
"aof_rewrite_scheduled": "0",
"aof_rewrites": "0",
"aof_rewrites_consecutive_failures": "0",
"async_loading": "0",
"current_cow_peak": "0",
"current_cow_size": "0",
"current_cow_size_age": "0",
"current_fork_perc": "0.00",
"current_save_keys_processed": "0",
"current_save_keys_total": "0",
"loading": "0",
"module_fork_in_progress": "0",
"module_fork_last_cow_size": "0",
"rdb_bgsave_in_progress": "0",
"rdb_changes_since_last_save": "215",
"rdb_current_bgsave_time_sec": "-1",
"rdb_last_bgsave_status": "ok",
"rdb_last_bgsave_time_sec": "0",
"rdb_last_cow_size": "962560",
"rdb_last_load_keys_expired": "1",
"rdb_last_load_keys_loaded": "114",
"rdb_last_save_time": "1712568097",
"rdb_saves": "2172"
},
"replication": {
"connected_slaves": "0",
"master_failover_state": "no-failover",
"master_repl_offset": "57",
"master_replid": "a8df674e95bb3a24d37a800f3e54fec532cbdc94",
"master_replid2": "0000000000000000000000000000000000000000",
"repl_backlog_active": "0",
"repl_backlog_first_byte_offset": "0",
"repl_backlog_histlen": "0",
"repl_backlog_size": "1048576",
"role": "master",
"second_repl_offset": "-1"
},
"server": {
"arch_bits": "64",
"atomicvar_api": "c11-builtin",
"config_file": "",
"configured_hz": "10",
"executable": "/data/redis-server",
"gcc_version": "12.2.0",
"hz": "10",
"io_threads_active": "0",
"listener0": "*,port=6379",
"lru_clock": "1292262",
"monotonic_clock": "POSIX clock_gettime",
"multiplexing_api": "epoll",
"os": "Linux 5.15.90.1-microsoft-standard-WSL2 x86_64",
"process_id": "1",
"process_supervised": "no",
"redis_build_id": "9b0796a828280810",
"redis_git_dirty": "0",
"redis_git_sha1": "00000000",
"redis_mode": "standalone",
"redis_version": "7.2.3",
"run_id": "2831087f076f4f96810773e0207f5d19ec0d57ba",
"server_time_usec": "1712568294458826",
"tcp_port": "6379",
"uptime_in_days": "11",
"uptime_in_seconds": "956181"
},
"stats": {
"acl_access_denied_auth": "0",
"acl_access_denied_channel": "0",
"acl_access_denied_cmd": "0",
"acl_access_denied_key": "0",
"active_defrag_hits": "0",
"active_defrag_key_hits": "0",
"active_defrag_key_misses": "0",
"active_defrag_misses": "0",
"current_active_defrag_time": "0",
"current_eviction_exceeded_time": "0",
"dump_payload_sanitizations": "0",
"eventloop_cycles": "10833780",
"eventloop_duration_cmd_sum": "6980386",
"eventloop_duration_sum": "993148545",
"evicted_clients": "0",
"evicted_keys": "0",
"expire_cycle_cpu_milliseconds": "17711",
"expired_keys": "86",
"expired_stale_perc": "0.00",
"expired_time_cap_reached_count": "0",
"instantaneous_eventloop_cycles_per_sec": "9",
"instantaneous_eventloop_duration_usec": "87",
"instantaneous_input_kbps": "0.00",
"instantaneous_input_repl_kbps": "0.00",
"instantaneous_ops_per_sec": "0",
"instantaneous_output_kbps": "0.00",
"instantaneous_output_repl_kbps": "0.00",
"io_threaded_reads_processed": "0",
"io_threaded_writes_processed": "0",
"keyspace_hits": "656615",
"keyspace_misses": "21349",
"latest_fork_usec": "284",
"migrate_cached_sockets": "0",
"pubsub_channels": "0",
"pubsub_patterns": "0",
"pubsubshard_channels": "0",
"rejected_connections": "0",
"reply_buffer_expands": "3799",
"reply_buffer_shrinks": "3912",
"slave_expires_tracked_keys": "0",
"sync_full": "0",
"sync_partial_err": "0",
"sync_partial_ok": "0",
"total_active_defrag_time": "0",
"total_commands_processed": "1320088",
"total_connections_received": "572",
"total_error_replies": "1",
"total_eviction_exceeded_time": "0",
"total_forks": "2172",
"total_net_input_bytes": "119768993",
"total_net_output_bytes": "67614465",
"total_net_repl_input_bytes": "0",
"total_net_repl_output_bytes": "0",
"total_reads_processed": "1321850",
"total_writes_processed": "1320083",
"tracking_total_items": "0",
"tracking_total_keys": "0",
"tracking_total_prefixes": "0",
"unexpected_error_replies": "0"
}
}
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------------------------------ | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» info | object | true | none | none |
| »»» server | object | true | none | none |
| »»»» redis_version | string | true | none | none |
| »»»» redis_git_sha1 | string | true | none | none |
| »»»» redis_git_dirty | string | true | none | none |
| »»»» redis_build_id | string | true | none | none |
| »»»» redis_mode | string | true | none | none |
| »»»» os | string | true | none | none |
| »»»» arch_bits | string | true | none | none |
| »»»» monotonic_clock | string | true | none | none |
| »»»» multiplexing_api | string | true | none | none |
| »»»» atomicvar_api | string | true | none | none |
| »»»» gcc_version | string | true | none | none |
| »»»» process_id | string | true | none | none |
| »»»» process_supervised | string | true | none | none |
| »»»» run_id | string | true | none | none |
| »»»» tcp_port | string | true | none | none |
| »»»» server_time_usec | string | true | none | none |
| »»»» uptime_in_seconds | string | true | none | none |
| »»»» uptime_in_days | string | true | none | none |
| »»»» hz | string | true | none | none |
| »»»» configured_hz | string | true | none | none |
| »»»» lru_clock | string | true | none | none |
| »»»» executable | string | true | none | none |
| »»»» config_file | string | true | none | none |
| »»»» io_threads_active | string | true | none | none |
| »»» clients | object | true | none | none |
| »»»» connected_clients | string | true | none | none |
| »»»» cluster_connections | string | true | none | none |
| »»»» maxclients | string | true | none | none |
| »»»» client_recent_max_input_buffer | string | true | none | none |
| »»»» client_recent_max_output_buffer | string | true | none | none |
| »»»» blocked_clients | string | true | none | none |
| »»»» tracking_clients | string | true | none | none |
| »»»» clients_in_timeout_table | string | true | none | none |
| »»» memory | object | true | none | none |
| »»»» used_memory | string | true | none | none |
| »»»» used_memory_human | string | true | none | none |
| »»»» used_memory_rss | string | true | none | none |
| »»»» used_memory_rss_human | string | true | none | none |
| »»»» used_memory_peak | string | true | none | none |
| »»»» used_memory_peak_human | string | true | none | none |
| »»»» used_memory_peak_perc | string | true | none | none |
| »»»» used_memory_overhead | string | true | none | none |
| »»»» used_memory_startup | string | true | none | none |
| »»»» used_memory_dataset | string | true | none | none |
| »»»» used_memory_dataset_perc | string | true | none | none |
| »»»» allocator_allocated | string | true | none | none |
| »»»» allocator_active | string | true | none | none |
| »»»» allocator_resident | string | true | none | none |
| »»»» total_system_memory | string | true | none | none |
| »»»» total_system_memory_human | string | true | none | none |
| »»»» used_memory_lua | string | true | none | none |
| »»»» used_memory_vm_eval | string | true | none | none |
| »»»» used_memory_lua_human | string | true | none | none |
| »»»» used_memory_scripts_eval | string | true | none | none |
| »»»» number_of_cached_scripts | string | true | none | none |
| »»»» number_of_functions | string | true | none | none |
| »»»» number_of_libraries | string | true | none | none |
| »»»» used_memory_vm_functions | string | true | none | none |
| »»»» used_memory_vm_total | string | true | none | none |
| »»»» used_memory_vm_total_human | string | true | none | none |
| »»»» used_memory_functions | string | true | none | none |
| »»»» used_memory_scripts | string | true | none | none |
| »»»» used_memory_scripts_human | string | true | none | none |
| »»»» maxmemory | string | true | none | none |
| »»»» maxmemory_human | string | true | none | none |
| »»»» maxmemory_policy | string | true | none | none |
| »»»» allocator_frag_ratio | string | true | none | none |
| »»»» allocator_frag_bytes | string | true | none | none |
| »»»» allocator_rss_ratio | string | true | none | none |
| »»»» allocator_rss_bytes | string | true | none | none |
| »»»» rss_overhead_ratio | string | true | none | none |
| »»»» rss_overhead_bytes | string | true | none | none |
| »»»» mem_fragmentation_ratio | string | true | none | none |
| »»»» mem_fragmentation_bytes | string | true | none | none |
| »»»» mem_not_counted_for_evict | string | true | none | none |
| »»»» mem_replication_backlog | string | true | none | none |
| »»»» mem_total_replication_buffers | string | true | none | none |
| »»»» mem_clients_slaves | string | true | none | none |
| »»»» mem_clients_normal | string | true | none | none |
| »»»» mem_cluster_links | string | true | none | none |
| »»»» mem_aof_buffer | string | true | none | none |
| »»»» mem_allocator | string | true | none | none |
| »»»» active_defrag_running | string | true | none | none |
| »»»» lazyfree_pending_objects | string | true | none | none |
| »»»» lazyfreed_objects | string | true | none | none |
| »»» persistence | object | true | none | none |
| »»»» loading | string | true | none | none |
| »»»» async_loading | string | true | none | none |
| »»»» current_cow_peak | string | true | none | none |
| »»»» current_cow_size | string | true | none | none |
| »»»» current_cow_size_age | string | true | none | none |
| »»»» current_fork_perc | string | true | none | none |
| »»»» current_save_keys_processed | string | true | none | none |
| »»»» current_save_keys_total | string | true | none | none |
| »»»» rdb_changes_since_last_save | string | true | none | none |
| »»»» rdb_bgsave_in_progress | string | true | none | none |
| »»»» rdb_last_save_time | string | true | none | none |
| »»»» rdb_last_bgsave_status | string | true | none | none |
| »»»» rdb_last_bgsave_time_sec | string | true | none | none |
| »»»» rdb_current_bgsave_time_sec | string | true | none | none |
| »»»» rdb_saves | string | true | none | none |
| »»»» rdb_last_cow_size | string | true | none | none |
| »»»» rdb_last_load_keys_expired | string | true | none | none |
| »»»» rdb_last_load_keys_loaded | string | true | none | none |
| »»»» aof_enabled | string | true | none | none |
| »»»» aof_rewrite_in_progress | string | true | none | none |
| »»»» aof_rewrite_scheduled | string | true | none | none |
| »»»» aof_last_rewrite_time_sec | string | true | none | none |
| »»»» aof_current_rewrite_time_sec | string | true | none | none |
| »»»» aof_last_bgrewrite_status | string | true | none | none |
| »»»» aof_rewrites | string | true | none | none |
| »»»» aof_rewrites_consecutive_failures | string | true | none | none |
| »»»» aof_last_write_status | string | true | none | none |
| »»»» aof_last_cow_size | string | true | none | none |
| »»»» module_fork_in_progress | string | true | none | none |
| »»»» module_fork_last_cow_size | string | true | none | none |
| »»»» aof_current_size | string | true | none | none |
| »»»» aof_base_size | string | true | none | none |
| »»»» aof_pending_rewrite | string | true | none | none |
| »»»» aof_buffer_length | string | true | none | none |
| »»»» aof_pending_bio_fsync | string | true | none | none |
| »»»» aof_delayed_fsync | string | true | none | none |
| »»» stats | object | true | none | none |
| »»»» total_connections_received | string | true | none | none |
| »»»» total_commands_processed | string | true | none | none |
| »»»» instantaneous_ops_per_sec | string | true | none | none |
| »»»» total_net_input_bytes | string | true | none | none |
| »»»» total_net_output_bytes | string | true | none | none |
| »»»» total_net_repl_input_bytes | string | true | none | none |
| »»»» total_net_repl_output_bytes | string | true | none | none |
| »»»» instantaneous_input_kbps | string | true | none | none |
| »»»» instantaneous_output_kbps | string | true | none | none |
| »»»» instantaneous_input_repl_kbps | string | true | none | none |
| »»»» instantaneous_output_repl_kbps | string | true | none | none |
| »»»» rejected_connections | string | true | none | none |
| »»»» sync_full | string | true | none | none |
| »»»» sync_partial_ok | string | true | none | none |
| »»»» sync_partial_err | string | true | none | none |
| »»»» expired_keys | string | true | none | none |
| »»»» expired_stale_perc | string | true | none | none |
| »»»» expired_time_cap_reached_count | string | true | none | none |
| »»»» expire_cycle_cpu_milliseconds | string | true | none | none |
| »»»» evicted_keys | string | true | none | none |
| »»»» evicted_clients | string | true | none | none |
| »»»» total_eviction_exceeded_time | string | true | none | none |
| »»»» current_eviction_exceeded_time | string | true | none | none |
| »»»» keyspace_hits | string | true | none | none |
| »»»» keyspace_misses | string | true | none | none |
| »»»» pubsub_channels | string | true | none | none |
| »»»» pubsub_patterns | string | true | none | none |
| »»»» pubsubshard_channels | string | true | none | none |
| »»»» latest_fork_usec | string | true | none | none |
| »»»» total_forks | string | true | none | none |
| »»»» migrate_cached_sockets | string | true | none | none |
| »»»» slave_expires_tracked_keys | string | true | none | none |
| »»»» active_defrag_hits | string | true | none | none |
| »»»» active_defrag_misses | string | true | none | none |
| »»»» active_defrag_key_hits | string | true | none | none |
| »»»» active_defrag_key_misses | string | true | none | none |
| »»»» total_active_defrag_time | string | true | none | none |
| »»»» current_active_defrag_time | string | true | none | none |
| »»»» tracking_total_keys | string | true | none | none |
| »»»» tracking_total_items | string | true | none | none |
| »»»» tracking_total_prefixes | string | true | none | none |
| »»»» unexpected_error_replies | string | true | none | none |
| »»»» total_error_replies | string | true | none | none |
| »»»» dump_payload_sanitizations | string | true | none | none |
| »»»» total_reads_processed | string | true | none | none |
| »»»» total_writes_processed | string | true | none | none |
| »»»» io_threaded_reads_processed | string | true | none | none |
| »»»» io_threaded_writes_processed | string | true | none | none |
| »»»» reply_buffer_shrinks | string | true | none | none |
| »»»» reply_buffer_expands | string | true | none | none |
| »»» replication | object | true | none | none |
| »»»» role | string | true | none | none |
| »»»» connected_slaves | string | true | none | none |
| »»»» master_failover_state | string | true | none | none |
| »»»» master_replid | string | true | none | none |
| »»»» master_replid2 | string | true | none | none |
| »»»» master_repl_offset | string | true | none | none |
| »»»» second_repl_offset | string | true | none | none |
| »»»» repl_backlog_active | string | true | none | none |
| »»»» repl_backlog_size | string | true | none | none |
| »»»» repl_backlog_first_byte_offset | string | true | none | none |
| »»»» repl_backlog_histlen | string | true | none | none |
| »»» cpu | object | true | none | none |
| »»»» used_cpu_sys | string | true | none | none |
| »»»» used_cpu_user | string | true | none | none |
| »»»» used_cpu_sys_children | string | true | none | none |
| »»»» used_cpu_user_children | string | true | none | none |
| »»»» used_cpu_sys_main_thread | string | true | none | none |
| »»»» used_cpu_user_main_thread | string | true | none | none |
| »»» modules | object | true | none | none |
| »»» errorstats | object | true | none | none |
| »»» cluster | object | true | none | none |
| »»»» cluster_enabled | string | true | none | none |
| »»» keyspace | object | true | none | none |
| »»»» db0 | string | true | none | none |
| »»»» db1 | string | true | none | none |
| »» dbSize | integer | true | none | none |
| »» commandStats | [object] | true | none | none |
| »»» name | string | true | none | none |
| »»» value | string | true | none | none |
## GET aquire cache name list
GET /monitor/cache/getNames
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> Success
```json
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» cacheName | string | true | none | none |
| »» cacheKey | string | true | none | none |
| »» cacheValue | string | true | none | none |
| »» remark | string | true | none | none |
## GET key name list by cache name
GET /monitor/cache/getKeys/{cacheName}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| cacheName | path | string | yes | Cache Name |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Success",
"data": [
{
"cacheName": "sys_config",
"cacheKey": "sys.user.initPassword",
"cacheValue": "",
"remark": ""
},
{
"cacheName": "sys_config",
"cacheKey": "sys.account.captchaEnabled",
"cacheValue": "",
"remark": ""
},
{
"cacheName": "sys_config",
"cacheKey": "sys.account.registerUser",
"cacheValue": "",
"remark": ""
},
{
"cacheName": "sys_config",
"cacheKey": "sys.account.captchaType",
"cacheValue": "",
"remark": ""
}
]
}
```
```json
{
"code": 403,
"msg": "Unauthorized access GET /monitor/cache/getKeys/epsgajtqg"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» cacheName | string | true | none | none |
| »» cacheKey | string | true | none | none |
| »» cacheValue | string | true | none | none |
| »» remark | string | true | none | none |
## GET aquire cache value by name or key
GET /monitor/cache/getValue/{cacheName}/{cacheKey}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------------------------- |
| cacheName | path | string | yes | Cache name obtained from key name list |
| cacheKey | path | string | yes | Cache key names obtained from the key name list |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": {
"cacheName": "sys_config",
"cacheKey": "sys.account.captchaType",
"cacheValue": "math",
"remark": ""
}
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» cacheName | string | true | none | none |
| »» cacheKey | string | true | none | none |
| »» cacheValue | string | true | none | none |
| »» remark | string | true | none | |
## DELETE delete cache key name
DELETE /monitor/cache/clearCacheKey/{cacheName}/{cacheKey}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------------------------- |
| cacheName | path | string | yes | Cache name obtained from key name list |
| cacheKey | path | string | yes | Cache key names obtained from the key name list |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 403,
"msg": "Unauthorized access DELETE /monitor/cache/clearCacheKey/mjhq/f22367b5-1547-4372-9a0f-2381a75a2148"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete cache name
DELETE /monitor/cache/clearCacheName/{cacheName}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------ |
| cacheName | path | string | yes | The cache name obtained from the cache name list |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE clear cache name safety
DELETE /monitor/cache/clearCacheSafe
Specify cache key names that can be cleared
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Scheduling task log information
## POST export scheduling task log
POST /monitor/jobLog/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx
content-length: 17079
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"jobName": "string",
"jobGroup": "string",
"status": "string",
"pageNum": 0,
"pageSize": 0,
"beginTime": "string",
"endTime": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » jobName | body | string | no | none |
| » jobGroup | body | string | no | none |
| » status | body | string | no | none |
| » pageNum | body | number | no | none |
| » pageSize | body | number | no | none |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
> Response Examples
> OK
```json
{
"code": 0,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET aquire scheduling task log list
GET /monitor/jobLog/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| jobName | query | string | no | job name |
| jobGroup | query | string | no | job group name |
| status | query | string | no | status |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"jobLogId": "246",
"jobName": "Delete Expired NE State Record",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":1,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":1223,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714407900038,
"costTime": 38
},
{
"jobLogId": "245",
"jobName": "Delete expired NE etc backup file",
"jobGroup": "SYSTEM",
"invokeTarget": "delExpiredNeBackup",
"targetParams": "{\"duration\":60}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714407600001,
"costTime": 1
},
{
"jobLogId": "244",
"jobName": "Delete expired KPI records",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":30,\"tableName\":\"gold_kpi\",\"colName\":\"date\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714407301671,
"costTime": 1671
},
{
"jobLogId": "243",
"jobName": "Delete expired historical alarm",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":90,\"tableName\":\"alarm\",\"colName\":\"event_time\",\"extras\":\"alarm_status='0'\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":26,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714407000095,
"costTime": 95
},
{
"jobLogId": "242",
"jobName": "Delete Expired NE State Record",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":1,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}",
"jobMsg": "{\"crom\":false,\"message\":{\"affected\":30093,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714383034113,
"costTime": 27321
},
{
"jobLogId": "241",
"jobName": "Delete Expired NE State Record",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":7,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714321501402,
"costTime": 1402
},
{
"jobLogId": "240",
"jobName": "Delete expired NE etc backup file",
"jobGroup": "SYSTEM",
"invokeTarget": "delExpiredNeBackup",
"targetParams": "{\"duration\":60}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714321200002,
"costTime": 2
},
{
"jobLogId": "239",
"jobName": "Delete expired KPI records",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":30,\"tableName\":\"gold_kpi\",\"colName\":\"date\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714320901523,
"costTime": 1523
},
{
"jobLogId": "238",
"jobName": "Delete expired historical alarm",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":90,\"tableName\":\"alarm\",\"colName\":\"event_time\",\"extras\":\"alarm_status='0'\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":384,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714320600186,
"costTime": 185
},
{
"jobLogId": "237",
"jobName": "Delete Expired NE State Record",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":7,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}",
"jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}",
"status": "1",
"createTime": 1714235100585,
"costTime": 585
}
],
"total": 246
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » rows | [object] | true | none | none |
| »» jobLogId | string | true | none | none |
| »» jobName | string | true | none | none |
| »» jobGroup | string | true | none | none |
| »» invokeTarget | string | true | none | none |
| »» targetParams | string | true | none | none |
| »» jobMsg | string | true | none | none |
| »» status | string | true | none | none |
| »» createTime | integer | true | none | none |
| »» costTime | integer | true | none | none |
| » total | integer | true | none | none |
## GET aquire scheduling task log
GET /monitor/jobLog/{jobLogId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| jobLogId | path | string | yes | log ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"jobLogId": "44",
"jobName": "job.genNeStateAlarm",
"jobGroup": "SYSTEM",
"invokeTarget": "genNeStateAlarm",
"targetParams": "{\"alarmID\":\"HXEMSSM10000\",\"alarmCode\":10000,\"alarmTitle\":\"The system state is abnormal\",\"neType\":\"OMC\",\"alarmType\":\"EquipmentAlarm\",\"origSeverity\": \"Major\",\"objectName\":\"EMS;SystemManagement;Heartbeat\",\"objectType\":\"SystemState\",\"specificProblem\":\"Alarm cause: the system state of target NE has not been received for {threshold} seconds\", \"specificProblemID\":\"AC10000\",\"threshold\":30}",
"jobMsg": "{\"crom\":true,\"message\":null,\"name\":\"completed\"}",
"status": "1",
"createTime": 1704450000000,
"costTime": 0
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» jobLogId | string | true | none | none |
| »» jobName | string | true | none | none |
| »» jobGroup | string | true | none | none |
| »» invokeTarget | string | true | none | none |
| »» targetParams | string | true | none | none |
| »» jobMsg | string | true | none | none |
| »» status | string | true | none | none |
| »» createTime | string | true | none | none |
## DELETE delete scheduling task log
DELETE /monitor/jobLog/{jobLogIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------------------------------- |
| jobLogIds | path | string | yes | Log ID, multiple can be separated by English commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Deleted successfully: 1"
}
```
```json
{
"code": 0,
"msg": "error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE clear scheduling task log
DELETE /monitor/jobLog/clean
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Scheduling task information
## POST export scheduling task list
POST /monitor/job/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=job_export_6_1684058991890.xlsx
content-length: 19346
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"jobName": "string",
"jobGroup": "string",
"status": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » jobName | body | string | no | none |
| » jobGroup | body | string | no | none |
| » status | body | string | no | none |
| » pageNum | body | number | no | none |
| » pageSize | body | number | no | none |
> Response Examples
> OK
```json
{
"code": 500,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET aquire scheduling task list
GET /monitor/job/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| jobName | query | string | no | job name |
| jobGroup | query | string | no | job group name |
| status | query | string | no | status |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"jobId": "1",
"jobName": "Monitor-System Resources",
"jobGroup": "SYSTEM",
"invokeTarget": "monitor_sys_resource",
"targetParams": "{\"interval\":5}",
"cronExpression": "0 0/5 * * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "0",
"createBy": "supervisor",
"createTime": 1698478134839,
"updateBy": "",
"updateTime": 0,
"remark": "System Resource CPU/IO/Netword Collection\r\ninterval unit minutes, average minute resource situation\r\nNote: Please pass the value of the parameter interva according to the time unit minutes of the cron expression"
},
{
"jobId": "4",
"jobName": "Delete expired NE etc backup file",
"jobGroup": "SYSTEM",
"invokeTarget": "delExpiredNeBackup",
"targetParams": "{\"duration\":60}",
"cronExpression": "0 20 0 * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "1",
"createBy": "supervisor",
"createTime": 1698478134840,
"updateBy": "",
"updateTime": 0,
"remark": "Delete expired network element etc backup file, pass in the parameter to keep the backup file for {duration} days, default is 60 days."
},
{
"jobId": "5",
"jobName": "Delete expired historical alarm",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":90,\"tableName\":\"alarm\",\"colName\":\"event_time\",\"extras\":\"alarm_status='0'\"}",
"cronExpression": "0 10 0 * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "1",
"createBy": "supervisor",
"createTime": 1698478134841,
"updateBy": "",
"updateTime": 0,
"remark": "Delete expired history alarm records, pass in the parameter to keep the history alarm records for {duration} days."
},
{
"jobId": "6",
"jobName": "Delete expired KPI records",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":30,\"tableName\":\"gold_kpi\",\"colName\":\"date\"}",
"cronExpression": "0 15 0 * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "1",
"createBy": "supervisor",
"createTime": 1698478134842,
"updateBy": "",
"updateTime": 0,
"remark": "KPI record retention for {duration} days"
},
{
"jobId": "7",
"jobName": "Network Element Configuration Auto Backup Task",
"jobGroup": "SYSTEM",
"invokeTarget": "backupEtcFromNE",
"targetParams": "",
"cronExpression": "0 30 0 * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "1",
"createBy": "supervisor",
"createTime": 1698478134843,
"updateBy": "",
"updateTime": 0,
"remark": "Automatically backs up the configuration files in the network element's etc directory."
},
{
"jobId": "8",
"jobName": "Delete Expired NE State Record",
"jobGroup": "SYSTEM",
"invokeTarget": "deleteExpiredRecord",
"targetParams": "{\"duration\":7,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}",
"cronExpression": "0 25 0 * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "1",
"createBy": "supervisor",
"createTime": 1698478134842,
"updateBy": "",
"updateTime": 0,
"remark": "Delete expired NE state records regularly and keep them for {duration} days by default."
},
{
"jobId": "9",
"jobName": "Get state from NEs",
"jobGroup": "SYSTEM",
"invokeTarget": "getStateFromNE",
"targetParams": "",
"cronExpression": "0/10 * * * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "0",
"createBy": "supervisor",
"createTime": 1698478134842,
"updateBy": "",
"updateTime": 0,
"remark": "Get state information from all NEs"
},
{
"jobId": "10",
"jobName": "Network Element Health Check",
"jobGroup": "SYSTEM",
"invokeTarget": "genNeStateAlarm",
"targetParams": "{\"alarmID\":\"HXEMSSM10000\",\"alarmCode\":10000,\"alarmTitle\":\"The system state is abnormal\",\"neType\":\"OMC\",\"alarmType\":\"EquipmentAlarm\",\"origSeverity\": \"Major\",\"objectName\":\"EMS;SystemManagement;Heartbeat\",\"objectType\":\"SystemState\",\"specificProblem\":\"Alarm cause: the system state of target NE has not been received for {threshold} seconds\", \"specificProblemID\":\"AC10000\",\"threshold\":30}",
"cronExpression": "0/5 * * * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "0",
"createBy": "supervisor",
"createTime": 1698478134842,
"updateBy": "",
"updateTime": 0,
"remark": "Health status inspection of network elements, generating alarms in case of abnormalities."
}
],
"total": 8
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» jobId | string | true | none | none |
| »» jobName | string | true | none | none |
| »» jobGroup | string | true | none | none |
| »» invokeTarget | string | true | none | none |
| »» targetParams | string | true | none | none |
| »» cronExpression | string | true | none | none |
| »» misfirePolicy | string | true | none | none |
| »» concurrent | string | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## GET aquire scheduling task by ID
GET /monitor/job/{jobId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| jobId | path | string | yes | task ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"jobId": "1",
"jobName": "Monitor-System Resources",
"jobGroup": "SYSTEM",
"invokeTarget": "monitor_sys_resource",
"targetParams": "{\"interval\":5}",
"cronExpression": "0 0/5 * * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"status": "1",
"saveLog": "0",
"createBy": "supervisor",
"createTime": 1698478134839,
"updateBy": "",
"updateTime": 0,
"remark": "System Resource CPU/IO/Netword Collection\r\ninterval unit minutes, average minute resource situation\r\nNote: Please pass the value of the parameter interva according to the time unit minutes of the cron expression"
},
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object¦null | true | none | none |
| »» jobId | string | true | none | none |
| »» jobName | string | true | none | none |
| »» jobGroup | string | true | none | none |
| »» invokeTarget | string | true | none | none |
| »» targetParams | string | true | none | none |
| »» cronExpression | string | true | none | none |
| »» misfirePolicy | string | true | none | none |
| »» concurrent | string | true | none | none |
| »» status | string | true | none | none |
| »» createBy | string | true | none | none |
| »» createTime | string | true | none | none |
| »» remark | string | true | none | none |
## POST add scheduling task
POST /monitor/job
> Body Parameters
```json
{
"jobName": "task1",
"invokeTarget": "test1",
"cronExpression": "0/22 * * * * ?",
"misfirePolicy": "3",
"concurrent": "0",
"jobGroup": "DEFAULT",
"status": "ullamco minim Ut",
"targetParams": "{\"a\":1,\"b\":1}",
"remark": "asdf"
}
```
### Params
| Name | Location | Type | Required | Description |
| ----------------- | -------- | ------ | -------- | ----------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » jobName | body | string | yes | Scheduling task name |
| » jobGroup | body | string | yes | Group name |
| » invokeTarget | body | string | yes | Invoke target, callback function |
| » targetParams | body | string | yes | Standard JSON format string |
| » cronExpression | body | string | yes | Cron expression, last '?' char not used |
| » misfirePolicy | body | string | yes | 1. Execute immediately 2. Execute once 3. Abandon execution |
| » concurrent | body | string | yes | 0 prohibited 1 allowed |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "Scheduled task [Monitor-System Resources] failed with incorrect Cron expression!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify scheduling task
PUT /monitor/job
> Body Parameters
```json
{
"jobName": "",
"invokeTarget": "test",
"cronExpression": "0/40 * * * * ?",
"misfirePolicy": "3",
"concurrent": "1",
"jobGroup": "SYSTEM",
"status": "0",
"targetParams": "{\"a\":1,\"b\":1}",
"remark": "。",
"jobId": "2"
}
```
### Params
| Name | Location | Type | Required | Description |
| ----------------- | -------- | ------ | -------- | ----------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » jobId | body | string | yes | Scheduling task ID |
| » jobName | body | string | yes | Scheduling task name |
| » jobGroup | body | string | yes | Group name |
| » invokeTarget | body | string | yes | Invoke target, callback function |
| » targetParams | body | string | yes | Standard JSON format string |
| » cronExpression | body | string | yes | Cron expression, last '?' char not used |
| » misfirePolicy | body | string | yes | 1. Execute immediately 2. Execute once 3. Abandon execution |
| » concurrent | body | string | yes | 0 prohibited 1 allowed |
| » status | body | string | yes | 0 Inactive 1 Active |
| » remark | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "Scheduled task [Monitor-System Resources] failed with incorrect Cron expression!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete scheduling task
DELETE /monitor/job/{jobIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------------------------------- |
| jobIds | path | string | yes | Task ID, multiple can be separated by English commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "there is no accessible scheduling task data"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT modify scheduling task status
PUT /monitor/job/changeStatus
> Body Parameters
```json
{
"jobId": "22",
"status": "0"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » jobId | body | string | yes | none |
| » status | body | string | yes | 0 Inactive 1 Active |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible scheduling task data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT schedule task to be executed immediately once
PUT /monitor/job/run/{jobId}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| jobId | path | string | yes | Task ID |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "There is no accessible scheduling task data!"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT reset schedule tasks queue
PUT /monitor/job/resetQueueJob
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Operation log information
## GET aquire operation log list
GET /system/log/operate/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------- |
| title | query | string | no | operation module name |
| operName | query | string | no | operator name |
| businessType | query | string | no | operation type |
| status | query | string | no | status |
| beginTime | query | string | no | begin time |
| endTime | query | string | no | end time |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"operId": "4274",
"title": "Operation Logging",
"businessType": "5",
"method": "controller.(*SysLogOperateController).Export-fm",
"requestMethod": "POST",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/system/log/operate/export",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"beginTime\":\"\",\"endTime\":\"\",\"operName\":\"\",\"pageNum\":1,\"pageSize\":20,\"title\":\"\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"8912\",\"content-type\":\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheetattachment; filename=\"sys_log_operate_export_20_1712650224134.xlsx\"\"}",
"status": "1",
"operTime": 1712650224177,
"costTime": 47
},
{
"operId": "4273",
"title": "Operation Logging",
"businessType": "5",
"method": "controller.(*SysLogOperateController).Export-fm",
"requestMethod": "POST",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/system/log/operate/export",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"beginTime\":\"\",\"endTime\":\"\",\"operName\":\"\",\"pageNum\":1,\"pageSize\":20,\"title\":\"\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"8798\",\"content-type\":\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheetattachment; filename=\"sys_log_operate_export_20_1712650216901.xlsx\"\"}",
"status": "1",
"operTime": 1712650216926,
"costTime": 38
},
{
"operId": "4272",
"title": "WS Sessions",
"businessType": "0",
"method": "controller.(*WSController).WS-fm",
"requestMethod": "GET",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/ws",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2NDI3ODk4NjksImV4cCI6MTcxMjY0OTk4OTg2OSwibG9naW5fa2V5IjoiMHFpd2kxcDJiaWR4Njc3MSIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.l-yIhxzVj1DGTGWr5AwcLE0guh8pIRqG7Pu4SfHshJmV3Lx3hCtwp_KTsV14wKgpO8phscD2FNObFvE4Y0sDxA\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}",
"status": "1",
"operTime": 1712649765251,
"costTime": 35009
},
{
"operId": "4271",
"title": "WS Sessions",
"businessType": "0",
"method": "controller.(*WSController).WS-fm",
"requestMethod": "GET",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/ws",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}",
"status": "1",
"operTime": 1712629470304,
"costTime": 1801
},
{
"operId": "4270",
"title": "WS Sessions",
"businessType": "0",
"method": "controller.(*WSController).WS-fm",
"requestMethod": "GET",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/ws",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}",
"status": "1",
"operTime": 1712629466870,
"costTime": 3371
},
{
"operId": "4269",
"title": "WS Sessions",
"businessType": "0",
"method": "controller.(*WSController).WS-fm",
"requestMethod": "GET",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/ws",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}",
"status": "1",
"operTime": 1712629453525,
"costTime": 9957
},
{
"operId": "4268",
"title": "WS Sessions",
"businessType": "0",
"method": "controller.(*WSController).WS-fm",
"requestMethod": "GET",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/ws",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}",
"status": "1",
"operTime": 1712629439209,
"costTime": 551
},
{
"operId": "4267",
"title": "WS Sessions",
"businessType": "0",
"method": "controller.(*WSController).WS-fm",
"requestMethod": "GET",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/ws",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}",
"operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}",
"status": "1",
"operTime": 1712629148548,
"costTime": 3581
},
{
"operId": "4266",
"title": "Scheduling Tasks",
"businessType": "8",
"method": "controller.(*SysJobController).ResetQueueJob-fm",
"requestMethod": "PUT",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/monitor/job/resetQueueJob",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{}",
"operMsg": "{\"status\":\"200\",\"size\":\"26\",\"content-type\":\"application/json; charset=utf-8\"}",
"status": "1",
"operTime": 1712628578539,
"costTime": 1
},
{
"operId": "4265",
"title": "Scheduling Tasks",
"businessType": "2",
"method": "controller.(*SysJobController).Run-fm",
"requestMethod": "PUT",
"operatorType": "1",
"operName": "admin",
"deptName": "",
"operUrl": "/monitor/job/run/8",
"operIp": "192.168.2.219",
"operLocation": "Intranet",
"operParam": "{}",
"operMsg": "{\"status\":\"200\",\"size\":\"26\",\"content-type\":\"application/json; charset=utf-8\"}",
"status": "1",
"operTime": 1712628417006,
"costTime": 0
}
],
"total": 4274
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------ | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» operId | string | true | none | none |
| »» title | string | true | none | none |
| »» businessType | string | true | none | none |
| »» method | string | true | none | none |
| »» requestMethod | string | true | none | none |
| »» operatorType | string | true | none | none |
| »» operName | string | true | none | none |
| »» deptName | string | true | none | none |
| »» operUrl | string | true | none | none |
| »» operIp | string | true | none | none |
| »» operLocation | string | true | none | none |
| »» operParam | string | true | none | none |
| »» operMsg | string | true | none | none |
| »» status | string | true | none | none |
| »» operTime | string | true | none | none |
| »» costTime | string | true | none | none |
## POST export operation log list
POST /system/log/operate/export
，
```text
content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx
content-length: 36500
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"title": "string",
"operName": "string",
"businessType": "string",
"status": "string",
"beginTime": "string",
"endTime": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » title | body | string | no | none |
| » operName | body | string | no | none |
| » businessType | body | string | no | none |
| » status | body | string | no | none |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> OK
```json
{
"code": 500,
"msg": ""
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE clean operation log
DELETE /system/log/operate/clean
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete operation log
DELETE /system/log/operate/{operIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------------- |
| operIds | path | string | yes | Operation log ID, multiple can be separated by English commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Deleted successfully: 1"
}
```
```json
{
"code": 0,
"msg": "error"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Security log information
## GET login access list
GET /system/log/login/list
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------ |
| ipaddr | query | string | no | login ip address |
| userName | query | string | no | login name |
| status | query | string | no | login status: 0 failed 1 successful |
| beginTime | query | string | no | begin time |
| endTime | query | string | no | end time |
| pageNum | query | number | no | Page number，default 1 |
| pageSize | query | number | no | Size of one page，default 10 |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"rows": [
{
"loginId": "1228",
"userName": "supervisor",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712654593452
},
{
"loginId": "1227",
"userName": "supervisor",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"status": "1",
"msg": "Logout Successful",
"loginTime": 1712654578672
},
{
"loginId": "1226",
"userName": "supervisor",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712654055458
},
{
"loginId": "1225",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"status": "1",
"msg": "Logout Successful",
"loginTime": 1712654052696
},
{
"loginId": "1224",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Chrome 86.0.4240.198",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712650911235
},
{
"loginId": "1223",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712642789872
},
{
"loginId": "1222",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Edge 123.0.0.0",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712627115231
},
{
"loginId": "1221",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Chrome 86.0.4240.198",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712627080393
},
{
"loginId": "1220",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Chrome 86.0.4240.198",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712568712553
},
{
"loginId": "1219",
"userName": "admin",
"ipaddr": "192.168.2.219",
"loginLocation": "Intranet",
"browser": "Chrome 86.0.4240.198",
"os": "Windows 10",
"status": "1",
"msg": "Login Success",
"loginTime": 1712562773610
}
],
"total": 1228
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------------------ | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » total | integer | true | none | none |
| » rows | [object] | true | none | none |
| »» infoId | string | true | none | none |
| »» userName | string | true | none | none |
| »» ipaddr | string | true | none | none |
| »» loginLocation | string | true | none | none |
| »» browser | string | true | none | none |
| »» os | string | true | none | none |
| »» status | string | true | none | 0 1Success |
| »» msg | string | true | none | none |
| »» loginTime | string | true | none | none |
## POST export login access list
POST /system/log/login/export
The file stream is returned normally, and the response header is as follows
```text
content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx
content-length: 24305
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
```
> Body Parameters
```json
{
"ipaddr": "string",
"userName": "string",
"status": "string",
"beginTime": "string",
"endTime": "string",
"pageNum": 0,
"pageSize": 0
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » ipaddr | body | string | no | none |
| » userName | body | string | no | none |
| » status | body | string | no | 0 failed 1 successful |
| » beginTime | body | string | no | none |
| » endTime | body | string | no | none |
| » pageNum | body | number | yes | none |
| » pageSize | body | number | yes | none |
> Response Examples
> OK
```json
{
"code": 500,
"msg": "Export data record is empty"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE clean login access list
DELETE /system/log/login/clean
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## PUT unlock login user
PUT /system/log/login/unlock/{userName}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| userName | path | string | yes | login name |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "The user is not locked"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## DELETE delete login user
DELETE /system/log/login/{infoIds}
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | --------------------------------------------------- |
| infoIds | path | string | yes | log ID, multiple can be separated by English commas |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 500,
"msg": ""
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# System/Server monitoring information
## GET server service information
GET /monitor/system-info
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"cpu": {
"core": 20,
"coreUsed": [
"3.47",
"1.48",
"3.97",
"1.62",
"4.06",
"2.07",
"54.30",
"1.85",
"6.01",
"0.02",
"6.06",
"0.02",
"8.89",
"22.90",
"21.61",
"23.85",
"3.98",
"3.40",
"2.77",
"3.22"
],
"model": "13th Gen Intel(R) Core(TM) i7-1370P",
"speed": "1900MHz"
},
"disk": [
{
"avail": "228.95GB",
"pcent": "49.1%",
"size": "449.81GB",
"target": "C:",
"used": "220.86GB"
},
{
"avail": "449.88GB",
"pcent": "10.2%",
"size": "501.01GB",
"target": "D:",
"used": "51.13GB"
},
{
"avail": "2.99GB",
"pcent": "89.5%",
"size": "28.37GB",
"target": "T:",
"used": "25.38GB"
},
{
"avail": "2.99GB",
"pcent": "89.5%",
"size": "28.37GB",
"target": "U:",
"used": "25.38GB"
},
{
"avail": "2.99GB",
"pcent": "89.5%",
"size": "28.37GB",
"target": "V:",
"used": "25.38GB"
},
{
"avail": "3.63GB",
"pcent": "84.2%",
"size": "22.94GB",
"target": "W:",
"used": "19.31GB"
},
{
"avail": "25.12GB",
"pcent": "56.5%",
"size": "57.79GB",
"target": "X:",
"used": "32.68GB"
},
{
"avail": "14.61GB",
"pcent": "50.3%",
"size": "29.36GB",
"target": "Y:",
"used": "14.75GB"
},
{
"avail": "4.40GB",
"pcent": "84.2%",
"size": "27.86GB",
"target": "Z:",
"used": "23.46GB"
}
],
"memory": {
"external": "16.66MB",
"freemem": "5.25GB",
"heapTotal": "105.09MB",
"heapUsed": "32.09MB",
"rss": "121.76MB",
"totalmem": "31.69GB",
"usage": "83.00"
},
"network": {
"Bluetooth network connection": "IPv6 fe80::8f77:9546:473a:6147 / IPv4 169.254.232.174",
"Ethernet": "IPv6 fd01:9495:228f::411 / IPv6 fd0e:192:168:4::119 / IPv6 fe80::f6bb:7d5f:bcb2:763b / IPv4 192.168.2.219",
"Loopback Pseudo-Interface 1": "IPv6 ::1 / IPv4 127.0.0.1",
"WLAN": "IPv6 fe80::cb34:45d6:7f13:a4a4 / IPv4 192.168.30.59",
"vEthernet (WSL)": "IPv6 fe80::f3c2:72b3:9809:26dc / IPv4 172.20.144.1",
"Local connection* 1": "IPv6 fe80::aef3:2c79:784e:8b21 / IPv4 169.254.40.119",
"Local connection* 2": "IPv6 fe80::8a02:620c:ecf7:5622 / IPv4 169.254.114.138"
},
"system": {
"arch": "x86_64",
"archVersion": "10.0.22631.3374 Build 22631.3374",
"bootTime": 1052280,
"hostname": "simonzhangsz",
"os": "windows",
"platform": "Microsoft Windows 11 Home China",
"platformVersion": "10.0.22631.3374 Build 22631.3374",
"processId": 46412,
"runArch": "amd64",
"runTime": 206594,
"runVersion": "go1.21.0"
},
"time": {
"current": "2024-04-09 19:55:24",
"timezone": "+0800 CST",
"timezoneName": "CST"
}
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------------------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» project | object | true | none | none |
| »»» appDir | string | true | none | none |
| »»» env | string | true | none | none |
| »»» name | string | true | none | none |
| »»» version | string | true | none | none |
| »»» dependencies | object | false | none | none |
| »»»» xlsx | string | true | none | none |
| »» cpu | object | true | none | none |
| »»» model | string | true | none | none |
| »»» speed | string | true | none | none |
| »»» core | integer | true | none | none |
| »»» coreUsed | [string] | true | none | none |
| »» memory | object | true | none | none |
| »»» usage | string | true | none | none |
| »»» freemem | string | true | none | none |
| »»» totalmem | string | true | none | none |
| »»» rss | string | true | none | none |
| »»» heapTotal | string | true | none | none |
| »»» heapUsed | string | true | none | none |
| »»» external | string | true | none | none |
| »» network | object | false | none | none |
| »»» Ethernet 2 | string | false | none | none |
| »»» Ethernet | string | false | none | none |
| »»» VirtualBox Host-Only Network | string | false | none | none |
| »»» Loopback Pseudo-Interface 1 | string | false | none | none |
| »» time | object | true | none | none |
| »»» current | string | true | none | none |
| »»» uptime | string | true | none | none |
| »»» timezone | string | true | none | none |
| »»» timezoneName | string | true | none | none |
| »» system | object | true | none | none |
| »»» platform | string | true | none | none |
| »»» node | string | true | none | none |
| »»» v8 | string | true | none | none |
| »»» processId | integer | true | none | none |
| »»» arch | string | true | none | none |
| »»» uname | string | true | none | none |
| »»» release | string | true | none | none |
| »»» hostname | string | true | none | none |
| »»» homeDir | string | true | none | none |
| »»» cmd | string | true | none | none |
| »»» execCommand | string | true | none | none |
| »» disk | [object] | true | none | none |
| »»» size | string | true | none | none |
| »»» used | string | true | none | none |
| »»» avail | string | true | none | none |
| »»» pcent | string | true | none | none |
| »»» target | string | true | none | none |
## GET load resource monitoring information
GET /monitor/load
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------- |
| type | query | string | yes | type: all/cpu/memory/io/network |
| startTime | query | number | yes | start time - (milliseconds) |
| endTime | query | number | yes | end time - (milliseconds) |
| neType | query | string | no | ne type |
| neId | query | string | no | ne ID |
| name | query | string | no | names, valid for network and io |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": {
"project": {
"appDir": "E:\\Self\\Projects\\mask_api_midwayjs",
"env": "local",
"name": "mask_api_midwayjs",
"version": "0.0.5",
"dependencies": {
"@dropb/diskinfo": "^3.0.0",
"@midwayjs/bootstrap": "^3.0.0",
"@midwayjs/bull": "^3.0.0",
"@midwayjs/core": "^3.0.0",
"@midwayjs/decorator": "^3.0.0",
"@midwayjs/jwt": "^3.0.0",
"@midwayjs/koa": "^3.0.0",
"@midwayjs/cross-domain": "^3.0.0",
"@midwayjs/logger": "^2.0.0",
"@midwayjs/redis": "^3.0.0",
"@midwayjs/static-file": "^3.0.0",
"@midwayjs/typeorm": "^3.0.0",
"@midwayjs/upload": "^3.0.0",
"cron-parser": "^4.0.0",
"bcrypt": "^5.0.0",
"dayjs": "^1.0.0",
"mini-svg-data-uri": "^1.4.0",
"mysql2": "^2.0.0",
"nanoid": "^3.0.0",
"svg-captcha": "^1.4.0",
"typeorm": "^0.3.0",
"ua-parser-js": "^1.0.0",
"xlsx": "^0.18.0"
}
},
"cpu": {
"model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz",
"speed": "2904MHz",
"core": 6,
"coreUsed": [
"12.94",
"16.88",
"14.15",
"14.48",
"13.20",
"15.08"
]
},
"memory": {
"usage": "71.57",
"freemem": "4.51GB",
"totalmem": "15.88GB",
"rss": "309.80MB",
"heapTotal": "252.49MB",
"heapUsed": "246.27MB",
"external": "6.54MB"
},
"network": {
"Ethernet": "IPv4 192.168.1.54 / IPv6 fe80::9906:92e5:b85e:3943",
"VirtualBox Host-Only Network": "IPv4 192.168.56.1 / IPv6 fe80::74da:97e8:b5e8:2c78",
"Loopback Pseudo-Interface 1": "IPv4 127.0.0.1 / IPv6 ::1"
},
"time": {
"current": "2023-02-01 17:20:07",
"uptime": "8h",
"timezone": "GMT+0800",
"timezoneName": "China Standard Time"
},
"system": {
"platform": "win32",
"node": "18.11.0",
"v8": "10.2.154.15-node.12",
"processId": 19988,
"arch": "x64",
"uname": "Windows_NT",
"release": "10.0.19045",
"hostname": "DESKTOP-QFRQUSF",
"homeDir": "C:\\Users\\LC1234",
"cmd": "E:\\Self\\Projects\\mask_api_midwayjs",
"execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register"
},
"disk": [
{
"size": "100.00GB",
"used": "91.22GB",
"avail": "8.78GB",
"pcent": "92%",
"target": "C:"
},
{
"size": "174.00GB",
"used": "114.02GB",
"avail": "59.98GB",
"pcent": "66%",
"target": "D:"
},
{
"size": "173.12GB",
"used": "138.62GB",
"avail": "34.50GB",
"pcent": "81%",
"target": "E:"
}
]
}
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------------------------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» project | object | true | none | none |
| »»» appDir | string | true | none | none |
| »»» env | string | true | none | none |
| »»» name | string | true | none | none |
| »»» version | string | true | none | none |
| »»» dependencies | object | false | none | none |
| »»»» xlsx | string | true | none | none |
| »» cpu | object | true | none | none |
| »»» model | string | true | none | none |
| »»» speed | string | true | none | none |
| »»» core | integer | true | none | none |
| »»» coreUsed | [string] | true | none | none |
| »» memory | object | true | none | none |
| »»» usage | string | true | none | none |
| »»» freemem | string | true | none | none |
| »»» totalmem | string | true | none | none |
| »»» rss | string | true | none | none |
| »»» heapTotal | string | true | none | none |
| »»» heapUsed | string | true | none | none |
| »»» external | string | true | none | none |
| »» network | object | false | none | none |
| »»» Ethernet 2 | string | false | none | none |
| »»» Ethernet | string | false | none | none |
| »»» VirtualBox Host-Only Network | string | false | none | none |
| »»» Loopback Pseudo-Interface 1 | string | false | none | none |
| »» time | object | true | none | none |
| »»» current | string | true | none | none |
| »»» uptime | string | true | none | none |
| »»» timezone | string | true | none | none |
| »»» timezoneName | string | true | none | none |
| »» system | object | true | none | none |
| »»» platform | string | true | none | none |
| »»» node | string | true | none | none |
| »»» v8 | string | true | none | none |
| »»» processId | integer | true | none | none |
| »»» arch | string | true | none | none |
| »»» uname | string | true | none | none |
| »»» release | string | true | none | none |
| »»» hostname | string | true | none | none |
| »»» homeDir | string | true | none | none |
| »»» cmd | string | true | none | none |
| »»» execCommand | string | true | none | none |
| »» disk | [object] | true | none | none |
| »»» size | string | true | none | none |
| »»» used | string | true | none | none |
| »»» avail | string | true | none | none |
| »»» pcent | string | true | none | none |
| »»» target | string | true | none | none |
# General APIs
## GET Default Home Page
GET /
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------ |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "Welcome to the CN EMS Core Network Management Platform, current version: 2.2404.6, please access via the frontend address."
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
## GET Captcha Code
GET /captchaImage
Captcha code valid for 2 minutes
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"captchaEnabled": true,
"uuid": "os0t2l1532dhuvqv",
"img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%2364e6e6' d='M62.19 26.62L62.24 26.67L62.16 26.59Q65.43 27.87 69.20 27.87L69.20 27.88L69.26 27.94Q70.89 27.97 72.45 27.75L72.42 27.71L72.32 27.61Q71.98 28.18 71.33 29.36L71.26 29.29L71.29 29.32Q71.92 29.46 72.60 29.23L72.65 29.27L72.49 29.11Q72.23 30.03 72.23 30.83L72.28 30.89L72.19 30.79Q72.19 31.52 72.46 32.24L72.54 32.32L72.51 32.29Q70.98 31.95 69.20 31.99L69.29 32.08L69.23 32.02Q67.58 32.12 66.17 32.39L66.17 32.39L66.03 32.25Q66.46 31.46 66.35 30.47L66.36 30.48L66.36 30.49Q66.19 30.62 65.97 30.58L65.86 30.48L65.87 30.49Q65.69 30.47 65.39 30.47L65.37 30.44L65.49 30.57Q65.20 28.71 62.15 26.58ZM65.45 29.99L65.54 30.08L65.51 30.05Q67.04 30.25 68.18 30.21L68.22 30.25L68.13 30.16Q70.97 30.30 70.97 30.30L70.96 30.28L70.83 30.16Q71.02 29.20 71.74 28.18L71.68 28.11L71.59 28.03Q70.56 28.29 69.38 28.29L69.45 28.36L69.38 28.29Q66.36 28.35 63.47 27.40L63.43 27.36L63.37 27.30Q65.24 28.64 65.62 30.17ZM65.12 30.77L65.19 30.84L65.23 30.87Q65.53 30.79 66.21 30.83L66.19 30.81L66.15 30.77Q66.09 31.89 65.56 32.65L65.56 32.66L65.59 32.69Q67.19 32.57 67.03 32.57L67.07 32.60L67.07 32.60Q66.49 33.54 65.73 34.31L65.65 34.22L65.68 34.26Q67.75 33.97 69.69 33.97L69.55 33.83L69.64 33.91Q74.20 33.87 78.31 35.58L78.40 35.67L75.97 34.31L75.83 34.16Q73.52 32.73 73.52 30.52L73.38 30.39L73.46 30.46Q73.14 30.45 72.88 30.45L72.98 30.55L72.52 30.63L72.40 30.51Q72.58 29.78 73.15 28.83L73.13 28.81L73.05 28.72Q72.58 28.75 71.63 28.94L71.80 29.11L71.65 28.96Q72.26 28.05 73.25 27.29L73.21 27.25L73.11 27.15Q71.26 27.58 69.24 27.58L69.32 27.66L69.18 27.52Q64.54 27.64 60.77 25.77L60.70 25.70L60.78 25.78Q65.14 28.39 65.25 30.90ZM66.06 29.73L66.15 29.82L65.84 29.78L65.93 29.86Q65.64 29.61 65.53 29.61L65.71 29.79L65.72 29.80Q65.53 29.23 65.15 28.82L64.97 28.64L64.22 27.77L64.27 27.82Q66.75 28.66 69.49 28.66L69.36 28.54L69.46 28.64Q70.16 28.50 71.03 28.42L71.14 28.52L70.96 28.84L70.75 29.05L70.74 29.04Q69.46 29.09 68.17 29.06L68.18 29.06L68.33 29.22Q66.91 29.10 65.62 28.83L65.53 28.74L65.68 28.88Q66.05 29.26 66.20 29.87Z'/%3e%3cpath fill='%2371ade8' d='M44.80 18.31L44.89 18.39L44.82 18.33Q41.80 18.50 39.97 17.43L39.85 17.31L39.91 17.37Q42.41 15.99 47.28 11.77L47.20 11.68L47.21 11.69Q47.93 11.50 49.23 10.89L49.37 11.03L49.19 10.85Q47.99 16.93 47.88 23.28L47.82 23.23L47.74 23.15Q47.66 29.54 48.72 35.63L48.88 35.78L48.77 35.68Q47.12 34.97 44.98 34.86L45.00 34.87L44.91 34.78Q44.95 30.79 44.95 26.71L44.85 26.62L44.84 26.60Q44.89 22.55 44.93 18.43ZM44.49 20.62L44.51 35.22L44.60 35.31Q45.66 35.15 46.61 35.34L46.63 35.36L46.75 35.48Q46.71 36.05 46.90 37.42L46.91 37.43L46.92 37.44Q49.78 37.98 52.21 40.22L52.28 40.29L52.29 40.30Q49.82 33.19 49.79 25.73L49.66 25.60L49.66 25.60Q49.66 18.22 51.49 10.98L51.52 11.02L51.56 11.05Q50.92 11.37 49.32 12.47L49.37 12.52L49.39 12.53Q49.53 11.73 49.84 10.21L49.89 10.26L49.86 10.23Q48.47 10.94 47.02 11.32L47.11 11.40L47.16 11.45Q43.30 14.94 39.00 17.22L39.01 17.23L38.93 17.16Q40.33 18.25 42.69 18.59L42.75 18.65L42.72 18.62Q42.05 19.13 40.76 20.20L40.80 20.24L40.77 20.21Q42.38 20.71 44.58 20.71L44.48 20.61Z'/%3e%3cpath fill='%23328ce5' d='M21.38 18.49L21.29 18.40L21.25 18.35Q18.06 18.36 16.23 17.29L16.30 17.36L16.32 17.39Q18.86 16.04 23.73 11.82L23.69 11.77L23.72 11.80Q24.32 11.48 25.61 10.87L25.68 10.95L25.67 10.93Q24.27 16.80 24.15 23.16L24.27 23.28L24.25 23.25Q24.08 29.55 25.14 35.65L25.24 35.75L25.26 35.76Q23.44 34.90 21.31 34.78L21.45 34.93L21.33 34.80Q21.30 30.73 21.30 26.66L21.32 26.68L21.30 26.66Q21.18 22.44 21.22 18.33ZM21.01 20.74L20.85 35.16L20.88 35.19Q22.20 35.29 23.15 35.48L23.18 35.51L23.02 35.35Q23.15 36.09 23.34 37.46L23.40 37.53L23.34 37.46Q26.25 38.05 28.68 40.29L28.73 40.34L28.57 40.18Q26.18 33.15 26.15 25.69L26.07 25.61L26.20 25.74Q26.00 18.15 27.82 10.92L27.83 10.92L27.98 11.08Q27.25 11.30 25.65 12.40L25.78 12.53L25.79 12.54Q25.94 11.73 26.24 10.21L26.19 10.16L26.21 10.19Q24.96 11.03 23.51 11.41L23.43 11.32L23.48 11.37Q19.71 14.95 15.41 17.23L15.40 17.22L15.37 17.19Q16.80 18.32 19.16 18.66L19.09 18.60L19.19 18.70Q18.48 19.16 17.18 20.22L17.13 20.18L17.27 20.32Q18.61 20.55 20.82 20.55L20.86 20.59Z'/%3e%3cpath fill='%23ea5b7f' d='M99.33 32.82L99.48 32.98L99.49 32.99Q99.70 33.88 100.23 35.90L100.26 35.93L100.19 35.86Q95.96 34.53 91.36 34.79L91.43 34.87L91.36 34.79Q86.86 35.13 82.86 37.11L82.93 37.18L82.77 37.02Q83.04 36.37 83.08 36.45L83.03 36.40L83.12 36.49Q86.76 32.44 90.68 28.03L90.81 28.15L90.75 28.10Q95.13 23.07 96.31 18.39L96.27 18.35L96.37 18.45Q96.79 16.66 95.52 15.48L95.57 15.53L95.51 15.48Q94.32 14.38 92.53 14.53L92.55 14.55L92.54 14.55Q92.19 14.49 91.85 14.49L91.78 14.43L91.82 14.47Q90.33 14.50 89.08 15.42L88.92 15.26L89.03 15.38Q87.75 16.75 87.97 19.42L87.92 19.37L88.00 19.44Q86.06 18.95 84.84 18.50L84.84 18.49L84.86 18.51Q84.76 17.19 84.68 15.75L84.69 15.75L84.77 15.83Q84.61 14.11 85.22 12.97L85.20 12.95L85.12 12.87Q87.02 11.61 90.37 11.61L90.36 11.60L92.10 11.59L92.14 11.63Q94.30 11.54 95.25 11.66L95.24 11.65L95.25 11.65Q99.69 12.18 99.96 14.61L99.85 14.51L99.95 14.61Q100.04 15.19 99.96 15.99L99.88 15.90L100.03 16.05Q99.98 16.69 99.83 17.37L99.82 17.37L99.67 17.22Q98.08 25.38 90.51 32.23L90.53 32.26L90.51 32.23Q91.96 32.12 93.33 32.12L93.30 32.09L93.29 32.08Q96.57 32.13 99.43 32.93ZM98.92 12.16L98.80 12.04L98.93 12.17Q97.17 11.37 95.46 11.29L95.53 11.37L92.18 11.25L92.06 11.13Q87.59 10.85 85.38 11.96L85.41 11.98L85.34 11.91Q84.31 13.32 84.31 15.38L84.34 15.40L84.44 15.51Q84.32 16.07 84.63 18.89L84.76 19.02L84.72 18.98Q85.24 19.19 86.42 19.50L86.39 19.47L86.47 20.58L86.37 20.48Q86.42 21.03 86.50 21.56L86.48 21.54L86.42 21.48Q87.75 21.67 90.23 21.90L90.24 21.92L90.11 21.79Q90.23 21.56 90.23 21.22L90.21 21.20L90.17 21.16Q90.16 19.32 91.37 17.96L91.45 18.04L91.47 18.06Q92.64 16.66 94.43 16.78L94.36 16.71L94.33 16.67Q95.20 16.82 95.96 16.97L95.93 16.94L95.93 16.94Q95.99 17.27 96.06 17.69L96.08 17.71L96.00 17.62Q96.11 18.11 96.03 18.46L95.97 18.39L96.15 18.57Q94.71 23.15 90.30 27.99L90.36 28.05L90.40 28.09Q88.21 30.27 82.76 36.33L82.77 36.33L82.78 36.35Q82.53 37.12 82.18 37.69L82.19 37.70L82.23 37.73Q83.92 36.95 85.45 36.42L85.31 36.28L85.46 36.43Q84.62 36.88 83.67 38.37L83.80 38.50L83.77 38.47Q83.69 38.85 83.57 39.19L83.52 39.14L83.49 39.10Q88.27 36.96 93.76 37.15L93.88 37.28L93.90 37.29Q99.62 37.50 104.19 39.86L104.12 39.79L103.17 37.70L103.03 37.56Q102.53 36.37 102.26 35.57L102.12 35.43L102.24 35.55Q101.46 35.08 100.24 34.66L100.30 34.71L100.21 34.63Q100.03 33.87 99.65 32.50L99.78 32.63L99.64 32.49Q97.40 31.89 95.12 31.70L95.17 31.75L95.13 31.71Q99.98 27.32 101.51 19.05L101.48 19.03L101.62 16.09L101.67 16.13Q101.59 14.34 100.37 13.66L100.31 13.59L100.27 13.59L100.27 13.59Q100.18 13.47 100.11 13.47L100.09 13.45L100.11 13.47Q100.01 12.76 98.91 12.15Z'/%3e%3cpath d='M14 30 C59 18%2c65 9%2c110 17' stroke='%2363dddd' fill='none'/%3e%3cpath d='M13 24 C48 26%2c39 6%2c107 9' stroke='%23de77c4' fill='none'/%3e%3cpath d='M12 11 C50 25%2c80 39%2c113 8' stroke='%23e593bc' fill='none'/%3e%3cpath d='M19 17 C43 30%2c51 8%2c109 8' stroke='%23ddc16d' fill='none'/%3e%3c/svg%3e"
}
```
```json
{
"code": 1,
"msg": "success",
"text": "9",
"captchaEnabled": true,
"uuid": "s7hf2j3erfpritqy",
"img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%23ec73ce' d='M85.44 24.04L85.53 24.13L85.51 24.11Q83.59 23.90 82.35 25.33L82.43 25.40L82.43 25.41Q81.15 26.79 80.96 28.70L81.02 28.76L81.00 28.73Q80.82 30.84 81.91 31.81L81.97 31.87L81.87 31.78Q83.04 32.83 85.13 32.72L84.98 32.56L85.02 32.61Q87.16 32.50 88.26 31.81L88.29 31.84L88.27 31.82Q89.38 30.68 89.38 29.12L89.37 29.11L89.44 29.19Q89.37 28.73 89.30 28.35L89.35 28.41L89.39 28.44Q89.39 26.69 88.28 25.34L88.23 25.29L88.35 25.40Q87.20 24.01 85.52 24.12ZM85.09 35.22L85.17 35.31L85.10 35.24Q80.72 35.24 79.32 34.48L79.34 34.50L79.28 34.44Q78.32 33.75 78.13 32.04L78.05 31.96L78.03 31.93Q78.01 31.27 78.05 30.55L78.11 30.61L78.16 30.65Q78.27 29.66 78.27 29.21L78.24 29.17L78.13 29.06Q78.70 26.32 78.85 25.64L78.79 25.57L78.85 25.64Q79.36 23.75 80.20 22.34L80.18 22.33L80.01 22.15Q82.70 17.80 88.64 11.44L88.62 11.42L88.67 11.48Q91.34 11.17 93.55 10.37L93.58 10.41L93.62 10.44Q86.67 17.81 83.47 22.04L83.47 22.03L83.48 22.04Q84.46 21.53 85.75 21.53L85.86 21.64L85.82 21.60Q89.14 21.61 90.67 23.56L90.71 23.60L90.75 23.64Q91.92 25.12 92.26 28.66L92.27 28.66L92.29 28.68Q92.39 29.43 92.39 30.04L92.36 30.01L92.47 30.12Q92.44 33.21 90.23 34.28L90.23 34.28L90.26 34.30Q88.98 34.86 85.10 35.24ZM87.47 37.72L87.43 37.68L87.35 37.60Q88.60 37.52 90.58 37.60L90.71 37.72L90.71 37.73Q92.28 37.73 93.84 37.01L93.93 37.09L93.82 36.99Q94.99 36.26 94.99 34.47L94.96 34.43L95.01 34.49Q95.03 34.01 94.86 33.02L94.88 33.04L94.82 32.98Q94.56 31.91 94.56 31.45L94.60 31.49L94.54 31.43Q93.75 26.79 92.15 24.88L92.04 24.78L92.07 24.81Q92.00 24.70 91.85 24.47L91.90 24.52L91.66 24.36L91.50 24.24L91.51 24.25Q91.11 23.69 90.50 22.74L90.55 22.79L90.49 22.74Q89.69 21.89 87.71 21.44L87.64 21.36L87.62 21.35Q88.95 19.86 91.92 16.17L91.82 16.07L96.16 10.89L96.12 10.85Q94.61 11.77 92.21 12.53L92.15 12.47L92.19 12.52Q93.08 11.51 94.87 9.53L94.82 9.48L94.81 9.46Q92.46 10.58 88.58 11.15L88.59 11.17L88.58 11.16Q82.94 17.12 79.97 22.07L79.85 21.95L79.89 21.99Q78.41 24.55 77.84 30.79L77.84 30.79L77.72 30.67Q77.67 31.27 77.74 32.22L77.69 32.17L77.72 32.20Q77.90 34.05 79.00 34.96L78.95 34.91L78.92 34.88Q79.37 35.10 79.33 35.14L79.29 35.10L79.36 35.17Q79.71 36.05 80.51 36.47L80.42 36.38L80.50 36.46Q81.90 37.10 83.84 37.29L83.84 37.29L83.85 37.30Q83.79 37.24 87.30 37.54ZM87.11 26.36L87.10 26.35L87.17 26.41Q87.77 26.33 88.72 26.83L88.63 26.74L88.77 26.87Q88.99 27.71 88.99 28.36L88.94 28.30L89.00 28.37Q89.12 30.16 88.17 31.15L88.28 31.26L88.28 31.26Q87.16 31.92 85.06 32.23L85.15 32.32L85.11 32.28Q83.59 32.20 83.05 31.93L83.20 32.08L83.03 31.91Q82.84 31.45 82.84 31.15L82.85 31.16L83.00 31.31Q82.76 28.03 85.69 26.73L85.62 26.66L85.62 26.65Q86.45 26.39 87.22 26.46Z'/%3e%3cpath d='M10 16 C70 25%2c49 8%2c114 10' stroke='%2378c4dd' fill='none'/%3e%3cpath fill='%23d24065' d='M23.39 35.44L23.31 35.35L23.31 35.35Q21.80 35.33 20.24 34.91L20.24 34.91L20.26 34.93Q19.14 34.12 18.99 32.48L18.89 32.38L18.88 32.38Q18.97 32.31 19.16 29.68L19.17 29.69L19.07 29.59Q20.06 29.37 22.08 28.99L22.06 28.97L21.89 29.75L22.00 29.86Q21.69 31.57 23.10 32.14L23.15 32.19L23.18 32.22Q23.98 32.57 26.08 32.57L26.01 32.50L25.93 32.42Q27.52 32.26 27.71 32.18L27.87 32.35L27.76 32.23Q28.67 32.08 29.39 31.58L29.52 31.71L29.51 31.70Q30.85 30.68 30.66 28.59L30.61 28.54L30.60 28.52Q30.46 26.14 28.73 24.58L28.78 24.63L28.81 24.66Q27.08 23.10 24.61 23.10L24.60 23.09L24.53 22.79L24.55 22.81Q24.82 22.67 25.69 22.59L25.87 22.76L25.67 22.57Q27.66 22.53 29.03 21.30L29.07 21.34L28.97 21.24Q30.46 20.12 30.61 18.26L30.65 18.29L30.63 18.27Q30.61 17.84 30.61 17.50L30.70 17.58L30.61 17.49Q30.67 16.03 29.29 15.11L29.30 15.12L29.23 15.05Q28.02 14.25 26.42 14.37L26.39 14.34L26.38 14.33Q25.06 14.15 23.84 14.57L23.94 14.67L23.85 14.58Q22.55 15.25 22.24 16.40L22.11 16.26L22.21 16.37Q21.98 17.09 22.06 17.85L22.16 17.96L22.17 17.96Q21.02 17.62 18.97 16.89L18.89 16.82L18.91 16.83Q18.81 15.28 18.85 14.45L18.82 14.42L18.84 14.44Q18.83 12.80 19.90 12.11L20.08 12.29L19.99 12.20Q21.48 11.67 23.08 11.67L22.93 11.53L22.93 11.53Q26.17 11.57 29.33 11.84L29.29 11.79L29.34 11.85Q34.43 12.29 34.12 16.06L34.06 16.00L34.04 15.97Q34.00 17.50 33.51 19.06L33.59 19.14L33.55 19.10Q32.65 22.20 30.29 23.12L30.22 23.04L30.14 22.97Q32.90 23.63 33.51 26.98L33.50 26.97L33.50 26.97Q33.63 28.02 33.71 30.03L33.80 30.12L33.74 30.06Q33.91 34.53 29.30 34.99L29.30 34.99L29.40 35.09Q28.57 35.06 23.28 35.33ZM28.53 37.60L28.57 37.65L28.41 37.49Q29.16 37.66 32.01 37.74L31.88 37.61L32.06 37.79Q33.81 37.86 35.45 37.22L35.45 37.22L35.35 37.11Q36.46 36.10 36.27 34.35L36.41 34.49L36.29 34.36Q36.31 33.16 36.00 31.41L35.88 31.29L35.94 31.36Q35.18 26.82 33.24 25.19L33.21 25.16L33.10 24.86L33.06 24.78L32.98 24.69Q34.87 23.39 35.63 19.01L35.50 18.88L35.45 18.84Q35.57 18.46 35.69 17.51L35.78 17.61L35.65 17.47Q35.78 16.76 35.70 16.08L35.80 16.17L35.71 16.08Q35.63 14.48 34.33 13.79L34.34 13.80L34.17 13.71L34.22 13.76Q33.85 12.70 32.71 12.17L32.80 12.26L32.68 12.14Q31.11 11.41 25.97 11.11L26.08 11.21L25.99 11.12Q24.41 11.14 22.81 11.14L22.83 11.16L22.87 11.20Q21.14 11.07 19.62 11.72L19.76 11.86L19.73 11.83Q18.52 12.60 18.52 14.35L18.51 14.34L18.41 14.24Q18.40 13.81 18.67 17.16L18.78 17.28L18.69 17.19Q18.99 17.26 20.63 17.87L20.60 17.84L20.62 17.86Q20.76 18.53 20.72 19.02L20.54 18.84L20.73 19.03Q20.54 19.34 20.58 19.87L20.63 19.93L20.66 19.95Q22.51 20.39 24.53 20.51L24.57 20.55L24.39 20.37Q24.38 18.42 25.48 17.58L25.50 17.59L25.44 17.54Q26.27 16.89 28.29 16.66L28.41 16.78L28.39 16.76Q29.52 16.75 30.09 16.94L30.06 16.90L30.08 16.92Q30.15 17.07 30.19 17.19L30.05 17.05L30.20 17.39L30.27 17.92L30.23 17.88Q30.30 18.13 30.26 18.28L30.18 18.21L30.31 18.34Q30.19 20.01 28.67 21.19L28.59 21.10L28.57 21.09Q27.71 22.06 25.69 22.25L25.72 22.28L25.69 22.24Q25.04 22.47 24.17 22.47L24.11 22.42L24.00 22.30Q24.03 22.64 24.19 23.33L24.35 23.49L24.35 23.50Q26.11 23.50 27.56 24.23L27.50 24.16L27.36 24.14L25.79 24.32L25.76 24.29Q25.76 24.59 25.87 25.20L26.02 25.36L25.90 25.23Q28.07 25.19 29.78 26.53L29.72 26.46L29.85 26.59Q30.02 26.92 30.33 28.55L30.36 28.59L30.35 28.58Q30.47 31.44 27.54 31.85L27.69 32.01L27.61 31.92Q25.48 32.16 24.91 32.12L24.88 32.09L24.98 32.19Q24.46 32.02 23.93 31.94L23.99 32.00L23.91 31.47L24.12 31.10L24.16 30.73L24.16 30.38L24.18 30.40Q23.17 30.42 22.37 30.61L22.44 30.68L22.41 30.65Q22.35 30.40 22.35 30.21L22.43 30.29L22.42 30.28Q22.46 30.09 22.46 29.86L22.33 29.73L22.34 29.74Q22.44 29.39 22.59 28.67L22.57 28.64L22.66 28.73Q20.80 28.96 18.93 29.30L18.88 29.26L18.80 29.18Q18.85 29.72 18.74 30.84L18.80 30.91L18.66 30.76Q18.64 31.99 18.64 32.59L18.55 32.50L18.55 32.50Q18.70 34.63 20.07 35.39L20.08 35.40L20.01 35.33Q21.56 37.68 26.28 37.49L26.31 37.52L26.24 37.45Q27.06 37.51 28.59 37.66Z'/%3e%3cpath d='M13 4 C51 9%2c65 6%2c110 4' stroke='%237590df' fill='none'/%3e%3cpath fill='%23d24b4b' d='M57.55 34.48L57.61 34.54L57.53 34.46Q56.76 34.34 56.08 34.38L56.14 34.44L56.20 34.50Q55.53 34.63 54.85 34.63L54.68 34.47L54.66 34.45Q55.13 31.03 55.13 27.61L55.18 27.66L55.14 27.61Q53.29 27.63 52.37 27.63L52.57 27.82L52.48 27.73Q51.54 27.64 49.72 27.56L49.69 27.54L49.80 27.64Q49.90 27.44 49.71 24.97L49.65 24.91L49.57 24.82Q52.15 25.39 55.12 25.39L55.18 25.45L55.19 25.46Q54.81 20.93 54.39 18.34L54.48 18.43L54.56 18.51Q55.36 18.62 56.16 18.62L56.03 18.49L57.67 18.50L57.78 18.61Q57.44 22.76 57.44 25.35L57.58 25.49L57.45 25.36Q59.72 25.46 62.92 25.12L62.84 25.04L62.84 25.03Q62.75 26.40 62.75 27.61L62.81 27.68L62.69 27.56Q62.58 27.71 61.78 27.75L61.75 27.72L61.70 27.66Q60.68 27.63 60.07 27.67L60.01 27.62L60.07 27.68Q60.10 27.71 57.44 27.71L57.51 27.78L57.34 31.04L57.51 31.21Q57.46 32.79 57.57 34.50ZM63.36 24.64L63.33 24.62L63.27 24.55Q61.46 24.95 59.59 25.03L59.54 24.98L59.53 24.97Q59.78 21.82 60.19 19.96L60.18 19.94L60.22 19.98Q59.51 20.03 58.10 20.18L58.10 20.18L58.31 18.15L58.19 18.03Q55.69 18.15 54.01 18.04L54.01 18.04L54.02 18.05Q54.54 21.12 54.73 25.00L54.70 24.97L54.67 24.94Q52.99 24.97 49.30 24.36L49.20 24.27L49.30 24.37Q49.53 25.51 49.53 28.14L49.55 28.16L51.02 28.11L50.96 28.05Q51.07 28.88 50.92 30.29L50.86 30.23L54.76 29.90L54.85 29.99Q54.64 33.17 54.34 35.00L54.38 35.04L54.33 34.99Q55.05 34.95 56.45 34.83L56.56 34.93L56.49 34.86Q56.55 35.62 56.52 36.95L56.41 36.85L56.39 36.83Q56.88 36.78 60.50 36.93L60.59 37.02L60.50 36.94Q59.71 33.98 59.48 30.02L59.38 29.92L59.45 29.99Q62.82 30.12 64.91 30.50L64.93 30.52L64.79 30.38Q64.61 29.43 64.61 28.48L64.58 28.46L64.74 26.71L64.69 26.66Q64.46 26.66 63.93 26.70L63.98 26.75L63.08 26.65L63.05 26.62Q63.09 25.86 63.20 24.49Z'/%3e%3cpath d='M6 19 C52 21%2c78 16%2c107 21' stroke='%2383ebb7' fill='none'/%3e%3cpath d='M8 38 C57 34%2c69 37%2c109 30' stroke='%237baddf' fill='none'/%3e%3c/svg%3e"
}
```
```json
{
"captchaEnabled": false,
"code": 1,
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ----------------- | ------- | -------- | ------------ | ------------------------------- |
| » code | number | true | none | none |
| » msg | string | true | none | none |
| » text | string | false | none | Only return in development mode |
| » captchaEnabled | boolean | true | none | none |
| » uuid | string | true | none | none |
| » img | string | true | none | none |
## GET System Configuration
GET /sys-conf
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> OK
```json
{
"code": 1,
"data": {
"buildTime": "-",
"copyright": "Copyright ©2023 AGrandTech",
"filePathBrand": "/static/logo/{language}_brand.png",
"filePathIcon": "/static/logo/{language}_icon.png",
"goVer": "-",
"helpDoc": "/static/helpDoc/{language}_doc.pdf",
"i18nDefault": "en_US",
"i18nOpen": "true",
"loginBackground": "#",
"logoType": "icon",
"officialUrl": "#",
"registerUser": "false",
"serialNum": "-",
"title": "AGrandEMS",
"version": "-"
},
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ---------------- | ------------ | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [object] | true | none | none |
| »» name | string | true | none | none |
| »» path | string | true | none | none |
| »» component | string | true | none | none |
| »» meta | object | true | none | none |
| »»» icon | string | true | none | none |
| »»» title | string | true | none | none |
| »»» hide | boolean | true | none | none |
| »»» cache | boolean | true | none | none |
| »»» target | string¦null | true | nonenone | |
| »» redirect | string | false | none | none |
| »» children | [object] | false | none | none |
| »»» name | string | true | none | none |
| »»» path | string | true | none | none |
| »»» component | string | true | none | none |
| »»» meta | object | true | none | none |
| »»»» icon | string | true | none | none |
| »»»» title | string | true | none | none |
| »»»» hide | boolean | true | none | none |
| »»»» cache | boolean | true | none | none |
| »»»» target | string¦null | true | none | none |
## POST Upload help document
POST /helpDoc
> Body Parameters
```json
{
"uploadPath": "string",
"language": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » uploadPath | body | string | yes | none |
| » language | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"data": "/static/helpDoc/omc_guide.pdf",
"msg": "success"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# General APIs/File operation
## POST upload file
POST /file/upload
> Body Parameters
```yaml
file: file://D:\Downloads\WPS_Setup_16417.exe
subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common',
'download', 'chunk'] %}"
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ---------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | yes | upload file |
| » subPath | body | string | yes | sub path: ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk'] |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": {
"url": "http://127.0.0.1:6275/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61miiq526uqv.png",
"fileName": "/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mi1_iq526uqv.png",
"newFileName": "o_1d2bofn8f19dh5s11okpje611_iq526uqv.png",
"originalFileName": "o_1d2bofn8f19dh5s11okpje61mi1.png"
}
}
```
```json
{
"code": 0,
"msg": "maximum upload file size 10.00MB"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| --------------------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | object | true | none | none |
| »» url | string | true | none | none |
| »» fileName | string | true | none | none |
| »» newFileName | string | true | none | none |
| »» originalFileName | string | true | none | none |
## POST check chunk file
POST /file/chunkCheck
> Body Parameters
```json
{
"identifier": "string",
"fileName": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ----------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » identifier | body | string | yes | MD5 |
| » fileName | body | string | yes | check if file types allow uploading |
> Response Examples
> Ok
```json
{
"code": 1,
"msg": "success",
"data": []
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Ok | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [string] | true | none | none |
## POST upload chunk file
POST /file/chunkUpload
```js
// upload form data
const formData = new FormData();
formData.append('file', chunk, 'xxx.pdf');
formData.append('index', chunksIndex);
formData.append('identifier', fileIdentifier);
```
Chunk is the data for file blocks, and the name of the uploaded file needs to be suffixed
> Body Parameters
```yaml
file: string
index: "{% mock 'increment' %}"
identifier: "{% mock 'id' %}"
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------------- | -------- | ------------------------------------------------------ |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » file | body | string(binary) | yes | file block Blob object, file name needs to be suffixed |
| » index | body | string | yes | number of file blocks |
| » identifier | body | string | yes | file block directory identifier |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": "/upload/chunk/2023/06/identifier/index"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | --------------------------------------------------------------- | ----------- | ----------- |
| 206 | [Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **206**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | string | true | none | none |
## POST Merge chunk file
POST /file/chunkMerge
> Body Parameters
```json
{
"identifier": "string",
"fileName": "string",
"subPath": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » identifier | body | string | yes | MD5(file name + file size) |
| » fileName | body | string | yes | Check if the suffix allows uploading |
| » subPath | body | string | yes | option ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk'] |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success",
"data": {
"url": "http://127.0.0.1:6275/upload/avatar/2023/06/gmircbr_48xqb8.png",
"fileName": "/upload/avatar/2023/06/gmircbr_48xqb8.png",
"newFileName": "gmircbr_48xqb8.png",
"originalFileName": "gmircbr.png"
}
}
```
```json
{
"code": 0,
"msg": "failed to read merge target file"
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | -------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
| » data | [string] | true | none | none |
## GET Download file
GET /file/download/{filePath}
The file Path parameter requires base64 encoding, base64 ("file storage resource path, URL relative address")
Breakpoint continuation can include a range for downloading data blocks in the request header, for example, a single block size of 5M ` Range: bytes=0-5242879`
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ---------------------------------------------------------- |
| filePath | path | string | yes | base64("file storage resource path, URL relative address") |
| Range | header | string | no | |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
> Response Examples
> file block
> 206 Response
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | --------------------------------------------------------------- | ---------------------------------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | file block | Inline |
| 206 | [Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1) | Breakpoint continuation file block | Inline |
### Responses Data Schema
# General APIs/Account Registration
## POST Registration
POST /register
> Body Parameters
```json
{
"username": "string",
"password": "string",
"confirmPassword": "string",
"code": "string",
"uuid": "string"
}
```
### Params
| Name | Location | Type | Required | Description |
| ------------------ | -------- | ------ | -------- | ------------------- |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| AccessToken | header | string | no | Access token |
| body | body | object | no | none |
| » username | body | string | yes | none |
| » password | body | string | yes | none |
| » confirmPassword | body | string | yes | none |
| » code | body | string | yes | none |
| » uuid | body | string | yes | none |
> Response Examples
> OK
```json
{
"code": 1,
"msg": "success"
}
```
```json
{
"code": 0,
"msg": "The current system has not enabled registration function!"
}
```
```json
{
"code": 0,
"msg": "failed to register user [manager]. Sorry, the system has closed the external user registration channel"
}
```
```json
{
"code": 0,
"msg": "The account number cannot start with a number, but can contain upper and lower case letters, numbers, and not less than 5 digits."
}
```
```json
{
"code": 0,
"msg": "The password must contain at least 6 upper and lower case letters, numbers, and special symbols."
}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline |
### Responses Data Schema
HTTP Status Code **200**
| Name | Type | Required | Restrictions | description |
| ------- | ------- | -------- | ------------ | ----------- |
| » code | integer | true | none | none |
| » msg | string | true | none | none |
# Data Management
## GET Fuzzy query with '%'
GET /api/rest/dataManagement/v1/omc_db/alarm
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| SQL | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## GET Query by where condition
GET /api/rest/databaseManagement/v1/omc_db/ne_info
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| WHERE | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## GET Multiple SQL query
GET /api/rest/databaseManagement/v1/omc_db/ne_state
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------------- | -------- | ------------------- |
| SQL | query | array[string] | yes | none |
| PAGE | query | string | yes | none |
| LIMIT | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## POST Insert multiple record into table alarm_log
POST /api/rest/dataManagement/v1/omc_db/alarm_log
> Body Parameters
```json
{
"alarm_log": [
{
"ne_type": "AMF",
"ne_id": "001",
"alarm_id": "2",
"alarm_code": "2",
"alarm_seq": "3",
"event_time": "2023-10-29 15:52:09"
},
{
"ne_type": "SMF",
"ne_id": "001",
"alarm_id": "4",
"alarm_code": "2",
"alarm_seq": "3",
"event_time": "2023-10-29 16:52:09"
}
]
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | -------- | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » alarm_log | body | [object] | yes | none |
| »» ne_type | body | string | yes | none |
| »» ne_id | body | string | yes | none |
| »» alarm_id | body | string | yes | none |
| »» alarm_code | body | string | yes | none |
| »» alarm_seq | body | string | yes | none |
| »» event_time | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## PUT Update single record
PUT /api/rest/dataManagement/v1/omc_db/user
> Body Parameters
```json
{
"user": {
"name": "test3"
}
}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| WHERE | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » user | body | object | yes | none |
| »» name | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## PUT UPDATE MeasureTask
PUT /api/rest/databaseManagement/v1/omc_db/measure_task
> Body Parameters
```json
{
"measure_task": {
"id": "28",
"ne_type": "SMF",
"ne_ids": "[\"SZ_01\"]",
"kpi_set": "[{\"Code\":\"SMFHA01\",\"KPIs\":[\"SMF.AttCreatePduSession\",\"SMF.AttCreatePduSession._Dnn\"]}]",
"schedule": "[{\"Type\":\"\",\"Days\":[]}]",
"start_time": "",
"end_time": "",
"granul_option": "30M",
"status": "Inactive",
"create_time": "2023-5-25 21:59:9",
"periods": "[]"
}
}
```
### Params
| Name | Location | Type | Required | Description |
| ------------------ | -------- | ------ | -------- | ------------------- |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
| » measure_task | body | object | yes | none |
| »» id | body | string | yes | none |
| »» ne_type | body | string | yes | none |
| »» ne_ids | body | string | yes | none |
| »» kpi_set | body | string | yes | none |
| »» schedule | body | string | yes | none |
| »» start_time | body | string | yes | none |
| »» end_time | body | string | yes | none |
| »» granul_option | body | string | yes | none |
| »» status | body | string | yes | none |
| »» create_time | body | string | yes | none |
| »» periods | body | string | yes | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
## DELETE Delete historical alarm exceeding 90 days
DELETE /api/rest/databaseManagement/v1/delete/omc_db/alarm
> Body Parameters
```json
{}
```
### Params
| Name | Location | Type | Required | Description |
| --------------- | -------- | ------ | -------- | ------------------- |
| WHERE | query | string | yes | none |
| AccessToken | header | string | yes | none |
| Authorization | header | string | yes | Authoirzation token |
| Referer | header | string | yes | User Referer |
| User-Agent | header | string | yes | User Agent |
| Accept-Language | header | string | yes | en_US;q=0.9 |
| body | body | object | no | none |
> Response Examples
> 200 Response
```json
{}
```
### Responses
| HTTP Status Code | Meaning | Description | Data schema |
| ---------------- | ---------------------------------------------------- | ----------- | ----------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline |
### Responses Data Schema
# Data Schema
Reference in New Issue View Git Blame Copy Permalink