OMC/build.ems

Fork 0

Files

simonzhangsz 10c02071e3 fix: doc and logo

2023-12-06 14:47:53 +08:00

466 KiB

Raw Blame History

OMC HTTP Restful API Interfaces

Authentication

GET User Information

GET /getInfo

Request Parameters

Name	Location	Type	Required	Description
Authorization	header	string	Yes	Authorization token
Referer	header	string	Yes	Referer
User-Agent	header	string	Yes	User agent
Accept-Language	header	string	Yes	zh_CN;q=0.9 en_US;q=0.9

Response example

Success

{ 
  "code": 200,
  "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": "Admin",
      "nickName": "Admin",
      "userType": "sys",
      "email": "",
      "avatar": "",
      "phonenumber": "",
      "sex": "1",
      "status": "1",
      "delFlag": "0",
      "loginIp": "127.0.0.1",
      "loginDate": "1683968355811",
      "createBy": "Admin",
      "createTime": "1682264526306",
      "remark": "Admin",
      "dept": {
        "deptId": "103",
        "parentId": "101",
        "ancestors": "0,100,101",
        "deptName": "R&D",
        "orderNum": 1,
        "leader": "",
        "status": "1"
      }
    }
  }
}

Response

HTTP Status Code	Meaning	Description	Data Schema
200	OK	Success	Inline

Response Data Schema

HTTP Status Code 200

Name	Type	Required	Constraint	Title	Description
» code	integer	true	none		none
» msg	string	true	none		none
» data	object	true	none		none
»» permissions	[string]	true	none	Permissions	character array
»» roles	[string]	true	none	Role	character array
»» user	object	true	none	User info	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 Router Information

GET /getRouters

Request Parameters

Name	Location	Type	Required	Description
Authorization	header	string	Yes	Authorization token
Referer	header	string	Yes	Use the specified Referer
User-Agent	header	string	Yes	User agent
Accept-Language	header	string	Yes	zh_CN;q=0.9 en_US;q=0.9

Response example

Success

{
  "code": 200,
  "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": "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": "Position management",
            "hide": false,
            "cache": true,
            "target": null
          }
        }
      ]
    }
  ]
}

Response

HTTP Status Code	Meaning	Description	Data Schema
200	OK	Success	Inline

Response Data Schema

HTTP Status Code 200

Name	Type	Required	Constraint	Title	Description
» code	integer	true	none		none
» msg	string	true	none		none
» data	[object]	true	none	Route data	none
»» name	string	true	none	Route name	none
»» path	string	true	none	Route path	none
»» component	string	true	none	Component
»» meta	object	true	none	Metadata	none
»»» icon	string	true	none	Menu icon	none
»»» title	string	true	none	Menu title	none
»»» hide	boolean	true	none	Whether to hide	Default false
»»» cache	boolean	true	none	Is cached	Default false
»»» target	string¦null	true	none	link behavior
»» redirect	string	false	none	directory redirection	none
»» children	[object]	false	none	Sub-menu	none
»»» name	string	true	none		none
»»» path	string	true	none		none
»»» component	string	true	none		none
»»» meta	object	true	none	Metadata	none
»»»» icon	string	true	none		none
»»»» title	string	true	none	Title	none
»»»» hide	boolean	true	none		none
»»»» cache	boolean	true	none		none
»»»» target	string¦null	true	none		none

POST /login

Body Request Parameters

{
  "username": "admin",
  "password": "rootaa",
  "code": "{{code-text}}",
  "uuid": "{{code-uuid}}"
}

Request Parameters

Name	Location	Type	Required	Title	Description
Referer	header	string	Yes
User-Agent	header	string	Yes
Accept-Language	header	string	Yes		zh_CN;q=0.9 en_US;q=0.9
body	body	object	No		none
» username	body	string	Yes	Login name	none
» password	body	string	Yes	Password	none
» code	body	string	Yes	Verification code value	none
» uuid	body	string	Yes	Verification code UID	none

Response example

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo"
  }
}

{
  "code": 500,
  "msg": "Verification code has expired"
}

{
  "code": 500,
  "msg": "Verification code error"
}

Response

HTTP Status Code	Meaning	Description	Data Schema
200	OK	Success	Inline

Response Data Schema

HTTP Status Code 200

Name	Type	Required	Constraint	Title	Description
» code	integer	true	none		none
» msg	string	true	none		none
» data	object	false	none		none
»» access_token	string	true	none	Authorization token	none

POST Logout

POST /logout

Request Parameters

Name	Location	Type	Required	Description
Authorization	header	string	No	Authorization token, optional
Referer	header	string	Yes
User-Agent	header	string	Yes
Accept-Language	header	string	Yes	zh_CN;q=0.9 en_US;q=0.9

Response example

Success

{
  "code": 200,
  "msg": "Logout Success"
}

{
  "code": 500,
  "msg": "The access is too frequent, please try again later."
}

Response

HTTP Status Code	Meaning	Description	Data Schema
200	OK	Success	Inline

Response Data Schema

HTTP Status Code 200

Name	Type	Required	Constraint	Value	Description
» code	integer	true	none	Fixed value	none
» msg	string	true	none	Fixed value	none

Monitor & Alarm

GET Get ALL NEs System State

GET /api/rest/systemManagement/v1/elementType/ALL/objectType/systemState

Get ALL NEs system state

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

0 Response

{}

OK

{
  "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": 200559,
                "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": 200559,
                "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": 200559,
                "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": 200559,
                "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": 200559,
                "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": 200559,
                "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": 200559,
                "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	OK	Inline
401	Unauthorized	Unauthorized	Inline
500	Internal Server Error	Server Error	Inline

Responses Data Schema

GET Get Alarm from NF

GET /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms

Sync alarms from NF

Body Parameters

[
  {
    "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"
  }
]

Request Parameters

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	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
body	body	array[object]	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline

Responses Data Schema

GET Get OMC Local Time

GET /api/rest/systemManagement/v1/elementType/OMC/objectType/time

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get All UDM System State

GET /api/rest/systemManagement/v1/elementType/udm/objectType/systemState

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	OK	Inline

Responses Data Schema

POST Get Alarm from NF

POST /api/rest/faultManagement/v1/elementType/smf/objectType/alarms

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get OMC System State

GET /api/rest/systemManagement/v1/elementType/omc/objectType/systemState

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post Alarm from AMF

POST /api/rest/faultManagement/v1/elementType/amf/objectType/alarms

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

Performance

PATCH Patch Measure Task

PATCH /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask

Request Parameters

Name	Location	Type	Required	Description
taskId	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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post Measure Task

POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask

Body Parameters

{}

Request Parameters

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	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
body	body	object	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

Trace

DELETE Patch Measure Task

DELETE /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask

Request Parameters

Name	Location	Type	Required	Description
taskId	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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post Trace Task No NeType

POST /api/rest/traceManagement/v1/subscriptions

Body Parameters

{
  "traceType": "Interface",
  "startTime": "2023-07-04 13:00:00",
  "endTime": "2023-07-04 19:00:00",
  "neType": "",
  "neId": "",
  "interfaces": [
    "N8",
    "N10"
  ]
}

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT Put Trace Task No NeType

PUT /api/rest/traceManagement/v1/subscriptions

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Delete Trace Task No NeType

DELETE /api/rest/traceManagement/v1/subscriptions

Body Parameters

{}

Request Parameters

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	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
body	body	object	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post AMF Measure Task

POST /api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask

Body Parameters

{}

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST

POST /tcpdump/ne

Body Parameters

{
  "neType": "string",
  "neId": "string",
  "timeout": 0,
  "cmd": "string",
  "timestamp": "string"
}

Request Parameters

Name	Location	Type	Required	Description
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
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 record file

Response Examples

200 Response

{
  "code": 0,
  "data": {
    "cmd": "string",
    "fileName": "string",
    "msg": "string"
  },
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	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 Post Measure Report

POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport

Body Parameters

{
  "id": 1,
  "NeType": "SMF"
}

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» id	body	integer	yes	none
» NeType	body	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post Measurement

POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measurement

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
Content-Type	header	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST UPF Capture PACP

POST /tcpdump/neUPF

Body Parameters

{
  "neType": "string",
  "neId": "string",
  "runType": "string",
  "cmd": "string",
  "timestamp": "string"
}

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» neType	body	string	yes	none
» neId	body	string	yes	none
» runType	body	string	yes
» cmd	body	string	yes
» timestamp	body	string	yes	timestamp record file

Description

» cmd: Method 1: Suitable for situations where other network elements are abnormal and UPF cooperates with packet capture. Package files are relatively small. After entering the command line:

Start capturing packets pcap trace rx tx max 100000 intfc any file upf_test.pcap
Stop capturing packets pcap trace rx tx off

Method 2: Suitable for situations where UPF anomalies require packet capture and analysis. The package file is relatively large. After entering the command line:

Start capturing packets pcap dispatch trace on max 100000 file upf_test.pcap
Stop capturing packets pcap dispatch trace off

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET PACP file download

GET /tcpdump/download

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

Configuration/Export/Import NE

POST Post MML UDM

POST /api/rest/opeartionManagement/v1/elementType/udm/objectType/mml

Body Parameters

{
  "mml": [
    "date",
    "dsp authdat:imsi=460000100000030"
  ]
}

Request Parameters

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
body	body	object	no	none
» mml	body	[string]	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get Software from OMC

GET /api/rest/systemManagement/v1/AMF/software/123

Body Parameters

string

Request Parameters

Name	Location	Type	Required	Description
accessToken	header	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
body	body	string(binary)	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Upload Software To OMC

POST /api/rest/systemManagement/v1/AMF/software/123

Body Parameters

file: string

Request Parameters

Name	Location	Type	Required	Description
accessToken	header	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
body	body	object	no	none
» file	body	string(binary)	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Export CM From NF

GET /api/rest/systemManagement/v1/elementType/udm/objectType/cm

Body Parameters

string

Request Parameters

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	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
body	body	string(binary)	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Import CM to NF

POST /api/rest/systemManagement/v1/elementType/udm/objectType/cm

Body Parameters

{
  "fileName": "udm-sz_01-etc-20230627002725.zip"
}

Request Parameters

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	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
body	body	object	no	none
» fileName	body	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Delete Software from OMC

DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/cm

Body Parameters

{
  "fileName": "udm-sz_01-etc-20230615171608.zip"
}

Request Parameters

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	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
body	body	object	no	none
» fileName	body	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT Active Software To NF

PUT /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01

Body Parameters

{}

Request Parameters

Name	Location	Type	Required	Description
accessToken	header	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
body	body	object	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PATCH Rollback Software To NF

PATCH /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01

Body Parameters

file: string

Request Parameters

Name	Location	Type	Required	Description
accessToken	header	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
body	body	object	no	none
» file	body	string(binary)	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Distribute Software To NF

POST /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230621/SZ_T01

Body Parameters

file: string

Request Parameters

Name	Location	Type	Required	Description
accessToken	header	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
body	body	object	no	none
» file	body	string(binary)	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post MML

POST /api/rest/opeartionManagement/v1/elementType/udm/objectType/MML

Body Parameters

{
  "mml": [
    "date",
    "date"
  ]
}

Request Parameters

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
body	body	object	no	none
» mml	body	[string]	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

Configuration/NE Management

PUT Put NE Info

PUT /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo

Body Parameters

{
  "pvFlag": "VNF",
  "province": "GD",
  "vendorName": "AGT",
  "dn": "cmjicai"
}

Request Parameters

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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post NE Info

POST /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo

Body Parameters

{
  "neType": "UDM",
  "neId": "SZ_02",
  "neName": "UDM_SZ_01",
  "ip": "192.168.1.187",
  "port": "8080",
  "pvFlag": "VNF",
  "province": "GD",
  "vendorName": "AGT",
  "dn": "cmjicai"
}

Request Parameters

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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Delete NE info

DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo

Body Parameters

string

Request Parameters

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	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
body	body	string	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

Configuration/Parameter config

GET Get UDM subUEambr

GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/system

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT Put System Parameter to UDM

PUT /api/rest/systemManagement/v1/elementType/udm/objectType/config/system

Body Parameters

{
  "capacity": 1000,
  "priority": 2
}

Request Parameters

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	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
body	body	object	no	none
» capacity	body	integer	yes	none
» priority	body	integer	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Post System Parameter to UDM

POST /api/rest/systemManagement/v1/elementType/udm/objectType/config/system

Body Parameters

{
  "capacity": 1000,
  "priority": 2
}

Request Parameters

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	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
body	body	object	no	none
» capacity	body	integer	yes	none
» priority	body	integer	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Delete System Parameter to UDM

DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/config/system

Body Parameters

{
  "capacity": 1000,
  "priority": 2
}

Request Parameters

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	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
body	body	object	no	none
» capacity	body	integer	yes	none
» priority	body	integer	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get IMS system param

GET /api/rest/systemManagement/v1/elementType/amf/objectType/config/guami

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get subsUEAmbr Parameter from UDM

GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get UDM smfSelection

GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

UE Management

PUT Batch Modify PCF UE Info

PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/{number}

Body Parameters

{
  "imsi": "000510200000001",
  "msisdn": "1350000001",
  "rfsp": "omitempty",
  "sar": "",
  "pccRules": "",
  "sessRules": "",
  "uePolicy": "",
  "qosAudio": "",
  "qosVideo": "",
  "hdrEnrich": ""
}

Request Parameters

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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

UE Management/UDM Subscirber Data

GET subscriber data

GET /ne/udm/sub/{neId}/{imsi}

Request Parameters

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

Response Examples

200 Response

{
  "code": 0,
  "data": {
    "id": "string",
    "msisdn": "string",
    "imsi": "string",
    "ambr": "string",
    "nssai": "string",
    "rat": "string",
    "arfb": "string",
    "sar": "string",
    "cn": "string",
    "smData": "string",
    "smfSel": "string",
    "epsDat": "string",
    "neId": "string",
    "epsFlag": "string",
    "epsOdb": "string",
    "hplmnOdb": "string",
    "ard": "string",
    "epstpl": "string",
    "contextId": "string",
    "apnContext": "string",
    "staticIp": "string"
  },
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 delete subscriber data

DELETE /ne/udm/sub/{neId}/{imsi}

Request Parameters

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

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 new subscriber data

POST /ne/udm/sub/{neId}

This API can add 4&5G subscriber at the same time

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
neId	path	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
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	static_ip: Refers to the static IP assigned to 4G UE. This field name is optional.

Response Examples

200 Response

{
  "code": 0,
  "data": "string",
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 subscriber data

PUT /ne/udm/sub/{neId}

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
neId	path	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
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	static_ip: Refers to the static IP assigned to 4G UE. This field name is optional.

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 subscriber data

POST /ne/udm/sub/{neId}/{num}

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
neId	path	string	yes	none
num	path	string	yes	number
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
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	static_ip: Refers to the static IP assigned to 4G UE. This field name is optional.

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 deletion

DELETE /ne/udm/sub/{neId}/{imsi}/{num}

Request Parameters

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

Response Examples

200 Response

{
  "code": 0,
  "data": "string",
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 import subsriber data file

POST /ne/udm/sub/export

Body Parameters

{
  "neId": "string",
  "type": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» neId	body	string	yes		none
» type	body	string	yes	csv txt	none

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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}

Request Parameters

Name	Location	Type	Required	Description
neId	path	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

Response Examples

Success

{
  "code": 200,
  "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": "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": "Position management",
            "hide": false,
            "cache": true,
            "target": null
          }
        }
      ]
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none	Route data	none
»» name	string	true	none	Route name	none
»» path	string	true	none	Route path	none
»» component	string	true	none	Component
»» meta	object	true	none	Metadata	none
»»» icon	string	true	none	Menu icon	none
»»» title	string	true	none	Menu title	none
»»» hide	boolean	true	none	Whether to hide	Default false
»»» cache	boolean	true	none	Is cached	Default false
»»» target	string¦null	true	none	link behavior
»» redirect	string	false	none	directory redirection	none
»» children	[object]	false	none	Sub-menu	none
»»» name	string	true	none		none
»»» path	string	true	none		none
»»» component	string	true	none		none
»»» meta	object	true	none	Metadata	none
»»»» icon	string	true	none		none
»»»» title	string	true	none	Title	none
»»»» hide	boolean	true	none		none
»»»» cache	boolean	true	none		none
»»»» target	string¦null	true	none		none

POST import subscirber data file

POST /ne/udm/sub/import

Body Parameters

neId: "002"
file: string

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» neId	body	string	yes	none
» file	body	string(binary)	yes	none

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 list

GET /ne/udm/sub/list

Request Parameters

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

Response Examples

200 Response

{
  "code": 0,
  "msg": "string",
  "rows": [
    {
      "id": "string",
      "msisdn": "string",
      "imsi": "string",
      "ambr": "string",
      "nssai": "string",
      "rat": "string",
      "arfb": "string",
      "sar": "string",
      "cn": "string",
      "smData": "string",
      "smfSel": "string",
      "epsDat": "string",
      "neId": "string",
      "epsFlag": "string",
      "epsOdb": "string",
      "hplmnOdb": "string",
      "ard": "string",
      "epstpl": "string",
      "contextId": "string",
      "apnContext": "string",
      "staticIp": "string"
    }
  ],
  "total": 0
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

Request Parameters

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

Response Examples

200 Response

{
  "code": 0,
  "msg": "string",
  "rows": [
    {
      "id": "string",
      "imsi": "string",
      "amf": "string",
      "status": "string",
      "ki": "string",
      "algoIndex": "string",
      "opc": "string",
      "neId": "string"
    }
  ],
  "total": 0
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 authentication data

GET /ne/udm/auth/{neId}/{imsi}

Request Parameters

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

Response Examples

200 Response

{
  "code": 0,
  "data": {
    "id": "string",
    "imsi": "string",
    "amf": "string",
    "status": "string",
    "ki": "string",
    "algoIndex": "string",
    "opc": "string",
    "neId": "string"
  },
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 authentication data

DELETE /ne/udm/auth/{neId}/{imsi}

Request Parameters

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

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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/auth/resetData/{neId}

Request Parameters

Name	Location	Type	Required	Description
neId	path	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

Response Examples

Success

{
  "code": 1,
  "data": 37981,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 authentication data

POST /ne/udm/auth/{neId}

Body Parameters

{
  "algoIndex": "string",
  "amf": "string",
  "imsi": "string",
  "ki": "string",
  "opc": "string"
}

Request Parameters

Name	Location	Type	Required	Description
neId	path	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
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

200 Response

{
  "code": 0,
  "data": "string",
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 authentication data

PUT /ne/udm/auth/{neId}

Body Parameters

{
  "algoIndex": "string",
  "amf": "string",
  "imsi": "string",
  "ki": "string",
  "opc": "string"
}

Request Parameters

Name	Location	Type	Required	Description
neId	path	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
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

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 authentication data

POST /ne/udm/auth/{neId}/{num}

Body Parameters

{
  "algoIndex": "string",
  "amf": "string",
  "imsi": "string",
  "ki": "string",
  "opc": "string"
}

Request Parameters

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

200 Response

{
  "code": 0,
  "data": "string",
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE batch delete authentication data

DELETE /ne/udm/auth/{neId}/{imsi}/{num}

Request Parameters

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

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 export authentication data file

POST /ne/udm/auth/export

Body Parameters

{
  "neId": "string",
  "type": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» neId	body	string	yes		none
» type	body	string	yes	csv txt	none

Response Examples

Success

{
  "code": 1,
  "data": 2021,
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 authentication data file

POST /ne/udm/auth/import

Body Parameters

neId: "002"
file: string

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» neId	body	string	yes	none
» file	body	string(binary)	yes	none

Response Examples

200 Response

{
  "code": 0,
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

UE Management/PCF User PCC Rules

GET Query PCF UE Info

GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo

Request Parameters

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

Response Examples

Success

{
  "data": [
    {
      "msisdn": "12307550237",
      "pccRules": "internet",
      "rfsp": 0,
      "sessRules": "internet"
    },
    {
      "msisdn": "12307550238",
      "pccRules": "internet|ims_sig",
      "rfsp": 0,
      "sessRules": "internet|ims_sig"
    }
  ]
}

{
  "data": [
    {
      "msisdn": "12307550237",
      "pccRules": "internet",
      "rfsp": 0,
      "sessRules": "internet"
    },
    {
      "msisdn": "12307550238",
      "pccRules": "internet|ims_sig",
      "rfsp": 0,
      "sessRules": "internet|ims_sig"
    }
  ]
}

{
  "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	Success	Inline

Responses Data Schema

POST Add PCF UE Info

POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
neId	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT Modify PCF UE Info

PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo

Body Parameters

{
  "imsi": "000510200000001",
  "msisdn": "1350000001",
  "rfsp": "omitempty",
  "sar": "",
  "pccRules": "",
  "sessRules": "",
  "uePolicy": "",
  "qosAudio": "",
  "qosVideo": "",
  "hdrEnrich": ""
}

Request Parameters

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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Delete PCF UE Info

DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo

Request Parameters

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

Response Examples

Record Not Found

{
  "cause": "DATA_NOT_FOUND",
  "status": 404
}

Responses

HTTP Status Code	Meaning	Description	Data schema
404	Not Found	Record Not Found	Inline

Responses Data Schema

HTTP Status Code 404

Name	Type	Required	Restrictions	Title	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/{number}

Body Parameters

{
  "imsi": "000510200000001",
  "msisdn": "1350000001",
  "rfsp": "omitempty",
  "sar": "",
  "pccRules": "",
  "sessRules": "",
  "uePolicy": "",
  "qosAudio": "",
  "qosVideo": "",
  "hdrEnrich": ""
}

Request Parameters

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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Batch Delete PCF UE Info

DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/number

Body Parameters

{
  "imsi": "000510200000001",
  "msisdn": "1350000001",
  "rfsp": "omitempty",
  "sar": "",
  "pccRules": "",
  "sessRules": "",
  "uePolicy": "",
  "qosAudio": "",
  "qosVideo": "",
  "hdrEnrich": ""
}

Request Parameters

Name	Location	Type	Required	Description
imsi	query	string	yes	none
msisdn	query	string	yes	none
neId	query	string	no	none
AccessToken	header	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

UE Management/N3IWF Online User

GET Query N3IWF UE Info

GET /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo

Request Parameters

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

Response Examples

OK

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

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Get UE Number from SMF

GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

UE Management/General APIs

GET query NE's type and ID

GET /ne/info

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST files to the NE

POST /ne/action/pushFile

Body Parameters

{
  "uploadPath": "string",
  "neType": "string",
  "neId": "string"
}

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» uploadPath	body	string	yes	Upload files through the common interface to get the address
» neType	body	string	yes	NE type
» neId	body	string	yes	none

Response Examples

OK

{
  "code": 1,
  "data": "/home/agtuser/5G_cn.pdf",
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 OMC MMLs

POST /api/rest/opeartionManagement/v1/elementType/omc/objectType/mml

Body Parameters

{
  "mml": [
    "date",
    "date"
  ]
}

Request Parameters

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
body	body	object	no	none
» mml	body	[string]	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

Security/Departent info

GET Department list

GET /system/dept/list

Request Parameters

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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "deptId": "100",
      "parentId": "0",
      "ancestors": "0",
      "deptName": "-",
      "orderNum": 0,
      "leader": "-",
      "phone": "15888888888",
      "email": "xx@gmail.com",
      "status": "1",
      "delFlag": "0",
      "createBy": "Admin",
      "createTime": "1682264526241"
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none		none
»» deptId	string	true	none	Department ID	none
»» parentId	string	true	none	Parent ID	none
»» ancestors	string	true	none	ancestor list	none
»» deptName	string	true	none	Department name	none
»» orderNum	integer	true	none	Menu sort	none
»» leader	string	true	none	principal	none
»» phone	string	true	none	contact number	none
»» email	string	true	none	Mail	none
»» status	string	true	none	Department status	0 Inactive 1 Active
»» delFlag	string	true	none	delete flag	0 No 1 Yes
»» createBy	string	true	none		none
»» createTime	string	true	none		none

GETDepartment list (exclude nodes)

GET /system/dept/list/exclude/{deptId}

Request Parameters

Name	Location	Type	Required	Description
deptId	path	string	yes	Department ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "deptId": "100",
      "parentId": "0",
      "ancestors": "0",
      "deptName": "-",
      "orderNum": 0,
      "leader": "-",
      "phone": "15888888888",
      "email": "-@gmail.com",
      "status": "1",
      "delFlag": "0",
      "createBy": "Admin",
      "createTime": "1682264526241"
    },

  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none		none
»» deptId	string	true	none	Department ID	none
»» parentId	string	true	none	Parent ID	none
»» ancestors	string	true	none	ancestor list	none
»» deptName	string	true	none	Department name	none
»» orderNum	integer	true	none	Menu sort	none
»» leader	string	true	none	principal	none
»» phone	string	true	none	contact number	none
»» email	string	true	none	Mail	none
»» status	string	true	none	Department status	0 Inactive 1 Active
»» delFlag	string	true	none	delete flag	0 No 1 Yes
»» createBy	string	true	none		none
»» createTime	string	true	none		none

GET Department tree structure list

GET /system/dept/treeSelect

Request Parameters

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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "id": "100",
      "label": "-",
      "children": [
        {
          "id": "101",
          "label": "-",
          "children": [
            {
              "id": "103",
              "label": "R&D",
              "children": []
            }
          ]
        },
      ]
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
»» id	string	true	none	none
»» label	string	true	none	none
»» children	[object]	true	none	none
»»» id	string	true	none	none
»»» label	string	true	none	none
»»» children	[object]	false	none	none

GET Department tree structure list (specified roles)

GET /system/dept/roleDeptTreeSelect/{roleId}

Request Parameters

Name	Location	Type	Required	Description
roleId	path	string	yes	Role ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "depts": [
    {
      "id": "100",
      "label": "-",
      "children": [
        {
          "id": "101",
          "label": "-",
          "children": [
            {
              "id": "103",
              "label": "R&D",
              "children": []
            },
         ]
        },
      ]
    }
  ],
  "checkedKeys": []
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object	true	none		none
»» depts	[object]	true	none	Department node	none
»»» id	string	true	none	ID	none
»»» label	string	true	none	Name	none
»»» children	[object]	true	none	child node	none
»»»» id	string	false	none	ID	none
»»»» label	string	false	none	Name	none
»»»» children	[object]	false	none	child node	none
»» checkedKeys	[object]	true	none	Array of selected IDs	none

POST department add

POST /system/dept

Body Parameters

{
  "orderNum": 0,
  "deptName": "string",
  "leader": "string",
  "phone": "string",
  "email": "string",
  "status": "string",
  "parentId": "string",
  "parentName": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» orderNum	body	integer	yes	Menu sort	none
» deptName	body	string	yes	Department name	none
» leader	body	string	yes	principal	none
» phone	body	string	yes	contact number	none
» email	body	string	yes	Mail	none
» status	body	string	yes	Department status	0 Inactive 1 Active
» parentId	body	string	yes	Parent ID	0 is the root node
» parentName	body	string	no	Parent department name	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Failed to add [xxx] to department, department name already exists"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Department modification

PUT /system/dept

Body Parameters

{
  "orderNum": 0,
  "deptName": "string",
  "leader": "string",
  "phone": "string",
  "email": "string",
  "status": "string",
  "parentId": "string",
  "parentName": "string",
  "deptId": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» orderNum	body	integer	yes	Menu sort	none
» deptName	body	string	yes	Department name	none
» leader	body	string	yes	principal	none
» phone	body	string	yes	contact number	none
» email	body	string	yes	Mail	none
» status	body	string	yes	Department status	0 Inactive 1 Active
» parentId	body	string	yes	Parent ID	none
» parentName	body	string	no	Parent department name	none
» deptId	body	string	yes	Department ID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access department data"
}

{
  "code": 500,
  "msg": "Department modification [xxx] failed, the superior department cannot be myself"
}

{
  "code": 500,
  "msg": "This department contains sub-departments that are not deactivated!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Department deletion

DELETE /system/dept/{deptId}

Request Parameters

Name	Location	Type	Required	Description
deptId	path	string	yes	Department ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access department data"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

GET Departent info

GET /system/dept/{deptId}

Request Parameters

Name	Location	Type	Required	Description
deptId	path	string	yes	Department ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "deptId": "109",
    "parentId": "102",
    "ancestors": "0,100,102",
    "deptName": "financial department",
    "orderNum": 2,
    "leader": "-",
    "phone": "15888888888",
    "email": "@gmail.com",
    "status": "1",
    "parentName": ""
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object¦null	true	none		none
»» deptId	string	true	none	Department ID	none
»» parentId	string	true	none	Parent ID	none
»» ancestors	string	true	none	ancestor list	none
»» deptName	string	true	none	Department name	none
»» orderNum	integer	true	none	Menu sort	none
»» leader	string	true	none	principal	none
»» phone	string	true	none	contact number	none
»» email	string	true	none	Mail	none
»» status	string	true	none	Department status	0 Inactive 1 Active
»» parentName	string	true	none	Parent department name	none

Security/Postion Info

GET Postion list

GET /system/post/list

Request Parameters

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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 4,
  "rows": [
    {
      "postId": "1",
      "postCode": "SE",
      "postName": "System  Engineer",
      "postSort": 1,
      "status": "1",
      "createBy": "Admin",
      "createTime": "1682264526344",
      "remark": ""
    },
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» total	integer	true	none		none
» rows	[object]	true	none		none
»» postId	string	true	none	Postion ID	none
»» postCode	string	true	none	Code	none
»» postName	string	true	none	Name	none
»» postSort	integer	true	none	Sort	none
»» status	string	true	none	Status	none
»» createBy	string	true	none		none
»» createTime	string	true	none		none
»» remark	string	true	none	Remark	none

POST Export Position List

POST /system/post/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=post_export_16_1684133344353.xlsx
content-length: 19438
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "configName": "string",
  "postCode": "string",
  "status": "string",
  "pageNum": 0,
  "pageSize": 0
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» configName	body	string	no	Position name	none
» postCode	body	string	no	Position code	none
» status	body	string	no	Status	0 Inactive 1 Active
» pageNum	body	number	yes	Number of pages, default 1	none
» pageSize	body	number	yes	Number of records on a single page, default 10	none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

GET Position Details

GET /system/post/{postId}

Request Parameters

Name	Location	Type	Required	Description
postId	path	string	yes	Postion ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "postId": "1",
    "postCode": "se",
    "postName": "System Engineer",
    "postSort": 1,
    "status": "1",
    "createBy": "Admin",
    "createTime": "1682264526344",
    "remark": ""
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object¦null	true	none		none
»» postId	string	true	none	Postion ID	none
»» postCode	string	true	none	Code	none
»» postName	string	true	none	Name	none
»» postSort	integer	true	none	Sort	none
»» status	string	true	none	Status	none
»» createBy	string	true	none		none
»» createTime	string	true	none		none
»» remark	string	true	none	Remark	none

POST New postion

POST /system/post

Body Parameters

{
  "postCode": "string",
  "postName": "string",
  "postSort": "string",
  "phone": "string",
  "remark": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» postCode	body	string	yes	Position code	none
» postName	body	string	yes	Position name	none
» postSort	body	string	yes	Sort	none
» phone	body	string	yes	Status	0 Inactive 1 Active
» remark	body	string	yes	Remark	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Failed to add [xxx] to the position, the position name already exists"
}

{
  "code": 500,
  "msg": "Failed to add [xxx] to the position, the position code already exists"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Position modification

PUT /system/post

Body Parameters

{
  "postCode": "string",
  "postName": "string",
  "postSort": "string",
  "phone": "string",
  "remark": "string",
  "postId": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» postCode	body	string	yes	Position code	none
» postName	body	string	yes	Position name	none
» postSort	body	string	yes	Sort	none
» phone	body	string	yes	Status	0 Inactive 1 Active
» remark	body	string	yes	Remark	none
» postId	body	string	yes	Postion ID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Position modification [xxx] failed, the position name already exists"
}

{
  "code": 500,
  "msg": "Position modification [xxx] failed, the position code already exists"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Position deletation

DELETE /system/post/{postIds}

Request Parameters

Name	Location	Type	Required	Description
postIds	path	string	yes	Position ID, separated by commas
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access job data!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

Security/User information

GET User basic information

GET /system/user/profile

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "user": {
      "roles": [
        {
          "roleId": "1",
          "roleName": "Admin",
          "roleKey": "admin",
          "roleSort": 1,
          "dataScope": "1",
          "status": "1"
        }
      ],
      "userId": "1",
      "deptId": "103",
      "userName": "Admin",
      "nickName": "Admin",
      "userType": "sys",
      "email": "",
      "avatar": "",
      "phonenumber": "",
      "sex": "1",
      "status": "1",
      "delFlag": "0",
      "loginIp": "127.0.0.1",
      "loginDate": "1683968355811",
      "createBy": "Admin",
      "createTime": "1682264526306",
      "remark": "Admin",
      "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	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	object	true	none	User info	none
»» user	object	true	none	User info	none
»»» roles	[object]	true	none	Role info	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	Position	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
»» roleGroup	[string]	true	none	Role	character array
»» postGroup	[string]	true	none	Position	character array

PUT Basic information modification

PUT /system/user/profile

Body Parameters

{
  "nickName": "Simon",
  "sex": "1",
  "phonenumber": "18169338391",
  "email": "xx@gmail.com"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» nickName	body	string	yes	Nick name	none
» email	body	string	no	Mail	none
» phonenumber	body	string	no	Mobile phone	none
» sex	body	string	yes	Gender	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Failed to modify user [xxxx], the mobile phone number format is wrong"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

POST Modify avatar

POST /system/user/profile/avatar

Body Parameters

file: string

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» file	body	string(binary)	yes	Please choose a proportional picture as the avatar, such as 200x200, 400x400

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": "/upload/avatar/2023/04/11.png"
}

{
  "code": 500,
  "msg": "The uploaded file type is not supported, only the following types are supported: jpg, jpeg, png"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	string	true	none	The image's address	none

PUT change Password

PUT /system/user/profile/updatePwd

Body Parameters

{
  "oldPassword": "admin@1234",
  "newPassword": "Admin@1234"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» oldPassword	body	string	yes	old password	none
» newPassword	body	string	yes	new password	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "The new password cannot be the same as the old password"
}

{
  "code": 500,
  "msg": "Failed to change password, old password is wrong"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

Security/Role info

GET Role information list

GET /system/role/list

Request Parameters

Name	Location	Type	Required	Description
roleName	query	string	no	Role name
roleKey	query	string	no	permission characters
status	query	string	no	Status 0 Inactive 1 Active
beginTime	query	string	no	Creation time-start
endTime	query	string	no	Creation time-end
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 2,
  "rows": [
    {
      "roleId": "1",
      "roleName": "Admin",
      "roleKey": "admin",
      "roleSort": 1,
      "dataScope": "1",
      "menuCheckStrictly": "1",
      "deptCheckStrictly": "1",
      "status": "1",
      "delFlag": "0",
      "createTime": "1682264526399",
      "remark": "Admin"
    },
    {
      "roleId": "2",
      "roleName": "Common Role",
      "roleKey": "common",
      "roleSort": 2,
      "dataScope": "2",
      "menuCheckStrictly": "1",
      "deptCheckStrictly": "1",
      "status": "1",
      "delFlag": "0",
      "createTime": "1682264526404",
      "remark": "Common Role"
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» total	integer	true	none		none
» rows	[object]	true	none		none
»» roleId	string	true	none	Role ID	none
»» roleName	string	true	none	Name	none
»» roleKey	string	true	none	Key	none
»» roleSort	integer	true	none	Sort	none
»» dataScope	string	true	none	data range
»» menuCheckStrictly	string	true	none
»» deptCheckStrictly	string	true	none
»» status	string	true	none	Role status	0 Inactive 1 Active
»» delFlag	string	true	none	delete flag	0 No 1 Yes
»» createTime	string	true	none		none
»» remark	string	true	none	Remark	none

GET Role assignment user list

GET /system/role/authUser/allocatedList

Request Parameters

Name	Location	Type	Required	Description
userName	query	string	no	User name
phonenumber	query	string	no
status	query	string	no
roleId	query	string	yes	Role ID
allocated	query	string	yes
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	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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 1,
  "rows": [
    {
      "roles": [],
      "userId": "2",
      "deptId": "105",
      "userName": "User",
      "nickName": "User",
      "email": "user@gmail.com",
      "phonenumber": "13412341234",
      "status": "1",
      "createTime": "1682264526309",
      "dept": {
        "deptId": "105",
        "deptName": "Test department"
      }
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» total	integer	true	none		none
» rows	[object]	true	none		none
»» status	string	false	none	Role status	0 Inactive 1 Active
»» createTime	string	false	none	Create time	none
»» roles	[string]	false	none	Role ID array	none
»» userId	string	false	none	User ID	none
»» deptId	string	false	none	Department ID	none
»» userName	string	false	none	User name	none
»» nickName	string	false	none	Nick name	none
»» email	string	false	none	Mail	none
»» phonenumber	string	false	none		none
»» dept	object	false	none	Departent info	none
»»» deptId	string	false	none	Department ID	none
»»» deptName	string	false	none	Department name	none

GET role information

GET /system/role/{roleId}

Request Parameters

Name	Location	Type	Required	Description
roleId	path	string	yes	Role ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "roleId": "1",
    "roleName": "Admin",
    "roleKey": "admin",
    "roleSort": 1,
    "dataScope": "1",
    "menuCheckStrictly": "1",
    "deptCheckStrictly": "1",
    "status": "1",
    "delFlag": "0",
    "createTime": "1682264526399",
    "remark": "Admin"
  }
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object	true	none		none
»» roleId	string	true	none	Role ID	none
»» roleName	string	true	none	Name	none
»» roleKey	string	true	none	Key	none
»» roleSort	integer	true	none	Sort	none
»» dataScope	string	true	none	data range
»» menuCheckStrictly	string	true	none
»» deptCheckStrictly	string	true	none
»» status	string	true	none	Role status	0 Inactive 1 Active
»» delFlag	string	true	none	delete flag	0 No 1 Yes
»» createTime	string	true	none		none
»» remark	string	true	none	Remark	none

PUT Role information modification

PUT /system/role

Body Parameters

{
  "roleName": "string",
  "roleKey": "string",
  "roleSort": 0,
  "status": "string",
  "remark": "string",
  "dataScope": "string",
  "menuCheckStrictly": "string",
  "menuIds": [
    "string"
  ],
  "roleId": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» roleName	body	string	yes	Name	none
» roleKey	body	string	yes	Key	none
» roleSort	body	integer	yes	Sort	none
» status	body	string	yes	Role status	0 Inactive 1 Active
» remark	body	string	yes	Remark	none
» dataScope	body	string	yes	data range
» menuCheckStrictly	body	string	yes
» menuIds	body	[string]	yes
» roleId	body	string	yes	Role ID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Modify Role [xxx] failed, the role name already exists"
}

{
  "code": 500,
  "msg": "Modify Role [xxxx] failed, the permission key value already exists"
}

{
  "code": 500,
  "msg": "No permission to access character data!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

POST role information add

POST /system/role

Body Parameters

{
  "roleName": "string",
  "roleKey": "string",
  "roleSort": 0,
  "status": "string",
  "remark": "string",
  "dataScope": "string",
  "menuCheckStrictly": "string",
  "menuIds": [
    "string"
  ]
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» roleName	body	string	yes	Name	none
» roleKey	body	string	yes	Key	none
» roleSort	body	integer	yes	Sort	none
» status	body	string	yes	Role status	0 Inactive 1 Active
» remark	body	string	yes	Remark	none
» dataScope	body	string	yes	data range
» menuCheckStrictly	body	string	yes
» menuIds	body	[string]	yes

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Add Role[xxxx] failed, role name already exists"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE role information delete

DELETE /system/role/{roleIds}

Request Parameters

Name	Location	Type	Required	Description
roleIds	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access character data!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT role status changes

PUT /system/role/changeStatus

Body Parameters

{
  "roleId": "string",
  "status": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» roleId	body	string	yes	Role ID	none
» status	body	string	no	Status	0 Inactive 1 Active

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access character data!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Role data permission modification

PUT /system/role/dataScope

Body Parameters

{
  "dataScope": "string",
  "deptCheckStrictly": "string",
  "menuIds": [
    "string"
  ],
  "roleId": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» dataScope	body	string	yes	data range
» deptCheckStrictly	body	string	yes
» menuIds	body	[string]	no
» roleId	body	string	yes	Role ID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access character data!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

POST Role list export

POST /system/role/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=role_export_16_1684133344353.xlsx
content-length: 19438
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "roleName": "string",
  "roleKey": "string",
  "status": "string",
  "beginTime": "string",
  "endTime": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» roleName	body	string	no	Role name	none
» roleKey	body	string	no	permission characters	none
» status	body	string	no	Status	0 Inactive 1 Active
» beginTime	body	string	no	Creation time-start	none
» endTime	body	string	no	Creation time-end	none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Role assignment selection authorization

PUT /system/role/authUser/checked

Body Parameters

{
  "roleId": "string",
  "userIds": "string",
  "checked": true
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» roleId	body	string	yes	Role ID	none
» userIds	body	string	yes	User ID	Separated by commas
» checked	body	boolean	yes	Select action	ture: add false: cancel

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access character data!"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

Security/User info

POST User information list import file template download

POST /system/user/importTemplate

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=user_import_template_1684230715497.xlsx
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

200 Response

{
  "code": 0,
  "msg": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

GET User information list

GET /system/user/list

Request Parameters

Name	Location	Type	Required	Description
userName	query	string	no	User name
phonenumber	query	string	no	phone number
status	query	string	no	Status
beginTime	query	string	no	Creation time-start
endTime	query	string	no	Creation time-end
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	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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 1,
  "rows": [
    {
      "roles": [],
      "userId": "2",
      "deptId": "105",
      "nickName": "User",
      "userName": "User",
      "email": "User@gmail.com",
      "avatar": "",
      "phonenumber": "13412341234",
      "sex": "1",
      "status": "1",
      "delFlag": "0",
      "loginIp": "192.168.56.1",
      "loginDate": "1683364764238",
      "createBy": "Admin",
      "createTime": "1682264526309",
      "remark": "User",
      "dept": {
        "deptId": "105",
        "deptName": "Test department",
        "leader": "-"
      }
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» total	integer	true	none		none
» rows	[object]	true	none		none
»» roles	[string]	true	none	Role ID array	none
»» userId	string	true	none	User ID	none
»» deptId	string¦null	true	none	Department ID	none
»» nickName	string	true	none	Nick name	none
»» userName	string	true	none	User name	none
»» email	string	true	none	Mail	none
»» avatar	string	true	none	avatar	none
»» phonenumber	string	true	none	Telephone	none
»» sex	string	true	none	Gender	0Unknown 1 male 2 female
»» status	string	true	none	Status	0 Inactive 1 Active
»» delFlag	string	true	none	delete or not	0 No 1 Yes
»» loginIp	string	true	none	Login IP	none
»» loginDate	string	true	none	Login time	none
»» createBy	string	true	none	Create by	none
»» createTime	string	true	none	Create time	none
»» remark	string¦null	true	none	Remark	none
»» dept	object	true	none	Departent info	none
»»» deptId	string¦null	true	none	Department ID	none
»»» deptName	string¦null	true	none	Department name	none
»»» leader	string¦null	true	none	principal	none

GET User information details

GET /system/user/{userId}

Request Parameters

Name	Location	Type	Required	Description
userId	path	string	yes	User ID, add 0
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "user": {
      "roles": [
        {
          "roleId": "2",
          "roleName": "Common Role",
          "roleKey": "common",
          "roleSort": 2,
          "dataScope": "2",
          "status": "1"
        }
      ],
      "userId": "2",
      "deptId": "105",
      "userName": "User",
      "nickName": "User",
      "userType": "sys",
      "email": "User@gmail.com",
      "avatar": "",
      "phonenumber": "13412341234",
      "sex": "1",
      "status": "1",
      "delFlag": "0",
      "loginIp": "192.168.56.1",
      "loginDate": "1683364764238",
      "createBy": "Admin",
      "createTime": "1682264526309",
      "remark": "User",
      "dept": {
        "deptId": "105",
        "parentId": "101",
        "ancestors": "0,100,101",
        "deptName": "Test department",
        "orderNum": 3,
        "leader": "-",
        "status": "1"
      }
    },
    "roleIds": [
      "2"
    ],
    "postIds": [
      "2"
    ],
    "roles": [
      {
        "roleId": "2",
        "roleName": "General Role",
        "roleKey": "common",
        "roleSort": 2,
        "dataScope": "2",
        "menuCheckStrictly": "1",
        "deptCheckStrictly": "1",
        "status": "1",
        "delFlag": "0",
        "createTime": "1682264526404",
        "remark": "General Role"
      }
    ],
    "posts": [
      {
        "postId": "1",
        "postCode": "ceo",
        "postName": "CEO",
        "postSort": 1,
        "status": "1",
        "createBy": "Admin",
        "createTime": "1682264526344",
        "remark": ""
      },

      {
        "postId": "4",
        "postCode": "employee",
        "postName": "General employee",
        "postSort": 4,
        "status": "1",
        "createBy": "Admin",
        "createTime": "1682264526358",
        "remark": ""
      }
    ]
  }
}

{
  "code": 200,
  "msg": "Success",
  "data": {
    "user": {},
    "roleIds": [],
    "postIds": [],
    "roles": [
      {
        "roleId": "2",
        "roleName": "Common Role",
        "roleKey": "common",
        "roleSort": 2,
        "dataScope": "2",
        "menuCheckStrictly": "1",
        "deptCheckStrictly": "1",
        "status": "1",
        "delFlag": "0",
        "createTime": "1682264526404",
        "remark": "Common Role"
      }
    ],
    "posts": [
      {
        "postId": "1",
        "postCode": "pm",
        "postName": "Product manager",
        "postSort": 1,
        "status": "1",
        "createBy": "Admin",
        "createTime": "1682264526344",
        "remark": ""
      },
      {
        "postId": "2",
        "postCode": "se",
        "postName": "System engineer",
        "postSort": 2,
        "status": "1",
        "createBy": "Admin",
        "createTime": "1682264526348",
        "remark": ""
      }
    ]
  }
}

{
  "code": 500,
  "msg": "No permission to access user data"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object¦null	true	none		none
»» user	object	true	none	User info	none
»»» roles	[object]	true	none	Role info	none
»»»» roleId	string	false	none	Role ID	none
»»»» roleName	string	false	none	Name	none
»»»» roleKey	string	false	none	Key	none
»»»» roleSort	integer	false	none	Sort	none
»»»» dataScope	string	false	none	data range
»»»» status	string	false	none	Role status	0 Inactive 1 Active
»»» userId	string	true	none	User ID	none
»»» deptId	string¦null	true	none	Department ID	none
»»» userName	string	true	none	User name	none
»»» nickName	string	true	none	Nick name	none
»»» email	string	true	none	Mail	none
»»» avatar	string	true	none	avatar	none
»»» phonenumber	string	true	none	Telephone	none
»»» sex	string	true	none	Gender	0 Unknown 1 male 2 female
»»» status	string	true	none	Status	0 Inactive 1 Active
»»» delFlag	string	true	none	delete or not	0 No 1 Yes
»»» loginIp	string	true	none	LoginIP	none
»»» loginDate	string	true	none	Login time	none
»»» createBy	string	true	none	Create by	none
»»» createTime	string	true	none	Create time	none
»»» remark	string¦null	true	none	Remark	none
»»» dept	object	true	none	Departent info	none
»»»» deptId	string	true	none	Department ID	none
»»»» parentId	string	true	none	Parent ID	none
»»»» ancestors	string	true	none	ancestor list	none
»»»» deptName	string	true	none	Department name	none
»»»» orderNum	integer	true	none	Menu sort	none
»»»» leader	string	true	none	principal	none
»»»» status	string	true	none	Department status	0 Inactive 1 Active
»»»» phone	string	false	none	contact number	none
»»»» email	string	false	none	Mail	none
»» roleIds	[string]	true	none		none
»» postIds	[string]	true	none		none
»» roles	[object]	true	none		none
»»» roleId	string	true	none	Role ID	none
»»» roleName	string	true	none	Name	none
»»» roleKey	string	true	none	Key	none
»»» roleSort	integer	true	none	Sort	none
»»» dataScope	string	true	none	data range
»»» menuCheckStrictly	string	true	none
»»» deptCheckStrictly	string	true	none
»»» status	string	true	none	Role status	0 Inactive 1 Active
»»» delFlag	string	true	none	delete flag	0 No 1 Yes
»»» createTime	string	true	none		none
»»» remark	string	true	none	Remark	none
»» posts	[object]	true	none		none
»»» postId	string	true	none	Postion ID	none
»»» postCode	string	true	none	Code	none
»»» postName	string	true	none	Name	none
»»» postSort	integer	true	none	Sort	none
»»» status	string	true	none	Status	none
»»» createBy	string	true	none		none
»»» createTime	string	true	none		none
»»» remark	string	true	none	Remark	none

POST New user information

POST /system/user

Body Parameters

{
  "postIds": [
    1,
    2,
    3,
    4
  ],
  "userName": "gijobqebs",
  "password": "123456"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» userName	body	string	yes	User name	none
» password	body	string	yes	Pasword	none
» nickName	body	string	yes	Nick name	none
» email	body	string	yes	Mail	none
» phonenumber	body	string	yes	Telephone	none
» sex	body	string	yes	Gender	0Unknown 1 male 2 female
» status	body	string	yes	Status	0 Inactive 1 Active
» remark	body	string	yes	Remark	none
» deptId	body	string	yes	Department ID	none
» roleIds	body	[string]	yes	Role ID array	none
» postIds	body	[string]	yes	post id	none
» userType	body	string	no	User type	sys: system user
» avatar	body	string	no	avatar	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

{
  "code": 500,
  "msg": "Failed to add user [xxxx], the login account already exists"
}

{
  "code": 500,
  "msg": "Failed to add user [xxxx], the mobile phone number already exists"
}

{
  "code": 500,
  "msg": "Failed to add user [xxxx], the mailbox already exists"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT Modify user information

PUT /system/user

Body Parameters

{
  "remark": "",
  "deptId": 80,
  "nickName": "simon",
  "email": "x.swtaf@oypeubb.tg",
  "phonenumber": "3224224",
  "sex": "1",
  "status": "1",
  "roleIds": [
    2
  ],
  "postIds": [
    2
  ],
  "userId": "101",
  "userName": "x34bvpi"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» userId	body	string	yes	User ID	none
» userName	body	string	yes	User name	none
» nickName	body	string	yes	Nick name	none
» email	body	string	yes	Mail	none
» phonenumber	body	string	yes	Telephone	none
» sex	body	string	yes	Gender	0Unknown 1 male 2 female
» status	body	string	yes	Status	0 Inactive 1 Active
» remark	body	string	yes	Remark	none
» deptId	body	string	yes	Department ID	none
» roleIds	body	[string]	yes	Role ID array	none
» postIds	body	[string]	yes		none
» userType	body	string	no
» avatar	body	string	no	avatar	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

{
  "code": 500,
  "msg": "Failed to modify user [xxx], the mobile phone number already exists"
}

{
  "code": 500,
  "msg": "Failed to modify user [xxx], the login account already exists"
}

{
  "code": 500,
  "msg": "Failed to modify user [xxx], the mailbox already exists"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

POST Export user information list

POST /system/user/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=user_export_11_1684230271701.xlsx
content-length: 21499
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "userName": "string",
  "phonenumber": "string",
  "status": "string",
  "beginTime": "string",
  "endTime": "string",
  "deptId": "string",
  "pageNum": 0,
  "pageSize": 0
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» userName	body	string	no	User name	none
» phonenumber	body	string	no	phone number	none
» status	body	string	no	Status	0 Inactive 1 Active
» beginTime	body	string	no	Create start time	none
» endTime	body	string	no	Creation end time	none
» deptId	body	string	no	Department ID	none
» pageNum	body	number	yes	Number of pages, default 1	none
» pageSize	body	number	yes	Number of records on a single page, default 10	none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

POST User information list import file

POST /system/user/importData

Body Parameters

file: []
updateSupport: "{% mock 'pick' , ['false','true'] %}"

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» file	body	string(binary)	no
» updateSupport	body	string	no

Response Examples

Success

{
  "code": 200,
  "msg": ""
}

{
  "code": 200,
  "msg": ""
}

{
  "code": 200,
  "msg": ""
}

{
  "code": 500,
  "msg": "fail"
}

{
  "code": 500,
  "msg": ""
}

{
  "code": 500,
  "msg": ""
}

{
  "code": 500,
  "msg": "The uploaded file type is not supported, only the following types are supported: xls, xlsx"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE User information deletion

DELETE /system/user/{userIds}

Request Parameters

Name	Location	Type	Required	Description
userIds	path	string	yes	User ID, separated by commas
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access user data！"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT reset user password

PUT /system/user/resetPwd

Body Parameters

{
  "password": "string",
  "userId": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» password	body	string	yes	Password	none
» userId	body	string	yes	User ID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access user data！"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT User status modification

PUT /system/user/changeStatus

Body Parameters

{
  "status": "string",
  "userId": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» status	body	string	yes	Status	0 Inactive 1 Active
» userId	body	string	yes	User ID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "No permission to access user data！"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/cache information

GET cache information

GET /monitor/cache

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "info": {
      "server": {
        "redis_version": "7.0.5",
        "redis_git_sha1": "00000000",
        "redis_git_dirty": "0",
        "redis_build_id": "aab17434977410f1",
        "redis_mode": "standalone",
        "os": "Linux 5.4.0-137-generic x86_64",
        "arch_bits": "64",
        "monotonic_clock": "POSIX clock_gettime",
        "multiplexing_api": "epoll",
        "atomicvar_api": "c11-builtin",
        "gcc_version": "10.2.1",
        "process_id": "1",
        "process_supervised": "no",
        "run_id": "94ee88d0059383b5c1a29d292dbdcb228022c001",
        "tcp_port": "6379",
        "server_time_usec": "1683985833118338",
        "uptime_in_seconds": "25513",
        "uptime_in_days": "0",
        "hz": "10",
        "configured_hz": "10",
        "lru_clock": "6264233",
        "executable": "/data/redis-server",
        "config_file": "/etc/redis/redis.conf",
        "io_threads_active": "0"
      },
      "clients": {
        "connected_clients": "11",
        "cluster_connections": "0",
        "maxclients": "10000",
        "client_recent_max_input_buffer": "20565",
        "client_recent_max_output_buffer": "0",
        "blocked_clients": "3",
        "tracking_clients": "0",
        "clients_in_timeout_table": "3"
      },
    ]
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	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	CPU	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 Cache name list

GET /monitor/cache/getNames

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": [
    {
      "cacheName": "login_tokens",
      "cacheKey": "",
      "cacheValue": "",
      "remark": "User Info"
    },
    {
      "cacheName": "sys_config",
      "cacheKey": "",
      "cacheValue": "",
      "remark": "Configuration information"
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none		none
»» cacheName	string	true	none		none
»» cacheKey	string	true	none
»» cacheValue	string	true	none
»» remark	string	true	none	Remark	none

GET List of key names under cache name

GET /monitor/cache/getKeys/{cacheName}

Request Parameters

Name	Location	Type	Required	Description
cacheName	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "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": ""
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none		none
»» cacheName	string	true	none	Cache name
»» cacheKey	string	true	none	Cache key	none
»» cacheValue	string	true	none	cache content
»» remark	string	true	none	Remark

GET cache content

GET /monitor/cache/getValue/{cacheName}/{cacheKey}

Request Parameters

Name	Location	Type	Required	Description
cacheName	path	string	yes
cacheKey	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "cacheName": "sys_config",
    "cacheKey": "sys.account.captchaType",
    "cacheValue": "math",
    "remark": ""
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object	true	none		none
»» cacheName	string	true	none	Cache name
»» cacheKey	string	true	none	Cache name
»» cacheValue	string	true	none	cache content	none
»» remark	string	true	none	Remark

DELETE delete cache key

DELETE /monitor/cache/clearCacheKey/{cacheName}/{cacheKey}

Request Parameters

Name	Location	Type	Required	Description
cacheName	path	string	yes
cacheKey	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE delete list of key names under cache name

DELETE /monitor/cache/clearCacheName/{cacheName}

Request Parameters

Name	Location	Type	Required	Description
cacheName	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Safely clear cached names

DELETE /monitor/cache/clearCacheSafe

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/Scheduling task log information

POST Scheduled task log list export

POST /monitor/jobLog/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx
content-length: 17079
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "jobName": "string",
  "jobGroup": "string",
  "status": "string",
  "pageNum": 0,
  "pageSize": 0,
  "beginTime": "string",
  "endTime": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» jobName	body	string	no		none
» jobGroup	body	string	no		none
» status	body	string	no		none
» pageNum	body	number	no	Number of pages, default 1	none
» pageSize	body	number	no	Number of records on a single page, default 10	none
» beginTime	body	string	no		none
» endTime	body	string	no		none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

GET Scheduled task log list export

GET /monitor/jobLog/list

Request Parameters

Name	Location	Type	Required	Description
jobName	query	string	no
jobGroup	query	string	no
status	query	string	no
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	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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 4,
  "rows": [
    {
      "jobLogId": "4",
      "jobName": "2-20 characters",
      "jobGroup": "DEFAULT",
      "invokeTarget": "test",
      "targetParams": "{\"a\":1,\"b\":1}",
      "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}",
      "status": "1",
      "createTime": "1684056232934"
    },
    {
      "jobLogId": "3",
      "jobName": "2-20 characters",
      "jobGroup": "DEFAULT",
      "invokeTarget": "test",
      "targetParams": "{\"a\":1,\"b\":1}",
      "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}",
      "status": "1",
      "createTime": "1684056199482"
    },
    {
      "jobLogId": "2",
      "jobName": "2-20 characters",
      "jobGroup": "DEFAULT",
      "invokeTarget": "test",
      "targetParams": "{\"a\":1,\"b\":1}",
      "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}",
      "status": "1",
      "createTime": "1684056090490"
    },
    {
      "jobLogId": "1",
      "jobName": "Abnormal execution",
      "jobGroup": "SYSTEM",
      "invokeTarget": "bar",
      "targetParams": "String parameters",
      "jobMsg": "{\"name\":\"Error\",\"message\":\"Error during program execution\"}",
      "status": "0",
      "createTime": "1683901320750"
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» total	integer	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	Status	none
»» createTime	string	true	none		none

GET Scheduling task log information

GET /monitor/jobLog/{jobLogId}

Request Parameters

Name	Location	Type	Required	Description
jobLogId	path	string	yes	Log ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "jobLogId": "3",
    "jobName": "2-20 characters",
    "jobGroup": "DEFAULT",
    "invokeTarget": "test",
    "targetParams": "{\"a\":1,\"b\":1}",
    "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}",
    "status": "1",
    "createTime": "1684056199482"
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	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	Status	none
»» createTime	string	true	none		none

DELETE Scheduling task log deletion

DELETE /monitor/jobLog/{jobLogIds}

Request Parameters

Name	Location	Type	Required	Description
jobLogIds	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Clear scheduled task logs

DELETE /monitor/jobLog/clean

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/Scheduling task information

POST Scheduled task list export

POST /monitor/job/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=job_export_6_1684058991890.xlsx
content-length: 19346
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "jobName": "string",
  "jobGroup": "string",
  "status": "string",
  "pageNum": 0,
  "pageSize": 0
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» jobName	body	string	no		none
» jobGroup	body	string	no		none
» status	body	string	no		none
» pageNum	body	number	no	Number of pages, default 1	none
» pageSize	body	number	no	Number of records on a single page, default 10	none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

GET Scheduling task list

GET /monitor/job/list

Request Parameters

Name	Location	Type	Required	Description
jobName	query	string	no
jobGroup	query	string	no
status	query	string	no
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	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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 3,
  "rows": [
    {
      "jobId": "1",
      "jobName": "trigger execution",
      "jobGroup": "SYSTEM",
      "invokeTarget": "test",
      "targetParams": "String parameters",
      "cronExpression": "0/10 * * * * ?",
      "misfirePolicy": "3",
      "concurrent": "0",
      "status": "0",
      "createBy": "Admin",
      "createTime": "1682264527348",
      "remark": ""
    },
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» total	integer	true	none		none
» rows	[object]	true	none		none
»» jobId	string	true	none		none
»» jobName	string	true	none		none
»» jobGroup	string	true	none
»» invokeTarget	string	true	none
»» targetParams	string	true	none
»» cronExpression	string	true	none
»» misfirePolicy	string	true	none
»» concurrent	string	true	none
»» status	string	true	none	Status	none
»» createBy	string	true	none		none
»» createTime	string	true	none	Create time	none
»» remark	string	true	none	Remark	none

GET Scheduling task information

GET /monitor/job/{jobId}

Request Parameters

Name	Location	Type	Required	Description
jobId	path	string	yes	Task ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "jobId": "1",
    "jobName": "trigger execution",
    "jobGroup": "SYSTEM",
    "invokeTarget": "test",
    "targetParams": "String parameters",
    "cronExpression": "0/10 * * * * ?",
    "misfirePolicy": "3",
    "concurrent": "0",
    "status": "0",
    "createBy": "Admin",
    "createTime": "1682264527348",
    "remark": ""
  }
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object¦null	true	none		none
»» jobId	string	true	none		none
»» jobName	string	true	none		none
»» jobGroup	string	true	none
»» invokeTarget	string	true	none
»» targetParams	string	true	none
»» cronExpression	string	true	none
»» misfirePolicy	string	true	none
»» concurrent	string	true	none
»» status	string	true	none	Status	none
»» createBy	string	true	none		none
»» createTime	string	true	none	Create time	none
»» remark	string	true	none	Remark	none

POST Scheduling task add

POST /monitor/job

Body Parameters

{
  "jobName": "2-20 characters",
  "invokeTarget": "test1",
  "cronExpression": "0/22 * * * * ?",
  "misfirePolicy": "3",
  "concurrent": "0",
  "jobGroup": "DEFAULT",
  "status": "ullamco minim Ut",
  "targetParams": "{\"a\":1,\"b\":1}",
  "remark": "asdf"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» jobName	body	string	yes		none
» jobGroup	body	string	yes		none
» invokeTarget	body	string	yes
» targetParams	body	string	yes
» cronExpression	body	string	yes
» misfirePolicy	body	string	yes
» concurrent	body	string	yes
» status	body	string	yes
» remark	body	string	yes	Remark	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Scheduling task add[xxx] failed, the same task name exists in the same task group"
}

{
  "code": 500,
  "msg": "Scheduling task add[xxxx] failed, Cron expression is incorrect"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Scheduling task modification

PUT /monitor/job

Body Parameters

{
  "jobName": "job1",
  "invokeTarget": "test",
  "cronExpression": "0/40 * * * * ?",
  "misfirePolicy": "3",
  "concurrent": "1",
  "jobGroup": "SYSTEM",
  "status": "0",
  "targetParams": "{\"a\":1,\"b\":1}",
  "remark": "",
  "jobId": "2"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» jobId	body	string	yes		none
» jobName	body	string	yes		none
» jobGroup	body	string	yes		none
» invokeTarget	body	string	yes
» targetParams	body	string	yes
» cronExpression	body	string	yes
» misfirePolicy	body	string	yes
» concurrent	body	string	yes
» status	body	string	yes
» remark	body	string	yes	Remark	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "Scheduling task modification [xxxx] failed, the Cron expression is incorrect"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Schedule task delete

DELETE /monitor/job/{jobIds}

Request Parameters

Name	Location	Type	Required	Description
jobIds	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Scheduling task modification status

PUT /monitor/job/changeStatus

Body Parameters

{
  "jobId": "22",
  "status": "0"
}

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» jobId	body	string	yes	none
» status	body	string	yes	0 Inactive 1 Active

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Schedule the task to be executed immediately

PUT /monitor/job/run/{jobId}

Request Parameters

Name	Location	Type	Required	Description
jobId	path	string	yes	Task ID
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Scheduling task reset refresh queue

PUT /monitor/job/resetQueueJob

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/Operation log information

GET Operation log lists

GET /monitor/operlog/list

Request Parameters

Name	Location	Type	Required	Description
title	query	string	no	Title
operName	query	string	no	Name
businessType	query	string	no	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	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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 125,
  "rows": [
    {
      "operId": "224",
      "title": "information",
      "businessType": "3",
      "method": "SysNoticeController.remove()",
      "requestMethod": "DELETE",
      "operatorType": "1",
      "operName": "Admin",
      "deptName": "R&D",
      "operUrl": "/system/notice/17",
      "operIp": "127.0.0.1",
      "operLocation": "Intranet IP",
      "operParam": "{}",
      "operMsg": "{\"code\":200,\"msg\":\"Success\"}",
      "status": "1",
      "operTime": "1684071705357"
    },

  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» 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
»» 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	Request Parameters	none
»» operMsg	string	true	none	nformation	none
»» status	string	true	none	Status	none
»» operTime	string	true	none		none
»» costTime	string	true	none		none

POST Operation log list export

POST /monitor/operlog/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx
content-length: 36500
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "title": "string",
  "operName": "string",
  "businessType": "string",
  "status": "string",
  "beginTime": "string",
  "endTime": "string",
  "pageNum": 0,
  "pageSize": 0
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
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	Number of pages, default 1	none
» pageSize	body	number	yes	Number of records on a single page, default 10	none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Clear operation log

DELETE /monitor/operlog/clean

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Operation log deletion

DELETE /monitor/operlog/{operIds}

Request Parameters

Name	Location	Type	Required	Description
operIds	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/Logged in information

GET /monitor/logininfor/list

Request Parameters

Name	Location	Type	Required	Description
ipaddr	query	string	no
userName	query	string	no	User name
status	query	string	no	0Fail 1Success
beginTime	query	string	no
endTime	query	string	no
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	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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "total": 130,
  "rows": [
    {
      "infoId": "119",
      "userName": "Admin",
      "ipaddr": "127.0.0.1",
      "loginLocation": "Intranet IP",
      "browser": "Chrome 86.0.4240.198",
      "os": "Windows 10",
      "status": "1",
      "msg": "Login Success",
      "loginTime": "1683370928996"
    },
    {
      "infoId": "118",
      "userName": "liming",
      "ipaddr": "127.0.0.1",
      "loginLocation": "Intranet IP",
      "browser": "Chrome 86.0.4240.198",
      "os": "Windows 10",
      "status": "1",
      "msg": "Logout Success",
      "loginTime": "1683370924042"
    },
    {
      "infoId": "110",
      "userName": "Admin",
      "ipaddr": "192.168.56.1",
      "loginLocation": "Intranet IP",
      "browser": "Chrome 86.0.4240.198",
      "os": "Windows 10",
      "status": "1",
      "msg": "Logout Success",
      "loginTime": "1683364727385"
    }
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
» 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	Status	0Fail 1Success
»» msg	string	true	none		none
»» loginTime	string	true	none	Login time	none

POST /monitor/logininfor/export

The file stream is Response ed normally, and the response header is as follows

content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx
content-length: 24305
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Body Parameters

{
  "ipaddr": "string",
  "userName": "string",
  "status": "string",
  "beginTime": "string",
  "endTime": "string",
  "pageNum": 0,
  "pageSize": 0
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» ipaddr	body	string	no		none
» userName	body	string	no	User name	none
» status	body	string	no		0Fail 1Success
» beginTime	body	string	no		none
» endTime	body	string	no		none
» pageNum	body	number	yes	Number of pages, default 1	none
» pageSize	body	number	yes	Number of records on a single page, default 10	none

Response Examples

Success

{
  "code": 500,
  "msg": "Export data record is empty"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE /monitor/logininfor/clean

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

PUT Logged in account unlock

PUT /monitor/logininfor/unlock/{userName}

Request Parameters

Name	Location	Type	Required	Description
userName	path	string	yes	User name
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

DELETE Logged in account delete

DELETE /monitor/logininfor/{infoIds}

Request Parameters

Name	Location	Type	Required	Description
infoIds	path	string	yes
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/Online user information

GET Online user list

GET /monitor/online/list

Request Parameters

Name	Location	Type	Required	Description
userName	query	string	no
ipaddr	query	string	no
Authorization	header	string	yes	Authorization token
Referer	header	string	yes	Referer
User-Agent	header	string	yes	User agent
Accept-Language	header	string	yes	zh_CN;q=0.9 en_US;q=0.9

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "rows": [
    {
      "tokenId": "vikufxmx625271bnddbe9t79p4pik5kv",
      "userName": "Admin",
      "ipaddr": "127.0.0.1",
      "loginLocation": "Intranet IP",
      "browser": "Unknown Unknown",
      "os": "Unknown Unknown",
      "loginTime": 1684046645462,
      "deptName": "R&D"
    },
    {
      "tokenId": "lpatqefeohnxsnjpp28radugp0bovwt1",
      "userName": "Admin",
      "ipaddr": "127.0.0.1",
      "loginLocation": "Intranet IP",
      "browser": "Chrome 86.0.4240.198",
      "os": "Windows 10",
      "loginTime": 1684046560517,
      "deptName": "R&D"
    }
  ],
  "total": 2
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
»» 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 Forced user quit

DELETE /monitor/online/{tokenId}

Request Parameters

Name	Location	Type	Required	Description
tokenId	path	string	yes	Token ID
Authorization	header	string	yes	Authorization token
Referer	header	string	no	Referer
User-Agent	header	string	yes	User agent
Accept-Language	header	string	yes	zh_CN;q=0.9 en_US;q=0.9

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "fail"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

System/Server monitoring information

GET Server information

GET /monitor/system-info

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "project": {
      "appDir": "E:\\Self\\Projects\\-_api_midwayjs",
      "env": "local",
      "name": "-_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": {
      "ether 2": "IPv4 1.251.212.178",
      "ether": "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": ""
    },
    "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\\-_api_midwayjs",
      "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\-_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\-_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\-_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	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	object	true	none		none
»» project	object	true	none	project	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	CPU	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	memory	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	network	none
»»» ether 2	string	false	none		none
»»» ether	string	false	none		none
»»» VirtualBox Host-Only Network	string	false	none		none
»»» Loopback Pseudo-Interface 1	string	false	none		none
»» time	object	true	none	time	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	system	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	disk	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 Resource loading information

GET /monitor/load

Request Parameters

Name	Location	Type	Required	Description
type	query	string	yes	all/cpu/memory/io/network
startTime	query	number	yes
endTime	query	number	yes
neType	query	string	no	NE type
neId	query	string	no
name	query	string	no
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "project": {
      "appDir": "E:\\Self\\Projects\\-_api_midwayjs",
      "env": "local",
      "name": "-_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": {
      "ether 2": "IPv4 1.251.212.178",
      "ether": "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": ""
    },
    "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\\-_api_midwayjs",
      "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\-_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\-_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\-_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	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	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	CPU	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
»»» ether 2	string	false	none		none
»»» ether	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

GET /

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": ""
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

GET verification code

GET /captchaImage

Verification code is valid for 2 minutes

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "captchaEnabled": true,
  "uuid": "os0t2l1532dhuvqv",
  "img": ""
}

{
  "code": 200,
  "msg": "Success",
  "text": "9",
  "captchaEnabled": true,
  "uuid": "s7hf2j3erfpritqy",
  "img": ""
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» code	number	true	none		none
» msg	string	true	none		none
» text	string	false	none	Verification code value
» captchaEnabled	boolean	true	none		none
» uuid	string	true	none	uuid	none
» img	string	true	none	base64	none

GET Obtain configuration information that can be exposed by the system

GET /sys-conf

Request Parameters

Name	Location	Type	Required	Title	Description
Authorization	header	string	yes		Authoirzation token
Accept-Language	header	string	yes		zh_CN;q=0.9 en_US;q=0.9

Response Examples

Success

{
  "code": 200,
  "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/authUser/:roleId",
          "component": "system/role/authUser",
          "meta": {
            "icon": "icon-pcduan",
            "title": "Assign role 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": "Position management",
            "hide": false,
            "cache": true,
            "target": null
          }
        },
      ]
    },
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none	Route data	none
»» name	string	true	none	Route name	none
»» path	string	true	none	Route path	none
»» component	string	true	none	Component
»» meta	object	true	none	Metadata	none
»»» icon	string	true	none	Menu icon	none
»»» title	string	true	none	Menu title	none
»»» hide	boolean	true	none	Whether to hide	Default false
»»» cache	boolean	true	none	Is cached	Default false
»»» target	string¦null	true	none	link behavior
»» redirect	string	false	none	directory redirection	none
»» children	[object]	false	none	Sub-menu	none
»»» name	string	true	none		none
»»» path	string	true	none		none
»»» component	string	true	none		none
»»» meta	object	true	none	Metadata	none
»»»» icon	string	true	none		none
»»»» title	string	true	none	Title	none
»»»» hide	boolean	true	none		none
»»»» cache	boolean	true	none		none
»»»» target	string¦null	true	none		none

POST shelp document

POST /helpDoc

Body Parameters

{
  "uploadPath": "string",
  "language": "string"
}

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» uploadPath	body	string	yes	none
» language	body	string	yes	none

Response Examples

Success

{
  "code": 1,
  "data": "/static/helpDoc/zh_doc.pdf",
  "msg": "success"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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

General APIs/File operations

POST upload files

POST /file/upload

Body Parameters

file: string
subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common',
  'download', 'chunk'] %}"

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» file	body	string(binary)	yes	upload files
» subPath	body	string	yes	subpath, optional range ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "url": "http://127.0.0.1:6275/upload/common/2023/05/o_iq526uqv.png",
    "fileName": "/upload/common/2023/05/o_iq526uqv.png",
    "newFileName": "o_iq526uqv.png",
    "originalFileName": "o_iq526uqv.png"
  }
}

{
  "code": 500,
  "msg": "The uploaded file type is not supported. The following types are supported:bmp,gif,jpg,jpeg,png,doc,docx,xls,xlsx,ppt,pptx,html,htm,txt,rar,zip,gz,bz2,mp4,avi,rmvb,pdf"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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
»» url	string	true	none	none
»» fileName	string	true	none	none
»» newFileName	string	true	none	none
»» originalFileName	string	true	none	none

POST file chunks check

POST /file/chunkCheck

Body Parameters

{
  "identifier": "string",
  "fileName": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» identifier	body	string	yes	Form data of directory ID	MD5(File name + file size)
» fileName	body	string	yes	Original file name	Check if the format allows uploading

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": []
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[string]	true	none	The number of the uploaded form data	none

POST file chunk upload

POST /file/chunkUpload

// upload form data of files
const formData = new FormData();
formData.append('file', chunk, 'xxx.pdf');
formData.append('index', chunksIndex);
formData.append('identifier', fileIdentifier);

Chunk is the form data of file. You need to add a suffix to the name of the uploaded file.

Body Parameters

file: string
index: "{% mock 'increment' %}"
identifier: "{% mock 'id' %}"

Request Parameters

Name	Location	Type	Required	Description
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
body	body	object	no	none
» file	body	string(binary)	yes	Data block Blob object, you need to add a suffix to the file name
» index	body	string	yes	Form data index
» identifier	body	string	yes	Form data of directory ID

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": "/upload/chunk/2023/06/identifier/index"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
206	Partial Content	Success	Inline

Responses Data Schema

HTTP Status Code 206

Name	Type	Required	Restrictions	Title	description
» code	integer	true	none		none
» msg	string	true	none		none
» data	string	true	none	Upload resource address	none

POST file chunk merge

POST /file/chunkMerge

Body Parameters

{
  "identifier": "string",
  "fileName": "string",
  "subPath": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» identifier	body	string	yes	Form data of directory ID	MD5(File name + file size)
» fileName	body	string	yes	Original file name	Check if the format allows uploading
» subPath	body	string	yes	Subpath	Optional range ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']

Response Examples

Success

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

{
  "code": 500,
  "msg": "The uploaded file type is not supported. The following types are supported.：bmp,gif,jpg,jpeg,png,doc,docx,xls,xlsx,ppt,pptx,html,htm,txt,rar,zip,gz,bz2,mp4,avi,rmvb,pdf"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[string]	true	none	none

GET download file

GET /file/download/{filePath}

The filePath parameter needs to be base64 encoded, base64 ("file storage resource path, URL relative address")

When resuming the download, you can add the range of downloaded data blocks in the request header, for example, the size of a single block is 5M. Range: bytes=0-5242879

Request Parameters

Name	Location	Type	Required	Description
filePath	path	string	yes	base64("File storage resource path, URL relative address")
Range	header	string	no	Perform breakpoint resumable data block download
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

Response Examples

file data

206 Response

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	file data	Inline
206	Partial Content	Resume data block transfer from breakpoint	Inline

Responses Data Schema

General APIs/General request

POST Hash encryption

POST /common/hash

Body Parameters

{
  "type": "string",
  "str": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» type	body	string	yes	Encryption type	'sha1'
» str	body	string	yes	Encrypted string	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": "9e9a253840ebd80b2160be621d2efc7c"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	string	true	none	none

GET multilingual processing

GET /common/i18n

Body Parameters

{
  "type": "string",
  "str": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
Accept-Language	header	string	no		en_US/zh_CN
Authorization	header	string	yes		Authoirzation token
Referer	header	string	yes		Use the specified declared Referer
User-Agent	header	string	yes		User agent
body	body	object	no		none
» type	body	string	yes	Encryption type	'sha1'
» str	body	string	yes	Encrypted string	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": "9e9a253840ebd80b2160be621d2efc7c"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	string	true	none	none

POST Hash and salt encryption

POST /common/hmac

Body Parameters

{
  "type": "string",
  "str": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» type	body	string	yes	Encryption type	'sha1'
» str	body	string	yes	Encrypted string	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": "6c44dbdf8d759c97dfd8c43a2974ba22"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	string	true	none	none

General APIs/User operation

GET user information

GET /getInfo

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "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": "Admin",
      "nickName": "Admin",
      "userType": "sys",
      "email": "",
      "avatar": "",
      "phonenumber": "",
      "sex": "1",
      "status": "1",
      "delFlag": "0",
      "loginIp": "127.0.0.1",
      "loginDate": "1683968355811",
      "createBy": "Admin",
      "createTime": "1682264526306",
      "remark": "Admin",
      "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	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	object	true	none		none
»» permissions	[string]	true	none	Permissions	character array
»» roles	[string]	true	none	Role	character array
»» user	object	true	none	User info	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 Router Information

GET /getRouters

Request Parameters

Name	Location	Type	Required	Description
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

Response Examples

Success

{
  "code": 200,
  "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
          }
        }
      ]
    },
  ]
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	[object]	true	none	Route data	none
»» name	string	true	none	Route name	none
»» path	string	true	none	Route path	none
»» component	string	true	none	Component
»» meta	object	true	none	Metadata	none
»»» icon	string	true	none	Menu icon	none
»»» title	string	true	none	Menu title	none
»»» hide	boolean	true	none	Whether to hide	Default false
»»» cache	boolean	true	none	Is cached	Default false
»»» target	string¦null	true	none	link behavior
»» redirect	string	false	none	directory redirection	none
»» children	[object]	false	none	Sub-menu	none
»»» name	string	true	none		none
»»» path	string	true	none		none
»»» component	string	true	none		none
»»» meta	object	true	none	Metadata	none
»»»» icon	string	true	none		none
»»»» title	string	true	none	Title	none
»»»» hide	boolean	true	none		none
»»»» cache	boolean	true	none		none
»»»» target	string¦null	true	none		none

POST /login

Body Parameters

{
  "username": "admin",
  "password": "rootaa",
  "code": "{{code-text}}",
  "uuid": "{{code-uuid}}"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» username	body	string	yes	Login name	none
» password	body	string	yes	Password	none
» code	body	string	yes	Verification code value	none
» uuid	body	string	yes	Verification code UID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success",
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo"
  }
}

{
  "code": 500,
  "msg": "Verification code has expired"
}

{
  "code": 500,
  "msg": "Verification code error"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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	object	false	none		none
»» access_token	string	true	none	Authorization token	none

POST Logout

POST /logout

Limit IP traffic

Request Parameters

Name	Location	Type	Required	Description
Authorization	header	string	no	Authorization token, optional
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

Response Examples

Success

{
  "code": 200,
  "msg": "Logout Success"
}

{
  "code": 500,
  "msg": "The access is too frequent, please try again later."
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» code	integer	true	none	Fixed value	none
» msg	string	true	none	Fixed value	none

General APIs/Account registration operation

POST account registration

POST /register

Body Parameters

{
  "username": "string",
  "password": "string",
  "confirmPassword": "string",
  "code": "string",
  "uuid": "string"
}

Request Parameters

Name	Location	Type	Required	Title	Description
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
body	body	object	no		none
» username	body	string	yes	User name	none
» password	body	string	yes	Password	none
» confirmPassword	body	string	yes	Confirm password	none
» code	body	string	yes	Verification code value	none
» uuid	body	string	yes	Verification code UID	none

Response Examples

Success

{
  "code": 200,
  "msg": "Success"
}

{
  "code": 500,
  "msg": "The registration function is not currently enabled in the system!"
}

{
  "code": 500,
  "msg": "Failed to register user [xxxx], the registered account already exists"
}

{
  "code": 500,
  "msg": "The account number cannot start with a number, and can contain uppercase and lowercase letters, numbers, and no less than 5 digits."
}

{
  "code": 500,
  "msg": "The password must contain at least uppercase and lowercase letters, numbers, and special symbols, and must be no less than 6 characters."
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	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 Management

GET Fuzzy query with '%'

GET /api/rest/dataManagement/v1/omc_db/alarm

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Query by where condition

GET /api/rest/dataManagement/v1/omc_db/ne_info

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

GET Multiple SQL query

GET /api/rest/dataManagement/v1/omc_db/ne_state

Request Parameters

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

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

POST Insert multiple record into table alarm_log

POST /api/rest/dataManagement/v1/omc_db/alarm_log

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT Update single record

PUT /api/rest/dataManagement/v1/omc_db/user

Body Parameters

{
  "user": {
    "name": "test3"
  }
}

Request Parameters

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	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
body	body	object	no	none
» user	body	object	yes	none
»» name	body	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

PUT UPDATE MeasureTask

PUT /api/rest/dataManagement/v1/omc_db/measure_task

Body Parameters

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

Request Parameters

Name	Location	Type	Required	Description
AccessToken	header	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
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

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

Responses Data Schema

DELETE Delete historical alarm exceeding 90 days

DELETE /api/rest/dataManagement/v1/delete/omc_db/alarm

Body Parameters

{}

Request Parameters

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	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
body	body	object	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Success	Inline

466 KiB Raw Blame History Unescape Escape

Authentication

GET User Information

Request Parameters

Response

Response Data Schema

GET Router Information

Request Parameters

Response

Response Data Schema

POST Login

Request Parameters

Response

Response Data Schema

POST Logout

Request Parameters

Response

Response Data Schema

Monitor & Alarm

GET Get ALL NEs System State

Request Parameters

Responses

Responses Data Schema

GET Get Alarm from NF

Request Parameters

Responses

Responses Data Schema

GET Get OMC Local Time

Request Parameters

Responses

Responses Data Schema

GET Get All UDM System State

Request Parameters

Responses

Responses Data Schema

POST Get Alarm from NF

Request Parameters

Responses

Responses Data Schema

GET Get OMC System State

Request Parameters

Responses

Responses Data Schema

POST Post Alarm from AMF

Request Parameters

Responses

Responses Data Schema

Performance

PATCH Patch Measure Task

Request Parameters

Responses

Responses Data Schema

POST Post Measure Task

Request Parameters

Responses

Responses Data Schema

Trace

DELETE Patch Measure Task

Request Parameters

Responses

Responses Data Schema

POST Post Trace Task No NeType

Request Parameters

Responses

Responses Data Schema

PUT Put Trace Task No NeType

Request Parameters

Responses

Responses Data Schema

DELETE Delete Trace Task No NeType

Request Parameters

Responses

Responses Data Schema

POST Post AMF Measure Task

Request Parameters

Responses

Responses Data Schema

POST

Request Parameters

Responses

466 KiB

Raw Blame History