diff --git a/.gitignore b/.gitignore deleted file mode 100644 index aa55de8..0000000 --- a/.gitignore +++ /dev/null @@ -1,31 +0,0 @@ -# ---> VisualStudioCode -.vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json -!.vscode/*.code-snippets - -# Local History for Visual Studio Code -.history/ - -# Run temp file and dir -docs/temp/ - -# Built Visual Studio Code Extensions -*.vsix -*.bak -# build files -build -debbuild/etc -debbuild/usr -debbuild/lib -debbuild/22.04/etc -debbuild/22.04/usr -debbuild/22.04/lib -release -rpmbuild/RPMS -rpmbuild/SOURCES -rpmbuild/BUILD - - diff --git a/README.md b/README.md index 0fd7102..df0f37c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ OS: Ubuntu 18.04 / 22.04 (Recommendation) Arch: amd64 -Golang: go1.22.1 linux/amd64 +Golang: go1.22.1 linux/amd64 Database: 10.6.16-MariaDB, Redis server v=5.0.5 (or above) @@ -23,4 +23,7 @@ npm install npm run build cd ../build.ems ./build.sh deb + +find "${fehooksdir}" -type f -name '*.ts' -exec sed -i 's/[一-龥（）“”，。？！］～·]//g' {} + + ``` diff --git a/bin/binWriter b/bin/binWriter deleted file mode 100644 index 4c0e7be..0000000 Binary files a/bin/binWriter and /dev/null differ diff --git a/build.sh b/build.sh index 02dbf05..923056c 100755 --- a/build.sh +++ b/build.sh @@ -1,363 +1,173 @@ #!/bin/bash +# 默认版本值 +VERSION="1.0.0" +# usage usage() { - echo "Usage: $0 [OPTION] deb|badeb|rpm" - echo - echo "Build omc package, option as follow:" - echo " deb|badeb|rpm, deb: ubuntu|debian package build by dpkg" - echo " badeb: ubuntu|debian package build by dpkg" - echo " rpm: centos/redhat package, build by rpmbuild" - echo " -r, =build root directory build root directory, default directory is $HOME/omc.git" - echo " -d dump SQL from database" - echo + echo "Usage: bash $0 [OPTION]" + echo + echo "Build Software Package OPTION:" + echo " -v Specify the version" + echo " -h Display this help message" + echo + exit 1 } +# 读取命令行参数 +while [[ $# -gt 0 ]]; do + case "$1" in + -v) VERSION="$2"; shift 2 ;; # 处理 -v 后面的版本 + *) usage ;; + esac +done +# 输出结果 +echo "Version: $VERSION" -pkgtype="" -new_args=() -# Traverse all parameters -for arg in "$@"; do - if [[ "$arg" == "deb" || "$arg" == "badeb" || "$arg" == "rpm" ]]; then - pkgtype=$arg +# =================== + +# 操作系统名称 +get_os_name() { + if [ -f /etc/os-release ]; then + . /etc/os-release + # 检查 $ID 是否为空 + if [ -z "$ID" ]; then + echo "ID is not defined in /etc/os-release" + exit 1 + fi + echo "$ID" else - new_args+=("$arg") # Add non pkgtype parameters to a new parameter list - fi -done + echo "unknown ID: /etc/os-release not found" + exit 1 + fi +} +# 获取当前操作系统名称 +OS_NAME=$(get_os_name) +echo "OS: $OS_NAME" -if [ -z "$pkgtype" ]; then - usage - exit 1 -fi - -# Use a new parameter list -set -- "${new_args[@]}" - -GitLocalRoot=${HOME}/omc.git -while getopts "r:d" option; do - case $option in - r) - GitLocalRoot=$OPTARG - ;; - d) - dumpdb="yes" - ;; - \?) - echo "Invalid option: -$OPTARG" >&2 - usage - exit 2 - ;; - esac -done - -if [ ! -d ${GitLocalRoot} ]; then - echo "Not exist directory: ${GitLocalRoot}" - exit 3 -fi - -ProjectL=omc -ProjectU=OMC -PROJECT=${ProjectL} -VERSION=2.2503.2 -RelDate=`date +%Y%m%d` -RelVer=${VERSION}-${RelDate} -Ky10Arch=ky10.aarch64 -RpmPkgName=${ProjectL}-${RelVer}.ky10.aarch64.rpm -RpmPkgRename=${ProjectL}-r${RelVer}-ky10.rpm -DebPkgName=${ProjectL}-r${RelVer}-ub*.deb -EmsBEDir=${GitLocalRoot}/be.ems -EmsBuildRoot=${GitLocalRoot}/build.ems -RpmArch=`arch` -RpmsDir=${EmsBuildRoot}/rpmbuild/RPMS -ReleaseDir=${EmsBuildRoot}/release -DumpToolDir=${EmsBEDir}/tools/misc -ProjectTag="" - -BuildDir=${EmsBuildRoot}/build -CustomizedDir=${EmsBuildRoot}/customized -BuildOMCDir=${BuildDir}/usr/local/omc -BuildOMCBinDir=${BuildOMCDir}/bin -BuildOMCEtcDir=${BuildOMCDir}/etc -BuildLibDir=${BuildDir}/lib -BuildLibSystemDir=${BuildLibDir}/systemd/system -DebBuildDir=${EmsBuildRoot}/debbuild -DebBuildOMCDir=${EmsBuildRoot}/debbuild/usr/local/omc -DebFEBuildDir=${DebBuildOMCDir}/htdocs -DebBuild2204Dir=${EmsBuildRoot}/debbuild/22.04 -DebBuild2204OMCDir=${EmsBuildRoot}/debbuild/22.04/usr/local/omc -DebFEBuild2204Dir=${DebBuild2204OMCDir}/htdocs -RpmBuildDir=${EmsBuildRoot}/rpmbuild -RpmBuildOMCDir=${RpmBuildDir}/BUILD/usr/local/omc -RpmFEBuildDir=${RpmBuildOMCDir}/htdocs -OmcInstallDir=/usr/local/omc -ConfigEtcDir=${EmsBEDir}/config/etc -ConfigSystemdDir=${EmsBEDir}/config/systemd -EmsFEDir=${GitLocalRoot}/fe.ems -EmsFEVue3Dir=${GitLocalRoot}/fe.ems.vue3/dist -LibDir=${EmsBEDir}/lib -RESTAGENT=restagent -SshSvcBin=sshsvc -RestagentDir=${EmsBEDir}/${RESTAGENT} -SshSvcDir=${EmsBEDir}/${SshSvcBin} -DBSQLSrcDir=${EmsBEDir}/database -MiscDir=${EmsBEDir}/misc -FrontBuildDir=${BuildOMCDir}/htdocs -FrontSrcDir=${EmsBEDir}/front -BinWriterDir=${HOME}/bin - -# Get the output of uname -a -UnameOutput=$(uname -a) - -# Extract hardware architecture -if [[ $UnameOutput =~ "x86_64" ]]; then - RelArch=amd64 - RpmArch=x86_64 -elif [[ $UnameOutput =~ "aarch64" ]]; then - RelArch=arm64 - RpmArch=aarch64 -else - echo "Unsupported hardware architecture" +# 包管理器 +get_manager() { + if command -v rpm &> /dev/null; then + echo "rpm" + elif command -v dpkg &> /dev/null; then + echo "deb" + else + echo "unknown manager" + cat /etc/os-release exit 1 + fi +} +# 获取当前系统的包管理器 +PACKAGE_MANAGER=$(get_manager) +echo "Package Manager: $PACKAGE_MANAGER" + +# 架构 +get_arch() { + ARCH_UNAME=$(uname -m) + case $ARCH_UNAME in + x86_64) echo "amd64" ;; + aarch64) echo "arm64" ;; + i386|i686) echo "i386" ;; + *) + echo "unknown architecture: $ARCH_UNAME" + exit 1 + ;; + esac +} +# 获取当前系统的架构 +PACKAGE_ARCH=$(get_arch) +echo "Architecture: $PACKAGE_ARCH" + +# =================== + +# 编译日期 +Date=`date +%Y%m%d` +# 脚本所在路径 +RootDir=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) +# 编译Linux目录 +BuildLinuxDir=${RootDir}/linux +# 编译包管理目录 +BuildPackagelDir=${RootDir}/pkg +# 编译目录 +BuildDir=${RootDir}/tmp +# 发布包目录 +ReleaseDir=${RootDir}/release/${PACKAGE_MANAGER}/${PACKAGE_ARCH} +# 发布包文件名称 +ReleaseFileName=omc-r${VERSION}-${Date}-${OS_NAME}-${PACKAGE_ARCH}.${PACKAGE_MANAGER} + +# =================== + +# 应用文件处理 +app() { + # 数据库脚本 common属于重建脚本 + modeList="standard lite" + for v in ${modeList}; do + cp -rf $BuildDir/usr/local/etc/omc/database/${v}/common/* $BuildDir/usr/local/etc/omc/database/${v}/install/ + cp -rf $BuildDir/usr/local/etc/omc/database/${v}/common/* $BuildDir/usr/local/etc/omc/database/${v}/upgrade/ + rm -rf $BuildDir/usr/local/etc/omc/database/${v}/common + done +} + +# =================== + +# deb包管理器 +deb() { + cd ${BuildDir} + + # 替换标签 {version} {arch} + sed -i "s/{arch}/${PACKAGE_ARCH}/g" ./DEBIAN/control + sed -i "s/{version}/${VERSION}/g" ./DEBIAN/control + sed -i "s/{date}/${Date}/g" ./DEBIAN/control + + # 打包deb + chmod 755 -R ${BuildDir} + dpkg -b ${BuildDir} ${ReleaseDir}/${ReleaseFileName} + + # 生成MD5文件 + rm -f omc_md5sum.txt + md5sum ${ReleaseDir}/${ReleaseFileName} >${ReleaseDir}/omc_md5sum.txt + cat ${ReleaseDir}/omc_md5sum.txt +} + +# rpm包管理器 +rpm() { + cd ${BuildDir} + ARCH_UNAME=$(uname -m) + # 替换标签 {version} {arch} {date} + sed -i "s/{version}/${VERSION}/g" ./SPECS/omc.spec + sed -i "s/{arch}/${ARCH_UNAME}/g" ./SPECS/omc.spec + sed -i "s/{date}/${Date}/g" ./SPECS/omc.spec + + # 打包rpm + chmod 755 -R ${BuildDir} + rpmbuild -bb -D "_topdir ${BuildDir}" ${BuildDir}/SPECS/omc.spec + mv ${BuildDir}/RPMS/${ARCH_UNAME}/omc-${VERSION}-${Date}.${ARCH_UNAME}.rpm ${ReleaseDir}/${ReleaseFileName} + rm -rf ${BuildDir}/RPMS + + # 生成MD5文件 + rm -f omc_md5sum.txt + md5sum ${ReleaseDir}/${ReleaseFileName} >${ReleaseDir}/omc_md5sum.txt + cat ${ReleaseDir}/omc_md5sum.txt +} + +# =================== +echo +echo "building omc..." +rm -rf ${BuildDir} && mkdir -p ${BuildDir} +cp -rf ${BuildPackagelDir}/${PACKAGE_MANAGER}/* ${BuildDir} +if [[ $PACKAGE_MANAGER = "deb" ]]; then + cp -rf ${BuildLinuxDir}/* ${BuildDir} + cd ${BuildDir} + # 应用处理 + app + # 打包 + deb +elif [[ $PACKAGE_MANAGER = "rpm" ]]; then + cp -rf ${BuildLinuxDir}/* ${BuildDir}/BUILD + cd ${BuildDir}/BUILD + # 应用处理 + app + # 打包 + rpm +else + echo "unknown runing: $PACKAGE_MANAGER" + exit 1 fi - -get_os_info() { - if [ -f /etc/os-release ]; then - . /etc/os-release - echo $ID - else - echo "unknown" - fi -} - -get_os_version() { - if [ -f /etc/os-release ]; then - . /etc/os-release - echo $VERSION_ID - else - echo "unknown" - fi -} - -OSVersion=$(get_os_version) -case $(get_os_info) in - ubuntu|debian) - ptype=deb - if [[ "$OSVersion" == "22.04" ]]; then - RelOS=ub22 - DebBuildDir=${DebBuild2204Dir} - DebBuildOMCDir=${DebBuild2204OMCDir} - DebFEBuildDir=${DebFEBuild2204Dir} - elif [[ "$OSVersion" == "18.04" ]]; then - RelOS=ub18 - else - echo "Unsupported Ubuntu version: $OSVersion" - exit 1 - fi - ;; - centos|rhel) - ptype=rpm - RelOS=ct8 - RpmPkgRename=${ProjectL}-r${RelVer}-${RelOS}-${RelArch}.${ptype} - ;; - openEuler) - ptype=rpm - RelOS=oe20 - RpmPkgName=${ProjectL}-${RelVer}.${RpmArch}.${ptype} - RpmPkgRename=${ProjectL}-r${RelVer}-${RelOS}-${RelArch}.${ptype} - ;; - kylin|anolis) - ptype=rpm - RelOS=ky - RpmPkgName=${ProjectL}-${RelVer}.${RpmArch}.${ptype} - RpmPkgRename=${ProjectL}-r${RelVer}-${RelOS}-${RelArch}.${ptype} - ;; - *) - echo "Unsupported OS" - exit 1 - ;; -esac - -case "${pkgtype}" in - rpm) - echo "Begin to make ${pkgtype} package ======>" - ReleasePkgDir=${ReleaseDir}/rpms/${RelArch} - ProcList="restagent sshsvc" - cd $EmsBEDir - for procName in $ProcList;do - cd $EmsBEDir/$procName - echo "Make $procName ..." - make - done - - cd $EmsBEDir - # make rpm - # clear build cache - rm -rf ${FrontBuildDir}/front/* - rm -rf ${RpmFEBuildDir}/front/* - rm -rf ${RpmBuildDir}/BUILD/usr/local/omc/etc/db/* - - cp -rf ${RestagentDir}/${RESTAGENT} ${BuildOMCBinDir} - cp -rf ${SshSvcDir}/${SshSvcBin} ${BuildOMCBinDir} - - cp -rf ${MiscDir}/* ${BuildOMCBinDir} - # rm -rf ${BinDir2}/ne-hosts - cp -rf ${ConfigEtcDir}/* ${BuildOMCEtcDir} - rm -rf ${BuildOMCEtcDir}/db/* - cp -rf ${DBSQLSrcDir}/* ${BuildOMCEtcDir}/db/ - cp -rf ${BuildOMCEtcDir}/db/common/* ${BuildOMCEtcDir}/db/install - cp -rf ${BuildOMCEtcDir}/db/common/* ${BuildOMCEtcDir}/db/upgrade - #Get SQL from database, overwrite from git - if [ "$dumpdb" = "yes" ]; then - cd ${DumpToolDir} - chmod +x ${DumpToolDir}/dumpsql.sh - ${DumpToolDir}/dumpsql.sh - fi - cp -rf ${ConfigSystemdDir}/* ${BuildLibSystemDir} - #unzip ${FrontSrcDir}/front.zip -d ${FrontBuildDir} >/dev/null - mkdir -p ${FrontBuildDir}/front - cp -rf ${EmsFEVue3Dir}/* ${FrontBuildDir}/front >/dev/null - chmod 755 ${BuildOMCBinDir}/* - cp -rf ${BuildDir}/* ${RpmBuildDir}/BUILD/ - cp -rf ${CustomizedDir}/agt.d ${RpmBuildOMCDir}/static - cp -rf ${CustomizedDir}/omc.d ${RpmBuildOMCDir}/static - cd ${RpmBuildDir} - rpmbuild -bb -D "_topdir ${RpmBuildDir}" ${RpmBuildDir}/SPECS/omc.spec - - mv -f $RpmsDir/$RpmArch/$RpmPkgName ${ReleasePkgDir}/$RpmPkgRename - cd ${ReleasePkgDir} - rm -f omc-md5sum.txt -# rpm --addsign *.rpm - md5sum $RpmPkgRename >omc-md5sum.txt - echo "Finish to make ${pkgtype} package <======" - ;; - deb) - echo "Begin to make ${pkgtype} package ======>" - ReleasePkgDir=${ReleaseDir}/debs/${RelArch} - ProcList="restagent sshsvc" - cd $EmsBEDir - for procName in $ProcList;do - cd $EmsBEDir/$procName - echo "Make $procName ..." - make - done - - DebPkgFile=${ProjectL}-r${RelVer}-${RelOS}-${RelArch}.${ptype} - if [ ! $ProjectTag = "" ]; then - DebPkgFile=${ProjectL}-r${RelVer}-${RelOS}-${RelArch}-${ProjectTag}.${ptype} - fi - - cd ${EmsBEDir} - - #make deb - # clear build cache - rm -rf ${FrontBuildDir}/front/* - rm -rf ${DebFEBuildDir}/front/* - rm -rf ${DebBuildDir}/usr/local/omc/etc/db/* - rm -rf ${DebBuildOMCDir}/static/* - - cp -rf ${RestagentDir}/${RESTAGENT} ${BuildOMCBinDir} - cp -rf ${SshSvcDir}/${SshSvcBin} ${BuildOMCBinDir} - - cp -rf ${MiscDir}/* ${BuildOMCBinDir} - cp -rf ${ConfigEtcDir}/* ${BuildOMCEtcDir} - rm -rf ${BuildOMCEtcDir}/db/* - cp -rf ${DBSQLSrcDir}/* ${BuildOMCEtcDir}/db/ - cp -rf ${BuildOMCEtcDir}/db/common/* ${BuildOMCEtcDir}/db/install - cp -rf ${BuildOMCEtcDir}/db/common/* ${BuildOMCEtcDir}/db/upgrade - #Get SQL from database, overwrite from git - if [ "${dumpdb}" = "yes" ]; then - cd ${DumpToolDir} - chmod +x ${DumpToolDir}/dumpsql.sh - ${DumpToolDir}/dumpsql.sh - fi - cp -rf ${ConfigSystemdDir}/* ${BuildLibSystemDir} - cp -rf ${EmsFEVue3Dir}/* ${FrontBuildDir}/front >/dev/null - chmod 755 ${BuildOMCBinDir}/* - chmod 755 ${DebBuildDir}/DEBIAN/preinst - chmod 755 ${DebBuildDir}/DEBIAN/postinst - chmod 755 ${DebBuildDir}/DEBIAN/postrm - cp -rf ${BuildDir}/* ${DebBuildDir}/ - cp -rf ${CustomizedDir}/agt.d ${DebBuildOMCDir}/static - cp -rf ${CustomizedDir}/omc.d ${DebBuildOMCDir}/static - #cp -rf ${BuildDir}/nginx/* ${DebBuildDir}/etc/nginx/conf.d - #cp -rf ${BuildDir}/systemd/*.service ${DebBuildDir}/lib/systemd/system/ - chmod +x ${DebBuildDir}/usr/local/omc/bin/* - sed -i "s/YYYYMMDD/${RelDate}/g" ${DebBuildDir}/DEBIAN/control - sed -i "s/Architecture: amd64/Architecture: ${RelArch}/g" ${DebBuildDir}/DEBIAN/control - perl -0777 -i -pe 's/ne:\n user: root/ne:\n user: omcuser/g' ${DebBuildDir}/usr/local/omc/etc/default/restconf.yaml - dpkg -b ${DebBuildDir} ${ReleasePkgDir}/${DebPkgFile} - - cd ${ReleasePkgDir} - rm -f omc-md5sum.txt -# rpm --addsign *.rpm - md5sum ${DebPkgName} >omc-md5sum.txt - echo "Finish to make ${pkgtype} package <=======" - ;; - badeb) - echo "Begin to make ${pkgtype} package ======>" - ReleasePkgDir=${ReleaseDir}/debs/${RelArch} - ProcList="restagent sshsvc" - cd $EmsBEDir - for procName in $ProcList;do - cd $EmsBEDir/$procName - echo "Make $procName ..." - make - done - - DebPkgFile=${ProjectL}-r${RelVer}-${RelOS}-${RelArch}-ba.deb - - cd ${EmsBEDir} - - #make deb - # clear build cache - rm -rf ${FrontBuildDir}/front/* - rm -rf ${DebFEBuildDir}/front/* - rm -rf ${DebBuildDir}/usr/local/omc/etc/db/* - rm -rf ${DebBuildOMCDir}/static/* - - cp -rf ${RestagentDir}/${RESTAGENT} ${BuildOMCBinDir} - cp -rf ${SshSvcDir}/${SshSvcBin} ${BuildOMCBinDir} - - cp -rf ${MiscDir}/* ${BuildOMCBinDir} - cp -rf ${ConfigEtcDir}/* ${BuildOMCEtcDir} - rm -rf ${BuildOMCEtcDir}/db/* - cp -rf ${DBSQLSrcDir}/* ${BuildOMCEtcDir}/db/ - cp -rf ${BuildOMCEtcDir}/db/common/* ${BuildOMCEtcDir}/db/install - cp -rf ${BuildOMCEtcDir}/db/common/* ${BuildOMCEtcDir}/db/upgrade - - #Get SQL from database, overwrite from git - if [ "${dumpdb}" = "yes" ]; then - cd ${DumpToolDir} - chmod +x ${DumpToolDir}/dumpsql.sh - ${DumpToolDir}/dumpsql.sh - fi - cp -rf ${ConfigSystemdDir}/* ${BuildLibSystemDir} - cp -rf ${EmsFEVue3Dir}/* ${FrontBuildDir}/front >/dev/null - chmod 755 ${BuildOMCBinDir}/* - chmod 755 ${DebBuildDir}/DEBIAN/preinst - chmod 755 ${DebBuildDir}/DEBIAN/postinst - chmod 755 ${DebBuildDir}/DEBIAN/postrm - cp -rf ${BuildDir}/* ${DebBuildDir}/ - cp -rf ${CustomizedDir}/omc.d ${DebBuildOMCDir}/static - rm -rf ${DebBuildOMCDir}/static/omc.d/* - cp -rf ${CustomizedDir}/ba.d/* ${DebBuildOMCDir}/static/omc.d - cp -rf ${CustomizedDir}/ba.d/logo/en_brand.png ${DebBuildOMCDir}/static/omc.d/logo/zh_brand.png - cp -rf ${CustomizedDir}/ba.d/logo/en_icon.png ${DebBuildOMCDir}/static/omc.d/logo/zh_icon.png - cp -rf ${CustomizedDir}/ba.d ${DebBuildOMCDir}/static - # replace Chinese character - find "${DebBuildOMCDir}/etc/db" -type f -name '*.sql' -exec sed -i 's/[一-龥（）“”，。？！］～·]//g' {} + - echo "Replace all chinese character." - chmod +x ${DebBuildDir}/usr/local/omc/bin - sed -i "s/YYYYMMDD/${RelDate}/g" ${DebBuildDir}/DEBIAN/control - sed -i "s/Architecture: amd64/Architecture: ${RelArch}/g" ${DebBuildDir}/DEBIAN/control - perl -0777 -i -pe 's/ne:\n user: root/ne:\n user: omcuser/g' ${DebBuildDir}/usr/local/omc/etc/default/restconf.yaml - dpkg -b ${DebBuildDir} ${ReleasePkgDir}/${DebPkgFile} - - cd ${ReleasePkgDir} - rm -f omc-md5sum.txt - md5sum ${DebPkgName} >omc-md5sum.txt - echo "Finish to make ${pkgtype} package <======" - ;; - *) - usage - exit 4 - ;; -esac diff --git a/build/etc/nginx/conf.d/omc.conf b/build/etc/nginx/conf.d/omc.conf deleted file mode 100644 index 0e1facc..0000000 --- a/build/etc/nginx/conf.d/omc.conf +++ /dev/null @@ -1,71 +0,0 @@ -server { - listen 44080; - listen 44443; - listen [::]:44080; - listen [::]:44443; - server_name localhost; - - client_max_body_size 100M; - keepalive_timeout 180s; - - #access_log /var/log/nginx/host.access.log main; - - # ssl_certificate /usr/local/omc/etc/certs/omc-server.crt; - # ssl_certificate_key /usr/local/omc/etc/certs/omc-server.key; - # ssl_client_certificate /usr/local/omc/etc/certs/omc-ca.crt; - # ssl_verify_client on; - # ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; - # ssl_session_timeout 5m; - # ssl_ciphers EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5; - # ssl_prefer_server_ciphers on; - - # OMC - location / { - root /usr/local/omc/htdocs/front; - - try_files $uri $uri/ /index.html; - index index.html index.htm; - } - - location /omc-api/ { - proxy_pass http://127.0.0.1:33030/; - - proxy_connect_timeout 180s; - proxy_send_timeout 180s; - proxy_read_timeout 180s; - - proxy_cache_bypass $http_upgrade; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; - } - - location /api/rest/ { - proxy_pass http://127.0.0.1:33030/api/rest/; - - proxy_cache_bypass $http_upgrade; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; - } - - #error_page 404 /404.html; - - # redirect server error pages to the static page /50x.html - # - error_page 500 502 503 504 /50x.html; - location = /50x.html { - root /usr/share/nginx/html; - } -} - diff --git a/build/usr/local/omc/.ssh/id_rsa b/build/usr/local/omc/.ssh/id_rsa deleted file mode 100644 index b9e6a0e..0000000 --- a/build/usr/local/omc/.ssh/id_rsa +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/build/usr/local/omc/.ssh/id_rsa.pub b/build/usr/local/omc/.ssh/id_rsa.pub deleted file mode 100644 index 93e845f..0000000 --- a/build/usr/local/omc/.ssh/id_rsa.pub +++ /dev/null @@ -1 +0,0 @@ -ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCjzE0MHy0P2sQmG1OKvArwLEzR77BwxPp+4N9NKBz8lEyNch4zoHvoLDaUJKPBMwTrScZnxhvRJNde6hz5Z0QVxZolVKV95fMfgb9YICzDfPF3Bphae5q/PBYUJNfrC9SAjQeHV4CCO6xk6LV8O/Nfw8uaXwtuN3yfpUWd5mRWKMc3GHV4vxerfKoIQZN6etLhIEYibAhCJ21P0uoWzZl7ceLmkG+6qrRSbyC0bCnrN3+wjN4bwtflrEFJk3XQGuRbVsYLzux+mMm9p22+CLPRl/FUPF3x4/wKCsqr7JDSxx80HSPhk4g/1nCTpDR9hAfF6A9ww2va/k8jMeYPBO8Owe7erLEZzvg5WQAR3Wj05eJpJD99BeC91S5KW6AFQDfDHxWWprSibd/Jj9dtct2pK2ZxW0ph9OJ49ftRhzT1iVi4UnJwnG5/qLfwl6Tnx+qnQ1If/9lY/99erCTATzFTMSImKrRz7CnuPlcw8WkzCYpWKKe0kJLkL2cRD5Qi4yk= simon@simonzhangsz diff --git a/build/usr/local/omc/.ssh/private_key.pem b/build/usr/local/omc/.ssh/private_key.pem deleted file mode 100644 index b9e6a0e..0000000 --- a/build/usr/local/omc/.ssh/private_key.pem +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/build/usr/local/omc/etc/cm/cm-amf.yaml b/build/usr/local/omc/etc/cm/cm-amf.yaml deleted file mode 100644 index 319a85f..0000000 --- a/build/usr/local/omc/etc/cm/cm-amf.yaml +++ /dev/null @@ -1,49 +0,0 @@ -ManagedElement: - Id: "" - UserLabel: "" - VendorName: "" - ManagedBy: "" - ManagementIpAddress: "" - SwVersion: "" - PatchInfo: "" - AdministrativeState: "" - OperationalState: "" - -AmfFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - SbiServiceList: "" - AmfGuamiList: "" - SnssaiList: "" - MaxUser: "" - RelativeCapacity: "" - MaxGnbNum: "" - -EpRpDynN8Amf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -EpRpDynN11Amf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -EpRpDynN12Amf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -IPResource: - Id: "" - UserLabel: "" - InterfaceType: "" - LocIpV4AddrList: "" - LocIpV6AddrList: "" diff --git a/build/usr/local/omc/etc/cm/cm-smf.yaml b/build/usr/local/omc/etc/cm/cm-smf.yaml deleted file mode 100644 index a1ad373..0000000 --- a/build/usr/local/omc/etc/cm/cm-smf.yaml +++ /dev/null @@ -1,48 +0,0 @@ -ManagedElement: - Id: "" - UserLabel: "" - VendorName: "" - ManagedBy: "" - ManagementIpAddress: "" - SwVersion: "" - PatchInfo: "" - AdministrativeState: "" - OperationalState: "" - -SmfFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - SbiServiceList: "" - MaxPduSessions: "" - MaxQfi: "" - UpfList: "" - -AddrPool: - Id: "" - UserLabel: "" - AddrType: "Static" - IpVersion: "" - AddrSegList: "" - -EpRpDynN7Smf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -EpRpDynN10Smf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -IPResource: - Id: "" - UserLabel: "" - InterfaceType: "" - LocIpV4AddrList: "" - LocIpV6AddrList: "" \ No newline at end of file diff --git a/build/usr/local/omc/etc/cm/cm-udm.yaml b/build/usr/local/omc/etc/cm/cm-udm.yaml deleted file mode 100644 index 5e823ae..0000000 --- a/build/usr/local/omc/etc/cm/cm-udm.yaml +++ /dev/null @@ -1,39 +0,0 @@ -ManagedElement: - Id: "" - UserLabel: "" - VendorName: "" - ManagedBy: "" - ManagementIpAddress: "" - SwVersion: "" - PatchInfo: "" - AdministrativeState: "" - OperationalState: "" - -UdmFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - SbiServiceList: "" - -UdrFunction: - Id: "" - UserLabel: "" - AddrType: "Static" - IpVersion: "" - AddrSegList: "" - -AusfFunction: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -IPResource: - Id: "" - UserLabel: "" - InterfaceType: "" - LocIpV4AddrList: "" - LocIpV6AddrList: "" \ No newline at end of file diff --git a/build/usr/local/omc/etc/cm/cm-upf.yaml b/build/usr/local/omc/etc/cm/cm-upf.yaml deleted file mode 100644 index d291c68..0000000 --- a/build/usr/local/omc/etc/cm/cm-upf.yaml +++ /dev/null @@ -1,141 +0,0 @@ -ManagedElement: - Id: "" - UserLabel: "" - VendorName: "" - ManagedBy: "" - ManagementIpAddress: "" - SwVersion: "" - PatchInfo: "" - AdministrativeState: "" - OperationalState: "" - -InventoryUnitRack: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - SbiServiceList: "" - MaxPduSessions: "" - MaxQfi: "" - UpfList: "" - -InventoryUnitShelf: - Id: "" - UserLabel: "" - VendorUnitFamilyType: "" - VendorUnitTypeNumber: "" - VendorName: "" - SerialNumber: "" - VersionNumber: "" - DateOfManufacture: "" - DateOfLastService: "" - ManufacturerData: "" - RackPosition: "" - -InventoryUnitPack: - Id: "" - UserLabel: "" - VendorUnitFamilyType: "" - VendorUnitTypeNumber: "" - VendorName: "" - SerialNumber: "" - VersionNumber: "" - DateOfManufacture: "" - DateOfLastService: "" - ManufacturerData: "" - PortsInformation: "" - PackPosition: "" - SlotsOccupied: "" - -InventoryUnitHost: - Id: "" - UserLabel: "" - VendorUnitFamilyType: "" - VendorUnitTypeNumber: "" - VendorName: "" - SerialNumber: "" - VersionNumber: "" - DateOfManufacture: "" - DateOfLastService: "" - ManufacturerData: "" - HostPosition: "" - NumberOfCpu: "" - MemSize: "" - HardDiskSize: "" - -InventoryUnitAccessory: - Id: "" - UserLabel: "" - VendorUnitFamilyType: "" - VendorUnitTypeNumber: "" - VendorName: "" - SerialNumber: "" - VersionNumber: "" - DateOfManufacture: "" - DateOfLastService: "" - ManufacturerData: "" - AccessoryPosition: "" - AccessoryType: "" - AddtionalInformation: "" - -UpfFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - MaxQosFlows: "" - MaxThroughput: "" - -EpRpDynN9Upf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -EpRpDynN3Upf: - Id: "" - UserLabel: "" - LocIpAddrList: "" - FarIpSubnetworkList: "" - -AmfFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - -SmfFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - -UdrFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - -AusfFunction: - Id: "" - UserLabel: "" - AdministrativeState: "" - OperationalState: "" - VnfInstanceId: "" - Fqdn: "" - -IPResource: - Id: "" - UserLabel: "" - InterfaceType: "" - LocIpV4AddrList: "" - LocIpV6AddrList: "" diff --git a/build/usr/local/omc/etc/default/restconf.yaml b/build/usr/local/omc/etc/default/restconf.yaml deleted file mode 100644 index 60d882a..0000000 --- a/build/usr/local/omc/etc/default/restconf.yaml +++ /dev/null @@ -1,193 +0,0 @@ -# file: log file name -# level: /trace/debug/info/warn/error/fatal, default: debug -# duration: rotation time with xx hours, example: 1/12/24 hours -# count: rotation count of log, default is 30 rotation -logger: - file: /usr/local/omc/log/restagent.log - level: warn - duration: 24 - count: 90 - -# rest agent listen ipv4/v6 and port, support multiple routines -# ip: 0.0.0.0 or ::0, support IPv4/v6 -# clientAuthType: 0:NoClientCert (default), 1:RequestClientCert, 2:RequireAnyClientCert, -# 3:VerifyClientCertIfGiven, 4:RequireAndVerifyClientCerts -rest: - - ipv4: 0.0.0.0 - ipv6: - port: 33030 - - ipv4: 0.0.0.0 - ipv6: - port: 33443 - schema: https - clientAuthType: 0 - caFile: /usr/local/omc/etc/certs/omc-ca.crt - certFile: /usr/local/omc/etc/certs/omc-server.crt - keyFile: /usr/local/omc/etc/certs/omc-server.key - -webServer: - enabled: true - rootDir: /usr/local/omc/htdocs/front - listen: - - addr: :80 - schema: http - - addr: :443 - schema: https - clientAuthType: 0 - caFile: /usr/local/omc/etc/certs/omc-ca.crt - certFile: /usr/local/omc/etc/certs/omc-server.crt - keyFile: /usr/local/omc/etc/certs/omc-server.key - -database: - type: mysql - user: root - password: 1000omc@kp! - host: 127.0.0.1 - port: 33066 - name: omc_db - connParam: charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&interpolateParams=True - backup: /usr/local/omc/database - -# Redis data cache -redis: - dataSource: - # OMC system db - default: - port: 6379 # Redis port - host: "127.0.0.1" # Redis host - password: "helloearth" - db: 10 # Redis db_num - # UDM sub/auth db - udmuser: - port: 6379 # Redis port - host: "127.0.0.1" - password: "helloearth" - db: 0 # Redis db_num - # used to specify the default data source for multiple data resourece - defaultDataSourceName: "default" - -# sleep: time delay for after write buffer (millisecond) -# deadLine: timeout for io read and write (second) -mml: - sleep: 200 - deadLine: 10 - sizeRow: 600 - sizeCol: 128 - bufferSize: 65535 - mmlHome: ./mmlhome - -# Tracking configuration -trace: - enabled: true - host: "172.16.5.100" # Fill in the specific IP address - port: 33033 - -# NE config -ne: - user: omcuser - etcdir: /usr/local/etc - bindir: /usr/local/bin - omcdir: /usr/local/omc - scpdir: /tmp - licensedir: /usr/local/etc/{neType}/license - # backup etc list of IMS, does not contain spaces - etcListIMS: '{*.yaml,mmtel,vars.cfg}' - etcListDefault: '{*.yaml,*.conf,*.cfg}' - # true/false to overwrite config file when dpkg ne software - dpkgOverwrite: false - # dpkg timeout (second) - dpkgTimeout: 180 - -# chk2ne: true/false, if put OmcNeConfig parameters to NE -omc: - uriPrefix: "/omc/rest" - neType: OMC - neId: 001 - rmUID: 4400HX101 - neName: OMC - province: "" - vendor: "" - dn: "" - chk2ne: false - sn: "-" - checksign: false - rootDir: /usr/local/omc - binDir: /usr/local/omc/bin - backup: /usr/local/omc/backup - upload: /usr/local/omc/upload - frontUpload: /usr/local/omc/htdocs/front/upload - frontTraceDir: /usr/local/omc/htdocs/front/trace - software: /usr/local/omc/software - license: /usr/local/omc/license - gtpUri: gtp:192.168.2.119:32152 - checkContentType: false - testMode: false - rbacMode: true - runDir: /usr/local/omc/run - cmdTimeout: 120 - -# Alarm module setting -# Forward interface: -# TLS Skip verify: true/false -# email/sms -# smProxy: sms(Short Message Service)/smsc(SMS Centre) -# dataCoding: 0:GSM7BIT, 1:ASCII, 2:BINARY8BIT1, 3:LATIN1, -# 4:BINARY8BIT2, 6:CYRILLIC, 7:HEBREW, 8:UCS2 -alarm: - alarmEmailForward: - enable: true - emailList: - smtp: mail.smtp.com - port: 25 - user: smtpext@smtp.com - password: "1000smtp@omc!" - tlsSkipVerify: true - alarmSMSForward: - enable: true - mobileList: - smscAddr: "192.168.13.114:2775" - systemID: "omc" - password: "omc123" - systemType: "UTRAN" - dataCoding: 0 - serviceNumber: "OMC" - sms: - apiURL: http://smsc.xxx.com/ - accessKeyID: xxxx - accessKeySecret: xxxx - signName: xxx SMSC - templateCode: 1000 - smProxy: smsc - -# User authorized information -# crypt: mysql/md5/bcrypt -# token: true/false to check accessToken -# expires for session, unit: second -# Support single/multiple session of user -# -auth: - crypt: bcrypt - token: true - expires: 1800 - session: multiple - publicKey: /usr/local/omc/etc/certs/omc - privateKey: /usr/local/omc/etc/certs/omc - -# Parameter for limit number -# rmuid_maxnum: the max number of rmUID, default: 50 -# alarmid_maxnum: the max number of AlarmID, default: 50 -# pmid_maxnum: the max number of pmID, default: 50 -# subid_maxnum: the max number of subscription ID, default: 20 -# uri_maxlen: the max length of uri, default: 8192 -# rmuid_regexp: regexp pattern of rmUID -params: - rmuidmaxnum: 50 - alarmidmaxnum: 50 - pmidmaxnum: 50 - subidmaxnum: 20 - urimaxlen: 2100000 - rmuidregexp: "[0-9]{4}[A-Z]{2}[A-Z]{2}[0-9A-Z]{1}[0-9A-Z]{3}[0-9A-Z]{1,16}" - -testConfig: - enabled: false - file: /usr/local/omc/etc/testconfig.yaml \ No newline at end of file diff --git a/build/usr/local/omc/etc/default/sshsvc.yaml b/build/usr/local/omc/etc/default/sshsvc.yaml deleted file mode 100644 index 414c397..0000000 --- a/build/usr/local/omc/etc/default/sshsvc.yaml +++ /dev/null @@ -1,87 +0,0 @@ -# file: log file name -# level: /trace/debug/info/warn/error/fatal, default: debug -# duration: rotation time with xx hours, example: 1/12/24 hours -# count: rotation count of log, default is 30 rotation -logger: - file: /usr/local/omc/log/sshsvc.log - level: warn - duration: 24 - count: 30 - -# file: MML log file name -# duration: rotation time with xx hours, example: 1/12/24 hours -# count: rotation count of log, default is 30 rotation -# level: cmd/ret log cmd/log cmd & result -logmml: - file: /usr/local/omc/mmllog/omcmml.log - duration: 24 - count: 30 - level: cmd - -# ssh service listen ipv4/v6 and port, support multiple routines -# ip: 0.0.0.0 or ::0, support IPv4/v6 -# session: single/multiple session for one user -sshd: - listenAddr: 0.0.0.0 - listenPort: 32222 - privateKey: /usr/local/omc/.ssh/id_rsa - maxConnNum: 2 - timeout: 1800 - session: multiple - mmlHome: /usr/local/omc/mmlhome - userName: manager - password: pass123 - authType: local - tagNE: omc - -# authType: local/omc -telnetServer: - listenAddr: 0.0.0.0 - listenPort: 32323 - maxConnNum: 2 - timeout: 1800 - session: multiple - mmlHome: /usr/local/omc/mmlhome - userName: manager - password: pass123 - authType: local - tagNE: omc - -# authproto: NoAuth/MD5/SHA -# privProto: NoPriv/DES/AES/AES192/AES256 -snmpServer: - listenAddr: '[::]' - listenPort: 34957 - userName: manager - authPass: pass123 - authproto: MD5 - privPass: "3F2A1B4C5D6E7F8A9B0C1D2E3F4A5B6C7D8E9F0A1B2C3D4E" - privProto: DES - engineID: "8000000004323030313a6462383a3a39313636" - trapPort: 34958 - trapListen: false - trapBool: false - trapTick: 60 - timeOut: 5 - trapTarget: "" - -database: - type: mysql - user: root - password: 1000omc@kp! - host: 127.0.0.1 - port: 33066 - name: omc_db - connParam: charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&interpolateParams=True - -omc: - httpUri: http://127.0.0.1:33030 - userCrypt: bcrypt - -ne: - port: 4100 - sleep: 200 - user: admin - password: admin - - diff --git a/build/usr/local/omc/etc/schema/cm-schema.xsd b/build/usr/local/omc/etc/schema/cm-schema.xsd deleted file mode 100644 index 5e7e46c..0000000 --- a/build/usr/local/omc/etc/schema/cm-schema.xsd +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/build/usr/local/omc/etc/schema/pm-schema.xsd b/build/usr/local/omc/etc/schema/pm-schema.xsd deleted file mode 100644 index bb01840..0000000 --- a/build/usr/local/omc/etc/schema/pm-schema.xsd +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/build/usr/local/omc/static/helpDoc/en_doc.pdf b/build/usr/local/omc/static/helpDoc/en_doc.pdf deleted file mode 100644 index 257e76b..0000000 Binary files a/build/usr/local/omc/static/helpDoc/en_doc.pdf and /dev/null differ diff --git a/build/usr/local/omc/static/helpDoc/zh_doc.pdf b/build/usr/local/omc/static/helpDoc/zh_doc.pdf deleted file mode 100644 index 9e2eee2..0000000 Binary files a/build/usr/local/omc/static/helpDoc/zh_doc.pdf and /dev/null differ diff --git a/build/usr/local/omc/upload/.gitkeep b/build/usr/local/omc/upload/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/build_after.sh b/build_after.sh new file mode 100644 index 0000000..b38cbfe --- /dev/null +++ b/build_after.sh @@ -0,0 +1,11 @@ +#!/bin/bash +echo +echo "==> after compilation" +# 编译目录 +echo "BuildDir: $BuildDir" +# 发布包目录 +echo "ReleaseDir: $ReleaseDir" +# 发布包文件名称 +echo "ReleaseFileName: $ReleaseFileName" + +# =================== diff --git a/build_before.sh b/build_before.sh new file mode 100644 index 0000000..efe76f1 --- /dev/null +++ b/build_before.sh @@ -0,0 +1,19 @@ +#!/bin/bash +echo +echo "==> before compilation" +# 编译目录 +echo "BuildDir: $BuildDir" +# 发布包目录 +echo "ReleaseDir: $ReleaseDir" +# 发布包文件名称 +echo "ReleaseFileName: $ReleaseFileName" + +# =================== + +# 数据库脚本 common属于重建脚本 +modeList="standard lite" +for v in ${modeList}; do + cp -rf $BuildDir/usr/local/etc/omc/database/${v}/common/* $BuildDir/usr/local/etc/omc/database/${v}/install/ + cp -rf $BuildDir/usr/local/etc/omc/database/${v}/common/* $BuildDir/usr/local/etc/omc/database/${v}/upgrade/ + rm -rf $BuildDir/usr/local/etc/omc/database/${v}/common +done diff --git a/customized/agt.d/db/customized.sql b/customized/agt.d/db/customized.sql deleted file mode 100644 index 96acc22..0000000 --- a/customized/agt.d/db/customized.sql +++ /dev/null @@ -1,17 +0,0 @@ -SET FOREIGN_KEY_CHECKS = 0; - --- -REPLACE INTO `sys_config` VALUES (6, 'config.sys.officialUrl', 'sys.officialUrl', 'https://www.agrandtech.com', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.officialUrlRemark'); -REPLACE INTO `sys_config` VALUES (26, 'config.sys.title', 'sys.title', 'config.sys.titleValue', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.titleRemark'); -REPLACE INTO `sys_config` VALUES (27, 'config.sys.copyright', 'sys.copyright', 'config.sys.copyrightValue', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.copyrightRemark'); -REPLACE INTO `sys_config` VALUES (28, 'config.sys.i18nOpen', 'sys.i18n.open', 'true', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.i18nOpenRemark'); -REPLACE INTO `sys_config` VALUES (29, 'config.sys.i18nDefault', 'sys.i18n.default', 'en_US', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.i18nDefaultRemark'); - --- -REPLACE INTO `sys_i18n` VALUES (281, '0', 'system', 1699348237468, 'system', 1699348237468, 'config.sys.titleValue', 'AGrand EMS', 'AGrand EMS'); -REPLACE INTO `sys_i18n` VALUES (282, '0', 'system', 1699348237468, 'system', 1699348237468, 'config.sys.copyrightValue', 'Copyright ©2024 千通科技', 'Copyright ©2024 AGrandTech'); - --- set internationalization switching to ON -UPDATE `sys_menu` SET `status_flag` = '1' WHERE `menu_id` = 2122; - -SET FOREIGN_KEY_CHECKS = 1; \ No newline at end of file diff --git a/customized/agt.d/doc/en_doc.pdf b/customized/agt.d/doc/en_doc.pdf deleted file mode 100644 index 257e76b..0000000 Binary files a/customized/agt.d/doc/en_doc.pdf and /dev/null differ diff --git a/customized/agt.d/doc/zh_doc.pdf b/customized/agt.d/doc/zh_doc.pdf deleted file mode 100644 index 9e2eee2..0000000 Binary files a/customized/agt.d/doc/zh_doc.pdf and /dev/null differ diff --git a/customized/agt.d/images/background_dark.jpg b/customized/agt.d/images/background_dark.jpg deleted file mode 100644 index 1b64e7d..0000000 Binary files a/customized/agt.d/images/background_dark.jpg and /dev/null differ diff --git a/customized/agt.d/images/background_light.jpg b/customized/agt.d/images/background_light.jpg deleted file mode 100644 index 1014183..0000000 Binary files a/customized/agt.d/images/background_light.jpg and /dev/null differ diff --git a/customized/agt.d/locales/.gitkeep b/customized/agt.d/locales/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/customized/agt.d/logo/en_brand.png b/customized/agt.d/logo/en_brand.png deleted file mode 100644 index 200025e..0000000 Binary files a/customized/agt.d/logo/en_brand.png and /dev/null differ diff --git a/customized/agt.d/logo/en_icon.png b/customized/agt.d/logo/en_icon.png deleted file mode 100644 index 3ed445d..0000000 Binary files a/customized/agt.d/logo/en_icon.png and /dev/null differ diff --git a/customized/agt.d/logo/zh_brand.png b/customized/agt.d/logo/zh_brand.png deleted file mode 100644 index 5810cf5..0000000 Binary files a/customized/agt.d/logo/zh_brand.png and /dev/null differ diff --git a/customized/agt.d/logo/zh_icon.png b/customized/agt.d/logo/zh_icon.png deleted file mode 100644 index a5b6907..0000000 Binary files a/customized/agt.d/logo/zh_icon.png and /dev/null differ diff --git a/customized/ba.d/db/customized.sql b/customized/ba.d/db/customized.sql deleted file mode 100644 index 641d694..0000000 --- a/customized/ba.d/db/customized.sql +++ /dev/null @@ -1,17 +0,0 @@ -SET FOREIGN_KEY_CHECKS = 0; - --- -REPLACE INTO `sys_config` VALUES (6, 'config.sys.officialUrl', 'sys.officialUrl', 'https://www.bluearcus.com', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.officialUrlRemark'); -REPLACE INTO `sys_config` VALUES (26, 'config.sys.title', 'sys.title', 'config.sys.titleValue', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.titleRemark'); -REPLACE INTO `sys_config` VALUES (27, 'config.sys.copyright', 'sys.copyright', 'config.sys.copyrightValue', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.copyrightRemark'); -REPLACE INTO `sys_config` VALUES (28, 'config.sys.i18nOpen', 'sys.i18n.open', 'false', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.i18nOpenRemark'); -REPLACE INTO `sys_config` VALUES (29, 'config.sys.i18nDefault', 'sys.i18n.default', 'en_US', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.i18nDefaultRemark'); - --- -REPLACE INTO `sys_i18n` VALUES (281, '0', 'system', 1699348237468, 'system', 1699348237468, 'config.sys.titleValue', 'BlueArcus EMS', 'BlueArcus EMS'); -REPLACE INTO `sys_i18n` VALUES (282, '0', 'system', 1699348237468, 'system', 1699348237468, 'config.sys.copyrightValue', 'Copyright ©2024 BlueArcus', 'Copyright ©2024 BlueArcus'); - --- set internationalization switching to ON -UPDATE `sys_menu` SET `status_flag` = '0' WHERE `menu_id` = 2122; - -SET FOREIGN_KEY_CHECKS = 1; \ No newline at end of file diff --git a/customized/ba.d/doc/en_doc.pdf b/customized/ba.d/doc/en_doc.pdf deleted file mode 100644 index 257e76b..0000000 Binary files a/customized/ba.d/doc/en_doc.pdf and /dev/null differ diff --git a/customized/ba.d/images/background_dark.jpg b/customized/ba.d/images/background_dark.jpg deleted file mode 100644 index 5daea14..0000000 Binary files a/customized/ba.d/images/background_dark.jpg and /dev/null differ diff --git a/customized/ba.d/images/background_light.jpg b/customized/ba.d/images/background_light.jpg deleted file mode 100644 index 5daea14..0000000 Binary files a/customized/ba.d/images/background_light.jpg and /dev/null differ diff --git a/customized/ba.d/locales/zh-CN.ts b/customized/ba.d/locales/zh-CN.ts deleted file mode 100644 index 02a61be..0000000 --- a/customized/ba.d/locales/zh-CN.ts +++ /dev/null @@ -1,2 +0,0 @@ -export default { -}; diff --git a/customized/ba.d/logo/en_brand.png b/customized/ba.d/logo/en_brand.png deleted file mode 100644 index 5d04ab3..0000000 Binary files a/customized/ba.d/logo/en_brand.png and /dev/null differ diff --git a/customized/ba.d/logo/en_icon.png b/customized/ba.d/logo/en_icon.png deleted file mode 100644 index 8ba330e..0000000 Binary files a/customized/ba.d/logo/en_icon.png and /dev/null differ diff --git a/customized/omc.d/db/customized.sql b/customized/omc.d/db/customized.sql deleted file mode 100644 index 68daedc..0000000 --- a/customized/omc.d/db/customized.sql +++ /dev/null @@ -1,17 +0,0 @@ -SET FOREIGN_KEY_CHECKS = 0; - --- -REPLACE INTO `sys_config` VALUES (6, 'config.sys.officialUrl', 'sys.officialUrl', '#', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.officialUrlRemark'); -REPLACE INTO `sys_config` VALUES (26, 'config.sys.title', 'sys.title', 'config.sys.titleValue', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.titleRemark'); -REPLACE INTO `sys_config` VALUES (27, 'config.sys.copyright', 'sys.copyright', 'config.sys.copyrightValue', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.copyrightRemark'); -REPLACE INTO `sys_config` VALUES (28, 'config.sys.i18nOpen', 'sys.i18n.open', 'true', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.i18nOpenRemark'); -REPLACE INTO `sys_config` VALUES (29, 'config.sys.i18nDefault', 'sys.i18n.default', 'en_US', 'Y', '0', 'system', 1704960008300, 'system', 1704960008300, 'config.sys.i18nDefaultRemark'); - --- -REPLACE INTO `sys_i18n` VALUES (281, '0', 'system', 1699348237468, 'system', 1699348237468, 'config.sys.titleValue', 'OMC', 'OMC'); -REPLACE INTO `sys_i18n` VALUES (282, '0', 'system', 1699348237468, 'system', 1699348237468, 'config.sys.copyrightValue', 'Copyright ©2024 OMC', 'Copyright ©2024 OMC'); - --- set internationalization switching to ON -UPDATE `sys_menu` SET `status_flag` = '1' WHERE `menu_id` = 2122; - -SET FOREIGN_KEY_CHECKS = 1; \ No newline at end of file diff --git a/customized/omc.d/doc/en_doc.pdf b/customized/omc.d/doc/en_doc.pdf deleted file mode 100644 index 257e76b..0000000 Binary files a/customized/omc.d/doc/en_doc.pdf and /dev/null differ diff --git a/customized/omc.d/doc/zh_doc.pdf b/customized/omc.d/doc/zh_doc.pdf deleted file mode 100644 index 9e2eee2..0000000 Binary files a/customized/omc.d/doc/zh_doc.pdf and /dev/null differ diff --git a/customized/omc.d/images/background_dark.jpg b/customized/omc.d/images/background_dark.jpg deleted file mode 100644 index 1b64e7d..0000000 Binary files a/customized/omc.d/images/background_dark.jpg and /dev/null differ diff --git a/customized/omc.d/images/background_light.jpg b/customized/omc.d/images/background_light.jpg deleted file mode 100644 index 1014183..0000000 Binary files a/customized/omc.d/images/background_light.jpg and /dev/null differ diff --git a/customized/omc.d/locales/.gitkeep b/customized/omc.d/locales/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/customized/omc.d/logo/en_brand.png b/customized/omc.d/logo/en_brand.png deleted file mode 100644 index c5d39e4..0000000 Binary files a/customized/omc.d/logo/en_brand.png and /dev/null differ diff --git a/customized/omc.d/logo/en_icon.png b/customized/omc.d/logo/en_icon.png deleted file mode 100644 index 6fb8d2b..0000000 Binary files a/customized/omc.d/logo/en_icon.png and /dev/null differ diff --git a/customized/omc.d/logo/zh_brand.png b/customized/omc.d/logo/zh_brand.png deleted file mode 100644 index c5d39e4..0000000 Binary files a/customized/omc.d/logo/zh_brand.png and /dev/null differ diff --git a/customized/omc.d/logo/zh_icon.png b/customized/omc.d/logo/zh_icon.png deleted file mode 100644 index 6fb8d2b..0000000 Binary files a/customized/omc.d/logo/zh_icon.png and /dev/null differ diff --git a/debbuild/22.04/DEBIAN/control b/debbuild/22.04/DEBIAN/control deleted file mode 100644 index 887c0ae..0000000 --- a/debbuild/22.04/DEBIAN/control +++ /dev/null @@ -1,8 +0,0 @@ -Package: OMC -Version: 2.2503.2-YYYYMMDD -Section: AGrandTech -Prioritt: optional -Architecture: amd64 -Maintainer: Simon Zhangsz -Depends: -Description: OMC diff --git a/debbuild/22.04/DEBIAN/postinst b/debbuild/22.04/DEBIAN/postinst deleted file mode 100755 index 87ca049..0000000 --- a/debbuild/22.04/DEBIAN/postinst +++ /dev/null @@ -1,95 +0,0 @@ -# !/bin/bash - -OMCRootDir=/usr/local/omc -SystemdRootDir=/lib/systemd/system -OMCEtcDir=${OMCRootDir}/etc -FERootDir=${OMCRootDir}/htdocs/front -OmcBinDir=${OMCRootDir}/bin -OMCStaticDir=${OMCRootDir}/static -UsrLocalBinDir=/usr/local/bin -OmcDaemon=omcd -NginxEtcDir=/etc/nginx -NginxConfDir=${NginxEtcDir}/conf.d -CFileList="restconf.yaml sshsvc.yaml omc.conf" -LogoFileList="zh_brand.png zh_icon.png en_brand.png en_icon.png" - -echo "" -echo "* To start/stop/restart/status omc service, please run:" -echo " sudo systemctl start/stop/restart/status restagent.service" -echo " sudo systemctl start/stop/restart/status sshsvc.service" -echo " or run: " -echo " sudo /usr/local/omc/bin/omcsvc.sh start/stop/restart/status" -echo "" - -cd ${UsrLocalBinDir} -if [ ! -e ${OmcDaemon} ]; then ln -s ${OmcBinDir}/omcsvc.sh ${OmcDaemon}; fi - -chmod +rx ${OMCRootDir}/bin/* -chmod +rx ${OMCRootDir}/* -chmod +rx ${UsrLocalBinDir}/* -chmod -R 755 ${OMCRootDir}/htdocs/front - -for CFile in ${CFileList}; do - if [ ! -e "${OMCEtcDir}/${CFile}" ]; then - cp -f ${OMCEtcDir}/default/${CFile} ${OMCEtcDir} - else - # mv -f ${OMCEtcDir}/${CFile} ${OMCEtcDir}/${CFile}.bak - # cp -f ${OMCEtcDir}/default/${CFile} ${OMCEtcDir} - if [ -e "${OMCBinDir}/upgconf.sh" ]; then - ${OMCBinDir}/upgconf.sh - fi - fi -done - -if [ ! -e "${FERootDir}/config.js" ]; then - cp ${FERootDir}/default/config.js ${FERootDir}; -fi - -for LogoFile in ${LogoFileList}; do - if [ ! -e "${OMCStaticDir}/logo/${LogoFile}" ]; then - cp ${OMCStaticDir}/omc.d/logo/${LogoFile} ${OMCStaticDir}/logo; - fi -done - -if ! id -u omc >/dev/null 2>&1 ; then - useradd -d /opt/omc -m -s /bin/bash -pomc123 omc; - mkdir -p /opt/omc/ftp -else - echo "user omc exist"; -fi - -if [ ! -e "${NginxConfDir}/omc.conf" ]; then - mkdir -p ${NginxConfDir} - cp -f ${OMCEtcDir}/nginx/omc.conf ${NginxConfDir}; -fi - -systemctl daemon-reload - -# disable auto upgrade -systemctl disable --now unattended-upgrades - -systemctl enable restagent.service -systemctl enable sshsvc.service - -systemctl daemon-reload - -# read environment parameter and to do -if [ "$M_PARAM" = "install" -o "$M_PARAM" = "upgrade" ]; then - echo "M parameter: $M_PARAM" - if [ -n "$C_PARAM" ]; then - echo "C parameter: $C_PARAM" - ${OMCRootDir}/bin/setomc.sh -m $M_PARAM -c $C_PARAM - else - ${OMCRootDir}/bin/setomc.sh -m $M_PARAM - fi - # exit while failed to run setomc.sh - if [ $? -ne 0 ]; then - echo "setomc.sh execution failed. Exiting." - exit 1 - fi -fi - -echo -n "Starting OMC service ... " -systemctl start sshsvc.service -systemctl start restagent.service -echo "done" diff --git a/debbuild/22.04/DEBIAN/postrm b/debbuild/22.04/DEBIAN/postrm deleted file mode 100755 index 87c42a9..0000000 --- a/debbuild/22.04/DEBIAN/postrm +++ /dev/null @@ -1,19 +0,0 @@ -# !/bin/bash - -#rm -rf /usr/local/omc -rm -rf /etc/nginx/conf.d/omc.conf -rm -f /usr/local/bin/omcd - -systemctl daemon-reload - -if systemctl list-units --type=service --all | grep -q 'restagent.service'; then - echo -n "Stopping OMC service ... " - systemctl stop restagent.service - systemctl stop sshsvc.service - echo "done" -fi - -systemctl disable restagent.service -systemctl disable sshsvc.service - -systemctl daemon-reload diff --git a/debbuild/22.04/DEBIAN/preinst b/debbuild/22.04/DEBIAN/preinst deleted file mode 100755 index d9a5cb1..0000000 --- a/debbuild/22.04/DEBIAN/preinst +++ /dev/null @@ -1,17 +0,0 @@ -# !/bin/bash - -systemctl daemon-reload -if systemctl list-units --type=service --all | grep -q 'restagent.service'; then - echo -n "Stopping OMC service ... " - systemctl stop restagent.service - systemctl stop sshsvc.service - echo "done" -fi - -FERootDir=/usr/local/omc/htdocs/front - -# apt-get install zip -# clear front-end old hash js files -rm -rf ${FERootDir}/assets -rm -rf ${FERootDir}/js -rm -rf ${FERootDir}/index.*.js diff --git a/debbuild/22.04/etc/nginx/conf.d/omc.conf b/debbuild/22.04/etc/nginx/conf.d/omc.conf deleted file mode 100644 index 0e1facc..0000000 --- a/debbuild/22.04/etc/nginx/conf.d/omc.conf +++ /dev/null @@ -1,71 +0,0 @@ -server { - listen 44080; - listen 44443; - listen [::]:44080; - listen [::]:44443; - server_name localhost; - - client_max_body_size 100M; - keepalive_timeout 180s; - - #access_log /var/log/nginx/host.access.log main; - - # ssl_certificate /usr/local/omc/etc/certs/omc-server.crt; - # ssl_certificate_key /usr/local/omc/etc/certs/omc-server.key; - # ssl_client_certificate /usr/local/omc/etc/certs/omc-ca.crt; - # ssl_verify_client on; - # ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; - # ssl_session_timeout 5m; - # ssl_ciphers EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5; - # ssl_prefer_server_ciphers on; - - # OMC - location / { - root /usr/local/omc/htdocs/front; - - try_files $uri $uri/ /index.html; - index index.html index.htm; - } - - location /omc-api/ { - proxy_pass http://127.0.0.1:33030/; - - proxy_connect_timeout 180s; - proxy_send_timeout 180s; - proxy_read_timeout 180s; - - proxy_cache_bypass $http_upgrade; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; - } - - location /api/rest/ { - proxy_pass http://127.0.0.1:33030/api/rest/; - - proxy_cache_bypass $http_upgrade; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; - } - - #error_page 404 /404.html; - - # redirect server error pages to the static page /50x.html - # - error_page 500 502 503 504 /50x.html; - location = /50x.html { - root /usr/share/nginx/html; - } -} - diff --git a/debbuild/22.04/lib/x86_64-linux-gnu/libwireshark.so.15.0.12 b/debbuild/22.04/lib/x86_64-linux-gnu/libwireshark.so.15.0.12 deleted file mode 100644 index 9a42ac2..0000000 Binary files a/debbuild/22.04/lib/x86_64-linux-gnu/libwireshark.so.15.0.12 and /dev/null differ diff --git a/debbuild/22.04/lib/x86_64-linux-gnu/libwiretap.so.12.0.12 b/debbuild/22.04/lib/x86_64-linux-gnu/libwiretap.so.12.0.12 deleted file mode 100644 index 83e6ac4..0000000 Binary files a/debbuild/22.04/lib/x86_64-linux-gnu/libwiretap.so.12.0.12 and /dev/null differ diff --git a/debbuild/22.04/lib/x86_64-linux-gnu/libwsutil.so.13.1.0 b/debbuild/22.04/lib/x86_64-linux-gnu/libwsutil.so.13.1.0 deleted file mode 100644 index 3b1d380..0000000 Binary files a/debbuild/22.04/lib/x86_64-linux-gnu/libwsutil.so.13.1.0 and /dev/null differ diff --git a/debbuild/22.04/usr/local/bin/tshark b/debbuild/22.04/usr/local/bin/tshark deleted file mode 100644 index f0dc292..0000000 Binary files a/debbuild/22.04/usr/local/bin/tshark and /dev/null differ diff --git a/debbuild/22.04/usr/local/bin/unzip b/debbuild/22.04/usr/local/bin/unzip deleted file mode 100644 index c361807..0000000 Binary files a/debbuild/22.04/usr/local/bin/unzip and /dev/null differ diff --git a/debbuild/22.04/usr/local/bin/xsltproc b/debbuild/22.04/usr/local/bin/xsltproc deleted file mode 100644 index fecac3e..0000000 Binary files a/debbuild/22.04/usr/local/bin/xsltproc and /dev/null differ diff --git a/debbuild/22.04/usr/local/bin/zip b/debbuild/22.04/usr/local/bin/zip deleted file mode 100644 index 5e347a4..0000000 Binary files a/debbuild/22.04/usr/local/bin/zip and /dev/null differ diff --git a/debbuild/22.04/usr/local/omc/.ssh/id_rsa b/debbuild/22.04/usr/local/omc/.ssh/id_rsa deleted file mode 100644 index b9e6a0e..0000000 --- a/debbuild/22.04/usr/local/omc/.ssh/id_rsa +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/debbuild/22.04/usr/local/omc/.ssh/id_rsa.pub b/debbuild/22.04/usr/local/omc/.ssh/id_rsa.pub deleted file mode 100644 index 93e845f..0000000 --- a/debbuild/22.04/usr/local/omc/.ssh/id_rsa.pub +++ /dev/null @@ -1 +0,0 @@ -ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCjzE0MHy0P2sQmG1OKvArwLEzR77BwxPp+4N9NKBz8lEyNch4zoHvoLDaUJKPBMwTrScZnxhvRJNde6hz5Z0QVxZolVKV95fMfgb9YICzDfPF3Bphae5q/PBYUJNfrC9SAjQeHV4CCO6xk6LV8O/Nfw8uaXwtuN3yfpUWd5mRWKMc3GHV4vxerfKoIQZN6etLhIEYibAhCJ21P0uoWzZl7ceLmkG+6qrRSbyC0bCnrN3+wjN4bwtflrEFJk3XQGuRbVsYLzux+mMm9p22+CLPRl/FUPF3x4/wKCsqr7JDSxx80HSPhk4g/1nCTpDR9hAfF6A9ww2va/k8jMeYPBO8Owe7erLEZzvg5WQAR3Wj05eJpJD99BeC91S5KW6AFQDfDHxWWprSibd/Jj9dtct2pK2ZxW0ph9OJ49ftRhzT1iVi4UnJwnG5/qLfwl6Tnx+qnQ1If/9lY/99erCTATzFTMSImKrRz7CnuPlcw8WkzCYpWKKe0kJLkL2cRD5Qi4yk= simon@simonzhangsz diff --git a/debbuild/22.04/usr/local/omc/.ssh/private_key.pem b/debbuild/22.04/usr/local/omc/.ssh/private_key.pem deleted file mode 100644 index b9e6a0e..0000000 --- a/debbuild/22.04/usr/local/omc/.ssh/private_key.pem +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/debbuild/22.04/usr/local/omc/etc/default/restconf.yaml b/debbuild/22.04/usr/local/omc/etc/default/restconf.yaml deleted file mode 100644 index 60d882a..0000000 --- a/debbuild/22.04/usr/local/omc/etc/default/restconf.yaml +++ /dev/null @@ -1,193 +0,0 @@ -# file: log file name -# level: /trace/debug/info/warn/error/fatal, default: debug -# duration: rotation time with xx hours, example: 1/12/24 hours -# count: rotation count of log, default is 30 rotation -logger: - file: /usr/local/omc/log/restagent.log - level: warn - duration: 24 - count: 90 - -# rest agent listen ipv4/v6 and port, support multiple routines -# ip: 0.0.0.0 or ::0, support IPv4/v6 -# clientAuthType: 0:NoClientCert (default), 1:RequestClientCert, 2:RequireAnyClientCert, -# 3:VerifyClientCertIfGiven, 4:RequireAndVerifyClientCerts -rest: - - ipv4: 0.0.0.0 - ipv6: - port: 33030 - - ipv4: 0.0.0.0 - ipv6: - port: 33443 - schema: https - clientAuthType: 0 - caFile: /usr/local/omc/etc/certs/omc-ca.crt - certFile: /usr/local/omc/etc/certs/omc-server.crt - keyFile: /usr/local/omc/etc/certs/omc-server.key - -webServer: - enabled: true - rootDir: /usr/local/omc/htdocs/front - listen: - - addr: :80 - schema: http - - addr: :443 - schema: https - clientAuthType: 0 - caFile: /usr/local/omc/etc/certs/omc-ca.crt - certFile: /usr/local/omc/etc/certs/omc-server.crt - keyFile: /usr/local/omc/etc/certs/omc-server.key - -database: - type: mysql - user: root - password: 1000omc@kp! - host: 127.0.0.1 - port: 33066 - name: omc_db - connParam: charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&interpolateParams=True - backup: /usr/local/omc/database - -# Redis data cache -redis: - dataSource: - # OMC system db - default: - port: 6379 # Redis port - host: "127.0.0.1" # Redis host - password: "helloearth" - db: 10 # Redis db_num - # UDM sub/auth db - udmuser: - port: 6379 # Redis port - host: "127.0.0.1" - password: "helloearth" - db: 0 # Redis db_num - # used to specify the default data source for multiple data resourece - defaultDataSourceName: "default" - -# sleep: time delay for after write buffer (millisecond) -# deadLine: timeout for io read and write (second) -mml: - sleep: 200 - deadLine: 10 - sizeRow: 600 - sizeCol: 128 - bufferSize: 65535 - mmlHome: ./mmlhome - -# Tracking configuration -trace: - enabled: true - host: "172.16.5.100" # Fill in the specific IP address - port: 33033 - -# NE config -ne: - user: omcuser - etcdir: /usr/local/etc - bindir: /usr/local/bin - omcdir: /usr/local/omc - scpdir: /tmp - licensedir: /usr/local/etc/{neType}/license - # backup etc list of IMS, does not contain spaces - etcListIMS: '{*.yaml,mmtel,vars.cfg}' - etcListDefault: '{*.yaml,*.conf,*.cfg}' - # true/false to overwrite config file when dpkg ne software - dpkgOverwrite: false - # dpkg timeout (second) - dpkgTimeout: 180 - -# chk2ne: true/false, if put OmcNeConfig parameters to NE -omc: - uriPrefix: "/omc/rest" - neType: OMC - neId: 001 - rmUID: 4400HX101 - neName: OMC - province: "" - vendor: "" - dn: "" - chk2ne: false - sn: "-" - checksign: false - rootDir: /usr/local/omc - binDir: /usr/local/omc/bin - backup: /usr/local/omc/backup - upload: /usr/local/omc/upload - frontUpload: /usr/local/omc/htdocs/front/upload - frontTraceDir: /usr/local/omc/htdocs/front/trace - software: /usr/local/omc/software - license: /usr/local/omc/license - gtpUri: gtp:192.168.2.119:32152 - checkContentType: false - testMode: false - rbacMode: true - runDir: /usr/local/omc/run - cmdTimeout: 120 - -# Alarm module setting -# Forward interface: -# TLS Skip verify: true/false -# email/sms -# smProxy: sms(Short Message Service)/smsc(SMS Centre) -# dataCoding: 0:GSM7BIT, 1:ASCII, 2:BINARY8BIT1, 3:LATIN1, -# 4:BINARY8BIT2, 6:CYRILLIC, 7:HEBREW, 8:UCS2 -alarm: - alarmEmailForward: - enable: true - emailList: - smtp: mail.smtp.com - port: 25 - user: smtpext@smtp.com - password: "1000smtp@omc!" - tlsSkipVerify: true - alarmSMSForward: - enable: true - mobileList: - smscAddr: "192.168.13.114:2775" - systemID: "omc" - password: "omc123" - systemType: "UTRAN" - dataCoding: 0 - serviceNumber: "OMC" - sms: - apiURL: http://smsc.xxx.com/ - accessKeyID: xxxx - accessKeySecret: xxxx - signName: xxx SMSC - templateCode: 1000 - smProxy: smsc - -# User authorized information -# crypt: mysql/md5/bcrypt -# token: true/false to check accessToken -# expires for session, unit: second -# Support single/multiple session of user -# -auth: - crypt: bcrypt - token: true - expires: 1800 - session: multiple - publicKey: /usr/local/omc/etc/certs/omc - privateKey: /usr/local/omc/etc/certs/omc - -# Parameter for limit number -# rmuid_maxnum: the max number of rmUID, default: 50 -# alarmid_maxnum: the max number of AlarmID, default: 50 -# pmid_maxnum: the max number of pmID, default: 50 -# subid_maxnum: the max number of subscription ID, default: 20 -# uri_maxlen: the max length of uri, default: 8192 -# rmuid_regexp: regexp pattern of rmUID -params: - rmuidmaxnum: 50 - alarmidmaxnum: 50 - pmidmaxnum: 50 - subidmaxnum: 20 - urimaxlen: 2100000 - rmuidregexp: "[0-9]{4}[A-Z]{2}[A-Z]{2}[0-9A-Z]{1}[0-9A-Z]{3}[0-9A-Z]{1,16}" - -testConfig: - enabled: false - file: /usr/local/omc/etc/testconfig.yaml \ No newline at end of file diff --git a/debbuild/DEBIAN/control b/debbuild/DEBIAN/control deleted file mode 100644 index 887c0ae..0000000 --- a/debbuild/DEBIAN/control +++ /dev/null @@ -1,8 +0,0 @@ -Package: OMC -Version: 2.2503.2-YYYYMMDD -Section: AGrandTech -Prioritt: optional -Architecture: amd64 -Maintainer: Simon Zhangsz -Depends: -Description: OMC diff --git a/debbuild/DEBIAN/postinst b/debbuild/DEBIAN/postinst deleted file mode 100644 index 55ebdd3..0000000 --- a/debbuild/DEBIAN/postinst +++ /dev/null @@ -1,100 +0,0 @@ -# !/bin/bash - -OMCRootDir=/usr/local/omc -SystemdRootDir=/lib/systemd/system -OMCEtcDir=${OMCRootDir}/etc -FERootDir=${OMCRootDir}/htdocs/front -OmcBinDir=${OMCRootDir}/bin -OMCStaticDir=${OMCRootDir}/static -UsrLocalBinDir=/usr/local/bin -OmcDaemon=omcd -NginxEtcDir=/etc/nginx -NginxConfDir=${NginxEtcDir}/conf.d -CFileList="restconf.yaml sshsvc.yaml omc.conf" -LogoFileList="zh_brand.png zh_icon.png en_brand.png en_icon.png" - -echo "" -echo "* To start/stop/restart/status omc service, please run:" -echo " sudo systemctl start/stop/restart/status restagent.service" -echo " sudo systemctl start/stop/restart/status sshsvc.service" -echo " or run: " -echo " sudo /usr/local/omc/bin/omcsvc.sh start/stop/restart/status" -echo "" - -cd ${UsrLocalBinDir} -if [ ! -e ${OmcDaemon} ]; then ln -s ${OmcBinDir}/omcsvc.sh ${OmcDaemon}; fi - -chmod +rx ${OMCRootDir}/bin/* -chmod +rx ${OMCRootDir}/* -chmod +rx ${UsrLocalBinDir}/* -chmod -R 755 ${OMCRootDir}/htdocs/front - -for CFile in ${CFileList}; do - if [ ! -e "${OMCEtcDir}/${CFile}" ]; then - cp -f ${OMCEtcDir}/default/${CFile} ${OMCEtcDir} - else - # mv -f ${OMCEtcDir}/${CFile} ${OMCEtcDir}/${CFile}.bak - # cp -f ${OMCEtcDir}/default/${CFile} ${OMCEtcDir} - if [ -e "${OMCBinDir}/upgconf.sh" ]; then - ${OMCBinDir}/upgconf.sh - fi - fi -done - -if [ ! -e "${FERootDir}/config.js" ]; then - cp ${FERootDir}/default/config.js ${FERootDir}; -fi - -for LogoFile in ${LogoFileList}; do - if [ ! -e "${OMCStaticDir}/logo/${LogoFile}" ]; then - cp ${OMCStaticDir}/omc.d/logo/${LogoFile} ${OMCStaticDir}/logo; - fi -done - -if ! id -u omc >/dev/null 2>&1 ; then - useradd -d /opt/omc -m -s /bin/bash -pomc123 omc; - mkdir -p /opt/omc/ftp -else - echo "user omc exist"; -fi - -if [ ! -e "${NginxConfDir}/omc.conf" ]; then - mkdir -p ${NginxConfDir} - cp -f ${OMCEtcDir}/nginx/omc.conf ${NginxConfDir}; -fi - -if [ ! -e "${OMCRootDir}/database/omc_db.sqlite" ]; then - mkdir -p ${OMCRootDir}/database - cp -f ${OMCRootDir}/etc/db/omc_db.sqlite ${OMCRootDir}/database/omc_db.sqlite; -fi - -systemctl daemon-reload - -# disable auto upgrade -systemctl disable --now unattended-upgrades - -systemctl enable restagent.service -systemctl enable sshsvc.service - -systemctl daemon-reload - -# read environment parameter and to do -if [ "$M_PARAM" = "install" -o "$M_PARAM" = "upgrade" ]; then - echo "M parameter: $M_PARAM" - if [ -n "$C_PARAM" ]; then - echo "C parameter: $C_PARAM" - ${OMCRootDir}/bin/setomc.sh -m $M_PARAM -c $C_PARAM - else - ${OMCRootDir}/bin/setomc.sh -m $M_PARAM - fi - # exit while failed to run setomc.sh - if [ $? -ne 0 ]; then - echo "setomc.sh execution failed. Exiting." - exit 1 - fi -fi - -echo -n "Starting OMC service ... " -systemctl start sshsvc.service -systemctl start restagent.service -echo "done" diff --git a/debbuild/DEBIAN/postrm b/debbuild/DEBIAN/postrm deleted file mode 100644 index 87c42a9..0000000 --- a/debbuild/DEBIAN/postrm +++ /dev/null @@ -1,19 +0,0 @@ -# !/bin/bash - -#rm -rf /usr/local/omc -rm -rf /etc/nginx/conf.d/omc.conf -rm -f /usr/local/bin/omcd - -systemctl daemon-reload - -if systemctl list-units --type=service --all | grep -q 'restagent.service'; then - echo -n "Stopping OMC service ... " - systemctl stop restagent.service - systemctl stop sshsvc.service - echo "done" -fi - -systemctl disable restagent.service -systemctl disable sshsvc.service - -systemctl daemon-reload diff --git a/debbuild/DEBIAN/preinst b/debbuild/DEBIAN/preinst deleted file mode 100644 index d9a5cb1..0000000 --- a/debbuild/DEBIAN/preinst +++ /dev/null @@ -1,17 +0,0 @@ -# !/bin/bash - -systemctl daemon-reload -if systemctl list-units --type=service --all | grep -q 'restagent.service'; then - echo -n "Stopping OMC service ... " - systemctl stop restagent.service - systemctl stop sshsvc.service - echo "done" -fi - -FERootDir=/usr/local/omc/htdocs/front - -# apt-get install zip -# clear front-end old hash js files -rm -rf ${FERootDir}/assets -rm -rf ${FERootDir}/js -rm -rf ${FERootDir}/index.*.js diff --git a/debbuild/lib/x86_64-linux-gnu/libwireshark.so.15.0.12 b/debbuild/lib/x86_64-linux-gnu/libwireshark.so.15.0.12 deleted file mode 100644 index 9a42ac2..0000000 Binary files a/debbuild/lib/x86_64-linux-gnu/libwireshark.so.15.0.12 and /dev/null differ diff --git a/debbuild/lib/x86_64-linux-gnu/libwiretap.so.12.0.12 b/debbuild/lib/x86_64-linux-gnu/libwiretap.so.12.0.12 deleted file mode 100644 index 83e6ac4..0000000 Binary files a/debbuild/lib/x86_64-linux-gnu/libwiretap.so.12.0.12 and /dev/null differ diff --git a/debbuild/lib/x86_64-linux-gnu/libwsutil.so.13.1.0 b/debbuild/lib/x86_64-linux-gnu/libwsutil.so.13.1.0 deleted file mode 100644 index 3b1d380..0000000 Binary files a/debbuild/lib/x86_64-linux-gnu/libwsutil.so.13.1.0 and /dev/null differ diff --git a/debbuild/usr/local/bin/tshark b/debbuild/usr/local/bin/tshark deleted file mode 100644 index 05374f6..0000000 Binary files a/debbuild/usr/local/bin/tshark and /dev/null differ diff --git a/debbuild/usr/local/bin/unzip b/debbuild/usr/local/bin/unzip deleted file mode 100644 index cda83f9..0000000 Binary files a/debbuild/usr/local/bin/unzip and /dev/null differ diff --git a/debbuild/usr/local/bin/xsltproc b/debbuild/usr/local/bin/xsltproc deleted file mode 100644 index 428a6d1..0000000 Binary files a/debbuild/usr/local/bin/xsltproc and /dev/null differ diff --git a/debbuild/usr/local/bin/zip b/debbuild/usr/local/bin/zip deleted file mode 100644 index 1bbc48e..0000000 Binary files a/debbuild/usr/local/bin/zip and /dev/null differ diff --git a/debbuild/usr/local/omc/.ssh/id_rsa b/debbuild/usr/local/omc/.ssh/id_rsa deleted file mode 100644 index b9e6a0e..0000000 --- a/debbuild/usr/local/omc/.ssh/id_rsa +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/debbuild/usr/local/omc/.ssh/id_rsa.pub b/debbuild/usr/local/omc/.ssh/id_rsa.pub deleted file mode 100644 index 93e845f..0000000 --- a/debbuild/usr/local/omc/.ssh/id_rsa.pub +++ /dev/null @@ -1 +0,0 @@ -ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCjzE0MHy0P2sQmG1OKvArwLEzR77BwxPp+4N9NKBz8lEyNch4zoHvoLDaUJKPBMwTrScZnxhvRJNde6hz5Z0QVxZolVKV95fMfgb9YICzDfPF3Bphae5q/PBYUJNfrC9SAjQeHV4CCO6xk6LV8O/Nfw8uaXwtuN3yfpUWd5mRWKMc3GHV4vxerfKoIQZN6etLhIEYibAhCJ21P0uoWzZl7ceLmkG+6qrRSbyC0bCnrN3+wjN4bwtflrEFJk3XQGuRbVsYLzux+mMm9p22+CLPRl/FUPF3x4/wKCsqr7JDSxx80HSPhk4g/1nCTpDR9hAfF6A9ww2va/k8jMeYPBO8Owe7erLEZzvg5WQAR3Wj05eJpJD99BeC91S5KW6AFQDfDHxWWprSibd/Jj9dtct2pK2ZxW0ph9OJ49ftRhzT1iVi4UnJwnG5/qLfwl6Tnx+qnQ1If/9lY/99erCTATzFTMSImKrRz7CnuPlcw8WkzCYpWKKe0kJLkL2cRD5Qi4yk= simon@simonzhangsz diff --git a/debbuild/usr/local/omc/.ssh/private_key.pem b/debbuild/usr/local/omc/.ssh/private_key.pem deleted file mode 100644 index b9e6a0e..0000000 --- a/debbuild/usr/local/omc/.ssh/private_key.pem +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/debbuild/usr/local/omc/etc/default/restconf.yaml b/debbuild/usr/local/omc/etc/default/restconf.yaml deleted file mode 100644 index 72cbf8e..0000000 --- a/debbuild/usr/local/omc/etc/default/restconf.yaml +++ /dev/null @@ -1,183 +0,0 @@ -# file: log file name -# level: /trace/debug/info/warn/error/fatal, default: debug -# duration: rotation time with xx hours, example: 1/12/24 hours -# count: rotation count of log, default is 30 rotation -logger: - file: /usr/local/omc/log/restagent.log - level: warn - duration: 24 - count: 90 - -# rest agent listen ipv4/v6 and port, support multiple routines -# ip: 0.0.0.0 or ::0, support IPv4/v6 -# clientAuthType: 0:NoClientCert (default), 1:RequestClientCert, 2:RequireAnyClientCert, -# 3:VerifyClientCertIfGiven, 4:RequireAndVerifyClientCerts -rest: - - ipv4: 0.0.0.0 - ipv6: - port: 33030 - - ipv4: 0.0.0.0 - ipv6: - port: 33443 - schema: https - clientAuthType: 0 - caFile: /usr/local/omc/etc/certs/omc-ca.crt - certFile: /usr/local/omc/etc/certs/omc-server.crt - keyFile: /usr/local/omc/etc/certs/omc-server.key - -webServer: - enabled: true - rootDir: /usr/local/omc/htdocs/front - listen: - - addr: :80 - schema: http - - addr: :443 - schema: https - clientAuthType: 0 - caFile: /usr/local/omc/etc/certs/omc-ca.crt - certFile: /usr/local/omc/etc/certs/omc-server.crt - keyFile: /usr/local/omc/etc/certs/omc-server.key - -database: - type: mysql - user: root - password: 1000omc@kp! - host: 127.0.0.1 - port: 33066 - name: omc_db - connParam: charset=utf8mb4&collation=utf8mb4_general_ci&parseTime=True&interpolateParams=True - backup: /usr/local/omc/database - -# Redis data cache -redis: - dataSource: - # OMC system db - default: - port: 6379 # Redis port - host: "127.0.0.1" # Redis host - password: "helloearth" - db: 10 # Redis db_num - # UDM sub/auth db - udmuser: - port: 6379 # Redis port - host: "127.0.0.1" - password: "helloearth" - db: 0 # Redis db_num - # used to specify the default data source for multiple data resourece - defaultDataSourceName: "default" - -# sleep: time delay for after write buffer (millisecond) -# deadLine: timeout for io read and write (second) -mml: - port: 4100 - port2: 5002 - sleep: 200 - deadLine: 10 - sizeRow: 600 - sizeCol: 128 - bufferSize: 65535 - user: admin - password: admin - mmlHome: ./mmlhome - -# NE config -ne: - user: omcuser - etcdir: /usr/local/etc - bindir: /usr/local/bin - omcdir: /usr/local/omc - scpdir: /tmp - licensedir: /usr/local/etc/{neType}/license - # backup etc list of IMS, does not contain spaces - etcListIMS: '{*.yaml,mmtel,vars.cfg}' - etcListDefault: '{*.yaml,*.conf,*.cfg}' - # true/false to overwrite config file when dpkg ne software - dpkgOverwrite: false - # dpkg timeout (second) - dpkgTimeout: 180 - -# chk2ne: true/false, if put OmcNeConfig parameters to NE -omc: - uriPrefix: "/omc/rest" - neType: OMC - neId: 001 - rmUID: 4400HX101 - neName: OMC - province: "" - vendor: "" - dn: "" - chk2ne: false - sn: "-" - checksign: false - rootDir: /usr/local/omc - binDir: /usr/local/omc/bin - backup: /usr/local/omc/backup - upload: /usr/local/omc/upload - frontUpload: /usr/local/omc/htdocs/front/upload - frontTraceDir: /usr/local/omc/htdocs/front/trace - software: /usr/local/omc/software - license: /usr/local/omc/license - gtpUri: gtp:192.168.2.119:32152 - checkContentType: false - testMode: false - rbacMode: true - runDir: /usr/local/omc/run - cmdTimeout: 120 - -# Alarm module setting -# Forward interface: -# email/sms/smsc -alarm: - forwardAlarm: true - email: - smtp: smtp.xxx.com - port: 25 - user: smtpuser@xxx.com - password: xxxxxx - # TLS skip verify: true/false - tlsSkipVerify: true - smProxy: smsc - sms: - apiURL: http://smsc.xxx.com - accessKeyID: xxx - accessKeySecret: xxx - signName: XXX SMSC - templateCode: 1000 - smsc: - addr: "192.168.13.114:2775" - systemID: "alarmsmsfw" - password: "omc123" - systemType: "" - -# User authorized information -# crypt: mysql/md5/bcrypt -# token: true/false to check accessToken -# expires for session, unit: second -# Support single/multiple session of user -# -auth: - crypt: bcrypt - token: true - expires: 1800 - session: multiple - publicKey: /usr/local/omc/etc/certs/omc - privateKey: /usr/local/omc/etc/certs/omc - -# Parameter for limit number -# rmuid_maxnum: the max number of rmUID, default: 50 -# alarmid_maxnum: the max number of AlarmID, default: 50 -# pmid_maxnum: the max number of pmID, default: 50 -# subid_maxnum: the max number of subscription ID, default: 20 -# uri_maxlen: the max length of uri, default: 8192 -# rmuid_regexp: regexp pattern of rmUID -params: - rmuidmaxnum: 50 - alarmidmaxnum: 50 - pmidmaxnum: 50 - subidmaxnum: 20 - urimaxlen: 2100000 - rmuidregexp: "[0-9]{4}[A-Z]{2}[A-Z]{2}[0-9A-Z]{1}[0-9A-Z]{3}[0-9A-Z]{1,16}" - -testConfig: - enabled: false - file: /usr/local/omc/etc/testconfig.yaml \ No newline at end of file diff --git a/docs/dataschema/07-OMC Database Diagrams.md b/docs/dataschema/07-OMC Database Diagrams.md deleted file mode 100644 index 1ae7ef0..0000000 --- a/docs/dataschema/07-OMC Database Diagrams.md +++ /dev/null @@ -1,11 +0,0 @@ -## OMC Database Diagrams - ---- - -### Diagram of OMC database - -![1700190137798](image/07-5GCOMCDatabaseDiagrams/1700190137798.png) - -### OMC Database Table Creation Script - -Refer to omc_db.sql diff --git a/docs/dataschema/07-OMC Database Diagrams.pdf b/docs/dataschema/07-OMC Database Diagrams.pdf deleted file mode 100644 index 91d7a53..0000000 Binary files a/docs/dataschema/07-OMC Database Diagrams.pdf and /dev/null differ diff --git a/docs/depends.list b/docs/depends.list deleted file mode 100644 index c263528..0000000 --- a/docs/depends.list +++ /dev/null @@ -1,36 +0,0 @@ -galera-4 -libcgi-fast-perl -libcgi-pm-perl -libclone-perl -libconfig-inifiles-perl -libdaxctl1 -libdbd-mysql-perl -libdbi-perl -libencode-locale-perl -libfcgi-bin -libfcgi-perl -libfcgi0ldbl -libhtml-parser-perl -libhtml-tagset-perl -libhtml-template-perl -libhttp-date-perl -libhttp-message-perl -libio-html-perl -liblwp-mediatypes-perl -libmariadb3 -libmysqlclient21 -libndctl6 -libpmem1 -libsnappy1v5 -libtimedate-perl -liburi-perl -liburing2 -mariadb-client -mariadb-client-10.6 -mariadb-client-core-10.6 -mariadb-common -mariadb-server -mariadb-server-10.6 -mariadb-server-core-10.6 -mysql-common -socat \ No newline at end of file diff --git a/docs/help/en_doc.pdf b/docs/help/en_doc.pdf deleted file mode 100644 index 257e76b..0000000 Binary files a/docs/help/en_doc.pdf and /dev/null differ diff --git a/docs/help/zh_doc.pdf b/docs/help/zh_doc.pdf deleted file mode 100644 index 9e2eee2..0000000 Binary files a/docs/help/zh_doc.pdf and /dev/null differ diff --git a/docs/image/01-5GCOMC安装指南/1682849935321.png b/docs/image/01-5GCOMC安装指南/1682849935321.png deleted file mode 100644 index 72a1361..0000000 Binary files a/docs/image/01-5GCOMC安装指南/1682849935321.png and /dev/null differ diff --git a/docs/image/01-5GCOMC安装指南/1682849936184.png b/docs/image/01-5GCOMC安装指南/1682849936184.png deleted file mode 100644 index 72a1361..0000000 Binary files a/docs/image/01-5GCOMC安装指南/1682849936184.png and /dev/null differ diff --git a/docs/image/04-5GCOMCArchitecture/1698907086637.png b/docs/image/04-5GCOMCArchitecture/1698907086637.png deleted file mode 100644 index 7275684..0000000 Binary files a/docs/image/04-5GCOMCArchitecture/1698907086637.png and /dev/null differ diff --git a/docs/image/04-5GCOMCArchitecturev0.81/1689742028472.png b/docs/image/04-5GCOMCArchitecturev0.81/1689742028472.png deleted file mode 100644 index 2e43e69..0000000 Binary files a/docs/image/04-5GCOMCArchitecturev0.81/1689742028472.png and /dev/null differ diff --git a/docs/image/04-5GCOMCArchitecturev0.81/1689742238527.png b/docs/image/04-5GCOMCArchitecturev0.81/1689742238527.png deleted file mode 100644 index 1ba5e7f..0000000 Binary files a/docs/image/04-5GCOMCArchitecturev0.81/1689742238527.png and /dev/null differ diff --git a/docs/image/04-5GCOMCArchitecturev0.81/1689742506514.png b/docs/image/04-5GCOMCArchitecturev0.81/1689742506514.png deleted file mode 100644 index 6c27581..0000000 Binary files a/docs/image/04-5GCOMCArchitecturev0.81/1689742506514.png and /dev/null differ diff --git a/docs/image/04-5GCOMCArchitecturev0.81/1689742719279.png b/docs/image/04-5GCOMCArchitecturev0.81/1689742719279.png deleted file mode 100644 index 674b170..0000000 Binary files a/docs/image/04-5GCOMCArchitecturev0.81/1689742719279.png and /dev/null differ diff --git a/docs/image/04-5GCOMCArchitecturev0.81/1689742764754.png b/docs/image/04-5GCOMCArchitecturev0.81/1689742764754.png deleted file mode 100644 index 86594d3..0000000 Binary files a/docs/image/04-5GCOMCArchitecturev0.81/1689742764754.png and /dev/null differ diff --git a/docs/image/07-5GCOMCDatabaseDiagrams/1700190137798.png b/docs/image/07-5GCOMCDatabaseDiagrams/1700190137798.png deleted file mode 100644 index fedbe03..0000000 Binary files a/docs/image/07-5GCOMCDatabaseDiagrams/1700190137798.png and /dev/null differ diff --git a/docs/image/EMSarch/1687858921768.png b/docs/image/EMSarch/1687858921768.png deleted file mode 100644 index 54a3dd7..0000000 Binary files a/docs/image/EMSarch/1687858921768.png and /dev/null differ diff --git a/docs/image/EMSarch/1688182161284.png b/docs/image/EMSarch/1688182161284.png deleted file mode 100644 index 5666ae8..0000000 Binary files a/docs/image/EMSarch/1688182161284.png and /dev/null differ diff --git a/docs/image/EMSarch/1688202959302.png b/docs/image/EMSarch/1688202959302.png deleted file mode 100644 index 5666ae8..0000000 Binary files a/docs/image/EMSarch/1688202959302.png and /dev/null differ diff --git a/docs/image/arch/1678264199243.png b/docs/image/arch/1678264199243.png deleted file mode 100644 index e69de29..0000000 diff --git a/docs/image/database/1679033737734.png b/docs/image/database/1679033737734.png deleted file mode 100644 index 05ca7e4..0000000 Binary files a/docs/image/database/1679033737734.png and /dev/null differ diff --git a/docs/interfaces/02-5GC OMC http restful external intefaces v0.7.pdf b/docs/interfaces/02-5GC OMC http restful external intefaces v0.7.pdf deleted file mode 100644 index 331d7f5..0000000 Binary files a/docs/interfaces/02-5GC OMC http restful external intefaces v0.7.pdf and /dev/null differ diff --git a/docs/interfaces/02-5GC OMC http restful external intefaces.md b/docs/interfaces/02-5GC OMC http restful external intefaces.md deleted file mode 100644 index 124c22d..0000000 --- a/docs/interfaces/02-5GC OMC http restful external intefaces.md +++ /dev/null @@ -1,1065 +0,0 @@ -# 5GC OMC Http External Restful Interfaces - -## 1 状态管理 - -* URI: - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/systemState - ``` - - 说明： - - ```Tips - ** elementTypeValue=smf/amf/..查询的网元网元类型 - ``` -* Method: - - GET -* Return: - - ```json - - "data": [ - { - "AMF_0": { - "error": { - "errorCode": "1", - "errorInfo": "Internal server error, NF connnect refused" - }, - "ipAddress": "192.168.2.188" - } - }, - { - "SMF_0": { - "ipAddress": "192.168.1.232", - "systemState": { - "capability": 10000, - "cpuUsage": { - "nfCpuUsage": 2, - "sysCpuUsage": 52 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 1920, - "used": 0 - }, - { - "total": 393, - "used": 13 - }, - { - "total": 48700, - "used": 32431 - }, - { - "total": 1965, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 1965, - "used": 0 - }, - { - "total": 55, - "used": 55 - }, - { - "total": 63, - "used": 63 - }, - { - "total": 91, - "used": 91 - }, - { - "total": 49, - "used": 49 - }, - { - "total": 55, - "used": 55 - }, - { - "total": 73, - "used": 73 - }, - { - "total": 91, - "used": 91 - }, - { - "total": 1475, - "used": 206 - }, - { - "total": 49, - "used": 49 - }, - { - "total": 393, - "used": 13 - }, - { - "total": 393, - "used": 0 - }, - { - "total": 73, - "used": 73 - }, - { - "total": 63, - "used": 63 - } - ], - "partitionNum": 19 - }, - "expiryDate": "2025-02-28", - "memUsage": { - "nfUsedMem": 163992, - "sysMemUsage": 1345, - "totalMem": 4025608 - }, - "serialNum": "13740126", - "version": "1.5.3.2" - } - } - }, - { - "SMF_1": { - "ipAddress": "192.168.1.173", - "systemState": { - "capability": 10000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 69 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 200559, - "used": 5968 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 212136, - "sysMemUsage": 720, - "totalMem": 8167360 - }, - "serialNum": "13740272", - "version": "1.5.3.3" - } - } - } - ] - } - ``` - -## 2 故障管理 - -### 2.1 告警上报 - -* URI - - ```uri - /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - ``` -* Method - - POST -* Relation - - NF->OMC -* Body - - ```json - type Alarm struct { - AlarmSeq int `json:"alarmSeq"` - AlarmId string `json:"alarmId"` - NeId string `json:"neId"` - AlarmCode int `json:"alarmCode"` - AlarmTitle string `json:"alarmTitle"` - EventTime string `json:"eventTime"` - AlarmType string `json:"alarmType"` - OrigSeverity string `json:"origSeverity"` - PVFlag string `json:"pvFlag"` - NeName string `json:"neName"` - NeType string `json:"neType"` - ObjectName string `json:"objectName"` - LocationInfo string `json:"locationInfo"` - Province string `json:"province"` - AlarmStatus int `json:"alarmStatus"` - SpecificProblem string `json:"specificProblem"` - SpecificProblemID string `json:"specificProblemID"` - AddInfo string `json:"addInfo"` - } - ``` - -### 2.2 获取网元告警 - -* URI - - ```uri - /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - ``` -* Method - - GET -* Relation - - OMC->NF -* Body - - n/a -* Return - - ```json - type Alarms struct { - Alarms []struct { - AlarmSeq int `json:"alarmSeq"` - AlarmId string `json:"alarmId"` - NeId string `json:"neId"` - AlarmCode int `json:"alarmCode"` - AlarmTitle string `json:"alarmTitle"` - EventTime string `json:"eventTime"` - AlarmType string `json:"alarmType"` - OrigSeverity string `json:"origSeverity"` - PVFlag string `json:"pvFlag"` - NeName string `json:"neName"` - NeType string `json:"neType"` - ObjectName string `json:"objectName"` - LocationInfo string `json:"locationInfo"` - Province string `json:"province"` - AlarmStatus int `json:"alarmStatus"` - SpecificProblem string `json:"specificProblem"` - SpecificProblemID string `json:"specificProblemID"` - AddInfo string `json:"addInfo"` - } `json:"Alarms"` - } - ``` - -## 3 配置管理 - -### 3.1 参数配置表 - -* 类型定义（type） - - * string - - > filter指定字符串长度，如："filter": "6~100" , 字符串的长度范围，如果单个数字表示最大长度 - > - * ipv4 - - > filter忽略 - > - * ipv6 - - > filter忽略 - > - * int - - > filter指定整型数的范围，如："filter": "100~999" - > - * enum - - > "filter": '{"0": "http", "1": "https"}' - > - * bool - - > "filter": '{"0": "false", "1": "true"}' - > - * regex - - > filter为正则表达式 - > -* 可选（optional） - - * true，默认值，表示该字段为可选填，没有写该属性项时optional为true（兼容以前配置文件） - * false，表示必填项 -* Example - - ```yaml - UDM: - system: - display: "System" - list: - - name: "serviceIP" - type: "ipv4" - value: "172.16.5.140" - optional: "false" - access: "read-write" - filter: '' - display: "Service IP" - comment: "" - - name: "servicePort" - type: "int" - value: "8080" - access: "read-write" - filter: "0~65535" - display: "Service Port" - comment: "0~65535" - subsSmfSelection: - display: "Subs Smf Selection" - array: - - name: "index" - type: "int" - value: "0" - access: "read-write" - filter: '0~15' - display: "Index" - comment: "0~15" - - name: "name" - type: "string" - value: 'def_ambr' - access: "read-write" - filter: '^.{1,32}$' - display: "Name" - comment: "0~32" - - name: "snssai" - type: "string" - value: '1-000001' - access: "read-write" - filter: '^\d{1,3}[A-Fa-f0-9]{6}$' - display: "Snssai" - comment: "" - - name: "dnnList" - type: "int" - value: '0' - access: "read-write" - filter: '0~3' - display: "Dnn List" - comment: "" - array: - - name: "index" - type: "int" - value: "0" - access: "read-write" - filter: '0~15' - display: "index" - comment: "0~15" - - name: "dnn" - type: "string" - value: 'cmnet' - access: "read-write" - filter: '^.{1,32}$' - display: "Dnn" - comment: "0~32" - - name: "defaultDnnInd" - type: "bool" - value: 'true' - access: "read-write" - filter: 'false;true;' - display: "default Dnn Indicator" - comment: "" - ``` - - 完整文件具体请参考 udm_param_config.yaml - -### 3.2 获取参数 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}?loc={index0}/{paraName1}/{index1}/... - ``` - - 说明 - - ```Tips - elementTypeValue: udm, smf, amf... 网元类型 - udm paraName: system, subsUEAmbr, subsSmfSelection ... - 非array的参数，忽略loc - ``` -* Params - - * loc 多层表的定位信息 -* Method - - > GET - > -* Return - - ```uri - /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - ``` - - ```json - { - "data": [ - { - "serviceIP": "172.16.5.140", - "servicePort": "8080", - "...": "..." - } - ] - } - ``` - - ```uri - /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsSmfSelection?loc=1/dnnList - ``` - - ```json - { - "data": [ - { - "index": "0", - "dnn": "cmnet", - "...": "..." - }, - { - "index": "1", - "dnn": "ims", - "...": "..." - } - ] - } - ``` - -### 3.3 配置参数 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}?loc={index0}/{paraName1}/{index1} - ``` -* Params - - * loc 多层表的定位信息 -* Method - - > POST/PUT/DELETE - > - - 说明： - - ```Tips - 单层表不支持POST/DELETE操作 - ``` -* Body - - ```json - { - "serviceIP": "172.16.5.140", - "servicePort": "8080", - "...": "..." - } - ``` - - 说明： - - ```Tips - DELETE操作不带Body - ``` - -### 3.4 创建网元 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/neInfo - ``` -* Params - - N/A -* Method - - > POST - > -* Body - - ```json - { - - } - ``` - -## 4 性能管理 - -### 4.1 任务管理 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measureTask?id={taskId1}&id={taskId2} - ``` -* Method - - POST/PUT/DELETE/PATCH -* Params - - taskId=1&taskId=2 - - * POST: 增加测量任务，激活任务，不带id参数，id在body - * PUT： 修改测量任务，激活任务，不带id参数，id在body - * DELETE：删除测量任务，不需要带body，带id参数，可带多个 - * PATCH: 暂停测量任务，不需要带body，带id参数，可带多个 - - 测量任务创建/修改后暂时存储在OMC数据库，激活任务时再下发到网元 -* Relation NF - - OMC -> NF/NF -> OMC -* Body - - 下发测量任务的报文结构 - - ```json - type MeasureTask struct { - Tasks []struct { - Id int `json:"Id"` - - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - - Schedule struct { - Type string `json:"Type"` // 计划类型：Weekly/Monthly, 如果type为"", 则任务以StartTime和EndTime为条件进行统计, 否则以Shedule方式进行 - Days []int `json:"Days"` // Weekly: [0,1,...5,6]，0~6表示星期日~星期六, Monthly: [1,2,3,...,30,31]一个月的几天 - Periods []struct { - Start string `json:"Start"` // 零点或者零点加测量粒度的整数倍 00:15:00 - End string `json:"End"` // 零点加测量粒度的整数倍 08:45:00, 16:15:00 - } `json:"Periods"` - } `json:"Schedule"` - - GranulOption string `json:"GranulOption"` // 测量粒度选项：15M/30M/60M/24H - - KPISet []struct { - Code string `json:"Code"` // 统计编码 如：SMFHA01 - KPIs []string `json:"KPIs` // 指标项集合 ["SMF.AttCreatePduSession", "SMF.AttCreatePduSession._Dnn"] - } `json:"KPISet"` - } `json:"Tasks"` - - NotifyUrl string `json:"NotifyUrl"` /* 数据上报URL "http://x.x.x.x:xxxx/api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport" */ - } - ``` -* Return - -### 4.2 订阅任务数据上报 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measureReport - ``` -* Method - - POST -* Relation - - NF -> OMC -* Body - - 网元返回测量数据的报文结构 - - ```json - type MeasureReport struct { - Id int `json:"Id"` - Timestamp string `json:"TimeStamp"` - NeName string `json:"NeName"` - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` - - Report struct { - Period struct { - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - } `json:"Period"` - - Datas []struct { - Code string `json:"Code"` // 统计编码 如：SMFHA01 - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int64 `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } `json:"Report"` - } - ``` - -### 4.3 黄金指标上报 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/kpiReport/{index} - ``` - - index取值范围： 0-1439 -* Method - - POST -* Body - - ```json - type KpiReport struct { - Timestamp string `json:"TimeStamp"` - Task struct { - Period struct { - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - } `json:"Period"` - NE struct { - NEName string `json:"NEName"` - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` - KPIs []struct { - KPIID string `json:"KPIID"` - Value int `json:"Value"` - Err string `json:"Err"` - } `json:"KPIs"` - } `json:"NE"` - } `json:"Task"` - } - ``` - -### 4.4 测量数据主动上报 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measurement/{index} - ``` -* Method - - POST -* Relations - - NF -> OMC -* Params - - NA -* Body - - 网元主动上报测量数据的报文结构 - - ```json - type Measurement struct { - Index int `json:"Index"` // 1天当中测量时间粒度(如15分钟)的切片索引: 0~95 - Timestamp string `json:"TimeStamp"` - NeName string `json:"NeName"` // UserLabel - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` // 网元类型 - PmVersion string `json:"PmVersion"` // 性能数据版本号 - Dn string `json:"Dn"` // (???)网元标识, 如:RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456 - Period string `json:"Period"` // 测量时间粒度选项：5/15/30/60 - TimeZone string `json:"TimeZone"` // 时区, 如: "UTC+8" - StartTime string `json:"StartTime"` - - Datas []struct { - ObjectType string `json:"ObjectType"` // 网络资源类别名称, Pm指标项列表中为空间粒度 如：SmfFunction - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int64 `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } - ``` -* Return - - Code: 204, no content - -### 4.5 测量数据获取/补采 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measurement/{index} - ``` -* Method - - GET -* Relations - - OMC -> NF -* Params - - NA -* Body - - NA -* Return - - 网元返回测量数据的报文结构 - - ```json - type Measurement struct { - Index int `json:"Index"` // 1天中测量时间粒度(如15分钟)的切片索引: 0~95 - Timestamp string `json:"TimeStamp"` - NeName string `json:"NeName"` // UserLabel - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` // 网元类型 - PmVersion string `json:"PmVersion"` // 性能数据版本号 - Dn string `json:"Dn"` // (???)网元标识, 如:RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456 - Period string `json:"Period"` // 测量时间粒度选项：5/15/30/60 - TimeZone string `json:"TimeZone"` - StartTime string `json:"StartTime"` - - Datas []struct { - ObjectType string `json:"ObjectType"` // 网络资源类别名称, Pm指标项列表中为空间粒度 如：SmfFunction - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int64 `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } - ``` - -## 5 跟踪管理 - -### 5.1 订阅管理 - -* 创建订阅 - - * URI - - ```uri - /api/rest/traceManagement/v1/subscriptions - ``` - * Method - - POST - * Relations - - OMC front-end->OMC back-end, OMC -> NF - * Body - - ```json - type TraceTask struct { - TraceType string `json:"traceType"` - StartTime string `json:"startTime"` - EndTime string `json:"endTime"` - Imsi string `json:"imsi"` - Msisdn string `json:"msisdn"` - SrcIp string `json:"srcIp"` - DstIp string `json:"dstIp"` - SignalPort int16 `json:"signalPort"` - NeType string `json:"neType"` - NeId string `json:"neId"` - UeIp string `json:"ueIp"` - Interfaces []string `json:"interfaces"` - } - ``` - - Example: - - ```json - { - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "UDM", - "neId": "SZ_01", - "interfaces": ["N8","N10"] - } - ``` - * Return - - Code=204 non-content -* 修改订阅 - - * URI - - ```uri - /api/rest/traceManagement/v1/subscriptions - ``` - * Method - - PUT - * Relations - - OMC front-end->OMC back-end, OMC -> NF - * Body - - ```json - type TraceTask struct { - Id int `json:"id"` - TraceType string `json:"traceType"` - StartTime string `json:"startTime"` - EndTime string `json:"endTime"` - Imsi string `json:"imsi"` - Msisdn string `json:"msisdn"` - SrcIp string `json:"srcIp"` - DstIp string `json:"dstIp"` - SignalPort int16 `json:"signalPort"` - NeType string `json:"neType"` - NeId string `json:"neId"` - UeIp string `json:"ueIp"` - Interfaces []string `json:"interfaces"` - } - ``` - - Example: - - ```json - { - "id": 1, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "UDM", - "neId": "SZ_01", - "interfaces": ["N8","N10", "N11"] - } - ``` - * Return - - Code=204 non-content -* 删除订阅 - - * URI - - ```uri - /api/rest/traceManagement/v1/subscriptions?id={id1}&id={id2} - ``` - * Method - - DELETE - * Relations - - OMC front-end->OMC back-end, OMC -> NF - * Params - - id：订阅任务id，支持多个 - * Body - - NA - * Return - - Code=204, non-content -* 查询订阅 (暂不实现，直接从数据库查询) - - * URI - 查询单个订阅： - - ```uri - /api/rest/traceManagement/v1/subscriptions?id={id} - ``` - - 查询所有订阅： - - ```http - /api/rest/traceManagement/v1/subscriptions - ``` - * Method - - GET - * Body - - NA - * Return - - ```json - { - "data": [ - { - "id": 1, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "UDM", - "neId": "SZ_01", - "interfaces": ["N8","N10", "N11"] - } - ] - } - ``` - -## 6 操作维护 - -### 6.1 MML命令 - -#### 6.1.1 MML命令格式 - -* 命令格式 - - ```mml - oper object:parameter1={value1},parameter2={value2},parameter3={value3}; - ``` - - * 操作(operation) - - * 根据实际操作可选用如下动作，如果没有合适的可自行增加，要做到简洁直观 - - ```list - add: 增加 - mod(set)：修改/设置 - del(rmv)：删除 - dsp(lst)：查询显示 - bak：备份 - exp：导出 - imp：导入 - bat: 批量 - exec(run)：执行 - act/dea: 激活/去激活 - ``` - * 与对象之间采用空格分隔 - * 对象(object) - - * 操作的对象，如签约数据(sub/udmuser)/鉴权数据(auth/authdat), n7接口(n7server) - * 对象名称用所操作对象的英文名(或缩写), 为字母或者数字的组合, 不含空格, "-", "_"等特殊字符 - * 使用":"与参数进行分隔 - * 参数(param) - - * 参数名采用英文常用名/约定俗成的缩写/缩略语等, 如imsi，msisdn，ip，port等, 为字母或者数字的组合, 不含空格, "-", "_"等特殊字符 - * 参数值为字符串, 如有":", ",", ";", "\\"字符, 需加"\\"进行转义 - * 参数之间用","进行分隔 - * 命令结束符";", 操作/对象/参数均采用小写字母（HW采用的都是大写字母） -* 目前现有的各个网元的命令格式 - - 除了UDM签约数据/鉴权数据的MML格式和上述格式基本一致, 各个网元的系统参数MML都不一样, 需统一成上述格式 - - * UDM鉴权数据/签约数据 - - ```mml - add authdat:imsi=460000100000030,ki=805DADC6E8A54A0D59D622C7A04D08E0,amf=8000,algo=0,opc=CF7FD414E05754CFE08B4FE7F2EF2A36 - ``` - * UDM系统参数 - - ```mml - set n8ip 172.16.5.130 - ``` - * AMF系统参数 - - ```mml - set n8_ip 192.168.1.121 - ``` - * SMF/UPF系统参数 - - ```mml - set n7 server - ``` - -### 6.2 MML接口 - -* URI - - ```uri - /api/rest/opeartionManagement/v1/elementType/{elementTypeValue}/objectType/mml?ne_id={neId} - ``` -* Related NF - - OMC front-end -> OMC back-end - - OSS -> OMC (北向接口) -* Params - - ne_id={neId} -* Method - - POST -* Body - - ```json - { - "mml": [ - "date", - "list ver", - "list lic", - "list comm" - ] - } - ``` -* Return - - ```json - { - "data": [ - "2023-05-11 17:52:32.37333745 +0800 CST m=+28762.188435351\n", - "16.1.1\n", - "Expiry date: 2024-12-31, sn: 13740272\n", - "COMMAND NOT FOUND, opr: list, obj: comm\n" - ] - } - ``` - -## 7 北向资源配置数据接口 - -### 7.1 查询资源数据接口 - -* URI - - ```uri - /api/rest/resourceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/{objectTypeValue}?rmUIDs={rmUIDValues}&fields={attributeNames} - ``` -* Related NF - - OMC -> NF - - OSS -> OMC (北向接口) -* Params - - * rmUIDs={rmUIDValues} - - 可携带多额rmUID(统一资源定位符), OMC->NF不带 - * fields={attributeNames} - - 属性域集合={属性名列表}, 指定资源对象多个属性名的英文逗号分割，一个属性名时无英文逗号。 -* Method - - GET -* Body - - ```json - GET /api/rest/resourceManagement/v1/elementType/SMF/objectType/ManagedElement?rmUIDs=1101AGTHXSMF0000015704000100&fields=UserLabel HTTP/1.1 - accessToken: 52661fbd-6b84-4fc2-aa1e-17879a5c6c9b - Host: serverIP:port - Content-Type: application/json; charset=UTF-8 - Content-Length:… - { - } - ``` -* Return - - ```json - HTTP/1.1 200 OK - Content - Type: application/json - Content-Length:… - { - "data": [{ - "rmUID": "1101AGTHXSMF0000015704000100", - "UserLabel": "SMFRJBJJC01", - ... - }] - } - ``` diff --git a/docs/interfaces/03-5GC OMC 北向接口.docx b/docs/interfaces/03-5GC OMC 北向接口.docx deleted file mode 100644 index 957ce7d..0000000 Binary files a/docs/interfaces/03-5GC OMC 北向接口.docx and /dev/null differ diff --git a/docs/interfaces/03-5GC OMC 北向接口.pdf b/docs/interfaces/03-5GC OMC 北向接口.pdf deleted file mode 100644 index 7841743..0000000 Binary files a/docs/interfaces/03-5GC OMC 北向接口.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v0.75.pdf b/docs/interfaces/05-5GC OMC restful intefaces v0.75.pdf deleted file mode 100644 index 0260261..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v0.75.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v0.76.pdf b/docs/interfaces/05-5GC OMC restful intefaces v0.76.pdf deleted file mode 100644 index 2fa2e5f..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v0.76.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v0.77.pdf b/docs/interfaces/05-5GC OMC restful intefaces v0.77.pdf deleted file mode 100644 index 5455fb7..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v0.77.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v0.78.pdf b/docs/interfaces/05-5GC OMC restful intefaces v0.78.pdf deleted file mode 100644 index 7de49d3..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v0.78.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v0.79.pdf b/docs/interfaces/05-5GC OMC restful intefaces v0.79.pdf deleted file mode 100644 index b24c189..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v0.79.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v0.80.pdf b/docs/interfaces/05-5GC OMC restful intefaces v0.80.pdf deleted file mode 100644 index 5158941..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v0.80.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v1.01.pdf b/docs/interfaces/05-5GC OMC restful intefaces v1.01.pdf deleted file mode 100644 index dee29f2..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v1.01.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces v1.10.pdf b/docs/interfaces/05-5GC OMC restful intefaces v1.10.pdf deleted file mode 100644 index 02505b9..0000000 Binary files a/docs/interfaces/05-5GC OMC restful intefaces v1.10.pdf and /dev/null differ diff --git a/docs/interfaces/05-5GC OMC restful intefaces.md b/docs/interfaces/05-5GC OMC restful intefaces.md deleted file mode 100644 index 2792de4..0000000 --- a/docs/interfaces/05-5GC OMC restful intefaces.md +++ /dev/null @@ -1,1988 +0,0 @@ -# EMS restful interfaces - -## 1. 状态管理 - -* URI: - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/systemState - ``` - - 说明： - - ```Tips - ** elementTypeValue=smf/amf/..查询的网元网元类型 - ``` -* Method: - - GET -* Return: - - NF -> OMC BE的json结构 - - ```json - type SysState struct { - HostName string `json:"hostName"` // linux命令: hostname - OsInfo string `json:"osInfo"` // linux命令: uname -a - DbInfo string `json:"dbInfo"` // 网元如果有db, 显示数据库名和版本信息， OMC: mysql --version - Version string `json:"version"` // 软件版本信息: 16.1.1 - IpAddr []string `json:"ipAddr"` // 网管的ipv4和ipv6 - Port uint16 `json:"port"` // 用于网管的port - Capability uint32 `json:"capability"` - SerialNum string `json:"serialNum"` - ExpiryDate string `json:"expiryDate"` - HardwareInfo struct { - CPUs int `json:"cpus"` // 主机(裸机/虚拟机)的cpu个数 - Memory int `json:"memory"` // 主机(裸机/虚拟机): 配置的内存 - } `json:"hardwareInfo"` - CpuUsage struct { - NfCpuUsage uint16 `json:"nfCpuUsage"` - SysCpuUsage uint16 `json:"sysCpuUsage"` - } `json:"cpuUsage"` - MemUsage struct { - TotalMem uint32 `json:"totalMem"` - NfUsedMem uint32 `json:"nfUsedMem"` - SysMemUsage uint16 `json:"sysMemUsage"` - } `json:"memUsage"` - DiskSpace struct { - PartitionNum uint8 `json:"partitionNum"` - PartitionInfo []struct { - Total uint32 `json:"total"` // MB - Used uint32 `json:"used"` // MB - } `json:"partitionInfo"` - } `json:"diskSpace"` - //Timestamp string `json:"timestamp"` - } - ``` -* Example: - OMC BE -> OMC FE - - ```json - - "data": [ - { - "AMF_0": { - "error": { - "errorCode": "1", - "errorInfo": "Internal server error, NF connnect refused" - }, - "ipAddress": "192.168.2.188" - } - }, - { - "SMF_0": { - "ipAddress": "192.168.1.232", - "systemState": { - "capability": 10000, - "cpuUsage": { - "nfCpuUsage": 2, - "sysCpuUsage": 52 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 1920, - "used": 0 - }, - { - "total": 393, - "used": 13 - }, - { - "total": 48700, - "used": 32431 - }, - { - "total": 1965, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 1965, - "used": 0 - }, - { - "total": 55, - "used": 55 - }, - { - "total": 63, - "used": 63 - }, - { - "total": 91, - "used": 91 - }, - { - "total": 49, - "used": 49 - }, - { - "total": 55, - "used": 55 - }, - { - "total": 73, - "used": 73 - }, - { - "total": 91, - "used": 91 - }, - { - "total": 1475, - "used": 206 - }, - { - "total": 49, - "used": 49 - }, - { - "total": 393, - "used": 13 - }, - { - "total": 393, - "used": 0 - }, - { - "total": 73, - "used": 73 - }, - { - "total": 63, - "used": 63 - } - ], - "partitionNum": 19 - }, - "expiryDate": "2025-02-28", - "memUsage": { - "nfUsedMem": 163992, - "sysMemUsage": 1345, - "totalMem": 4025608 - }, - "serialNum": "13740126", - "version": "1.5.3.2" - } - } - }, - { - "SMF_1": { - "ipAddress": "192.168.1.173", - "systemState": { - "capability": 10000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 69 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 200559, - "used": 5968 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 212136, - "sysMemUsage": 720, - "totalMem": 8167360 - }, - "serialNum": "13740272", - "version": "1.5.3.3" - } - } - } - ] - } - ``` - -## 2 故障管理 - -### 2.1 告警上报 - -* URI - - ```uri - /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - ``` -* Method - - POST -* Relations - - NF->OMC -* Body - - ```json - type Alarm struct { - AlarmSeq int `json:"alarmSeq"` - AlarmId string `json:"alarmId"` - NeId string `json:"neId"` - AlarmCode int `json:"alarmCode"` - AlarmTitle string `json:"alarmTitle"` - EventTime string `json:"eventTime"` - AlarmType string `json:"alarmType"` - OrigSeverity string `json:"origSeverity"` - PVFlag string `json:"pvFlag"` - NeName string `json:"neName"` - NeType string `json:"neType"` - ObjectName string `json:"objectName"` - LocationInfo string `json:"locationInfo"` - Province string `json:"province"` - AlarmStatus int `json:"alarmStatus"` - SpecificProblem string `json:"specificProblem"` - SpecificProblemID string `json:"specificProblemID"` - AddInfo string `json:"addInfo"` - } - ``` - -### 2.2 获取网元告警 - -* URI - - ```uri - /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - ``` -* Method - - GET -* Relations - - OMC->NF -* Body - - n/a -* Return - - ```json - type Alarms struct { - Alarms []struct { - AlarmSeq int `json:"alarmSeq"` - AlarmId string `json:"alarmId"` - NeId string `json:"neId"` - AlarmCode int `json:"alarmCode"` - AlarmTitle string `json:"alarmTitle"` - EventTime string `json:"eventTime"` - AlarmType string `json:"alarmType"` - OrigSeverity string `json:"origSeverity"` - PVFlag string `json:"pvFlag"` - NeName string `json:"neName"` - NeType string `json:"neType"` - ObjectName string `json:"objectName"` - LocationInfo string `json:"locationInfo"` - Province string `json:"province"` - AlarmStatus int `json:"alarmStatus"` - SpecificProblem string `json:"specificProblem"` - SpecificProblemID string `json:"specificProblemID"` - AddInfo string `json:"addInfo"` - } `json:"Alarms"` - } - ``` - -## 3. 配置管理 - -### 3.1 参数配置表 - -* 类型定义（type） - - * string - - > filter指定字符串长度，如："filter": "6~100" , 字符串的长度范围，如果单个数字表示最大长度 - > - * ipv4 - - > filter忽略 - > - * ipv6 - - > filter忽略 - > - * int - - > filter指定整型数的范围，如："filter": "100~999" - > - * enum - - > "filter": '{"0": "http", "1": "https"}' - > - * bool - - > "filter": '{"0": "false", "1": "true"}' - > - * regex - - > filter为正则表达式 - > -* 可选（optional） - - * true，默认值，表示该字段为可选填，没有写该属性项时optional为true（兼容以前配置文件） - * false，表示必填项 -* Method - - * 字符串"get,post,put,delete"，只用于Top Tag字段，默认为支持所有方法 - * get对应"获取"按钮, post对应"新增"按钮, put对应"修改"按钮, delete对应"删除"按钮 - * 配置相应方法，则显示相应的按钮，支持对应的方法 -* Example - - ```yaml - UDM: - system: - display: "System" - method: "get,post,put,delete" - list: - - name: "serviceIP" - type: "ipv4" - value: "172.16.5.140" - optional: "false" - access: "read-write" - filter: '' - display: "Service IP" - comment: "" - - name: "servicePort" - type: "int" - value: "8080" - access: "read-write" - filter: "0~65535" - display: "Service Port" - comment: "0~65535" - subsSmfSelection: - display: "Subs Smf Selection" - array: - - name: "index" - type: "int" - value: "0" - access: "read-write" - filter: '0~15' - display: "Index" - comment: "0~15" - - name: "name" - type: "string" - value: 'def_ambr' - access: "read-write" - filter: '^.{1,32}$' - display: "Name" - comment: "0~32" - - name: "snssai" - type: "string" - value: '1-000001' - access: "read-write" - filter: '^\d{1,3}[A-Fa-f0-9]{6}$' - display: "Snssai" - comment: "" - - name: "dnnList" - type: "int" - value: '0' - access: "read-write" - filter: '0~3' - display: "Dnn List" - comment: "" - array: - - name: "index" - type: "int" - value: "0" - access: "read-write" - filter: '0~15' - display: "index" - comment: "0~15" - - name: "dnn" - type: "string" - value: 'cmnet' - access: "read-write" - filter: '^.{1,32}$' - display: "Dnn" - comment: "0~32" - - name: "defaultDnnInd" - type: "bool" - value: 'true' - access: "read-write" - filter: 'false;true;' - display: "default Dnn Indicator" - comment: "" - ``` - - 完整文件具体请参考 udm_param_config.yaml - -### 3.2 获取参数 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}?loc={index0}/{paraName1}/{index1}/... - ``` - - 说明 - - ```Tips - elementTypeValue: udm, smf, amf... 网元类型 - udm paraName: system, subsUEAmbr, subsSmfSelection ... - 非array的参数，忽略loc - ``` -* Params - - * loc 多层表的定位信息 -* Method - - > GET - > -* Return - - ```uri - /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - ``` - - ```json - { - "data": [ - { - "serviceIP": "172.16.5.140", - "servicePort": "8080", - "...": "..." - } - ] - } - ``` - - ```uri - /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsSmfSelection?loc=1/dnnList - ``` - - ```json - { - "data": [ - { - "index": "0", - "dnn": "cmnet", - "...": "..." - }, - { - "index": "1", - "dnn": "ims", - "...": "..." - } - ] - } - ``` - -### 3.3 配置参数 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/{paraName}?loc={index0}/{paraName1}/{index1} - ``` -* Params - - * loc 多层表的定位信息 -* Method - - > POST/PUT/DELETE - > - - 说明： - - ```Tips - 单层表不支持POST/DELETE操作 - ``` -* Body - - ```json - { - "serviceIP": "172.16.5.140", - "servicePort": "8080", - "...": "..." - } - ``` - - 说明： - - ```Tips - DELETE操作不带Body - ``` - -### 3.4 创建/修改网元 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/omcNeConfig - ``` -* Params - - N/A -* Method - - PUT -* Body - - ```json - type OmcNeConfig struct { - NeId string `json:"neId" xorm:"ne_id"` // 网元标识(内部), - RmUID string `json:"rmUID" xorm:"rm_uid"` // neUID/rmUID 网元唯一标识 - NeName string `json:"neName" xorm:"ne_name"` // 网元名称/友好名称(北向资源/性能等使用) - PvFlag string `json:"pvFlag" xorm:"pv_flag"` // 网元虚实性标识 VNF/PNF: 虚拟/物理 - Province string `json:"province" xorm:"province"` // 网元所在省份 - VendorName string `json:"vendorName" xorm:"vendor_name"` // 厂商名称 - // ManagedBy string `json:"managedBy" xorm:"managed_by"` // 管理ManagedElement的ManagementNode对象类的DN值 - Dn string `json:"dn" xorm:"dn"` // 资源里边的ManagedBy，性能的Dn，网络唯一标识 - } - ``` - -### 3.5 网元服务启动/停止/重启 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/service/{action}?neId={neId} - ``` - - action: start/restart/stop -* Relations - - OMC FE -> OMC BE -> NF -* Params - - OMC-FE -> OMC-BE, neId={neId}, 指定NF的neId -* Method - - POST -* Body - - ```json - type NeService struct { - Action string `json:"action"` // 动作, start/restart/stop - } - ``` - -### 3.6 机器开机/重启/关机 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/instance/{action}?neId={neId} - ``` - - action: reboot/poweroff -* Relations - - OMC FE -> OMC BE -> NF -* Params - - OMC-FE -> OMC-BE, neId={neId}, 指定NF的neId -* Method - - POST -* Body - - ```json - type NeInstance struct { - Action string `json:"action"` // 动作, reboot/poweroff - } - ``` - -## 4 性能管理 - -### 4.1 任务管理 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measureTask?id={taskId1}&id={taskId2} - ``` -* Method - - POST/PUT/DELETE/PATCH -* Params - - taskId=1&taskId=2 - - * POST: 增加测量任务，激活任务，不带id参数，id在body - * PUT： 修改测量任务，激活任务，不带id参数，id在body - * DELETE：删除测量任务，不需要带body，带id参数，可带多个 - * PATCH: 暂停测量任务，不需要带body，带id参数，可带多个 - - 测量任务创建/修改后暂时存储在OMC数据库，激活任务时再下发到网元 -* Relations - - OMC -> NF/NF -> OMC -* Body - - 下发测量任务的报文结构 - - ```json - type MeasureTask struct { - Tasks []struct { - Id int `json:"Id"` - - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - - Schedule struct { - Type string `json:"Type"` // 计划类型：Weekly/Monthly, 如果type为"", 则任务以StartTime和EndTime为条件进行统计, 否则以Shedule方式进行 - Days []int `json:"Days"` // Weekly: [0,1,...5,6]，0~6表示星期日~星期六, Monthly: [1,2,3,...,30,31]一个月的几天 - Periods []struct { - Start string `json:"Start"` // 零点或者零点加测量粒度的整数倍 00:15:00 - End string `json:"End"` // 零点加测量粒度的整数倍 08:45:00, 16:15:00 - } `json:"Periods"` - } `json:"Schedule"` - - GranulOption string `json:"GranulOption"` // 测量粒度选项：15M/30M/60M/24H - - KPISet []struct { - Code string `json:"Code"` // 统计编码 如：SMFHA01 - KPIs []string `json:"KPIs` // 指标项集合 ["SMF.AttCreatePduSession", "SMF.AttCreatePduSession._Dnn"] - } `json:"KPISet"` - } `json:"Tasks"` - - NotifyUrl string `json:"NotifyUrl"` /* 数据上报URL "http://x.x.x.x:xxxx/api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport" */ - } - ``` -* Return - -### 4.2 订阅任务数据上报 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measureReport - ``` -* Method - - POST -* Relations - - NF -> OMC -* Body - - 网元返回测量数据的报文结构 - - ```json - type MeasureReport struct { - Id int `json:"Id"` - Timestamp string `json:"TimeStamp"` - NeName string `json:"NeName"` - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` - - Report struct { - Period struct { - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - } `json:"Period"` - - Datas []struct { - Code string `json:"Code"` // 统计编码 如：SMFHA01 - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int64 `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } `json:"Report"` - } - ``` - -### 4.3 黄金指标上报 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/kpiReport/{index} - ``` - - index取值范围： 0-1439 -* Method - - POST -* Body - - ```json - type KpiReport struct { - Timestamp string `json:"TimeStamp"` - Task struct { - Period struct { - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - } `json:"Period"` - NE struct { - NEName string `json:"NEName"` - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` - KPIs []struct { - KPIID string `json:"KPIID"` - Value int `json:"Value"` - Err string `json:"Err"` - } `json:"KPIs"` - } `json:"NE"` - } `json:"Task"` - } - ``` - -### 4.4 测量数据主动上报 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measurement/{index} - ``` -* Method - - POST -* Relations - - NF -> OMC -* Params - - NA -* Body - - 网元主动上报测量数据的报文结构 - - ```json - type Measurement struct { - Index int `json:"Index"` // 1天当中测量时间粒度(如15分钟)的切片索引: 0~95 - Timestamp string `json:"TimeStamp"` - NeName string `json:"NeName"` // UserLabel - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` // 网元类型 - PmVersion string `json:"PmVersion"` // 性能数据版本号 - Dn string `json:"Dn"` // (???)网元标识, 如:RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456 - Period string `json:"Period"` // 测量时间粒度选项：5/15/30/60 - TimeZone string `json:"TimeZone"` // 时区, 如: "UTC+8" - StartTime string `json:"StartTime"` - - Datas []struct { - ObjectType string `json:"ObjectType"` // 网络资源类别名称, Pm指标项列表中为空间粒度 如：SmfFunction - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int64 `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } - ``` -* Return - - Code: 204, no content - -### 4.5 测量数据获取/补采 - -* URI - - ```uri - /api/rest/performanceManagement/v1/elementType/{elementTypeValue}/objectType/measurement/{index} - ``` -* Method - - GET -* Relations - - OMC -> NF -* Params - - NA -* Body - - NA -* Return - - 网元返回测量数据的报文结构 - - ```json - type Measurement struct { - Index int `json:"Index"` // 1天中测量时间粒度(如15分钟)的切片索引: 0~95 - Timestamp string `json:"TimeStamp"` - NeName string `json:"NeName"` // UserLabel - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` // 网元类型 - PmVersion string `json:"PmVersion"` // 性能数据版本号 - Dn string `json:"Dn"` // (???)网元标识, 如:RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456 - Period string `json:"Period"` // 测量时间粒度选项：5/15/30/60 - TimeZone string `json:"TimeZone"` - StartTime string `json:"StartTime"` - - Datas []struct { - ObjectType string `json:"ObjectType"` // 网络资源类别名称, Pm指标项列表中为空间粒度 如：SmfFunction - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int64 `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } - ``` - -## 5 跟踪管理 - -### 5.1 订阅管理 - -* 创建订阅 - - * URI - - ```uri - /api/rest/traceManagement/v1/subscriptions - ``` - * Method - - POST - * Relations - - OMC front-end->OMC back-end, OMC -> NF - * Body - - OMC front-end->OMC back-end: id 不带 - OMC->NF：id必选 - - ```json - type TraceTask struct { - Id int `json:"id"` - TraceType string `json:"traceType"` - StartTime string `json:"startTime"` - EndTime string `json:"endTime"` - Imsi string `json:"imsi"` - Msisdn string `json:"msisdn"` - SrcIp string `json:"srcIp"` - DstIp string `json:"dstIp"` - SignalPort int16 `json:"signalPort"` - NeType string `json:"neType"` - NeId string `json:"neId"` - UeIp string `json:"ueIp"` - Interfaces []string `json:"interfaces"` - NotifyUrl string `json:"notifyUrl"` - } - ``` - - Example: - - ```json - { - "id": 3, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "UDM", - "neId": "SZ_01", - "interfaces": ["N8","N10"], - "notifyUrl": "gtp:192.168.0.229:2152", - } - ``` - * Return - - Code=204 non-content -* 修改订阅 - - * URI - - ```uri - /api/rest/traceManagement/v1/subscriptions - ``` - * Method - - PUT - * Relations - - OMC front-end->OMC back-end, OMC -> NF - * Body - - ```json - type TraceTask struct { - Id int `json:"id"` - TraceType string `json:"traceType"` - StartTime string `json:"startTime"` - EndTime string `json:"endTime"` - Imsi string `json:"imsi"` - Msisdn string `json:"msisdn"` - SrcIp string `json:"srcIp"` - DstIp string `json:"dstIp"` - SignalPort int16 `json:"signalPort"` - NeType string `json:"neType"` - NeId string `json:"neId"` - UeIp string `json:"ueIp"` - Interfaces []string `json:"interfaces"` - NotifyUrl string `json:"notifyUrl"` - } - ``` - - Example: - - ```json - { - "id": 3, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "UDM", - "neId": "SZ_01", - "interfaces": ["N8","N10", "N11"], - "notifyUrl": "gtp:192.168.0.229:2152", - } - ``` - * Return - - Code=204 non-content -* 删除订阅 - - * URI - - ```uri - /api/rest/traceManagement/v1/subscriptions?id={id1}&id={id2} - ``` - * Method - - DELETE - * Relations - - OMC front-end->OMC back-end, OMC -> NF - * Params - - id：订阅任务id，支持多个 - * Body - - NA - * Return - - Code=204, non-content -* 查询订阅 (暂不实现，直接从数据库查询) - - * URI - 查询单个订阅： - - ```uri - /api/rest/traceManagement/v1/subscriptions?id={id} - ``` - - 查询所有订阅： - - ```http - /api/rest/traceManagement/v1/subscriptions - ``` - * Method - - GET - * Body - - NA - * Return - - ```json - { - "data": [ - { - "id": 1, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "UDM", - "neId": "SZ_01", - "interfaces": ["N8","N10", "N11"] - } - ] - } - ``` - -### 5.2 消息上报 - -Example: - -```json -{ - "id": [1,2], - "timestamp": "20230413 16:02:27.523496", - "imsi": "4600001000000001", - "msisdn": "12307550001", - "srcAddr": "192.168.1.172:51034", - "dstAddr": "192.168.1.187:8080", - "neType": "AMF", - "neId": "SZ_0", - "interface": "N8", - "data": "00002f01040000007f418d0be25c2e3cb8570bcedc780f038345", - "diagnosis": "It is external debug information", -} -``` - -## 6. 操作维护 - -### 6.1 MML命令 - -#### 6.1.1 MML命令格式 - -* 命令格式 - - ```mml - oper object:parameter1={value1},parameter2={value2},parameter3={value3}; - ``` - - * 操作(operation) - - * 根据实际操作可选用如下动作，如果没有合适的可自行增加，要做到简洁直观 - - ```list - add: 增加 - mod(set)：修改/设置 - del(rmv)：删除 - dsp(lst)：查询显示 - bak：备份 - exp：导出 - imp：导入 - bat: 批量 - exec(run)：执行 - act/dea: 激活/去激活 - ``` - * 与对象之间采用空格分隔 - * 对象(object) - - * 操作的对象，如签约数据(sub/udmuser)/鉴权数据(auth/authdat), n7接口(n7server) - * 对象名称用所操作对象的英文名(或缩写), 为字母或者数字的组合, 不含空格, "-", "_"等特殊字符 - * 使用":"与参数进行分隔 - * 参数(param) - - * 参数名采用英文常用名/约定俗成的缩写/缩略语等, 如imsi，msisdn，ip，port等, 为字母或者数字的组合, 不含空格, "-", "_"等特殊字符 - * 参数值为字符串, 如有":", ",", ";", "\\"字符, 需加"\\"进行转义 - * 参数之间用","进行分隔 - * 命令结束符";", 操作/对象/参数均采用小写字母（HW采用的都是大写字母） -* 目前现有的各个网元的命令格式 - - 除了UDM签约数据/鉴权数据的MML格式和上述格式基本一致, 各个网元的系统参数MML都不一样, 需统一成上述格式 - - * UDM鉴权数据/签约数据 - - ```mml - add authdat:imsi=460000100000030,ki=805DADC6E8A54A0D59D622C7A04D08E0,amf=8000,algo=0,opc=CF7FD414E05754CFE08B4FE7F2EF2A36 - ``` - * UDM系统参数 - - ```mml - set n8ip 172.16.5.130 - ``` - * AMF系统参数 - - ```mml - set n8_ip 192.168.1.121 - ``` - * SMF/UPF系统参数 - - ```mml - set n7 server - ``` - -#### 6.1.2 MML配置表 - -* 类型定义（type） - - * string - - filter指定字符串长度，如："filter": "6~100" , 字符串的长度范围，如果单个数字表示最大长度 - * ipv4 - - filter忽略 - * ipv6 - - filter忽略 - * int - - filter指定整型数的范围，如："filter": "100~999" - * enum - - "filter": '{"0": "http", "1": "https"}' - * bool - - "filter": '{"0": "false", "1": "true"}' - * regex - - filter为正则表达式 -* Example - - ```yaml - udm: - authdataManagement: - display: "Authentication Data Management" - mml: - - operation: "dsp" - object: "authdat" - display: "Display Auth Data" - params: - - name: "imsi" - type: "string" - optional: "false" - filter: "" - display: "IMSI" - comment: "" - subscriberManagement: - display: "Subcriber Management" - mml: - - operation: "dsp" - object: "authdat" - display: "Display Auth Data" - params: - - name: "imsi" - type: "string" - optional: "false" - filter: "" - display: "IMSI" - comment: "" - systemManagement: - display: "System Management" - mml: - - operation: "set" - object: "n8ip" - display: "Set N8 IP Address" - params: - - name: "ip" - type: "ipv4" - optional: "false" - filter: "" - display: "IP Address" - comment: "" - ``` - -### 6.2 MML接口 - -* URI - - ```uri - /api/rest/operationManagement/v1/elementType/{elementTypeValue}/objectType/mml?ne_id={neId} - ``` -* Relations - - OMC front-end -> OMC back-end - - OSS -> OMC (北向接口) -* Params - - ne_id={neId} -* Method - - POST -* Body - - ```json - { - "mml": [ - "date", - "list ver", - "list lic", - "list comm" - ] - } - ``` -* Return - - ```json - { - "data": [ - "2023-05-11 17:52:32.37333745 +0800 CST m=+28762.188435351\n", - "16.1.1\n", - "Expiry date: 2024-12-31, sn: 13740272\n", - "COMMAND NOT FOUND, opr: list, obj: comm\n" - ] - } - ``` - -## 7 北向接口(NBI) - -### 7.1 查询资源数据接口 - -* URI - - ```uri - /api/rest/resourceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/{objectTypeValue}?rmUIDs={rmUIDValues}&fields={attributeNames} - ``` -* Relations - - OMC -> NF - - OSS -> OMC (北向接口) -* Params - - * rmUIDs={rmUIDValues} - - 可携带多额rmUID(统一资源定位符), OMC->NF不带 - * fields={attributeNames} - - 属性域集合={属性名列表}, 指定资源对象多个属性名的英文逗号分割，一个属性名时无英文逗号。 -* Method - - GET -* Body - - ```json - GET /api/rest/resourceManagement/v1/elementType/SMF/objectType/ManagedElement?rmUIDs=1101AGTHXSMF0000015704000100&fields=UserLabel HTTP/1.1 - accessToken: 52661fbd-6b84-4fc2-aa1e-17879a5c6c9b - Host: serverIP:port - Content-Type: application/json; charset=UTF-8 - Content-Length:… - { - } - ``` -* Return - - ```json - HTTP/1.1 200 OK - Content - Type: application/json - Content-Length:… - { - "data": [{ - "rmUID": "1101AGTHXSMF0000015704000100", - "UserLabel": "SMFRJBJJC01", - ... - }] - } - ``` - -## 8 文件接口 - -### 8.1 软件管理 - -#### 8.1.1 软件包管理接口 - -* URI - - ```uri - /api/rest/systemManagement/v1/{neType}/software/{version}?md5Sum={md5Sum} - ``` -* Relations - - OMC front-end -> OMC back-end -* Params - - md5Sum={md5Sum} -* Method - - * POST: upload to OMC, 上传文件到OMC, content_type=multipart/form-data - * GET: download from omc, 下载文件到OMC, content_type=multipart/form-data - * DELETE: delete from omc -* Body - - POST: 软件包文件, OMC按网元类型存储文件，如果文件名相同则会覆盖 -* Return - - * POST/DELETE: code=204 - * GET: code=200, 返回文件 - -#### 8.1.2 网元软件包管理接口 - -* URI - - ```uri - /api/rest/systemManagement/v1/{neType}/software/{version}/{neId} - ``` -* Relations - - OMC front-end -> OMC back-end -* Params -* Method - - * POST: distribute to NF - * PUT: active - * PATCH: rollback -* Body - - NA -* Return - - Code: 204 Not content - -### 8.2 License管理 - -#### 8.2.1 网元License管理接口 - -* URI - - ```uri - /api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/license?neId={neId} - ``` -* Relations - - OMC front-end -> OMC back-end ->NF -* Params -* Method - - POST: Upload license to NF -* Body - - * licens文件, content_type=multipart/form-data - * 附加license说明字段信息: "comment": "..." -* Return - - Code: 204 Not content - -## 9 4A接口 - -### 9.1 从账号(user)管理接口 - -#### 9.1.1 查询全部从账号(user)接口 - -* URI - - ```uri - /api/rest/aaaa/v1/security/users - ``` -* Relations - - 4A -> OMC -* Params -* Method - - GET -* Body - - ```json - - ``` -* Return - - ```json - - ``` - -#### 9.1.2 单个从账号(user)接口 - -* URI - - ```uri - /api/rest/aaaa/v1/security/users/{id} - ``` -* Relations - - 4A -> OMC -* Params -* Method - - GET/POST/PUT/DELETE -* Body - - ```json - - ``` -* Return - - ```json - - ``` - -### 9.2 角色(role)管理接口 - -#### 9.2.1 查询全部角色(role)接口 - -* URI - - ```uri - /api/rest/aaaa/v1/security/roles - ``` -* Relations - - 4A -> OMC -* Params -* Method - - GET -* Body - - ```json - - ``` -* Return - - ```json - - ``` - -#### 9.2.2 单个角色(role)接口 - -* URI - - ```uri - /api/rest/aaaa/v1/security/roles/{id} - ``` -* Relations - - 4A -> OMC -* Params -* Method - - GET/POST/PUT/DELETE -* Body - - ```json - - ``` -* Return - - ```json - - ``` - -### 9.3 登录认证接口 - -#### 9.2.1 登录认证 - -* URI - - ```uri - /api/rest/aaaa/v1/security/authentication/token - ``` -* Relations - - 4A -> OMC -* Params -* Method - - GET -* Body - - ```json - - ``` -* Return - - ```json - - ``` - -## 10 核心网用户信息接口 - -### 10.1 UDM签约用户 - -#### 10.1.1 查询/增加/修改/删除/批量增加/批量修改/批量删除 - -用MML接口 - -### 10.2 UDM鉴权用户 - -#### 10.2.1 查询/增加/修改/删除/批量增加/批量修改/批量删除 - -用MML接口 - -### 10.3 UE信息 - -#### 10.3.1 查询SMF在线用户数 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum?neId={neId} - ``` -* Relations - - OMC -> SMF -* Params - - OMC-FE -> OMC-BE, neId={neId}, 指定SMF的neId -* Method - - GET -* Body - - NA -* Return - -```json - // SmfUENum SMF在线用户数 - type SmfUENum struct { - UENum int `json:"ueNum"` // 当前在线用户数 - } -``` - -```json - { - "data": - { - "ueNum": 6 - } - } -``` - -#### 10.3.2 查询SMF在线用户 - -说明：为了避免在线用户太多，SMF可做限制，如返回不超过100条 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} - ``` -* Relations - - OMC -> SMF -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定SMF的neId - * OMC -> SMF, imsi={imsi} 或者 msisdn={msisdn}，可选，如果都不指定，则查询全部ueInfo -* Method - - GET -* Body - - NA -* Return - -```json - // SmfUEInfo SMF在线用户信息 - type SmfUEInfo []struct { - IMSI string `json:"imsi"` - MSISDN string `json:"msisdn"` - RatType string `json:"ratType"` - PduSessionInfo []struct { - PduSessionID int `json:"pduSessionID"` - IPv4 string `json:"ipv4"` - IPv6 string `json:"ipv6"` - Dnn string `json:"dnn"` - Tai string `json:"tai"` - SstSD string `json:"sstSD"` - UpfN3IP string `json:"upfN3IP"` - RanN3IP string `json:"ranN3IP"` - Activetime string `json:"activeTime"` - } `json:"pduSessionInfo"` - } -``` - -```json - { - "data": [ - { - "imsi": "460000100000010", - "msisdn": "12307550010", - "pduSessionInfo": [ - { - "pduSessionID": "1", - "ipv4": "172.16.5.5", - "...": "..." - }, - { - "pduSessionID": "2", - "ipv4": "172.16.5.6", - "...": "..." - } - ] - }, - { - "imsi": "460000100000238", - "msisdn": "12307550238", - "pduSessionInfo": [ - { - "pduSessionID": "3", - "ipv4": "172.16.5.7", - "...": "..." - }, - { - "pduSessionID": "4", - "ipv4": "172.16.5.8", - "...": "..." - } - ] - } - ] - } -``` - -### 10.4 IMS在线用户信息 - -#### 10.4.1 查询IMS在线用户信息 - -说明：为了避免在线用户太多，IMS可做限制，如返回不超过100条 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} - ``` -* Relations - - OMC -> IMS -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId - * OMC -> IMS, imsi={imsi} 或者 msisdn={msisdn}，可选，如果都不指定，则查询全部ueInfo -* Method - - GET -* Body - - NA -* Return - -```json - // ImsUEInfo IMS在线用户信息 - type ImsUEInfo []struct { - IMSI string `json:"imsi"` - MSISDN string `json:"msisdn"` - IMPU string `json:"impu"` - Barring int `json:"barring"` - RegState int `json:"regState"` - Activetime string `json:"activeTime"` - } -``` - -```json - { - "data": [ - { - "imsi": "460000100000010", - "msisdn": "12307550010", - "impu": "sip:12307550010@ims.mnc000.mcc460.3gppnetwork.org", - "barring": 0, - "regState": 1, - "activeTime": "2023-07-11 18:26:46" - }, - { - "imsi": "460000100000238", - "msisdn": "12307550038", - "impu": "sip:12307550238@ims.mnc000.mcc460.3gppnetwork.org", - "barring": 0, - "regState": 1, - "activeTime": "2023-07-11 18:26:46" - } - ] - } -``` - -### 10.5 基站信息 - -#### 10.5.1 查询某个AMF下的基站信息 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo?nbId={nbId}&neId={neId} - ``` -* Relations - - OMC -> AMF -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定AMF的neId - * OMC -> AMF, nbId={nbId}, 可选，如果不指定则查询全部基站信息 -* Method - - GET -* Body - - NA -* Return - -```json - // AmfNBInfo AMF的NodeB信息 - type AmfNBInfo []struct { - ID string `json:"id"` //NodeB ID - Name string `json:"name"` // NodeB name - Address string `json:"address"` // 基站地址 - UENum int `jons:"ueNum"` // UE数量 - } -``` - -```json - { - "data": [ - { - "id": "6001", - "name": "NB6001", - "address": "192.168.1.245:36412", - "ueNum": 2 - }, - { - "id": "6002", - "name": "NB6002", - "address": "192.168.1.246:36412", - "ueNum": 6 - } - ] - } -``` - -### 10.6 N3IWF在线用户信息 - -#### 10.6.1 查询N3IWF在线用户信息 - -说明：为了避免在线用户太多，N3IWF可做限制，如返回不超过100条 - -* Uri - - ```uri - /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo?imsi={imsi}&neId={neId} - ``` -* Relations - - OMC -> IMS -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定IMS的neId - * OMC -> IMS, imsi={imsi} ，可选，如果都不指定，则查询全部ueInfo -* Method - - GET -* Body - - NA -* Return - -```json -// N3iwfUEInfo N3IWF在线用户信息 -type N3iwfUEInfo struct { - IMSI string `json:"imsi"` - - NAI string `json:"nai"` - RegState int `json:"regState"` - Activetime string `json:"activeTime"` -} - -type N3iwfUEData struct { - Data []N3iwfUEInfo `json:"data"` -} -``` - -```json -{ - "data": [ - { - "imsi": "460000100000010", - "nai": "", - "regState": 1, - "activeTime": "2023-07-11 18:26:46" - }, - { - "imsi": "460000100000011", - "nai": "", - "regState": 1, - "activeTime": "2023-07-11 18:26:46" - } - ] -} -``` - -### 10.7 PCF用户策略控制信息 - -#### 10.7.1 查询/增加/修改/删除 - -说明：为了避免用户策略控制信息太多，PCF可做限制，如返回不超过100条 - -* URI - - ```uri - /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo?imsi={imsi}&msisdn={msisdn}&neId={neId} - ``` -* Relations - - OMC -> PCF -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定PCF的neId - * OMC -> PCF, 查询(GET)：imsi={imsi}/msisdn={msisdn}，两个必填一个，都填以imsi为主，如果都不指定，则查询全部ueInfo - * OMC -> PCF, POST/PUT/DELETE: imsi={imsi} 必选 -* Method - - GET/POST/PUT/DELETE -* Body (POST/PUT) - - ```json - // PCF UEInfo PCF用户策略控制信息 - type PcfUser struct { - Imsi string `json:"imsi,omitempty"` - Msisdn string `json:"msisdn,omitempty"` - - Rfsp int `json:"rfsp,omitempty"`// 0-256 - Sar string `json:"sar,omitempty"` - - PccRules string `json:"pccRules,omitempty"` - SessRules string `json:"sessRules,omitempty"` - UePolicy string `json:"uePolicy,omitempty"` - QosAudio string `json:"qosAudio,omitempty"` - QosVideo string `json:"qosVideo,omitempty"` - HdrEnrich string `json:"hdrEnrich,omitempty"` - } - ``` -* Return (GET) - -```json -// PCF UEInfo PCF用户策略控制信息 -type PcfUser struct { - Imsi string `json:"imsi,omitempty"` - Msisdn string `json:"msisdn,omitempty"` - - Rfsp int `json:"rfsp,omitempty"`// 0-256 - Sar string `json:"sar,omitempty"` - - PccRules string `json:"pccRules,omitempty"` - SessRules string `json:"sessRules,omitempty"` - UePolicy string `json:"uePolicy,omitempty"` - QosAudio string `json:"qosAudio,omitempty"` - QosVideo string `json:"qosVideo,omitempty"` - HdrEnrich string `json:"hdrEnrich,omitempty"` -} -``` - -```json - { - "data": [ - { - "imsi": "460000100000010", - "msisdn": "12307550010", - "rfsp": 1, - "sar": "", - ...... - }, - { - "imsi": "460000100000038", - "msisdn": "12307550038", - "rfsp": 2, - "sar": "", - ...... - } - ] - } -``` - -#### 10.7.2 批量增加/批量修改/批量删除 - -* URI - -```uri -/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/number?imsi={imsi}&neId={neId} -``` - -* Relations - - OMC -> PCF -* Params - - * OMC-FE -> OMC-BE, neId={neId}, 指定PCF的neId - * OMC -> PCF, imsi={imsi} 必选 -* Method - - POST/PUT/DELETE -* Body - - ```json - // PCF UEInfo PCF用户策略控制信息 - type PcfUser struct { - Imsi string `json:"imsi,omitempty"` - Msisdn string `json:"msisdn,omitempty"` - - Rfsp int `json:"rfsp,omitempty"`// 0-256 - Sar string `json:"sar,omitempty"` - - PccRules string `json:"pccRules,omitempty"` - SessRules string `json:"sessRules,omitempty"` - UePolicy string `json:"uePolicy,omitempty"` - QosAudio string `json:"qosAudio,omitempty"` - QosVideo string `json:"qosVideo,omitempty"` - HdrEnrich string `json:"hdrEnrich,omitempty"` - } - ``` -* Return - -```json -// PCF UEInfo PCF用户策略控制信息 -type PcfUser struct { - Imsi string `json:"imsi,omitempty"` - Msisdn string `json:"msisdn,omitempty"` - - Rfsp int `json:"rfsp,omitempty"`// 0-256 - Sar string `json:"sar,omitempty"` - - PccRules string `json:"pccRules,omitempty"` - SessRules string `json:"sessRules,omitempty"` - UePolicy string `json:"uePolicy,omitempty"` - QosAudio string `json:"qosAudio,omitempty"` - QosVideo string `json:"qosVideo,omitempty"` - HdrEnrich string `json:"hdrEnrich,omitempty"` -} -``` - -```json - { - "data": [ - { - "imsi": "460000100000010", - "msisdn": "12307550010", - "rfsp": 1, - "sar": "", - ...... - }, - { - "imsi": "460000100000038", - "msisdn": "12307550038", - "rfsp": 2, - "sar": "", - ...... - } - ] - } -``` - -## 11 系统管理 - -### 11.1 OMC系统 - -#### 11.1.1 获取OMC时间接口 - -* Uri - - ```uri - /api/rest/systemManagement/v1/elementType/OMC/objectType/time - ``` -* Relations - OMC FE -> OMC BE -* Params - - NA -* Method - GET -* Body - NA -* Return - - ```json - // OMC time 信息 - type OMCLocalTime struct { - Timestamp int64 `json:"timestamp"` // 时间戳 (单位:毫秒) - TimeZone int `json:"timeZone"` // 本地时区偏移（单位：秒） - } - ``` - Expample: - - ```json - { - "data": - { - "timestamp": "1697101301164" - "timeZone": "28800" - } - } - ``` diff --git a/docs/interfaces/06-5GC OMC restful internal intefaces.md b/docs/interfaces/06-5GC OMC restful internal intefaces.md deleted file mode 100644 index 553cf05..0000000 --- a/docs/interfaces/06-5GC OMC restful internal intefaces.md +++ /dev/null @@ -1,1023 +0,0 @@ -## EMS restful interfaces - ---- - -### 1. 状态管理 - -* URI: - - ``` - /api/rest/systemManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/systemState?ne_id=0 - ``` - - 说明： - - ```Tips - ** elementTypeValue=all/smf/amf/.. - ** all: 表示所有配置的NF（ems前端->后端） - ** smf：查询smf网元 - ** 参数ne_id指网元标识，指定ne_id条件表示查询该网元系统状态（ems前端->后端需要带该参数） - ``` -* Method: - - > GET - > -* Return: - - ```json - - "data": [ - { - "AMF_0": { - "error": { - "errorCode": "1", - "errorInfo": "Internal server error, NF connnect refused" - }, - "ipAddress": "192.168.2.188" - } - }, - { - "SMF_0": { - "ipAddress": "192.168.1.232", - "systemState": { - "capability": 10000, - "cpuUsage": { - "nfCpuUsage": 2, - "sysCpuUsage": 52 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 1920, - "used": 0 - }, - { - "total": 393, - "used": 13 - }, - { - "total": 48700, - "used": 32431 - }, - { - "total": 1965, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 1965, - "used": 0 - }, - { - "total": 55, - "used": 55 - }, - { - "total": 63, - "used": 63 - }, - { - "total": 91, - "used": 91 - }, - { - "total": 49, - "used": 49 - }, - { - "total": 55, - "used": 55 - }, - { - "total": 73, - "used": 73 - }, - { - "total": 91, - "used": 91 - }, - { - "total": 1475, - "used": 206 - }, - { - "total": 49, - "used": 49 - }, - { - "total": 393, - "used": 13 - }, - { - "total": 393, - "used": 0 - }, - { - "total": 73, - "used": 73 - }, - { - "total": 63, - "used": 63 - } - ], - "partitionNum": 19 - }, - "expiryDate": "2025-02-28", - "memUsage": { - "nfUsedMem": 163992, - "sysMemUsage": 1345, - "totalMem": 4025608 - }, - "serialNum": "13740126", - "version": "1.5.3.2" - } - } - }, - { - "SMF_1": { - "ipAddress": "192.168.1.173", - "systemState": { - "capability": 10000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 69 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 200559, - "used": 5968 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 212136, - "sysMemUsage": 720, - "totalMem": 8167360 - }, - "serialNum": "13740272", - "version": "1.5.3.3" - } - } - } - ] - } - ``` - -### 2. 数据库管理（内部接口） - -#### 2.1 查询(select) - -* URI: - - ``` - /api/rest/databaseManagement/{apiVersion}/{databaseName}/{tableName}?SQL={SQL}|WHERE={WHERE} - ``` -* Method: - - > GET - > -* Params: - - > 参数关键字大小写敏感 - > - - * WHERE - - > WHERE=id=1 and parent_id=0 - > - - 说明： - - ```Tips - ** 表名为tableName带的表名 - ``` - * SQL - - > SQL=select count(*) from sysmenu&SQL=SELECT * FROM menu - > - - 说明： - - ```Tips - ** 支持多个SQL查询 - ** SQL只能是查询语句 - ** tableName带的表名忽略 - ** 特殊字符需要转义，如"%"需转义为"%25" - ``` -* Return: - - ```json - { - "data": [ - { - "tableName1": [ - { - "column1": value1, - "column2": value2, - "column3": value3, - ... - } - ] - }, - { - "tableName2": [ - { - "column1": value11, - "column2": value12, - "column3": value13, - ... - }, - { - "column1": value21, - "column2": value22, - "column3": value23, - ... - } - ] - } - ] - } - ``` -* Example: - - * WHERE: - - ``` - /api/rest/databaseManagement/v1/omc_db/menu?WHERE=id=1 - ``` - - ```json - { - "data": [ - { - "menu": [ - { - "href": "111", - "icon": "11", - "id": 1, - "parent_id": 0, - "remark": "0", - "title": "test" - } - ] - } - ] - } - ``` - - * SQL: - - ``` - /api/rest/databaseManagement/v1/omc_db/menu?SQL=select count(*) from sysmenu&SQL=SELECT * FROM menu - ``` - - ```json - { - "data": [ - { - "sysmenu": [ - { - "count(*)": 4 - } - ] - }, - { - "menu": [ - { - "href": "111", - "icon": "11", - "id": 1, - "parent_id": 0, - "remark": "0", - "title": "test" - }, - { - "href": "31", - "icon": "313", - "id": 2, - "parent_id": 1, - "remark": "0", - "title": "test1" - } - ] - } - ] - } - ``` - -#### 2.2 增加（insert） - -* URI: - - ``` - /api/rest/databaseManagement/{apiVersion}/{databaseName}/{tableName} - ``` -* Method: - - > POST - > -* Body: - - > 参数关键字大小写敏感 - > - - ```json - { - "menu": [ - { - "id": 3, - "title": "test3", - "icon": "113", - "href": "1113", - "parent_id": 2, - "remark": "0" - } - ] - } - ``` - - 说明： - - ```Tips - ** 支持多条插入数据 - ** 支持多个表插入数据 - ** tableName带的表名忽略 - ``` -* Return: - - ```json - { - "data": { - "affected rows": 1 - } - } - ``` - -#### 2.3 修改（update） - -* URI: - - ``` - /api/rest/databaseManagement/{apiVersion}/{databaseName}/{tablename}?WHERE={where} - ``` -* Method: - - > PUT - > -* Params: - - * WHERE - ```Tips - 参数关键字大小写敏感 - exp: WHERE=id=1 - ``` -* Body: - - ```json - { - "menu": [ - { - "title": "test3", - "icon": "113", - "href": "1113", - } - ] - } - - ``` -* Return: - - ```json - { - "data": [ - { - "tableName1": [ - { - "column1": value1, - "column2": value2, - "column3": value3, - ... - } - ] - }, - { - "tableName2": [ - { - "column1": value11, - "column2": value12, - "column3": value13, - ... - }, - { - "column1": value21, - "column2": value22, - "column3": value23, - ... - } - ] - } - ] - } - ``` - -#### 2.4 删除（delete） -* URI: - - ``` - /api/rest/databaseManagement/{apiVersion}/{databaseName}/{tablename}?WHERE={where} - ``` -* Method: - - DELETE - -* Params: - - * WHERE - ```Tips - 参数关键字大小写敏感 - exp: WHERE=id=1 - ``` -* Body: - - NA - -* Return: - - Code: 200/204 - -### 3. 配置管理 - -#### 3.1 参数配置表 - -* 类型定义（type） - - * string - > filter指定字符串长度，如："filter": "6~100" , 字符串的长度范围，如果单个数字表示最大长度 - > - * ipv4 - > filter忽略 - > - * ipv6 - > filter忽略 - > - * int - > filter指定整型数的范围，如："filter": "100~999" - > - * enum - > "filter": '{"0": "http", "1": "https"}' - > - * bool - > "filter": '{"0": "false", "1": "true"}' - > - * regex - > filter为正则表达式 - > -* Example - - ```yaml - UDM: - system: - display: "System" - list: - - name: "serviceIP" - type: "ipv4" - value: "172.16.5.140" - access: "read-write" - filter: '' - display: "Service IP" - comment: "" - - name: "servicePort" - type: "int" - value: "8080" - access: "read-write" - filter: "0~65535" - display: "Service Port" - comment: "0~65535" - subsSmfSelection: - display: "Subs Smf Selection" - array: - - name: "index" - type: "int" - value: "0" - access: "read-write" - filter: '0~15' - display: "Index" - comment: "0~15" - - name: "name" - type: "string" - value: 'def_ambr' - access: "read-write" - filter: '^.{1,32}$' - display: "Name" - comment: "0~32" - - name: "snssai" - type: "string" - value: '1-000001' - access: "read-write" - filter: '^\d{1,3}[A-Fa-f0-9]{6}$' - display: "Snssai" - comment: "" - - name: "dnnList" - type: "int" - value: '0' - access: "read-write" - filter: '0~3' - display: "Dnn List" - comment: "" - array: - - name: "index" - type: "int" - value: "0" - access: "read-write" - filter: '0~15' - display: "index" - comment: "0~15" - - name: "dnn" - type: "string" - value: 'cmnet' - access: "read-write" - filter: '^.{1,32}$' - display: "Dnn" - comment: "0~32" - - name: "defaultDnnInd" - type: "bool" - value: 'true' - access: "read-write" - filter: 'false;true;' - display: "default Dnn Indicator" - comment: "" - ``` - - 完整文件具体请参考 udm_param_config.yaml - -#### 3.2 获取参数 - -* URI - - ``` - /api/rest/systemManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/config/{paraName}?ne_id=0&loc={index0}/{paraName1}/{index1}/... - ``` - - 说明 - - ```Tips - apiVersion: "v1" - elementTypeValue: udm, smf, amf... 网元类型 - udm paraName: system, subsUEAmbr, subsSmfSelection ... - 非array的参数，忽略loc - ``` -* Params - - * loc 多层表的定位信息 - * ne_id 网元标识 (ems前端->后端需要带该参数) -* Method - - > GET - > -* Return - - ``` - /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - ``` - - ```json - { - "data": [ - { - "serviceIP": "172.16.5.140", - "servicePort": "8080", - "...": "..." - } - ] - } - ``` - - ``` - /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsSmfSelection?loc=1/dnnList - ``` - - ```json - { - "data": [ - { - "index": "0", - "dnn": "cmnet", - "...": "..." - }, - { - "index": "1", - "dnn": "ims", - "...": "..." - } - ] - } - ``` - -#### 3.3 配置参数 - -* URI - - ``` - /api/rest/systemManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/config/{paraName}?ne_id=0&loc={index0}/{paraName1}/{index1} - ``` -* Params - - * loc 多层表的定位信息 - * ne_id 网元标识 (ems前端->后端需要带该参数) -* Method - - > POST/PUT/DELETE - - - 说明： - - ```Tips - 单层表不支持POST/DELETE操作 - ``` -* Body - - ```json - { - "serviceIP": "172.16.5.140", - "servicePort": "8080", - "...": "..." - } - ``` - - 说明： - - ```Tips - DELETE操作忽略Body - ``` - -#### 3.4 创建网元 - -* URI - - ``` - /api/rest/systemManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/neInfo - ``` -* Params - - N/A - -* Method - - > POST - -* Body - ```json - { - - } - ``` - -### 4 跟踪管理 - -#### 4.1 订阅管理 - -* 创建订阅 - - * URI - - ``` - /api/rest/traceManagement/{apiVersion}/subscriptions - ``` - * Method - - > POST - > - * Body - - ```json - { - "id": "1", - "filter": "...", - "callbackUrl": "https://x.x.x.x:x/api/rest/traceManagement/v1/events" - } - ``` - * Return - - > {} - > -* 查询订阅 - - * URI - 查询单个订阅： - - ``` - /api/rest/traceManagement/{apiVersion}/subscriptions/{id} - ``` - - 查询所有订阅： - - ```http - /api/rest/traceManagement/{apiVersion}/subscriptions - ``` - * Method - - > GET - > - * Body - - > null - > - * Return - - ```json - { - "data": [ - { - "id": "1", - "filter": "...", - "callbackUrl": "https://x.x.x.x:x/api/rest/traceManagement/v1/events" - } - ] - } - ``` -* 删除订阅 - - * URI - - ``` - /api/rest/traceManagement/{apiVersion}/subscriptions/{id} - ``` - * Method - - > DELETE - > - * Body - - > null - > - -#### 4.2 事件上报 - -* 事件上报 - - * URI - - ``` - /api/rest/traceManagement/{apiVersion}/events - ``` - * Method - - > POST - > - * Body - - ```json - { - "data": [ - { - "id": ["1", "2"], - "key1": "", - "key2": "...", - "content": "content0......" - }, - { - "id": ["1", "3"], - "key1": "", - "key2": "...", - "content": "content1......" - } - ] - } - ``` -### 5 性能管理 - -#### 5.1 任务管理 - -* URI - ``` - /api/rest/performanceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/measureTask?id={taskId1}&id={taskId2} - ``` -* Method - - POST/PUT/DELETE/PATCH - -* Params - - taskId=1&taskId=2 - - * POST: 增加测量任务，激活任务，不带id参数，id在body - * PUT： 修改测量任务，激活任务，不带id参数，id在body - * DELETE：删除测量任务，不需要带body，带id参数，可带多个 - * PATCH: 暂停测量任务，不需要带body，带id参数，可带多个 - -* Relation NF - - OMC -> NF/NF -> OMC - -* Body - - 下发测量任务的报文结构 - ```json - type MeasureTask struct { - Tasks []struct { - Id int `json:"Id"` - - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - - Schedule struct { - Type string `json:"Type"` // 计划类型：Weekly/Monthly - Days []int `json:"Days"` // Weekly: [0,1,...5,6]，0~6表示星期日~星期六, Monthly: [1,2,3,...,30,31]一个月的几天 - Periods []struct { - Start string `json:"Start"` // 零点或者零点加测量粒度的整数倍 00:15:00 - End string `json:"End"` // 零点加测量粒度的整数倍 08:45:00, 16:15:00 - } `json:"Periods"` - } `json:"Schedule"` - - GranulOption string `json:"GranulOption"` // 测量粒度选项：15M/30M/60M/24H - - KPISet []struct { - Code string `json:"Code"` // 统计编码 如：SMFHA01 - KPIs []string `json:"KPIs` // 指标项集合 ["SMF.AttCreatePduSession", "SMF.AttCreatePduSession._Dnn"] - } `json:"KPISet"` - } `json:"Task"` - } - ``` - -* Return - -#### 5.2 测量数据上报 -* URI - ``` - /api/rest/performanceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/measureReport - ``` -* Method - - POST - -* Body - - 网元返回测量数据的报文结构 - ```json - type MeasureReport struct { - Id int `json:"Id"` - Timestamp string `json:"TimeStamp"` - - Report struct { - Period struct { - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - } `json:"Period"` - - Datas []struct { - Code string `json:"Code"` // 统计编码 如：SMFHA01 - KPIs []struct { - KPIID string `json:"KPIID"` // 指标项, 如： SMF.AttCreatePduSession._Dnn - KPIValues []struct { - Name string `json:"Name"` // 单个的写"Total", 或者指标项有多个测量项，如Dnn的名称写对应的Dnn"cmnet"/"ims" - Value int `json:"Value"` - } `json:"KPIValues"` - } `json:"KPIs"` - } `json:"Datas"` - } `json:"Report"` - } - ``` -#### 5.3 黄金指标上报 -* URI - ``` - /api/rest/performanceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/kpiReport/{index} - ``` -* Method - - GET -* Body - - ```json - type KpiReport struct { - Timestamp string `json:"TimeStamp"` - Task struct { - Period struct { - StartTime string `json:"StartTime"` - EndTime string `json:"EndTime"` - } `json:"Period"` - NE struct { - NEName string `json:"NEName"` - RmUID string `json:"rmUID"` - NeType string `json:"NeType"` - KPIs []struct { - KPIID string `json:"KPIID"` - Value int `json:"Value"` - Err string `json:"Err"` - } `json:"KPIs"` - } `json:"NE"` - } `json:"Task"` - } - ``` -### 6 故障管理 -#### 6.1 告警上报 -* URI - ``` - /api/rest/faultManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/alarms - ``` -* Method - - POST - -* Relation NF - - NF->OMC - -* Body - - ```json - type Alarm struct { - AlarmSeq int `json:"alarmSeq"` - AlarmId string `json:"alarmId"` - NeId string `json:"neId"` - AlarmCode int `json:"alarmCode"` - AlarmTitle string `json:"alarmTitle"` - EventTime string `json:"eventTime"` - AlarmType string `json:"alarmType"` - OrigSeverity string `json:"origSeverity"` - PVFlag string `json:"pvFlag"` - NeName string `json:"neName"` - NeType string `json:"neType"` - ObjectName string `json:"objectName"` - LocationInfo string `json:"locationInfo"` - Province string `json:"province"` - AlarmStatus int `json:"alarmStatus"` - SpecificProblem string `json:"specificProblem"` - SpecificProblemID string `json:"specificProblemID"` - AddInfo string `json:"addInfo"` - } - ``` - -#### 6.2 获取网元告警 -* URI - ``` - /api/rest/faultManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/alarms - ``` -* Method - - GET - -* Relationship - - OMC->NF - -* Body - - n/a - -* Return - - ```json - type Alarms struct { - Alarms []struct { - AlarmSeq int `json:"alarmSeq"` - AlarmId string `json:"alarmId"` - NeId string `json:"neId"` - AlarmCode int `json:"alarmCode"` - AlarmTitle string `json:"alarmTitle"` - EventTime string `json:"eventTime"` - AlarmType string `json:"alarmType"` - OrigSeverity string `json:"origSeverity"` - PVFlag string `json:"pvFlag"` - NeName string `json:"neName"` - NeType string `json:"neType"` - ObjectName string `json:"objectName"` - LocationInfo string `json:"locationInfo"` - Province string `json:"province"` - AlarmStatus int `json:"alarmStatus"` - SpecificProblem string `json:"specificProblem"` - SpecificProblemID string `json:"specificProblemID"` - AddInfo string `json:"addInfo"` - } `json:"Alarms"` - } - ``` diff --git a/docs/interfaces/08-OMC FE2BE HTTP API Interfaces.md b/docs/interfaces/08-OMC FE2BE HTTP API Interfaces.md deleted file mode 100644 index 08607a8..0000000 --- a/docs/interfaces/08-OMC FE2BE HTTP API Interfaces.md +++ /dev/null @@ -1,14157 +0,0 @@ ---- -title: OMC v1.0.0 -language_tabs: - - shell: Shell - - http: HTTP - - javascript: JavaScript - - ruby: Ruby - - python: Python - - php: PHP - - java: Java - - go: Go -toc_footers: [] -includes: [] -search: true -code_clipboard: true -highlight_theme: darkula -headingLevel: 2 -generator: "@tarslib/widdershins v4.0.17" - ---- - -# OMC - -> v1.0.0 - -OMC Restful API服务接口 - -Base URLs: - -# Authentication - -# 通用模块 - -## GET 默认主页 - -GET / - -### 请求参数 - -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|Referer|header|string| 是 |使用指定声明的Referer| -|User-Agent|header|string| 是 |用户浏览器代理| -|Accept-Language|header|string| 是 |zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "欢迎使用mask_api_midwayjs后台管理框架，当前版本：0.0.5，请通过前端管理地址访问。" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 获取验证码 - -GET /captchaImage - -验证码有效期2分钟 - -### 请求参数 - -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|Referer|header|string| 是 |使用指定声明的Referer| -|User-Agent|header|string| 是 |用户浏览器代理| -|Accept-Language|header|string| 是 |zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "captchaEnabled": true, - "uuid": "os0t2l1532dhuvqv", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%2364e6e6' d='M62.19 26.62L62.24 26.67L62.16 26.59Q65.43 27.87 69.20 27.87L69.20 27.88L69.26 27.94Q70.89 27.97 72.45 27.75L72.42 27.71L72.32 27.61Q71.98 28.18 71.33 29.36L71.26 29.29L71.29 29.32Q71.92 29.46 72.60 29.23L72.65 29.27L72.49 29.11Q72.23 30.03 72.23 30.83L72.28 30.89L72.19 30.79Q72.19 31.52 72.46 32.24L72.54 32.32L72.51 32.29Q70.98 31.95 69.20 31.99L69.29 32.08L69.23 32.02Q67.58 32.12 66.17 32.39L66.17 32.39L66.03 32.25Q66.46 31.46 66.35 30.47L66.36 30.48L66.36 30.49Q66.19 30.62 65.97 30.58L65.86 30.48L65.87 30.49Q65.69 30.47 65.39 30.47L65.37 30.44L65.49 30.57Q65.20 28.71 62.15 26.58ZM65.45 29.99L65.54 30.08L65.51 30.05Q67.04 30.25 68.18 30.21L68.22 30.25L68.13 30.16Q70.97 30.30 70.97 30.30L70.96 30.28L70.83 30.16Q71.02 29.20 71.74 28.18L71.68 28.11L71.59 28.03Q70.56 28.29 69.38 28.29L69.45 28.36L69.38 28.29Q66.36 28.35 63.47 27.40L63.43 27.36L63.37 27.30Q65.24 28.64 65.62 30.17ZM65.12 30.77L65.19 30.84L65.23 30.87Q65.53 30.79 66.21 30.83L66.19 30.81L66.15 30.77Q66.09 31.89 65.56 32.65L65.56 32.66L65.59 32.69Q67.19 32.57 67.03 32.57L67.07 32.60L67.07 32.60Q66.49 33.54 65.73 34.31L65.65 34.22L65.68 34.26Q67.75 33.97 69.69 33.97L69.55 33.83L69.64 33.91Q74.20 33.87 78.31 35.58L78.40 35.67L75.97 34.31L75.83 34.16Q73.52 32.73 73.52 30.52L73.38 30.39L73.46 30.46Q73.14 30.45 72.88 30.45L72.98 30.55L72.52 30.63L72.40 30.51Q72.58 29.78 73.15 28.83L73.13 28.81L73.05 28.72Q72.58 28.75 71.63 28.94L71.80 29.11L71.65 28.96Q72.26 28.05 73.25 27.29L73.21 27.25L73.11 27.15Q71.26 27.58 69.24 27.58L69.32 27.66L69.18 27.52Q64.54 27.64 60.77 25.77L60.70 25.70L60.78 25.78Q65.14 28.39 65.25 30.90ZM66.06 29.73L66.15 29.82L65.84 29.78L65.93 29.86Q65.64 29.61 65.53 29.61L65.71 29.79L65.72 29.80Q65.53 29.23 65.15 28.82L64.97 28.64L64.22 27.77L64.27 27.82Q66.75 28.66 69.49 28.66L69.36 28.54L69.46 28.64Q70.16 28.50 71.03 28.42L71.14 28.52L70.96 28.84L70.75 29.05L70.74 29.04Q69.46 29.09 68.17 29.06L68.18 29.06L68.33 29.22Q66.91 29.10 65.62 28.83L65.53 28.74L65.68 28.88Q66.05 29.26 66.20 29.87Z'/%3e%3cpath fill='%2371ade8' d='M44.80 18.31L44.89 18.39L44.82 18.33Q41.80 18.50 39.97 17.43L39.85 17.31L39.91 17.37Q42.41 15.99 47.28 11.77L47.20 11.68L47.21 11.69Q47.93 11.50 49.23 10.89L49.37 11.03L49.19 10.85Q47.99 16.93 47.88 23.28L47.82 23.23L47.74 23.15Q47.66 29.54 48.72 35.63L48.88 35.78L48.77 35.68Q47.12 34.97 44.98 34.86L45.00 34.87L44.91 34.78Q44.95 30.79 44.95 26.71L44.85 26.62L44.84 26.60Q44.89 22.55 44.93 18.43ZM44.49 20.62L44.51 35.22L44.60 35.31Q45.66 35.15 46.61 35.34L46.63 35.36L46.75 35.48Q46.71 36.05 46.90 37.42L46.91 37.43L46.92 37.44Q49.78 37.98 52.21 40.22L52.28 40.29L52.29 40.30Q49.82 33.19 49.79 25.73L49.66 25.60L49.66 25.60Q49.66 18.22 51.49 10.98L51.52 11.02L51.56 11.05Q50.92 11.37 49.32 12.47L49.37 12.52L49.39 12.53Q49.53 11.73 49.84 10.21L49.89 10.26L49.86 10.23Q48.47 10.94 47.02 11.32L47.11 11.40L47.16 11.45Q43.30 14.94 39.00 17.22L39.01 17.23L38.93 17.16Q40.33 18.25 42.69 18.59L42.75 18.65L42.72 18.62Q42.05 19.13 40.76 20.20L40.80 20.24L40.77 20.21Q42.38 20.71 44.58 20.71L44.48 20.61Z'/%3e%3cpath fill='%23328ce5' d='M21.38 18.49L21.29 18.40L21.25 18.35Q18.06 18.36 16.23 17.29L16.30 17.36L16.32 17.39Q18.86 16.04 23.73 11.82L23.69 11.77L23.72 11.80Q24.32 11.48 25.61 10.87L25.68 10.95L25.67 10.93Q24.27 16.80 24.15 23.16L24.27 23.28L24.25 23.25Q24.08 29.55 25.14 35.65L25.24 35.75L25.26 35.76Q23.44 34.90 21.31 34.78L21.45 34.93L21.33 34.80Q21.30 30.73 21.30 26.66L21.32 26.68L21.30 26.66Q21.18 22.44 21.22 18.33ZM21.01 20.74L20.85 35.16L20.88 35.19Q22.20 35.29 23.15 35.48L23.18 35.51L23.02 35.35Q23.15 36.09 23.34 37.46L23.40 37.53L23.34 37.46Q26.25 38.05 28.68 40.29L28.73 40.34L28.57 40.18Q26.18 33.15 26.15 25.69L26.07 25.61L26.20 25.74Q26.00 18.15 27.82 10.92L27.83 10.92L27.98 11.08Q27.25 11.30 25.65 12.40L25.78 12.53L25.79 12.54Q25.94 11.73 26.24 10.21L26.19 10.16L26.21 10.19Q24.96 11.03 23.51 11.41L23.43 11.32L23.48 11.37Q19.71 14.95 15.41 17.23L15.40 17.22L15.37 17.19Q16.80 18.32 19.16 18.66L19.09 18.60L19.19 18.70Q18.48 19.16 17.18 20.22L17.13 20.18L17.27 20.32Q18.61 20.55 20.82 20.55L20.86 20.59Z'/%3e%3cpath fill='%23ea5b7f' d='M99.33 32.82L99.48 32.98L99.49 32.99Q99.70 33.88 100.23 35.90L100.26 35.93L100.19 35.86Q95.96 34.53 91.36 34.79L91.43 34.87L91.36 34.79Q86.86 35.13 82.86 37.11L82.93 37.18L82.77 37.02Q83.04 36.37 83.08 36.45L83.03 36.40L83.12 36.49Q86.76 32.44 90.68 28.03L90.81 28.15L90.75 28.10Q95.13 23.07 96.31 18.39L96.27 18.35L96.37 18.45Q96.79 16.66 95.52 15.48L95.57 15.53L95.51 15.48Q94.32 14.38 92.53 14.53L92.55 14.55L92.54 14.55Q92.19 14.49 91.85 14.49L91.78 14.43L91.82 14.47Q90.33 14.50 89.08 15.42L88.92 15.26L89.03 15.38Q87.75 16.75 87.97 19.42L87.92 19.37L88.00 19.44Q86.06 18.95 84.84 18.50L84.84 18.49L84.86 18.51Q84.76 17.19 84.68 15.75L84.69 15.75L84.77 15.83Q84.61 14.11 85.22 12.97L85.20 12.95L85.12 12.87Q87.02 11.61 90.37 11.61L90.36 11.60L92.10 11.59L92.14 11.63Q94.30 11.54 95.25 11.66L95.24 11.65L95.25 11.65Q99.69 12.18 99.96 14.61L99.85 14.51L99.95 14.61Q100.04 15.19 99.96 15.99L99.88 15.90L100.03 16.05Q99.98 16.69 99.83 17.37L99.82 17.37L99.67 17.22Q98.08 25.38 90.51 32.23L90.53 32.26L90.51 32.23Q91.96 32.12 93.33 32.12L93.30 32.09L93.29 32.08Q96.57 32.13 99.43 32.93ZM98.92 12.16L98.80 12.04L98.93 12.17Q97.17 11.37 95.46 11.29L95.53 11.37L92.18 11.25L92.06 11.13Q87.59 10.85 85.38 11.96L85.41 11.98L85.34 11.91Q84.31 13.32 84.31 15.38L84.34 15.40L84.44 15.51Q84.32 16.07 84.63 18.89L84.76 19.02L84.72 18.98Q85.24 19.19 86.42 19.50L86.39 19.47L86.47 20.58L86.37 20.48Q86.42 21.03 86.50 21.56L86.48 21.54L86.42 21.48Q87.75 21.67 90.23 21.90L90.24 21.92L90.11 21.79Q90.23 21.56 90.23 21.22L90.21 21.20L90.17 21.16Q90.16 19.32 91.37 17.96L91.45 18.04L91.47 18.06Q92.64 16.66 94.43 16.78L94.36 16.71L94.33 16.67Q95.20 16.82 95.96 16.97L95.93 16.94L95.93 16.94Q95.99 17.27 96.06 17.69L96.08 17.71L96.00 17.62Q96.11 18.11 96.03 18.46L95.97 18.39L96.15 18.57Q94.71 23.15 90.30 27.99L90.36 28.05L90.40 28.09Q88.21 30.27 82.76 36.33L82.77 36.33L82.78 36.35Q82.53 37.12 82.18 37.69L82.19 37.70L82.23 37.73Q83.92 36.95 85.45 36.42L85.31 36.28L85.46 36.43Q84.62 36.88 83.67 38.37L83.80 38.50L83.77 38.47Q83.69 38.85 83.57 39.19L83.52 39.14L83.49 39.10Q88.27 36.96 93.76 37.15L93.88 37.28L93.90 37.29Q99.62 37.50 104.19 39.86L104.12 39.79L103.17 37.70L103.03 37.56Q102.53 36.37 102.26 35.57L102.12 35.43L102.24 35.55Q101.46 35.08 100.24 34.66L100.30 34.71L100.21 34.63Q100.03 33.87 99.65 32.50L99.78 32.63L99.64 32.49Q97.40 31.89 95.12 31.70L95.17 31.75L95.13 31.71Q99.98 27.32 101.51 19.05L101.48 19.03L101.62 16.09L101.67 16.13Q101.59 14.34 100.37 13.66L100.31 13.59L100.27 13.59L100.27 13.59Q100.18 13.47 100.11 13.47L100.09 13.45L100.11 13.47Q100.01 12.76 98.91 12.15Z'/%3e%3cpath d='M14 30 C59 18%2c65 9%2c110 17' stroke='%2363dddd' fill='none'/%3e%3cpath d='M13 24 C48 26%2c39 6%2c107 9' stroke='%23de77c4' fill='none'/%3e%3cpath d='M12 11 C50 25%2c80 39%2c113 8' stroke='%23e593bc' fill='none'/%3e%3cpath d='M19 17 C43 30%2c51 8%2c109 8' stroke='%23ddc16d' fill='none'/%3e%3c/svg%3e" -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "text": "9", - "captchaEnabled": true, - "uuid": "s7hf2j3erfpritqy", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%23ec73ce' d='M85.44 24.04L85.53 24.13L85.51 24.11Q83.59 23.90 82.35 25.33L82.43 25.40L82.43 25.41Q81.15 26.79 80.96 28.70L81.02 28.76L81.00 28.73Q80.82 30.84 81.91 31.81L81.97 31.87L81.87 31.78Q83.04 32.83 85.13 32.72L84.98 32.56L85.02 32.61Q87.16 32.50 88.26 31.81L88.29 31.84L88.27 31.82Q89.38 30.68 89.38 29.12L89.37 29.11L89.44 29.19Q89.37 28.73 89.30 28.35L89.35 28.41L89.39 28.44Q89.39 26.69 88.28 25.34L88.23 25.29L88.35 25.40Q87.20 24.01 85.52 24.12ZM85.09 35.22L85.17 35.31L85.10 35.24Q80.72 35.24 79.32 34.48L79.34 34.50L79.28 34.44Q78.32 33.75 78.13 32.04L78.05 31.96L78.03 31.93Q78.01 31.27 78.05 30.55L78.11 30.61L78.16 30.65Q78.27 29.66 78.27 29.21L78.24 29.17L78.13 29.06Q78.70 26.32 78.85 25.64L78.79 25.57L78.85 25.64Q79.36 23.75 80.20 22.34L80.18 22.33L80.01 22.15Q82.70 17.80 88.64 11.44L88.62 11.42L88.67 11.48Q91.34 11.17 93.55 10.37L93.58 10.41L93.62 10.44Q86.67 17.81 83.47 22.04L83.47 22.03L83.48 22.04Q84.46 21.53 85.75 21.53L85.86 21.64L85.82 21.60Q89.14 21.61 90.67 23.56L90.71 23.60L90.75 23.64Q91.92 25.12 92.26 28.66L92.27 28.66L92.29 28.68Q92.39 29.43 92.39 30.04L92.36 30.01L92.47 30.12Q92.44 33.21 90.23 34.28L90.23 34.28L90.26 34.30Q88.98 34.86 85.10 35.24ZM87.47 37.72L87.43 37.68L87.35 37.60Q88.60 37.52 90.58 37.60L90.71 37.72L90.71 37.73Q92.28 37.73 93.84 37.01L93.93 37.09L93.82 36.99Q94.99 36.26 94.99 34.47L94.96 34.43L95.01 34.49Q95.03 34.01 94.86 33.02L94.88 33.04L94.82 32.98Q94.56 31.91 94.56 31.45L94.60 31.49L94.54 31.43Q93.75 26.79 92.15 24.88L92.04 24.78L92.07 24.81Q92.00 24.70 91.85 24.47L91.90 24.52L91.66 24.36L91.50 24.24L91.51 24.25Q91.11 23.69 90.50 22.74L90.55 22.79L90.49 22.74Q89.69 21.89 87.71 21.44L87.64 21.36L87.62 21.35Q88.95 19.86 91.92 16.17L91.82 16.07L96.16 10.89L96.12 10.85Q94.61 11.77 92.21 12.53L92.15 12.47L92.19 12.52Q93.08 11.51 94.87 9.53L94.82 9.48L94.81 9.46Q92.46 10.58 88.58 11.15L88.59 11.17L88.58 11.16Q82.94 17.12 79.97 22.07L79.85 21.95L79.89 21.99Q78.41 24.55 77.84 30.79L77.84 30.79L77.72 30.67Q77.67 31.27 77.74 32.22L77.69 32.17L77.72 32.20Q77.90 34.05 79.00 34.96L78.95 34.91L78.92 34.88Q79.37 35.10 79.33 35.14L79.29 35.10L79.36 35.17Q79.71 36.05 80.51 36.47L80.42 36.38L80.50 36.46Q81.90 37.10 83.84 37.29L83.84 37.29L83.85 37.30Q83.79 37.24 87.30 37.54ZM87.11 26.36L87.10 26.35L87.17 26.41Q87.77 26.33 88.72 26.83L88.63 26.74L88.77 26.87Q88.99 27.71 88.99 28.36L88.94 28.30L89.00 28.37Q89.12 30.16 88.17 31.15L88.28 31.26L88.28 31.26Q87.16 31.92 85.06 32.23L85.15 32.32L85.11 32.28Q83.59 32.20 83.05 31.93L83.20 32.08L83.03 31.91Q82.84 31.45 82.84 31.15L82.85 31.16L83.00 31.31Q82.76 28.03 85.69 26.73L85.62 26.66L85.62 26.65Q86.45 26.39 87.22 26.46Z'/%3e%3cpath d='M10 16 C70 25%2c49 8%2c114 10' stroke='%2378c4dd' fill='none'/%3e%3cpath fill='%23d24065' d='M23.39 35.44L23.31 35.35L23.31 35.35Q21.80 35.33 20.24 34.91L20.24 34.91L20.26 34.93Q19.14 34.12 18.99 32.48L18.89 32.38L18.88 32.38Q18.97 32.31 19.16 29.68L19.17 29.69L19.07 29.59Q20.06 29.37 22.08 28.99L22.06 28.97L21.89 29.75L22.00 29.86Q21.69 31.57 23.10 32.14L23.15 32.19L23.18 32.22Q23.98 32.57 26.08 32.57L26.01 32.50L25.93 32.42Q27.52 32.26 27.71 32.18L27.87 32.35L27.76 32.23Q28.67 32.08 29.39 31.58L29.52 31.71L29.51 31.70Q30.85 30.68 30.66 28.59L30.61 28.54L30.60 28.52Q30.46 26.14 28.73 24.58L28.78 24.63L28.81 24.66Q27.08 23.10 24.61 23.10L24.60 23.09L24.53 22.79L24.55 22.81Q24.82 22.67 25.69 22.59L25.87 22.76L25.67 22.57Q27.66 22.53 29.03 21.30L29.07 21.34L28.97 21.24Q30.46 20.12 30.61 18.26L30.65 18.29L30.63 18.27Q30.61 17.84 30.61 17.50L30.70 17.58L30.61 17.49Q30.67 16.03 29.29 15.11L29.30 15.12L29.23 15.05Q28.02 14.25 26.42 14.37L26.39 14.34L26.38 14.33Q25.06 14.15 23.84 14.57L23.94 14.67L23.85 14.58Q22.55 15.25 22.24 16.40L22.11 16.26L22.21 16.37Q21.98 17.09 22.06 17.85L22.16 17.96L22.17 17.96Q21.02 17.62 18.97 16.89L18.89 16.82L18.91 16.83Q18.81 15.28 18.85 14.45L18.82 14.42L18.84 14.44Q18.83 12.80 19.90 12.11L20.08 12.29L19.99 12.20Q21.48 11.67 23.08 11.67L22.93 11.53L22.93 11.53Q26.17 11.57 29.33 11.84L29.29 11.79L29.34 11.85Q34.43 12.29 34.12 16.06L34.06 16.00L34.04 15.97Q34.00 17.50 33.51 19.06L33.59 19.14L33.55 19.10Q32.65 22.20 30.29 23.12L30.22 23.04L30.14 22.97Q32.90 23.63 33.51 26.98L33.50 26.97L33.50 26.97Q33.63 28.02 33.71 30.03L33.80 30.12L33.74 30.06Q33.91 34.53 29.30 34.99L29.30 34.99L29.40 35.09Q28.57 35.06 23.28 35.33ZM28.53 37.60L28.57 37.65L28.41 37.49Q29.16 37.66 32.01 37.74L31.88 37.61L32.06 37.79Q33.81 37.86 35.45 37.22L35.45 37.22L35.35 37.11Q36.46 36.10 36.27 34.35L36.41 34.49L36.29 34.36Q36.31 33.16 36.00 31.41L35.88 31.29L35.94 31.36Q35.18 26.82 33.24 25.19L33.21 25.16L33.10 24.86L33.06 24.78L32.98 24.69Q34.87 23.39 35.63 19.01L35.50 18.88L35.45 18.84Q35.57 18.46 35.69 17.51L35.78 17.61L35.65 17.47Q35.78 16.76 35.70 16.08L35.80 16.17L35.71 16.08Q35.63 14.48 34.33 13.79L34.34 13.80L34.17 13.71L34.22 13.76Q33.85 12.70 32.71 12.17L32.80 12.26L32.68 12.14Q31.11 11.41 25.97 11.11L26.08 11.21L25.99 11.12Q24.41 11.14 22.81 11.14L22.83 11.16L22.87 11.20Q21.14 11.07 19.62 11.72L19.76 11.86L19.73 11.83Q18.52 12.60 18.52 14.35L18.51 14.34L18.41 14.24Q18.40 13.81 18.67 17.16L18.78 17.28L18.69 17.19Q18.99 17.26 20.63 17.87L20.60 17.84L20.62 17.86Q20.76 18.53 20.72 19.02L20.54 18.84L20.73 19.03Q20.54 19.34 20.58 19.87L20.63 19.93L20.66 19.95Q22.51 20.39 24.53 20.51L24.57 20.55L24.39 20.37Q24.38 18.42 25.48 17.58L25.50 17.59L25.44 17.54Q26.27 16.89 28.29 16.66L28.41 16.78L28.39 16.76Q29.52 16.75 30.09 16.94L30.06 16.90L30.08 16.92Q30.15 17.07 30.19 17.19L30.05 17.05L30.20 17.39L30.27 17.92L30.23 17.88Q30.30 18.13 30.26 18.28L30.18 18.21L30.31 18.34Q30.19 20.01 28.67 21.19L28.59 21.10L28.57 21.09Q27.71 22.06 25.69 22.25L25.72 22.28L25.69 22.24Q25.04 22.47 24.17 22.47L24.11 22.42L24.00 22.30Q24.03 22.64 24.19 23.33L24.35 23.49L24.35 23.50Q26.11 23.50 27.56 24.23L27.50 24.16L27.36 24.14L25.79 24.32L25.76 24.29Q25.76 24.59 25.87 25.20L26.02 25.36L25.90 25.23Q28.07 25.19 29.78 26.53L29.72 26.46L29.85 26.59Q30.02 26.92 30.33 28.55L30.36 28.59L30.35 28.58Q30.47 31.44 27.54 31.85L27.69 32.01L27.61 31.92Q25.48 32.16 24.91 32.12L24.88 32.09L24.98 32.19Q24.46 32.02 23.93 31.94L23.99 32.00L23.91 31.47L24.12 31.10L24.16 30.73L24.16 30.38L24.18 30.40Q23.17 30.42 22.37 30.61L22.44 30.68L22.41 30.65Q22.35 30.40 22.35 30.21L22.43 30.29L22.42 30.28Q22.46 30.09 22.46 29.86L22.33 29.73L22.34 29.74Q22.44 29.39 22.59 28.67L22.57 28.64L22.66 28.73Q20.80 28.96 18.93 29.30L18.88 29.26L18.80 29.18Q18.85 29.72 18.74 30.84L18.80 30.91L18.66 30.76Q18.64 31.99 18.64 32.59L18.55 32.50L18.55 32.50Q18.70 34.63 20.07 35.39L20.08 35.40L20.01 35.33Q21.56 37.68 26.28 37.49L26.31 37.52L26.24 37.45Q27.06 37.51 28.59 37.66Z'/%3e%3cpath d='M13 4 C51 9%2c65 6%2c110 4' stroke='%237590df' fill='none'/%3e%3cpath fill='%23d24b4b' d='M57.55 34.48L57.61 34.54L57.53 34.46Q56.76 34.34 56.08 34.38L56.14 34.44L56.20 34.50Q55.53 34.63 54.85 34.63L54.68 34.47L54.66 34.45Q55.13 31.03 55.13 27.61L55.18 27.66L55.14 27.61Q53.29 27.63 52.37 27.63L52.57 27.82L52.48 27.73Q51.54 27.64 49.72 27.56L49.69 27.54L49.80 27.64Q49.90 27.44 49.71 24.97L49.65 24.91L49.57 24.82Q52.15 25.39 55.12 25.39L55.18 25.45L55.19 25.46Q54.81 20.93 54.39 18.34L54.48 18.43L54.56 18.51Q55.36 18.62 56.16 18.62L56.03 18.49L57.67 18.50L57.78 18.61Q57.44 22.76 57.44 25.35L57.58 25.49L57.45 25.36Q59.72 25.46 62.92 25.12L62.84 25.04L62.84 25.03Q62.75 26.40 62.75 27.61L62.81 27.68L62.69 27.56Q62.58 27.71 61.78 27.75L61.75 27.72L61.70 27.66Q60.68 27.63 60.07 27.67L60.01 27.62L60.07 27.68Q60.10 27.71 57.44 27.71L57.51 27.78L57.34 31.04L57.51 31.21Q57.46 32.79 57.57 34.50ZM63.36 24.64L63.33 24.62L63.27 24.55Q61.46 24.95 59.59 25.03L59.54 24.98L59.53 24.97Q59.78 21.82 60.19 19.96L60.18 19.94L60.22 19.98Q59.51 20.03 58.10 20.18L58.10 20.18L58.31 18.15L58.19 18.03Q55.69 18.15 54.01 18.04L54.01 18.04L54.02 18.05Q54.54 21.12 54.73 25.00L54.70 24.97L54.67 24.94Q52.99 24.97 49.30 24.36L49.20 24.27L49.30 24.37Q49.53 25.51 49.53 28.14L49.55 28.16L51.02 28.11L50.96 28.05Q51.07 28.88 50.92 30.29L50.86 30.23L54.76 29.90L54.85 29.99Q54.64 33.17 54.34 35.00L54.38 35.04L54.33 34.99Q55.05 34.95 56.45 34.83L56.56 34.93L56.49 34.86Q56.55 35.62 56.52 36.95L56.41 36.85L56.39 36.83Q56.88 36.78 60.50 36.93L60.59 37.02L60.50 36.94Q59.71 33.98 59.48 30.02L59.38 29.92L59.45 29.99Q62.82 30.12 64.91 30.50L64.93 30.52L64.79 30.38Q64.61 29.43 64.61 28.48L64.58 28.46L64.74 26.71L64.69 26.66Q64.46 26.66 63.93 26.70L63.98 26.75L63.08 26.65L63.05 26.62Q63.09 25.86 63.20 24.49Z'/%3e%3cpath d='M6 19 C52 21%2c78 16%2c107 21' stroke='%2383ebb7' fill='none'/%3e%3cpath d='M8 38 C57 34%2c69 37%2c109 30' stroke='%237baddf' fill='none'/%3e%3c/svg%3e" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|number|true|none||none| -|» msg|string|true|none||none| -|» text|string|false|none|验证码值|仅开发模式返回显示| -|» captchaEnabled|boolean|true|none|是否启用|none| -|» uuid|string|true|none|uuid|none| -|» img|string|true|none|base64图片|none| - -## GET 获取系统可暴露的配置信息 - -GET /sys-conf - -### 请求参数 - -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|Accept-Language|header|string| 是 |zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none|路由数组|none| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST 转存帮助文档 - -POST /help-doc - -> Body 请求参数 - -```json -{ - "uploadPath": "string", - "language": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|Authorization|header|string| 是 |授权令牌| -|Referer|header|string| 是 |使用指定声明的Referer| -|User-Agent|header|string| 是 |用户浏览器代理| -|Accept-Language|header|string| 是 |zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 |none| -|» uploadPath|body|string| 是 |none| -|» language|body|string| 是 |none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": "/static/helpDoc/zh_doc.pdf", - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 通用模块/文件操作 - -## POST 上传文件 - -POST /file/upload - -> Body 请求参数 - -```yaml -file: string -subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common', - 'download', 'chunk'] %}" - -``` - -### 请求参数 - -|名称|位置|类型|必选|说明| -|---|---|---|---|---| -|Authorization|header|string| 是 |授权令牌| -|Referer|header|string| 是 |使用指定声明的Referer| -|User-Agent|header|string| 是 |用户浏览器代理| -|Accept-Language|header|string| 是 |zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 |none| -|» file|body|string(binary)| 是 |上传文件对象| -|» subPath|body|string| 是 |子路径，可选范围 ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "url": "http://127.0.0.1:6275/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "fileName": "/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "newFileName": "o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "originalFileName": "o_1d2bofn8f19dh5s11okpje61mipg_画板1.png" - } -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，支持以下类型：bmp,gif,jpg,jpeg,png,doc,docx,xls,xlsx,ppt,pptx,html,htm,txt,rar,zip,gz,bz2,mp4,avi,rmvb,pdf" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 切片文件检查 - -POST /file/chunkCheck - -> Body 请求参数 - -```json -{ - "identifier": "string", - "fileName": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» identifier|body|string| 是 | 切片文件目录标识符|MD5(文件名+文件大小)| -|» fileName|body|string| 是 | 原始文件名称|检查格式是否允许上传| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[string]|true|none|已上传切片数据块的编号|none| - -## POST 切片文件上传 - -POST /file/chunkUpload - -```js -// 上传数据块 -const formData = new FormData(); -formData.append('file', chunk, 'xxx.pdf'); -formData.append('index', chunksIndex); -formData.append('identifier', fileIdentifier); -``` - -chunk是切片块的数据需要给上传文件的名称带后缀 - -> Body 请求参数 - -```yaml -file: string -index: "{% mock 'increment' %}" -identifier: "{% mock 'id' %}" - -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» file|body|string(binary)| 是 ||数据块Blob对象，需要给文件名称带后缀| -|» index|body|string| 是 ||数据块的编号| -|» identifier|body|string| 是 ||切片文件目录标识符| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "/upload/chunk/2023/06/identifier/index" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|206|[Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)|成功|Inline| - -### 返回数据结构 - -状态码 **206** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|string|true|none|上传资源地址|none| - -## POST 切片文件合并 - -POST /file/chunkMerge - -> Body 请求参数 - -```json -{ - "identifier": "string", - "fileName": "string", - "subPath": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» identifier|body|string| 是 | 切片文件目录标识符|MD5(文件名+文件大小)| -|» fileName|body|string| 是 | 原始文件名称|检查格式是否允许上传| -|» subPath|body|string| 是 | 子路径|可选范围 ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "url": "http://127.0.0.1:6275/upload/avatar/2023/06/gmircbr_48xqb8.png", - "fileName": "/upload/avatar/2023/06/gmircbr_48xqb8.png", - "newFileName": "gmircbr_48xqb8.png", - "originalFileName": "gmircbr.png" - } -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，支持以下类型：bmp,gif,jpg,jpeg,png,doc,docx,xls,xlsx,ppt,pptx,html,htm,txt,rar,zip,gz,bz2,mp4,avi,rmvb,pdf" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[string]|true|none|已上传切片数据块的编号|none| - -## GET 下载文件 - -GET /file/download/{filePath} - -filePath参数需要进行base64编码，base64("文件存放资源路径，URL相对地址") - -断点续传可以在请求头中加入下载数据块的区间，示例如单块5M大小 `Range: bytes=0-5242879` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|filePath|path|string| 是 ||base64("文件存放资源路径，URL相对地址")| -|Range|header|string| 否 ||进行断点续传数据块下载| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 文件数据 - -> 206 Response - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|文件数据|Inline| -|206|[Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)|断点续传数据块|Inline| - -### 返回数据结构 - -# 通用模块/通用请求 - -## POST 哈希加密 - -POST /common/hash - -> Body 请求参数 - -```json -{ - "type": "string", - "str": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» type|body|string| 是 | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| 是 | 加密字符串|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|string|true|none||none| - -## GET 多语言处理 - -GET /common/i18n - -> Body 请求参数 - -```json -{ - "type": "string", - "str": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Accept-Language|header|string| 否 ||en_US/zh_CN| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|body|body|object| 否 ||none| -|» type|body|string| 是 | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| 是 | 加密字符串|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|string|true|none||none| - -## POST 哈希加盐加密 - -POST /common/hmac - -> Body 请求参数 - -```json -{ - "type": "string", - "str": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» type|body|string| 是 | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| 是 | 加密字符串|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "6c44dbdf8d759c97dfd8c43a2974ba22" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|string|true|none||none| - -## POST 微信数据解密 - -POST /common/decryptWxData - -> Body 请求参数 - -```json -{ - "encryptedData": "string", - "key": "string", - "iv": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» encryptedData|body|string| 是 | 加密数据|none| -|» key|body|string| 是 | 键|none| -|» iv|body|string| 是 | 向量值|none| - -> 返回示例 - -> 文件数据 - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|文件数据|Inline| - -### 返回数据结构 - -# 通用模块/账号身份操作 - -## GET 登录用户信息 - -GET /getInfo - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "permissions": [ - "*:*:*" - ], - "roles": [ - "admin" - ], - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "maskAdmin", - "nickName": "管理员", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "管理员", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "status": "1" - } - } - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» permissions|[string]|true|none|权限|字符数组| -|»» roles|[string]|true|none|角色|字符数组| -|»» user|object|true|none|用户信息|none| -|»»» roles|[object]|true|none||none| -|»»»» roleId|string|false|none||none| -|»»»» roleName|string|false|none||none| -|»»»» roleKey|string|false|none||none| -|»»»» roleSort|integer|false|none||none| -|»»»» dataScope|string|false|none||none| -|»»»» status|string|false|none||none| -|»»» userId|string|true|none||none| -|»»» deptId|string|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 登录路由信息 - -GET /getRouters - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none|路由数组|none| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST 系统登录 - -POST /login - -> Body 请求参数 - -```json -{ - "username": "admin", - "password": "rootaa", - "code": "{{code-text}}", - "uuid": "{{code-uuid}}" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» username|body|string| 是 | 登录名|none| -|» password|body|string| 是 | 密码|none| -|» code|body|string| 是 | 验证码值|none| -|» uuid|body|string| 是 | 验证码唯一标识|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -```json -{ - "code": 500, - "msg": "验证码已失效" -} -``` - -```json -{ - "code": 500, - "msg": "验证码错误" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|false|none||none| -|»» access_token|string|true|none|授权令牌|none| - -## POST 系统登出 - -POST /logout - -对IP进行限流 - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 否 ||授权令牌，可有可无| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "退出成功" -} -``` - -```json -{ - "code": 500, - "msg": "访问过于频繁，请稍候再试" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none|固定值|none| -|» msg|string|true|none|固定值|none| - -# 通用模块/账号注册操作 - -## POST 系统注册 - -POST /register - -> Body 请求参数 - -```json -{ - "username": "string", - "password": "string", - "confirmPassword": "string", - "code": "string", - "uuid": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» username|body|string| 是 | 用户名|none| -|» password|body|string| 是 | 密码|none| -|» confirmPassword|body|string| 是 | 确认密码|none| -|» code|body|string| 是 | 验证码值|none| -|» uuid|body|string| 是 | 验证码唯一标识|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "当前系统没有开启注册功能！" -} -``` - -```json -{ - "code": 500, - "msg": "注册用户【xxxx】失败，注册账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "账号不能以数字开头，可包含大写小写字母，数字，且不少于5位" -} -``` - -```json -{ - "code": 500, - "msg": "密码至少包含大小写字母、数字、特殊符号，且不少于6位" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/缓存信息 - -## GET 缓存监控信息 - -GET /monitor/cache - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "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" - }, - "memory": { - "used_memory": "1664304", - "used_memory_human": "1.59M", - "used_memory_rss": "9228288", - "used_memory_rss_human": "8.80M", - "used_memory_peak": "1917352", - "used_memory_peak_human": "1.83M", - "used_memory_peak_perc": "86.80%", - "used_memory_overhead": "978099", - "used_memory_startup": "863272", - "used_memory_dataset": "686205", - "used_memory_dataset_perc": "85.67%", - "allocator_allocated": "1851152", - "allocator_active": "2396160", - "allocator_resident": "4734976", - "total_system_memory": "2079748096", - "total_system_memory_human": "1.94G", - "used_memory_lua": "59392", - "used_memory_vm_eval": "59392", - "used_memory_lua_human": "58.00K", - "used_memory_scripts_eval": "5608", - "number_of_cached_scripts": "3", - "number_of_functions": "0", - "number_of_libraries": "0", - "used_memory_vm_functions": "32768", - "used_memory_vm_total": "92160", - "used_memory_vm_total_human": "90.00K", - "used_memory_functions": "184", - "used_memory_scripts": "5792", - "used_memory_scripts_human": "5.66K", - "maxmemory": "0", - "maxmemory_human": "0B", - "maxmemory_policy": "noeviction", - "allocator_frag_ratio": "1.29", - "allocator_frag_bytes": "545008", - "allocator_rss_ratio": "1.98", - "allocator_rss_bytes": "2338816", - "rss_overhead_ratio": "1.95", - "rss_overhead_bytes": "4493312", - "mem_fragmentation_ratio": "5.55", - "mem_fragmentation_bytes": "7565808", - "mem_not_counted_for_evict": "3584", - "mem_replication_backlog": "0", - "mem_total_replication_buffers": "0", - "mem_clients_slaves": "0", - "mem_clients_normal": "102107", - "mem_cluster_links": "0", - "mem_aof_buffer": "3584", - "mem_allocator": "jemalloc-5.2.1", - "active_defrag_running": "0", - "lazyfree_pending_objects": "0", - "lazyfreed_objects": "0" - }, - "persistence": { - "loading": "0", - "async_loading": "0", - "current_cow_peak": "0", - "current_cow_size": "0", - "current_cow_size_age": "0", - "current_fork_perc": "0.00", - "current_save_keys_processed": "0", - "current_save_keys_total": "0", - "rdb_changes_since_last_save": "28", - "rdb_bgsave_in_progress": "0", - "rdb_last_save_time": "1683985267", - "rdb_last_bgsave_status": "ok", - "rdb_last_bgsave_time_sec": "0", - "rdb_current_bgsave_time_sec": "-1", - "rdb_saves": "18", - "rdb_last_cow_size": "901120", - "rdb_last_load_keys_expired": "0", - "rdb_last_load_keys_loaded": "0", - "aof_enabled": "1", - "aof_rewrite_in_progress": "0", - "aof_rewrite_scheduled": "0", - "aof_last_rewrite_time_sec": "-1", - "aof_current_rewrite_time_sec": "-1", - "aof_last_bgrewrite_status": "ok", - "aof_rewrites": "0", - "aof_rewrites_consecutive_failures": "0", - "aof_last_write_status": "ok", - "aof_last_cow_size": "0", - "module_fork_in_progress": "0", - "module_fork_last_cow_size": "0", - "aof_current_size": "52707266", - "aof_base_size": "88", - "aof_pending_rewrite": "0", - "aof_buffer_length": "0", - "aof_pending_bio_fsync": "0", - "aof_delayed_fsync": "0" - }, - "stats": { - "total_connections_received": "139", - "total_commands_processed": "215944", - "instantaneous_ops_per_sec": "5", - "total_net_input_bytes": "6096966", - "total_net_output_bytes": "546971", - "total_net_repl_input_bytes": "0", - "total_net_repl_output_bytes": "0", - "instantaneous_input_kbps": "0.60", - "instantaneous_output_kbps": "0.01", - "instantaneous_input_repl_kbps": "0.00", - "instantaneous_output_repl_kbps": "0.00", - "rejected_connections": "0", - "sync_full": "0", - "sync_partial_ok": "0", - "sync_partial_err": "0", - "expired_keys": "1270", - "expired_stale_perc": "0.00", - "expired_time_cap_reached_count": "0", - "expire_cycle_cpu_milliseconds": "712", - "evicted_keys": "0", - "evicted_clients": "0", - "total_eviction_exceeded_time": "0", - "current_eviction_exceeded_time": "0", - "keyspace_hits": "1580", - "keyspace_misses": "27951", - "pubsub_channels": "3", - "pubsub_patterns": "0", - "pubsubshard_channels": "0", - "latest_fork_usec": "275", - "total_forks": "18", - "migrate_cached_sockets": "0", - "slave_expires_tracked_keys": "0", - "active_defrag_hits": "0", - "active_defrag_misses": "0", - "active_defrag_key_hits": "0", - "active_defrag_key_misses": "0", - "total_active_defrag_time": "0", - "current_active_defrag_time": "0", - "tracking_total_keys": "0", - "tracking_total_items": "0", - "tracking_total_prefixes": "0", - "unexpected_error_replies": "0", - "total_error_replies": "0", - "dump_payload_sanitizations": "0", - "total_reads_processed": "29542", - "total_writes_processed": "29425", - "io_threaded_reads_processed": "0", - "io_threaded_writes_processed": "0", - "reply_buffer_shrinks": "135", - "reply_buffer_expands": "9" - }, - "replication": { - "role": "master", - "connected_slaves": "0", - "master_failover_state": "no-failover", - "master_replid": "08e7cd72f9ecda6c4fd3e1e8504571203bb61290", - "master_replid2": "0000000000000000000000000000000000000000", - "master_repl_offset": "0", - "second_repl_offset": "-1", - "repl_backlog_active": "0", - "repl_backlog_size": "1048576", - "repl_backlog_first_byte_offset": "0", - "repl_backlog_histlen": "0" - }, - "cpu": { - "used_cpu_sys": "21.297760", - "used_cpu_user": "30.032301", - "used_cpu_sys_children": "0.033118", - "used_cpu_user_children": "0.030797", - "used_cpu_sys_main_thread": "20.252124", - "used_cpu_user_main_thread": "30.825211" - }, - "modules": {}, - "errorstats": {}, - "cluster": { - "cluster_enabled": "0" - }, - "keyspace": { - "db0": "keys=19,expires=0,avg_ttl=0", - "db1": "keys=22,expires=3,avg_ttl=21492323" - } - }, - "dbSize": 22, - "commandStats": [ - { - "name": "brpoplpush", - "value": "12044" - }, - { - "name": "get", - "value": "545" - }, - { - "name": "incr", - "value": "144" - }, - { - "name": "smembers", - "value": "1207" - }, - { - "name": "scan", - "value": "13" - }, - { - "name": "subscribe", - "value": "36" - }, - { - "name": "del", - "value": "147" - }, - { - "name": "auth", - "value": "139" - }, - { - "name": "exists", - "value": "2145" - }, - { - "name": "lrange", - "value": "1207" - }, - { - "name": "type", - "value": "28" - }, - { - "name": "ttl", - "value": "189" - }, - { - "name": "quit", - "value": "51" - }, - { - "name": "keys", - "value": "22" - }, - { - "name": "evalsha", - "value": "14200" - }, - { - "name": "select", - "value": "139" - }, - { - "name": "expire", - "value": "44" - }, - { - "name": "info", - "value": "61" - }, - { - "name": "zrevrange", - "value": "36" - }, - { - "name": "config|get", - "value": "9" - }, - { - "name": "zrangebyscore", - "value": "12087" - }, - { - "name": "client|setname", - "value": "37" - }, - { - "name": "ping", - "value": "1765" - }, - { - "name": "zrange", - "value": "12087" - }, - { - "name": "set", - "value": "1420" - }, - { - "name": "dbsize", - "value": "2" - }, - { - "name": "eval", - "value": "83" - } - ] - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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|Redis版本|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|RDB是否成功|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|AOF是否开启|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|Key数量|none| -|»» commandStats|[object]|true|none|命令统计|none| -|»»» name|string|true|none||none| -|»»» value|string|true|none||none| - -## GET 缓存名称列表 - -GET /monitor/cache/getNames - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "cacheName": "login_tokens", - "cacheKey": "", - "cacheValue": "", - "remark": "用户信息" - }, - { - "cacheName": "sys_config", - "cacheKey": "", - "cacheValue": "", - "remark": "配置信息" - }, - { - "cacheName": "sys_dict", - "cacheKey": "", - "cacheValue": "", - "remark": "数据字典" - }, - { - "cacheName": "captcha_codes", - "cacheKey": "", - "cacheValue": "", - "remark": "验证码" - }, - { - "cacheName": "repeat_submit", - "cacheKey": "", - "cacheValue": "", - "remark": "防重提交" - }, - { - "cacheName": "rate_limit", - "cacheKey": "", - "cacheValue": "", - "remark": "限流处理" - }, - { - "cacheName": "pwd_err_cnt", - "cacheKey": "", - "cacheValue": "", - "remark": "密码错误次数" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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|备注|none| - -## GET 缓存名称下键名列表 - -GET /monitor/cache/getKeys/{cacheName} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|cacheName|path|string| 是 ||缓存名称列表中得到的缓存名称| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "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": "" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» cacheName|string|true|none|缓存名称|缓存名称列表中得到的缓存名称| -|»» cacheKey|string|true|none|缓存键名|none| -|»» cacheValue|string|true|none|缓存内容|空字符串| -|»» remark|string|true|none|备注|空字符串| - -## GET 缓存内容 - -GET /monitor/cache/getValue/{cacheName}/{cacheKey} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|cacheName|path|string| 是 ||键名列表中得到的缓存名称| -|cacheKey|path|string| 是 ||键名列表中得到的缓存键名| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "cacheName": "sys_config", - "cacheKey": "sys.account.captchaType", - "cacheValue": "math", - "remark": "" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» cacheName|string|true|none|缓存名称|键名列表中得到的缓存名称| -|»» cacheKey|string|true|none|缓存名称|键名列表中得到的缓存键名| -|»» cacheValue|string|true|none|缓存内容|none| -|»» remark|string|true|none|备注|空字符串| - -## DELETE 删除缓存键名 - -DELETE /monitor/cache/clearCacheKey/{cacheName}/{cacheKey} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|cacheName|path|string| 是 ||键名列表中得到的缓存名称| -|cacheKey|path|string| 是 ||键名列表中得到的缓存键名| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 删除缓存名称下键名列表 - -DELETE /monitor/cache/clearCacheName/{cacheName} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|cacheName|path|string| 是 ||缓存名称列表中得到的缓存名称| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 安全清理缓存名称 - -DELETE /monitor/cache/clearCacheSafe - -指定可清理的缓存键名 - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/调度任务日志信息 - -## POST 调度任务日志列表导出 - -POST /monitor/jobLog/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx -content-length: 17079 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0, - "beginTime": "string", - "endTime": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» jobName|body|string| 否 | 任务名称|none| -|» jobGroup|body|string| 否 | 任务组名|none| -|» status|body|string| 否 | 执行状态|none| -|» pageNum|body|number| 否 | 页数，默认1|none| -|» pageSize|body|number| 否 | 单页记录数，默认10|none| -|» beginTime|body|string| 否 | 操作开始时间|none| -|» endTime|body|string| 否 | 操作结束时间|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 调度任务日志列表 - -GET /monitor/jobLog/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobName|query|string| 否 ||任务名称| -|jobGroup|query|string| 否 ||任务组名| -|status|query|string| 否 ||执行状态| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "jobLogId": "4", - "jobName": "2-20个字符", - "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个字符", - "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个字符", - "jobGroup": "DEFAULT", - "invokeTarget": "test", - "targetParams": "{\"a\":1,\"b\":1}", - "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}", - "status": "1", - "createTime": "1684056090490" - }, - { - "jobLogId": "1", - "jobName": "异常执行", - "jobGroup": "SYSTEM", - "invokeTarget": "bar", - "targetParams": "字符串参数", - "jobMsg": "{\"name\":\"Error\",\"message\":\"程序中途执行错误\"}", - "status": "0", - "createTime": "1683901320750" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» jobLogId|string|true|none|日志ID|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|none| -|»» invokeTarget|string|true|none|任务目标|none| -|»» targetParams|string|true|none|任务参数|none| -|»» jobMsg|string|true|none|日志记录|none| -|»» status|string|true|none|状态|none| -|»» createTime|string|true|none|记录时间|none| - -## GET 调度任务日志信息 - -GET /monitor/jobLog/{jobLogId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobLogId|path|string| 是 ||日志ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "jobLogId": "3", - "jobName": "2-20个字符", - "jobGroup": "DEFAULT", - "invokeTarget": "test", - "targetParams": "{\"a\":1,\"b\":1}", - "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}", - "status": "1", - "createTime": "1684056199482" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» jobLogId|string|true|none|日志ID|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|none| -|»» invokeTarget|string|true|none|任务目标|none| -|»» targetParams|string|true|none|任务参数|none| -|»» jobMsg|string|true|none|日志记录|none| -|»» status|string|true|none|状态|none| -|»» createTime|string|true|none|记录时间|none| - -## DELETE 调度任务日志删除 - -DELETE /monitor/jobLog/{jobLogIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobLogIds|path|string| 是 ||日志ID，多个可用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 调度任务日志清空 - -DELETE /monitor/jobLog/clean - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/调度任务信息 - -## POST 调度任务列表导出 - -POST /monitor/job/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=job_export_6_1684058991890.xlsx -content-length: 19346 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» jobName|body|string| 否 | 任务名称|none| -|» jobGroup|body|string| 否 | 任务组名|none| -|» status|body|string| 否 | 执行状态|none| -|» pageNum|body|number| 否 | 页数，默认1|none| -|» pageSize|body|number| 否 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 调度任务列表 - -GET /monitor/job/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobName|query|string| 否 ||任务名称| -|jobGroup|query|string| 否 ||任务组名| -|status|query|string| 否 ||任务状态| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 3, - "rows": [ - { - "jobId": "1", - "jobName": "触发执行", - "jobGroup": "SYSTEM", - "invokeTarget": "test", - "targetParams": "字符串参数", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527348", - "remark": "" - }, - { - "jobId": "2", - "jobName": "缓慢执行", - "jobGroup": "SYSTEM", - "invokeTarget": "foo", - "targetParams": "字符串参数", - "cronExpression": "0/15 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527355", - "remark": "" - }, - { - "jobId": "3", - "jobName": "异常执行", - "jobGroup": "SYSTEM", - "invokeTarget": "bar", - "targetParams": "字符串参数", - "cronExpression": "0/20 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527364", - "remark": "" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» jobId|string|true|none|任务id|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|同组内不可同任务名| -|»» invokeTarget|string|true|none|调用目标|需要代码中通过 @Processor('xxx') 注册任务目标| -|»» targetParams|string|true|none|传入参数|标准json格式字符串| -|»» cronExpression|string|true|none|cron表达式|6位，最后?号不使用| -|»» misfirePolicy|string|true|none|执行策略|计划执行错误策略（1立即执行 2执行一次 3放弃执行）| -|»» concurrent|string|true|none|是否并发|是否并发执行（0禁止 1允许）| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string|true|none|备注|none| - -## GET 调度任务信息 - -GET /monitor/job/{jobId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobId|path|string| 是 ||任务ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "jobId": "1", - "jobName": "触发执行", - "jobGroup": "SYSTEM", - "invokeTarget": "test", - "targetParams": "字符串参数", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527348", - "remark": "" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» jobId|string|true|none|任务id|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|同组内不可同任务名| -|»» invokeTarget|string|true|none|调用目标|需要代码中通过 @Processor('xxx') 注册任务目标| -|»» targetParams|string|true|none|传入参数|标准json格式字符串| -|»» cronExpression|string|true|none|cron表达式|6位，最后?号不使用| -|»» misfirePolicy|string|true|none|执行策略|计划执行错误策略（1立即执行 2执行一次 3放弃执行）| -|»» concurrent|string|true|none|是否并发|是否并发执行（0禁止 1允许）| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string|true|none|备注|none| - -## POST 调度任务新增 - -POST /monitor/job - -> Body 请求参数 - -```json -{ - "jobName": "2-20个字符", - "invokeTarget": "test1", - "cronExpression": "0/22 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "jobGroup": "DEFAULT", - "status": "ullamco minim Ut", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "asdf" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» jobName|body|string| 是 | 任务名称|none| -|» jobGroup|body|string| 是 | 任务组名|none| -|» invokeTarget|body|string| 是 | 调用目标字符串|需要代码中通过 @Processor('xxx') 注册任务目标| -|» targetParams|body|string| 是 | 调用目标传入参数|标准json格式字符串| -|» cronExpression|body|string| 是 | cron执行表达式|6位，最后?号不使用| -|» misfirePolicy|body|string| 是 | 计划执行错误策略|1立即执行 2执行一次 3放弃执行| -|» concurrent|body|string| 是 | 是否并发执行|0禁止 1允许| -|» status|body|string| 是 | 任务状态|0正常 1暂停| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务新增【xxx】失败，同任务组内有相同任务名称" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务新增【xxxx】失败，Cron表达式不正确" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 调度任务修改 - -PUT /monitor/job - -> Body 请求参数 - -```json -{ - "jobName": "大但任", - "invokeTarget": "test", - "cronExpression": "0/40 * * * * ?", - "misfirePolicy": "3", - "concurrent": "1", - "jobGroup": "SYSTEM", - "status": "0", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "据连思过维存斗维动南子听。", - "jobId": "2" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» jobId|body|string| 是 | 任务ID|none| -|» jobName|body|string| 是 | 任务名称|none| -|» jobGroup|body|string| 是 | 任务组名|none| -|» invokeTarget|body|string| 是 | 调用目标字符串|需要代码中通过 @Processor('xxx') 注册任务目标| -|» targetParams|body|string| 是 | 调用目标传入参数|标准json格式字符串| -|» cronExpression|body|string| 是 | cron执行表达式|6位，最后?号不使用| -|» misfirePolicy|body|string| 是 | 计划执行错误策略|1立即执行 2执行一次 3放弃执行| -|» concurrent|body|string| 是 | 是否并发执行|0禁止 1允许| -|» status|body|string| 是 | 任务状态|0正常 1暂停| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务修改【xxxx】失败，Cron表达式不正确" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 调度任务删除 - -DELETE /monitor/job/{jobIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobIds|path|string| 是 ||任务ID，多个可用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 调度任务修改状态 - -PUT /monitor/job/changeStatus - -> Body 请求参数 - -```json -{ - "jobId": "22", - "status": "0" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» jobId|body|string| 是 | 任务ID|none| -|» status|body|string| 是 | 变更的状态|0正常 1暂停| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 调度任务立即执行一次 - -PUT /monitor/job/run/{jobId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|jobId|path|string| 是 ||任务ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 调度任务重置刷新队列 - -PUT /monitor/job/resetQueueJob - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/操作日志信息 - -## GET 操作日志列表 - -GET /monitor/operlog/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|title|query|string| 否 ||操作模块名称| -|operName|query|string| 否 ||操作人员名称| -|businessType|query|string| 否 ||操作类型| -|status|query|string| 否 ||操作状态| -|beginTime|query|string| 否 ||操作开始时间| -|endTime|query|string| 否 ||操作结束时间| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 125, - "rows": [ - { - "operId": "224", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/17", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071705357" - }, - { - "operId": "223", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071683254" - }, - { - "operId": "222", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071682157" - }, - { - "operId": "221", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/201", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":500,\"msg\":\"失败\"}", - "status": "0", - "operTime": "1684071669833" - }, - { - "operId": "220", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/11,12,13", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071570065" - }, - { - "operId": "219", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/7,58,96,8,45", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":500,\"msg\":\"失败\"}", - "status": "0", - "operTime": "1684071537536" - }, - { - "operId": "218", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071459926" - }, - { - "operId": "217", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071429311" - }, - { - "operId": "216", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071426784" - }, - { - "operId": "215", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071419755" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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|IP地址|none| -|»» operLocation|string|true|none|IP地区|none| -|»» operParam|string|true|none|请求参数|none| -|»» operMsg|string|true|none|操作信息|none| -|»» status|string|true|none|状态|none| -|»» operTime|string|true|none|时间|none| -|»» costTime|string|true|none|消耗时间（毫秒）|none| - -## POST 操作日志列表导出 - -POST /monitor/operlog/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx -content-length: 36500 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "title": "string", - "operName": "string", - "businessType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» title|body|string| 否 | 操作模块名称|none| -|» operName|body|string| 否 | 操作人员名称|none| -|» businessType|body|string| 否 | 操作类型|none| -|» status|body|string| 否 | 操作状态|none| -|» beginTime|body|string| 否 | 操作开始时间|none| -|» endTime|body|string| 否 | 操作结束时间|none| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 操作日志清空 - -DELETE /monitor/operlog/clean - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 操作日志删除 - -DELETE /monitor/operlog/{operIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|operIds|path|string| 是 ||操作日志ID，多个可用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/登录访问信息 - -## GET 登录访问列表 - -GET /monitor/logininfor/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|ipaddr|query|string| 否 ||登录地址ip| -|userName|query|string| 否 ||用户名称| -|status|query|string| 否 ||登录状态 0失败 1成功| -|beginTime|query|string| 否 ||登录开始时间| -|endTime|query|string| 否 ||登录结束时间| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 130, - "rows": [ - { - "infoId": "119", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683370928996" - }, - { - "infoId": "118", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683370924042" - }, - { - "infoId": "117", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683370402328" - }, - { - "infoId": "116", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "注册成功", - "loginTime": "1683370382877" - }, - { - "infoId": "115", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683370352406" - }, - { - "infoId": "114", - "userName": "maskAdmin", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683364801882" - }, - { - "infoId": "113", - "userName": "maskUser", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683364794403" - }, - { - "infoId": "112", - "userName": "maskUser", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683364764244" - }, - { - "infoId": "111", - "userName": "wangdf", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "注册成功", - "loginTime": "1683364746502" - }, - { - "infoId": "110", - "userName": "maskAdmin", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683364727385" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» infoId|string|true|none|登录记录ID|none| -|»» userName|string|true|none|登录用户名称|none| -|»» ipaddr|string|true|none|IP地址|none| -|»» loginLocation|string|true|none|IP地区|none| -|»» browser|string|true|none|浏览器|none| -|»» os|string|true|none|操作系统|none| -|»» status|string|true|none|状态|0失败 1成功| -|»» msg|string|true|none|操作行为|none| -|»» loginTime|string|true|none|登录时间|none| - -## POST 登录访问列表导出 - -POST /monitor/logininfor/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx -content-length: 24305 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "ipaddr": "string", - "userName": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» ipaddr|body|string| 否 | 登录地址ip|none| -|» userName|body|string| 否 | 用户名称|none| -|» status|body|string| 否 | 登录状态|0失败 1成功| -|» beginTime|body|string| 否 | 登录开始时间|none| -|» endTime|body|string| 否 | 登录结束时间|none| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 登录访问清空 - -DELETE /monitor/logininfor/clean - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 登录访问账户解锁 - -PUT /monitor/logininfor/unlock/{userName} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|userName|path|string| 是 ||登录用户名| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 登录访问删除 - -DELETE /monitor/logininfor/{infoIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|infoIds|path|string| 是 ||访问日志ID，多个可用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/在线用户信息 - -## GET 在线用户列表 - -GET /monitor/online/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|userName|query|string| 否 ||用户名称（登录账号）| -|ipaddr|query|string| 否 ||登录主机| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "rows": [ - { - "tokenId": "vikufxmx625271bnddbe9t79p4pik5kv", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "未知 未知", - "os": "未知 未知", - "loginTime": 1684046645462, - "deptName": "研发部门" - }, - { - "tokenId": "lpatqefeohnxsnjpp28radugp0bovwt1", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "loginTime": 1684046560517, - "deptName": "研发部门" - } - ], - "total": 2 -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 强退用户 - -DELETE /monitor/online/{tokenId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|tokenId|path|string| 是 ||授权标识| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 否 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 服务器模块/服务器监控信息 - -## GET 服务器服务信息 - -GET /monitor/system-info - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "以太网 2": "IPv4 1.251.212.178", - "以太网": "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\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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| -|»»» 以太网 2|string|false|none||none| -|»»» 以太网|string|false|none||none| -|»»» VirtualBox Host-Only Network|string|false|none||none| -|»»» Loopback Pseudo-Interface 1|string|false|none||none| -|»» time|object|true|none|时间|none| -|»»» current|string|true|none||none| -|»»» uptime|string|true|none||none| -|»»» timezone|string|true|none||none| -|»»» timezoneName|string|true|none||none| -|»» system|object|true|none|系统|none| -|»»» platform|string|true|none||none| -|»»» node|string|true|none||none| -|»»» v8|string|true|none||none| -|»»» processId|integer|true|none||none| -|»»» arch|string|true|none||none| -|»»» uname|string|true|none||none| -|»»» release|string|true|none||none| -|»»» hostname|string|true|none||none| -|»»» homeDir|string|true|none||none| -|»»» cmd|string|true|none||none| -|»»» execCommand|string|true|none||none| -|»» disk|[object]|true|none|磁盘|none| -|»»» size|string|true|none||none| -|»»» used|string|true|none||none| -|»»» avail|string|true|none||none| -|»»» pcent|string|true|none||none| -|»»» target|string|true|none||none| - -## GET 资源监控信息加载 - -GET /monitor/load - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|type|query|string| 是 ||数据类型all/cpu/memory/io/network| -|startTime|query|number| 是 ||开始时间-时间戳毫秒| -|endTime|query|number| 是 ||结束时间-时间戳毫秒| -|neType|query|string| 否 ||网元类型| -|neId|query|string| 否 ||网元ID| -|name|query|string| 否 ||名称，networ和iok时有效| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "以太网 2": "IPv4 1.251.212.178", - "以太网": "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\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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| -|»»» 以太网 2|string|false|none||none| -|»»» 以太网|string|false|none||none| -|»»» VirtualBox Host-Only Network|string|false|none||none| -|»»» Loopback Pseudo-Interface 1|string|false|none||none| -|»» time|object|true|none|时间|none| -|»»» current|string|true|none||none| -|»»» uptime|string|true|none||none| -|»»» timezone|string|true|none||none| -|»»» timezoneName|string|true|none||none| -|»» system|object|true|none|系统|none| -|»»» platform|string|true|none||none| -|»»» node|string|true|none||none| -|»»» v8|string|true|none||none| -|»»» processId|integer|true|none||none| -|»»» arch|string|true|none||none| -|»»» uname|string|true|none||none| -|»»» release|string|true|none||none| -|»»» hostname|string|true|none||none| -|»»» homeDir|string|true|none||none| -|»»» cmd|string|true|none||none| -|»»» execCommand|string|true|none||none| -|»» disk|[object]|true|none|磁盘|none| -|»»» size|string|true|none||none| -|»»» used|string|true|none||none| -|»»» avail|string|true|none||none| -|»»» pcent|string|true|none||none| -|»»» target|string|true|none||none| - -# 系统模块/参数配置信息 - -## GET 参数配置列表 - -GET /system/config/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|configName|query|string| 否 ||参数名称| -|configKey|query|string| 否 ||参数键名| -|configType|query|string| 否 ||系统内置-是Y 否N| -|beginTime|query|string| 否 ||创建时间-开始| -|endTime|query|string| 否 ||创建时间-结束| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "configId": 1, - "configName": "用户管理-账号初始密码", - "configKey": "sys.user.initPassword", - "configValue": "123456", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527266", - "updateBy": "", - "updateTime": "0", - "remark": "导入用户初始化密码 123456" - }, - { - "configId": 2, - "configName": "账号自助-验证码开关", - "configKey": "sys.account.captchaEnabled", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527271", - "updateBy": "", - "updateTime": "0", - "remark": "是否开启验证码功能（true开启，false关闭）" - }, - { - "configId": 3, - "configName": "账号自助-验证码类型", - "configKey": "sys.account.captchaType", - "configValue": "math", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527277", - "updateBy": "", - "updateTime": "0", - "remark": "使用验证码类型（math数值计算，char字符验证）" - }, - { - "configId": 4, - "configName": "账号自助-是否开启用户注册功能", - "configKey": "sys.account.registerUser", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527280", - "updateBy": "maskAdmin", - "updateTime": "1683291796123", - "remark": "是否开启注册用户功能（true开启，false关闭）" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» configId|integer|true|none|配置ID|none| -|»» configName|string|true|none|配置名称|none| -|»» configKey|string|true|none|参数键名|none| -|»» configValue|string|true|none|配置值|none| -|»» configType|string|true|none|系统内置|Y是 N否| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 参数配置列表导出 - -POST /system/config/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=config_export_10_1684131509100.xlsx -content-length: 18337 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "configName": "string", - "configKey": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» configName|body|string| 否 | 参数名称|none| -|» configKey|body|string| 否 | 参数键名|none| -|» beginTime|body|string| 否 | 创建开始时间|none| -|» endTime|body|string| 否 | 创建结束时间|none| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 根据参数键名取值 - -GET /system/config/configKey/{configKey} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|configKey|path|string| 是 ||参数键名| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "true" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|string|true|none|配置值|none| - -## GET 参数配置信息 - -GET /system/config/{configId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|configId|path|string| 是 ||配置ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "configId": 4, - "configName": "账号自助-是否开启用户注册功能", - "configKey": "sys.account.registerUser", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527280", - "updateBy": "maskAdmin", - "updateTime": "1683291796123", - "remark": "是否开启注册用户功能（true开启，false关闭）" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» configId|integer|true|none|配置ID|none| -|»» configName|string|true|none|配置名称|none| -|»» configKey|string|true|none|参数键名|none| -|»» configValue|string|true|none|配置值|none| -|»» configType|string|true|none|系统内置|Y是 N否| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 参数配置新增 - -POST /system/config - -> Body 请求参数 - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» configName|body|string| 是 | 配置名称|none| -|» configKey|body|string| 是 | 参数键名|none| -|» configValue|body|string| 是 | 配置值|none| -|» configType|body|string| 是 | 系统内置|Y是 N否| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "参数配置新增【xxxx】失败，参数键名已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 参数配置修改 - -PUT /system/config - -> Body 请求参数 - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string", - "configId": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» configName|body|string| 是 | 配置名称|none| -|» configKey|body|string| 是 | 参数键名|none| -|» configValue|body|string| 是 | 配置值|none| -|» configType|body|string| 是 | 系统内置|Y是 N否| -|» remark|body|string| 是 | 备注|none| -|» configId|body|integer| 是 | 配置ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问参数配置数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 根据参数键名改值 - -PUT /system/config/changeValue - -> Body 请求参数 - -```json -{ - "key": "sys.logo.filePathIcon", - "value": "核心网" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» key|body|string| 是 ||none| -|» value|body|string| 是 ||none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "参数配置新增【xxxx】失败，参数键名已存在" -} -``` - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "变更状态与旧值相等！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 参数配置删除 - -DELETE /system/config/{configIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|configIds|path|string| 是 ||配置ID，多个用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "内置参数 xxx 不能删除" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 参数缓存刷新 - -PUT /system/config/refreshCache - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 系统模块/部门信息 - -## GET 部门列表 - -GET /system/dept/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|status|query|string| 否 ||状态（0正常 1停用）| -|deptName|query|string| 否 ||部门名称| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "MASK科技", - "orderNum": 0, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526241" - }, - { - "deptId": "101", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广西总公司", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526245" - }, - { - "deptId": "102", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广东分公司", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526248" - }, - { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526251" - }, - { - "deptId": "104", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "市场部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526254" - }, - { - "deptId": "105", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "测试部门", - "orderNum": 3, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526257" - }, - { - "deptId": "106", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "财务部门", - "orderNum": 4, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526261" - }, - { - "deptId": "107", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "运维部门", - "orderNum": 5, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526264" - }, - { - "deptId": "108", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "市场部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526268" - }, - { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526271" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» deptId|string|true|none|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| - -## GET 部门列表（排除节点） - -GET /system/dept/list/exclude/{deptId} - -进行更新操作时，可选的上级应排除当前部门下的所有节点 - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|deptId|path|string| 是 ||部门编号| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "MASK科技", - "orderNum": 0, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526241" - }, - { - "deptId": "102", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广东分公司", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526248" - }, - { - "deptId": "108", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "市场部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526268" - }, - { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526271" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» deptId|string|true|none|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| - -## GET 部门树结构列表 - -GET /system/dept/treeSelect - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|status|query|string| 否 ||状态（0正常 1停用）| -|deptName|query|string| 否 ||部门名称| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "id": "100", - "label": "MASK科技", - "children": [ - { - "id": "101", - "label": "广西总公司", - "children": [ - { - "id": "103", - "label": "研发部门", - "children": [] - }, - { - "id": "104", - "label": "市场部门", - "children": [] - }, - { - "id": "105", - "label": "测试部门", - "children": [] - }, - { - "id": "106", - "label": "财务部门", - "children": [] - }, - { - "id": "107", - "label": "运维部门", - "children": [] - } - ] - }, - { - "id": "102", - "label": "广东分公司", - "children": [ - { - "id": "108", - "label": "市场部门", - "children": [] - }, - { - "id": "109", - "label": "财务部门", - "children": [] - } - ] - } - ] - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 部门树结构列表（指定角色） - -GET /system/dept/roleDeptTreeSelect/{roleId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|roleId|path|string| 是 ||角色ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "depts": [ - { - "id": "100", - "label": "MASK科技", - "children": [ - { - "id": "101", - "label": "广西总公司", - "children": [ - { - "id": "103", - "label": "研发部门", - "children": [] - }, - { - "id": "104", - "label": "市场部门", - "children": [] - }, - { - "id": "105", - "label": "测试部门", - "children": [] - }, - { - "id": "106", - "label": "财务部门", - "children": [] - }, - { - "id": "107", - "label": "运维部门", - "children": [] - } - ] - }, - { - "id": "102", - "label": "广东分公司", - "children": [ - { - "id": "108", - "label": "市场部门", - "children": [] - }, - { - "id": "109", - "label": "财务部门", - "children": [] - } - ] - } - ] - } - ], - "checkedKeys": [] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» depts|[object]|true|none|部门节点|none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -## POST 部门新增 - -POST /system/dept - -> Body 请求参数 - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» orderNum|body|integer| 是 | 显示顺序|none| -|» deptName|body|string| 是 | 部门名称|none| -|» leader|body|string| 是 | 负责人|none| -|» phone|body|string| 是 | 联系电话|none| -|» email|body|string| 是 | 邮箱|none| -|» status|body|string| 是 | 部门状态|0正常 1停用| -|» parentId|body|string| 是 | 父部门ID|0为根节点| -|» parentName|body|string| 否 | 父部门名称|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "部门新增【xxx】失败，部门名称已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 部门修改 - -PUT /system/dept - -> Body 请求参数 - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string", - "deptId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» orderNum|body|integer| 是 | 显示顺序|none| -|» deptName|body|string| 是 | 部门名称|none| -|» leader|body|string| 是 | 负责人|none| -|» phone|body|string| 是 | 联系电话|none| -|» email|body|string| 是 | 邮箱|none| -|» status|body|string| 是 | 部门状态|0正常 1停用| -|» parentId|body|string| 是 | 父部门ID|none| -|» parentName|body|string| 否 | 父部门名称|none| -|» deptId|body|string| 是 | 部门ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问部门数据" -} -``` - -```json -{ - "code": 500, - "msg": "部门修改【拉高济查】失败，上级部门不能是自己" -} -``` - -```json -{ - "code": 500, - "msg": "该部门包含未停用的子部门！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 部门删除 - -DELETE /system/dept/{deptId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|deptId|path|string| 是 ||部门ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问部门数据" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 部门信息 - -GET /system/dept/{deptId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|deptId|path|string| 是 ||部门编号| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "parentName": "广东分公司" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» deptId|string|true|none|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» parentName|string|true|none|父部门名称|none| - -# 系统模块/字典数据信息 - -## POST 字典数据列表导出 - -POST /system/dict/data/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=dict_data_export_10_1684245668586.xlsx -content-length: 18236 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "dictLabel": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dictLabel|body|string| 否 | 数据标签|none| -|» dictType|body|string| 否 | 字典类型|none| -|» status|body|string| 否 | 状态|0正常 1停用| -|» beginTime|body|string| 否 | 创建开始时间|none| -|» endTime|body|string| 否 | 创建结束时间|none| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 字典数据列表 - -GET /system/dict/data/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictType|query|string| 否 ||字典类型| -|dictLabel|query|string| 否 ||数据标签| -|status|query|string| 否 ||状态（0正常 1停用）| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 3, - "rows": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "未知", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527109", - "remark": "性别男" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "男", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527118", - "remark": "性别女" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "女", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527126", - "remark": "性别未知" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» dictCode|string|true|none|编码ID|none| -|»» dictSort|integer|true|none|排序|none| -|»» dictLabel|string|true|none|标签名称|none| -|»» dictValue|string|true|none|标签值|none| -|»» dictType|string|true|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|true|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|true|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典数据详情 - -GET /system/dict/data/{dictCode} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictCode|path|string| 是 ||编码ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "dictCode": "15", - "dictSort": 2, - "dictLabel": "公告", - "dictValue": "2", - "dictType": "sys_notice_type", - "tagClass": "", - "tagType": "processing", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527183", - "remark": "公告" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» dictCode|string|true|none|编码ID|none| -|»» dictSort|integer|true|none|排序|none| -|»» dictLabel|string|true|none|标签名称|none| -|»» dictValue|string|true|none|标签值|none| -|»» dictType|string|true|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|true|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|true|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典数据列表（指定字典类型） - -GET /system/dict/data/type/{dictType} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictType|path|string| 是 ||字典类型，从字典类型列表中获取| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "未知", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527109", - "remark": "性别男" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "男", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527118", - "remark": "性别女" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "女", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527126", - "remark": "性别未知" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» dictCode|string|false|none|编码ID|none| -|»» dictSort|integer|false|none|排序|none| -|»» dictLabel|string|false|none|标签名称|none| -|»» dictValue|string|false|none|标签值|none| -|»» dictType|string|false|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|false|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|false|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|false|none|状态|0停用 1正常| -|»» createBy|string|false|none||none| -|»» createTime|string|false|none||none| -|»» remark|string|false|none|备注|none| - -## POST 字典数据新增 - -POST /system/dict/data - -> Body 请求参数 - -```json -{ - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dictType|body|string| 是 | 字典类型|从字典类型列表中获取| -|» dictLabel|body|string| 是 | 标签名称|none| -|» dictValue|body|string| 是 | 标签值|none| -|» dictSort|body|integer| 是 | 排序|none| -|» tagClass|body|string| 是 | 样式属性（样式扩展）|预设的class样式| -|» tagType|body|string| 是 | 标签类型（预设颜色）|预设数据固定项| -|» status|body|string| 是 | 状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "数据新增【xxxx】失败，该字典类型下标签名已存在" -} -``` - -```json -{ - "code": 500, - "msg": "数据新增【x】失败，该字典类型下标签值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 字典数据修改 - -PUT /system/dict/data - -> Body 请求参数 - -```json -{ - "dictCode": "string", - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dictCode|body|string| 是 | 编码ID|none| -|» dictType|body|string| 是 | 字典类型|从字典类型列表中获取| -|» dictLabel|body|string| 是 | 标签名称|none| -|» dictValue|body|string| 是 | 标签值|none| -|» dictSort|body|integer| 是 | 排序|none| -|» tagClass|body|string| 是 | 样式属性（样式扩展）|预设的class样式| -|» tagType|body|string| 是 | 标签类型（预设颜色）|预设数据固定项| -|» status|body|string| 是 | 状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典编码数据！" -} -``` - -```json -{ - "code": 500, - "msg": "数据修改【x】失败，该字典类型下标签值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "数据修改【xxxx】失败，该字典类型下标签名已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 字典数据删除 - -DELETE /system/dict/data/{dictCodes} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictCodes|path|string| 是 ||字典编码ID，多个用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典编码数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 系统模块/字典类型信息 - -## GET 字典类型列表 - -GET /system/dict/type/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictName|query|string| 否 ||名称| -|dictType|query|string| 否 ||类型| -|status|query|string| 否 ||状态（0正常 1停用）| -|beginTime|query|string| 否 ||创建时间-开始| -|endTime|query|string| 否 ||创建时间-结束| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 10, - "rows": [ - { - "dictId": "1", - "dictName": "用户性别", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526985", - "remark": "用户性别列表" - }, - { - "dictId": "2", - "dictName": "菜单状态", - "dictType": "sys_show_hide", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526992", - "remark": "菜单状态列表" - }, - { - "dictId": "3", - "dictName": "系统开关", - "dictType": "sys_normal_disable", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526999", - "remark": "系统开关列表" - }, - { - "dictId": "4", - "dictName": "任务状态", - "dictType": "sys_job_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527005", - "remark": "任务状态列表" - }, - { - "dictId": "5", - "dictName": "任务分组", - "dictType": "sys_job_group", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527010", - "remark": "任务分组列表" - }, - { - "dictId": "6", - "dictName": "系统是否", - "dictType": "sys_yes_no", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527016", - "remark": "系统是否列表" - }, - { - "dictId": "7", - "dictName": "通知类型", - "dictType": "sys_notice_type", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527023", - "remark": "通知类型列表" - }, - { - "dictId": "8", - "dictName": "通知状态", - "dictType": "sys_notice_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527029", - "remark": "通知状态列表" - }, - { - "dictId": "9", - "dictName": "操作类型", - "dictType": "sys_oper_type", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527035", - "remark": "操作类型列表" - }, - { - "dictId": "10", - "dictName": "系统状态", - "dictType": "sys_common_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527042", - "remark": "登录状态列表" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» dictId|string|true|none|字典ID|none| -|»» dictName|string|true|none|名称|none| -|»» dictType|string|true|none|类型|none| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典类型详细 - -GET /system/dict/type/{dictId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictId|path|string| 是 ||字典ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "dictId": "1", - "dictName": "用户性别", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526985", - "remark": "用户性别列表" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» dictId|string|true|none|字典ID|none| -|»» dictName|string|true|none|名称|none| -|»» dictType|string|true|none|类型|none| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 字典类型列表导出 - -POST /system/dict/type/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=dict_type_export_12_1684240671183.xlsx -content-length: 18246 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dictName|body|string| 否 | 名称|none| -|» dictType|body|string| 否 | 类型|none| -|» status|body|string| 否 | 状态|0正常 1停用| -|» beginTime|body|string| 否 | 创建开始时间|none| -|» endTime|body|string| 否 | 创建结束时间|none| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 字典类型新增 - -POST /system/dict/type - -> Body 请求参数 - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dictName|body|string| 是 | 名称|none| -|» dictType|body|string| 是 | 类型|none| -|» status|body|string| 是 | 状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "字典新增【xxx】失败，字典名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "字典新增【xxxx】失败，字典类型已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 字典类型修改 - -PUT /system/dict/type - -> Body 请求参数 - -```json -{ - "dictName": "string", - "dictType": "string", - "remark": "string", - "status": "string", - "dictId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dictName|body|string| 是 | 名称|none| -|» dictType|body|string| 是 | 类型|none| -|» remark|body|string| 是 | 备注|none| -|» status|body|string| 是 | 状态|0停用 1正常| -|» dictId|body|string| 否 | 字典ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "字典修改【xxxx】失败，字典名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "字典修改【xxxx】失败，字典类型已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 字典类型删除 - -DELETE /system/dict/type/{dictIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|dictIds|path|string| 是 ||字典ID，多个用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 字典类型选择框列表 - -GET /system/dict/type/getDictOptionselect - -在字典数据中进行下拉项选择 - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "label": "用户性别", - "value": "sys_user_sex" - }, - { - "label": "菜单状态", - "value": "sys_show_hide" - }, - { - "label": "系统开关", - "value": "sys_normal_disable" - }, - { - "label": "任务状态", - "value": "sys_job_status" - }, - { - "label": "任务分组", - "value": "sys_job_group" - }, - { - "label": "系统是否", - "value": "sys_yes_no" - }, - { - "label": "通知类型", - "value": "sys_notice_type" - }, - { - "label": "通知状态", - "value": "sys_notice_status" - }, - { - "label": "操作类型", - "value": "sys_oper_type" - }, - { - "label": "系统状态", - "value": "sys_common_status" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» label|string|true|none|标签名称|none| -|»» value|string|true|none|标签值|none| - -## PUT 字典类型刷新缓存 - -PUT /system/dict/type/refreshCache - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 系统模块/菜单信息 - -## GET 菜单列表 - -GET /system/menu/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|menuName|query|string| 否 ||菜单名称| -|status|query|string| 否 ||菜单状态 0正常 1停用| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "menuId": "1", - "menuName": "系统管理", - "parentId": "0", - "menuSort": 1, - "path": "system", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526443", - "remark": "系统管理目录" - }, - { - "menuId": "2", - "menuName": "系统监控", - "parentId": "0", - "menuSort": 2, - "path": "monitor", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526448", - "remark": "系统监控目录" - }, - { - "menuId": "3", - "menuName": "系统工具", - "parentId": "0", - "menuSort": 3, - "path": "tool", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526452", - "remark": "系统工具目录" - }, - { - "menuId": "4", - "menuName": "开源仓库", - "parentId": "0", - "menuSort": 4, - "path": "https://gitee.com/TsMask", - "component": "", - "isFrame": "0", - "isCache": "0", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526456", - "remark": "开源仓库跳转外部链接打开新窗口" - }, - { - "menuId": "100", - "menuName": "用户管理", - "parentId": "1", - "menuSort": 1, - "path": "user", - "component": "system/user/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:user:list", - "icon": "#", - "createTime": "1682264526459", - "remark": "用户管理菜单" - }, - { - "menuId": "101", - "menuName": "角色管理", - "parentId": "1", - "menuSort": 2, - "path": "role", - "component": "system/role/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:role:list", - "icon": "#", - "createTime": "1682264526463", - "remark": "角色管理菜单" - }, - { - "menuId": "102", - "menuName": "分配角色", - "parentId": "1", - "menuSort": 3, - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "system:role:auth", - "icon": "#", - "createTime": "1682264526467", - "remark": "分配角色内嵌隐藏菜单" - }, - { - "menuId": "103", - "menuName": "菜单管理", - "parentId": "1", - "menuSort": 4, - "path": "menu", - "component": "system/menu/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:menu:list", - "icon": "#", - "createTime": "1682264526471", - "remark": "菜单管理菜单" - }, - { - "menuId": "104", - "menuName": "部门管理", - "parentId": "1", - "menuSort": 5, - "path": "dept", - "component": "system/dept/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:dept:list", - "icon": "#", - "createTime": "1682264526475", - "remark": "部门管理菜单" - }, - { - "menuId": "105", - "menuName": "岗位管理", - "parentId": "1", - "menuSort": 6, - "path": "post", - "component": "system/post/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:post:list", - "icon": "#", - "createTime": "1682264526479", - "remark": "岗位管理菜单" - }, - { - "menuId": "106", - "menuName": "字典管理", - "parentId": "1", - "menuSort": 7, - "path": "dict", - "component": "system/dict/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:dict:list", - "icon": "#", - "createTime": "1682264526484", - "remark": "字典管理菜单" - }, - { - "menuId": "107", - "menuName": "字典数据", - "parentId": "1", - "menuSort": 8, - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "system:dict:data", - "icon": "#", - "createTime": "1682264526488", - "remark": "字典数据内嵌隐藏菜单" - }, - { - "menuId": "108", - "menuName": "参数设置", - "parentId": "1", - "menuSort": 9, - "path": "config", - "component": "system/config/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:config:list", - "icon": "#", - "createTime": "1682264526491", - "remark": "参数设置菜单" - }, - { - "menuId": "109", - "menuName": "通知公告", - "parentId": "1", - "menuSort": 10, - "path": "notice", - "component": "system/notice/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:notice:list", - "icon": "#", - "createTime": "1682264526495", - "remark": "通知公告菜单" - }, - { - "menuId": "111", - "menuName": "日志管理", - "parentId": "1", - "menuSort": 11, - "path": "log", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526498", - "remark": "日志管理菜单" - }, - { - "menuId": "112", - "menuName": "服务监控", - "parentId": "2", - "menuSort": 1, - "path": "server-info", - "component": "monitor/server/info", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:server:info", - "icon": "#", - "createTime": "1682264526502", - "remark": "服务监控菜单" - }, - { - "menuId": "113", - "menuName": "缓存监控", - "parentId": "2", - "menuSort": 2, - "path": "cache-info", - "component": "monitor/cache/info", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:cache:info", - "icon": "#", - "createTime": "1682264526505", - "remark": "缓存监控菜单" - }, - { - "menuId": "114", - "menuName": "缓存列表", - "parentId": "2", - "menuSort": 3, - "path": "cache", - "component": "monitor/cache/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:cache:list", - "icon": "#", - "createTime": "1682264526509", - "remark": "缓存列表菜单" - }, - { - "menuId": "115", - "menuName": "在线用户", - "parentId": "2", - "menuSort": 4, - "path": "online", - "component": "monitor/online/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:online:list", - "icon": "#", - "createTime": "1682264526513", - "remark": "在线用户菜单" - }, - { - "menuId": "116", - "menuName": "调度任务", - "parentId": "2", - "menuSort": 5, - "path": "job", - "component": "monitor/job/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:job:list", - "icon": "#", - "createTime": "1682264526517", - "remark": "调度任务菜单" - }, - { - "menuId": "117", - "menuName": "调度日志", - "parentId": "2", - "menuSort": 6, - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "monitor:job:log", - "icon": "#", - "createTime": "1682264526520", - "remark": "调度日志内嵌隐藏菜单" - }, - { - "menuId": "118", - "menuName": "系统接口", - "parentId": "3", - "menuSort": 1, - "path": "swagger", - "component": "tool/swagger/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:swagger:list", - "icon": "#", - "createTime": "1682264526524", - "remark": "系统接口菜单" - }, - { - "menuId": "1000", - "menuName": "用户查询", - "parentId": "100", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:query", - "icon": "#", - "createTime": "1682264526537", - "remark": "" - }, - { - "menuId": "1001", - "menuName": "用户新增", - "parentId": "100", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:add", - "icon": "#", - "createTime": "1682264526540", - "remark": "" - }, - { - "menuId": "1002", - "menuName": "用户修改", - "parentId": "100", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:edit", - "icon": "#", - "createTime": "1682264526545", - "remark": "" - }, - { - "menuId": "1003", - "menuName": "用户删除", - "parentId": "100", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:remove", - "icon": "#", - "createTime": "1682264526549", - "remark": "" - }, - { - "menuId": "1004", - "menuName": "用户导出", - "parentId": "100", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:export", - "icon": "#", - "createTime": "1682264526552", - "remark": "" - }, - { - "menuId": "1005", - "menuName": "用户导入", - "parentId": "100", - "menuSort": 6, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:import", - "icon": "#", - "createTime": "1682264526556", - "remark": "" - }, - { - "menuId": "1006", - "menuName": "重置密码", - "parentId": "100", - "menuSort": 7, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:resetPwd", - "icon": "#", - "createTime": "1682264526561", - "remark": "" - }, - { - "menuId": "1007", - "menuName": "角色查询", - "parentId": "101", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:query", - "icon": "#", - "createTime": "1682264526564", - "remark": "" - }, - { - "menuId": "1008", - "menuName": "角色新增", - "parentId": "101", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:add", - "icon": "#", - "createTime": "1682264526567", - "remark": "" - }, - { - "menuId": "1009", - "menuName": "角色修改", - "parentId": "101", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:edit", - "icon": "#", - "createTime": "1682264526571", - "remark": "" - }, - { - "menuId": "1010", - "menuName": "角色删除", - "parentId": "101", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:remove", - "icon": "#", - "createTime": "1682264526575", - "remark": "" - }, - { - "menuId": "1011", - "menuName": "角色导出", - "parentId": "101", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:export", - "icon": "#", - "createTime": "1682264526579", - "remark": "" - }, - { - "menuId": "1012", - "menuName": "菜单查询", - "parentId": "103", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:query", - "icon": "#", - "createTime": "1682264526583", - "remark": "" - }, - { - "menuId": "1013", - "menuName": "菜单新增", - "parentId": "103", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:add", - "icon": "#", - "createTime": "1682264526586", - "remark": "" - }, - { - "menuId": "1014", - "menuName": "菜单修改", - "parentId": "103", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:edit", - "icon": "#", - "createTime": "1682264526589", - "remark": "" - }, - { - "menuId": "1015", - "menuName": "菜单删除", - "parentId": "103", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:remove", - "icon": "#", - "createTime": "1682264526592", - "remark": "" - }, - { - "menuId": "1016", - "menuName": "部门查询", - "parentId": "104", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:query", - "icon": "#", - "createTime": "1682264526595", - "remark": "" - }, - { - "menuId": "1017", - "menuName": "部门新增", - "parentId": "104", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:add", - "icon": "#", - "createTime": "1682264526598", - "remark": "" - }, - { - "menuId": "1018", - "menuName": "部门修改", - "parentId": "104", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:edit", - "icon": "#", - "createTime": "1682264526600", - "remark": "" - }, - { - "menuId": "1019", - "menuName": "部门删除", - "parentId": "104", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:remove", - "icon": "#", - "createTime": "1682264526603", - "remark": "" - }, - { - "menuId": "1020", - "menuName": "岗位查询", - "parentId": "105", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:query", - "icon": "#", - "createTime": "1682264526606", - "remark": "" - }, - { - "menuId": "1021", - "menuName": "岗位新增", - "parentId": "105", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:add", - "icon": "#", - "createTime": "1682264526609", - "remark": "" - }, - { - "menuId": "1022", - "menuName": "岗位修改", - "parentId": "105", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:edit", - "icon": "#", - "createTime": "1682264526612", - "remark": "" - }, - { - "menuId": "1023", - "menuName": "岗位删除", - "parentId": "105", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:remove", - "icon": "#", - "createTime": "1682264526616", - "remark": "" - }, - { - "menuId": "1024", - "menuName": "岗位导出", - "parentId": "105", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:export", - "icon": "#", - "createTime": "1682264526618", - "remark": "" - }, - { - "menuId": "1025", - "menuName": "字典查询", - "parentId": "106", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:query", - "icon": "#", - "createTime": "1682264526621", - "remark": "" - }, - { - "menuId": "1026", - "menuName": "字典新增", - "parentId": "106", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:add", - "icon": "#", - "createTime": "1682264526623", - "remark": "" - }, - { - "menuId": "1027", - "menuName": "字典修改", - "parentId": "106", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:edit", - "icon": "#", - "createTime": "1682264526627", - "remark": "" - }, - { - "menuId": "1028", - "menuName": "字典删除", - "parentId": "106", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:remove", - "icon": "#", - "createTime": "1682264526630", - "remark": "" - }, - { - "menuId": "1029", - "menuName": "字典导出", - "parentId": "106", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:export", - "icon": "#", - "createTime": "1682264526632", - "remark": "" - }, - { - "menuId": "1030", - "menuName": "参数查询", - "parentId": "108", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:query", - "icon": "#", - "createTime": "1682264526635", - "remark": "" - }, - { - "menuId": "1031", - "menuName": "参数新增", - "parentId": "108", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:add", - "icon": "#", - "createTime": "1682264526638", - "remark": "" - }, - { - "menuId": "1032", - "menuName": "参数修改", - "parentId": "108", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:edit", - "icon": "#", - "createTime": "1682264526640", - "remark": "" - }, - { - "menuId": "1033", - "menuName": "参数删除", - "parentId": "108", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:remove", - "icon": "#", - "createTime": "1682264526643", - "remark": "" - }, - { - "menuId": "1034", - "menuName": "参数导出", - "parentId": "108", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:export", - "icon": "#", - "createTime": "1682264526646", - "remark": "" - }, - { - "menuId": "1035", - "menuName": "公告查询", - "parentId": "109", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:query", - "icon": "#", - "createTime": "1682264526650", - "remark": "" - }, - { - "menuId": "1036", - "menuName": "公告新增", - "parentId": "109", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:add", - "icon": "#", - "createTime": "1682264526654", - "remark": "" - }, - { - "menuId": "1037", - "menuName": "公告修改", - "parentId": "109", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:edit", - "icon": "#", - "createTime": "1682264526658", - "remark": "" - }, - { - "menuId": "1038", - "menuName": "公告删除", - "parentId": "109", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:remove", - "icon": "#", - "createTime": "1682264526662", - "remark": "" - }, - { - "menuId": "500", - "menuName": "操作日志", - "parentId": "111", - "menuSort": 1, - "path": "operlog", - "component": "monitor/operlog/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:list", - "icon": "#", - "createTime": "1682264526528", - "remark": "操作日志菜单" - }, - { - "menuId": "501", - "menuName": "登录日志", - "parentId": "111", - "menuSort": 2, - "path": "logininfor", - "component": "monitor/logininfor/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:list", - "icon": "#", - "createTime": "1682264526532", - "remark": "登录日志菜单" - }, - { - "menuId": "1046", - "menuName": "缓存查询", - "parentId": "114", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:cache:query", - "icon": "#", - "createTime": "1682264526692", - "remark": "" - }, - { - "menuId": "1047", - "menuName": "缓存删除", - "parentId": "114", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:cache:remove", - "icon": "#", - "createTime": "1682264526696", - "remark": "" - }, - { - "menuId": "1048", - "menuName": "在线查询", - "parentId": "115", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:query", - "icon": "#", - "createTime": "1682264526700", - "remark": "" - }, - { - "menuId": "1049", - "menuName": "批量强退", - "parentId": "115", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:batchLogout", - "icon": "#", - "createTime": "1682264526704", - "remark": "" - }, - { - "menuId": "1050", - "menuName": "单条强退", - "parentId": "115", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:forceLogout", - "icon": "#", - "createTime": "1682264526707", - "remark": "" - }, - { - "menuId": "1051", - "menuName": "任务查询", - "parentId": "116", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:query", - "icon": "#", - "createTime": "1682264526713", - "remark": "" - }, - { - "menuId": "1052", - "menuName": "任务新增", - "parentId": "116", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:add", - "icon": "#", - "createTime": "1682264526717", - "remark": "" - }, - { - "menuId": "1053", - "menuName": "任务修改", - "parentId": "116", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:edit", - "icon": "#", - "createTime": "1682264526721", - "remark": "" - }, - { - "menuId": "1054", - "menuName": "任务删除", - "parentId": "116", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:remove", - "icon": "#", - "createTime": "1682264526725", - "remark": "" - }, - { - "menuId": "1055", - "menuName": "状态修改", - "parentId": "116", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:changeStatus", - "icon": "#", - "createTime": "1682264526730", - "remark": "" - }, - { - "menuId": "1056", - "menuName": "任务导出", - "parentId": "116", - "menuSort": 6, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:export", - "icon": "#", - "createTime": "1682264526735", - "remark": "" - }, - { - "menuId": "1039", - "menuName": "操作查询", - "parentId": "500", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:query", - "icon": "#", - "createTime": "1682264526665", - "remark": "" - }, - { - "menuId": "1040", - "menuName": "操作删除", - "parentId": "500", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:remove", - "icon": "#", - "createTime": "1682264526670", - "remark": "" - }, - { - "menuId": "1041", - "menuName": "日志导出", - "parentId": "500", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:export", - "icon": "#", - "createTime": "1682264526673", - "remark": "" - }, - { - "menuId": "1042", - "menuName": "登录查询", - "parentId": "501", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:query", - "icon": "#", - "createTime": "1682264526677", - "remark": "" - }, - { - "menuId": "1043", - "menuName": "登录删除", - "parentId": "501", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:remove", - "icon": "#", - "createTime": "1682264526681", - "remark": "" - }, - { - "menuId": "1044", - "menuName": "日志导出", - "parentId": "501", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:export", - "icon": "#", - "createTime": "1682264526684", - "remark": "" - }, - { - "menuId": "1045", - "menuName": "账户解锁", - "parentId": "501", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:unlock", - "icon": "#", - "createTime": "1682264526688", - "remark": "" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» menuId|string|true|none|菜单ID|none| -|»» menuName|string|true|none|菜单名称|none| -|»» parentId|string|true|none|父菜单ID|none| -|»» menuSort|integer|true|none|显示顺序|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件路径|none| -|»» isFrame|string|true|none|是否内部跳转|0否 1是| -|»» isCache|string|true|none|是否缓存|0不缓存 1缓存| -|»» menuType|string|true|none|菜单类型|D目录 M菜单 B按钮| -|»» visible|string|true|none|是否显示|0隐藏 1显示| -|»» status|string|true|none|状态|0停用 1正常| -|»» perms|string|true|none|权限标识|none| -|»» icon|string|true|none|图标|无图标要#号或空字符串| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 菜单信息 - -GET /system/menu/{menuId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|menuId|path|string| 是 ||菜单ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "menuId": "100", - "menuName": "用户管理", - "parentId": "1", - "menuSort": 1, - "path": "user", - "component": "system/user/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:user:list", - "icon": "#", - "createTime": "1682264526459", - "remark": "用户管理菜单" - } -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "data": null -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» menuId|string|true|none|菜单ID|none| -|»» menuName|string|true|none|菜单名称|none| -|»» parentId|string|true|none|父菜单ID|none| -|»» menuSort|integer|true|none|显示顺序|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件路径|none| -|»» isFrame|string|true|none|是否内部跳转|0否 1是| -|»» isCache|string|true|none|是否缓存|0不缓存 1缓存| -|»» menuType|string|true|none|菜单类型|D目录 M菜单 B按钮| -|»» visible|string|true|none|是否显示|0隐藏 1显示| -|»» status|string|true|none|状态|0停用 1正常| -|»» perms|string|true|none|权限标识|none| -|»» icon|string|true|none|图标|无图标要#号或空字符串| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## DELETE 菜单删除 - -DELETE /system/menu/{menuId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|menuId|path|string| 是 ||菜单ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问菜单数据" -} -``` - -```json -{ - "code": 500, - "msg": "存在子菜单,不允许删除" -} -``` - -```json -{ - "code": 500, - "msg": "菜单已分配给角色,不允许删除" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 菜单修改 - -PUT /system/menu - -> Body 请求参数 - -```json -{ - "menuId": "string", - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» menuId|body|string| 是 | 菜单ID|none| -|» parentId|body|string| 是 | 父菜单ID|none| -|» menuName|body|string| 是 | 菜单名称|none| -|» menuType|body|string| 是 | 菜单类型|D目录 M菜单 B按钮| -|» menuSort|body|integer| 是 | 显示顺序|默认0| -|» isFrame|body|string| 否 | 是否内部跳转|目录和菜单必传，0否 1是| -|» isCache|body|string| 否 | 是否缓存|目录和菜单必传，0不缓存 1缓存| -|» visible|body|string| 否 | 是否显示|目录和菜单必传，0隐藏 1显示| -|» status|body|string| 否 | 状态|目录和菜单必传，0停用 1正常| -|» icon|body|string| 否 | 图标|目录和菜单必传，#无图标| -|» path|body|string| 否 | 路由地址|目录和菜单必传| -|» component|body|string| 否 | 组件路径|菜单必传| -|» perms|body|string| 否 | 权限标识|菜单和按钮必传| -|» remark|body|string| 否 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问菜单数据" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxxx】失败，非内部地址必须以http(s)://开头" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxxx】失败，菜单路由地址已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxx】失败，菜单名称已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -## POST 菜单新增 - -POST /system/menu - -> Body 请求参数 - -```json -{ - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» parentId|body|string| 是 | 父菜单ID|根据菜单ID| -|» menuName|body|string| 是 | 菜单名称|none| -|» menuType|body|string| 是 | 菜单类型|D目录 M菜单 B按钮| -|» menuSort|body|integer| 是 | 显示顺序|默认0| -|» isFrame|body|string| 否 | 是否内部跳转|目录和菜单必传，0否 1是| -|» isCache|body|string| 否 | 是否缓存|目录和菜单必传，0不缓存 1缓存| -|» visible|body|string| 否 | 是否显示|目录和菜单必传，0隐藏 1显示| -|» status|body|string| 否 | 状态|目录和菜单必传，0停用 1正常| -|» icon|body|string| 否 | 图标|目录和菜单必传，#无图标| -|» path|body|string| 否 | 路由地址|目录和菜单必传| -|» component|body|string| 否 | 组件路径|菜单必传| -|» perms|body|string| 否 | 权限标识|菜单和按钮必传| -|» remark|body|string| 否 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxx】失败，菜单路由地址已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxxx】失败，菜单名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxxx】失败，非内部地址必须以http(s)://开头" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 菜单树结构列表（指定角色） - -GET /system/menu/roleMenuTreeSelect/{roleId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|roleId|path|string| 是 ||角色ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "menus": [ - { - "id": "1", - "label": "系统管理", - "children": [ - { - "id": "100", - "label": "用户管理", - "children": [ - { - "id": "1000", - "label": "用户查询", - "children": [] - }, - { - "id": "1001", - "label": "用户新增", - "children": [] - }, - { - "id": "1002", - "label": "用户修改", - "children": [] - }, - { - "id": "1003", - "label": "用户删除", - "children": [] - }, - { - "id": "1004", - "label": "用户导出", - "children": [] - }, - { - "id": "1005", - "label": "用户导入", - "children": [] - }, - { - "id": "1006", - "label": "重置密码", - "children": [] - } - ] - }, - { - "id": "101", - "label": "角色管理", - "children": [ - { - "id": "1007", - "label": "角色查询", - "children": [] - }, - { - "id": "1008", - "label": "角色新增", - "children": [] - }, - { - "id": "1009", - "label": "角色修改", - "children": [] - }, - { - "id": "1010", - "label": "角色删除", - "children": [] - }, - { - "id": "1011", - "label": "角色导出", - "children": [] - } - ] - }, - { - "id": "102", - "label": "分配角色", - "children": [] - }, - { - "id": "103", - "label": "菜单管理", - "children": [ - { - "id": "1012", - "label": "菜单查询", - "children": [] - }, - { - "id": "1013", - "label": "菜单新增", - "children": [] - }, - { - "id": "1014", - "label": "菜单修改", - "children": [] - }, - { - "id": "1015", - "label": "菜单删除", - "children": [] - } - ] - }, - { - "id": "104", - "label": "部门管理", - "children": [ - { - "id": "1016", - "label": "部门查询", - "children": [] - }, - { - "id": "1017", - "label": "部门新增", - "children": [] - }, - { - "id": "1018", - "label": "部门修改", - "children": [] - }, - { - "id": "1019", - "label": "部门删除", - "children": [] - } - ] - }, - { - "id": "105", - "label": "岗位管理", - "children": [ - { - "id": "1020", - "label": "岗位查询", - "children": [] - }, - { - "id": "1021", - "label": "岗位新增", - "children": [] - }, - { - "id": "1022", - "label": "岗位修改", - "children": [] - }, - { - "id": "1023", - "label": "岗位删除", - "children": [] - }, - { - "id": "1024", - "label": "岗位导出", - "children": [] - } - ] - }, - { - "id": "106", - "label": "字典管理", - "children": [ - { - "id": "1025", - "label": "字典查询", - "children": [] - }, - { - "id": "1026", - "label": "字典新增", - "children": [] - }, - { - "id": "1027", - "label": "字典修改", - "children": [] - }, - { - "id": "1028", - "label": "字典删除", - "children": [] - }, - { - "id": "1029", - "label": "字典导出", - "children": [] - } - ] - }, - { - "id": "107", - "label": "字典数据", - "children": [] - }, - { - "id": "108", - "label": "参数设置", - "children": [ - { - "id": "1030", - "label": "参数查询", - "children": [] - }, - { - "id": "1031", - "label": "参数新增", - "children": [] - }, - { - "id": "1032", - "label": "参数修改", - "children": [] - }, - { - "id": "1033", - "label": "参数删除", - "children": [] - }, - { - "id": "1034", - "label": "参数导出", - "children": [] - } - ] - }, - { - "id": "109", - "label": "通知公告", - "children": [ - { - "id": "1035", - "label": "公告查询", - "children": [] - }, - { - "id": "1036", - "label": "公告新增", - "children": [] - }, - { - "id": "1037", - "label": "公告修改", - "children": [] - }, - { - "id": "1038", - "label": "公告删除", - "children": [] - } - ] - }, - { - "id": "111", - "label": "日志管理", - "children": [ - { - "id": "500", - "label": "操作日志", - "children": [ - { - "id": "1039", - "label": "操作查询", - "children": "[Object]" - }, - { - "id": "1040", - "label": "操作删除", - "children": "[Object]" - }, - { - "id": "1041", - "label": "日志导出", - "children": "[Object]" - } - ] - }, - { - "id": "501", - "label": "登录日志", - "children": [ - { - "id": "1042", - "label": "登录查询", - "children": "[Object]" - }, - { - "id": "1043", - "label": "登录删除", - "children": "[Object]" - }, - { - "id": "1044", - "label": "日志导出", - "children": "[Object]" - }, - { - "id": "1045", - "label": "账户解锁", - "children": "[Object]" - } - ] - } - ] - } - ] - }, - { - "id": "2", - "label": "系统监控", - "children": [ - { - "id": "112", - "label": "服务监控", - "children": [] - }, - { - "id": "113", - "label": "缓存监控", - "children": [] - }, - { - "id": "114", - "label": "缓存列表", - "children": [ - { - "id": "1046", - "label": "缓存查询", - "children": [] - }, - { - "id": "1047", - "label": "缓存删除", - "children": [] - } - ] - }, - { - "id": "115", - "label": "在线用户", - "children": [ - { - "id": "1048", - "label": "在线查询", - "children": [] - }, - { - "id": "1049", - "label": "批量强退", - "children": [] - }, - { - "id": "1050", - "label": "单条强退", - "children": [] - } - ] - }, - { - "id": "116", - "label": "调度任务", - "children": [ - { - "id": "1051", - "label": "任务查询", - "children": [] - }, - { - "id": "1052", - "label": "任务新增", - "children": [] - }, - { - "id": "1053", - "label": "任务修改", - "children": [] - }, - { - "id": "1054", - "label": "任务删除", - "children": [] - }, - { - "id": "1055", - "label": "状态修改", - "children": [] - }, - { - "id": "1056", - "label": "任务导出", - "children": [] - } - ] - }, - { - "id": "117", - "label": "调度日志", - "children": [] - } - ] - }, - { - "id": "3", - "label": "系统工具", - "children": [ - { - "id": "118", - "label": "系统接口", - "children": [] - } - ] - }, - { - "id": "4", - "label": "开源仓库", - "children": [] - }, - { - "id": "2002", - "label": "备千验白儿这", - "children": [] - }, - { - "id": "2001", - "label": "要形存做情式2史", - "children": [] - } - ], - "checkedKeys": [] - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» menus|[object]|true|none|菜单节点|none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -## GET 菜单树结构列表 - -GET /system/menu/treeSelect - -角色新增修改中菜单权限列表使用 - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|menuName|query|string| 否 ||菜单名称| -|status|query|string| 否 ||菜单状态 0正常 1停用| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "id": "1", - "label": "系统管理", - "children": [ - { - "id": "100", - "label": "用户管理", - "children": [ - { - "id": "1000", - "label": "用户查询", - "children": [] - }, - { - "id": "1001", - "label": "用户新增", - "children": [] - }, - { - "id": "1002", - "label": "用户修改", - "children": [] - }, - { - "id": "1003", - "label": "用户删除", - "children": [] - }, - { - "id": "1004", - "label": "用户导出", - "children": [] - }, - { - "id": "1005", - "label": "用户导入", - "children": [] - }, - { - "id": "1006", - "label": "重置密码", - "children": [] - } - ] - }, - { - "id": "101", - "label": "角色管理", - "children": [ - { - "id": "1007", - "label": "角色查询", - "children": [] - }, - { - "id": "1008", - "label": "角色新增", - "children": [] - }, - { - "id": "1009", - "label": "角色修改", - "children": [] - }, - { - "id": "1010", - "label": "角色删除", - "children": [] - }, - { - "id": "1011", - "label": "角色导出", - "children": [] - } - ] - }, - { - "id": "102", - "label": "分配角色", - "children": [] - }, - { - "id": "103", - "label": "菜单管理", - "children": [ - { - "id": "1012", - "label": "菜单查询", - "children": [] - }, - { - "id": "1013", - "label": "菜单新增", - "children": [] - }, - { - "id": "1014", - "label": "菜单修改", - "children": [] - }, - { - "id": "1015", - "label": "菜单删除", - "children": [] - } - ] - }, - { - "id": "104", - "label": "部门管理", - "children": [ - { - "id": "1016", - "label": "部门查询", - "children": [] - }, - { - "id": "1017", - "label": "部门新增", - "children": [] - }, - { - "id": "1018", - "label": "部门修改", - "children": [] - }, - { - "id": "1019", - "label": "部门删除", - "children": [] - } - ] - }, - { - "id": "105", - "label": "岗位管理", - "children": [ - { - "id": "1020", - "label": "岗位查询", - "children": [] - }, - { - "id": "1021", - "label": "岗位新增", - "children": [] - }, - { - "id": "1022", - "label": "岗位修改", - "children": [] - }, - { - "id": "1023", - "label": "岗位删除", - "children": [] - }, - { - "id": "1024", - "label": "岗位导出", - "children": [] - } - ] - }, - { - "id": "106", - "label": "字典管理", - "children": [ - { - "id": "1025", - "label": "字典查询", - "children": [] - }, - { - "id": "1026", - "label": "字典新增", - "children": [] - }, - { - "id": "1027", - "label": "字典修改", - "children": [] - }, - { - "id": "1028", - "label": "字典删除", - "children": [] - }, - { - "id": "1029", - "label": "字典导出", - "children": [] - } - ] - }, - { - "id": "107", - "label": "字典数据", - "children": [] - }, - { - "id": "108", - "label": "参数设置", - "children": [ - { - "id": "1030", - "label": "参数查询", - "children": [] - }, - { - "id": "1031", - "label": "参数新增", - "children": [] - }, - { - "id": "1032", - "label": "参数修改", - "children": [] - }, - { - "id": "1033", - "label": "参数删除", - "children": [] - }, - { - "id": "1034", - "label": "参数导出", - "children": [] - } - ] - }, - { - "id": "109", - "label": "通知公告", - "children": [ - { - "id": "1035", - "label": "公告查询", - "children": [] - }, - { - "id": "1036", - "label": "公告新增", - "children": [] - }, - { - "id": "1037", - "label": "公告修改", - "children": [] - }, - { - "id": "1038", - "label": "公告删除", - "children": [] - } - ] - }, - { - "id": "111", - "label": "日志管理", - "children": [ - { - "id": "500", - "label": "操作日志", - "children": [ - { - "id": "1039", - "label": "操作查询", - "children": [] - }, - { - "id": "1040", - "label": "操作删除", - "children": [] - }, - { - "id": "1041", - "label": "日志导出", - "children": [] - } - ] - }, - { - "id": "501", - "label": "登录日志", - "children": [ - { - "id": "1042", - "label": "登录查询", - "children": [] - }, - { - "id": "1043", - "label": "登录删除", - "children": [] - }, - { - "id": "1044", - "label": "日志导出", - "children": [] - }, - { - "id": "1045", - "label": "账户解锁", - "children": [] - } - ] - } - ] - } - ] - }, - { - "id": "2", - "label": "系统监控", - "children": [ - { - "id": "112", - "label": "服务监控", - "children": [] - }, - { - "id": "113", - "label": "缓存监控", - "children": [] - }, - { - "id": "114", - "label": "缓存列表", - "children": [ - { - "id": "1046", - "label": "缓存查询", - "children": [] - }, - { - "id": "1047", - "label": "缓存删除", - "children": [] - } - ] - }, - { - "id": "115", - "label": "在线用户", - "children": [ - { - "id": "1048", - "label": "在线查询", - "children": [] - }, - { - "id": "1049", - "label": "批量强退", - "children": [] - }, - { - "id": "1050", - "label": "单条强退", - "children": [] - } - ] - }, - { - "id": "116", - "label": "调度任务", - "children": [ - { - "id": "1051", - "label": "任务查询", - "children": [] - }, - { - "id": "1052", - "label": "任务新增", - "children": [] - }, - { - "id": "1053", - "label": "任务修改", - "children": [] - }, - { - "id": "1054", - "label": "任务删除", - "children": [] - }, - { - "id": "1055", - "label": "状态修改", - "children": [] - }, - { - "id": "1056", - "label": "任务导出", - "children": [] - } - ] - }, - { - "id": "117", - "label": "调度日志", - "children": [] - } - ] - }, - { - "id": "3", - "label": "系统工具", - "children": [ - { - "id": "118", - "label": "系统接口", - "children": [] - } - ] - }, - { - "id": "4", - "label": "开源仓库", - "children": [] - }, - { - "id": "2002", - "label": "备千验白儿这", - "children": [] - }, - { - "id": "2001", - "label": "要形存做情式2史", - "children": [] - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» menus|[object]|true|none||none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -# 系统模块/岗位信息 - -## GET 岗位列表 - -GET /system/post/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|postCode|query|string| 否 ||岗位编码| -|postName|query|string| 否 ||岗位名称| -|status|query|string| 否 ||状态（0正常 1停用）| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» postId|string|true|none|岗位ID|none| -|»» postCode|string|true|none|编码|none| -|»» postName|string|true|none|名称|none| -|»» postSort|integer|true|none|排序|none| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 岗位列表导出 - -POST /system/post/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=post_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "configName": "string", - "postCode": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» configName|body|string| 否 | 岗位名称|none| -|» postCode|body|string| 否 | 岗位编码|none| -|» status|body|string| 否 | 状态|0正常 1停用| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 岗位详细 - -GET /system/post/{postId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|postId|path|string| 是 ||岗位ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» postId|string|true|none|岗位ID|none| -|»» postCode|string|true|none|编码|none| -|»» postName|string|true|none|名称|none| -|»» postSort|integer|true|none|排序|none| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 岗位新增 - -POST /system/post - -> Body 请求参数 - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": "string", - "phone": "string", - "remark": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» postCode|body|string| 是 | 岗位编码|none| -|» postName|body|string| 是 | 岗位名称|none| -|» postSort|body|string| 是 | 排序|none| -|» phone|body|string| 是 | 状态|0正常 1停用| -|» remark|body|string| 是 | 备注|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "岗位新增【xxx】失败，岗位名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "岗位新增【xxx】失败，岗位编码已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 岗位修改 - -PUT /system/post - -> Body 请求参数 - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": "string", - "phone": "string", - "remark": "string", - "postId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» postCode|body|string| 是 | 岗位编码|none| -|» postName|body|string| 是 | 岗位名称|none| -|» postSort|body|string| 是 | 排序|none| -|» phone|body|string| 是 | 状态|0正常 1停用| -|» remark|body|string| 是 | 备注|none| -|» postId|body|string| 是 | 岗位ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "岗位修改【xxx】失败，岗位名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "岗位修改【xxx】失败，岗位编码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 岗位删除 - -DELETE /system/post/{postIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|postIds|path|string| 是 ||岗位ID，多个用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问岗位数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 系统模块/个人信息 - -## GET 基础信息获取 - -GET /system/user/profile - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "maskAdmin", - "nickName": "管理员", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "管理员", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "status": "1" - } - }, - "roleGroup": [ - "管理员" - ], - "postGroup": [ - "董事长" - ] - } -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none|用户信息|none| -|»» user|object|true|none|用户信息|none| -|»»» roles|[object]|true|none|角色信息|none| -|»»»» roleId|string|false|none||none| -|»»»» roleName|string|false|none||none| -|»»»» roleKey|string|false|none||none| -|»»»» roleSort|integer|false|none||none| -|»»»» dataScope|string|false|none||none| -|»»»» status|string|false|none||none| -|»»» userId|string|true|none||none| -|»»» deptId|string|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| -|»» roleGroup|[string]|true|none|角色|字符数组| -|»» postGroup|[string]|true|none|岗位|字符数组| - -## PUT 基础信息修改 - -PUT /system/user/profile - -> Body 请求参数 - -```json -{ - "nickName": "阎秀兰", - "sex": "1", - "phonenumber": "18169338391", - "email": "t.eknevzfl@htejfppo.so" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» nickName|body|string| 是 | 昵称|none| -|» email|body|string| 否 | 邮箱|none| -|» phonenumber|body|string| 否 | 手机|none| -|» sex|body|string| 是 | 性别|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxxx】失败，手机号码格式错误" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 修改头像 - -POST /system/user/profile/avatar - -> Body 请求参数 - -```yaml -file: string - -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» file|body|string(binary)| 是 ||请选择等比大小图片作为头像，如200x200、400x400| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "/upload/avatar/2023/04/o_1d2bofn8f19dh5s11okpje61mipg_画板1_bf3wq4h6.png" -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，仅支持以下类型：jpg,jpeg,png" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|string|true|none|图片地址|none| - -## PUT 修改密码 - -PUT /system/user/profile/updatePwd - -> Body 请求参数 - -```json -{ - "oldPassword": "admin@1234", - "newPassword": "Admin@1234" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» oldPassword|body|string| 是 | 旧密码|none| -|» newPassword|body|string| 是 | 新密码|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "新密码不能与旧密码相同" -} -``` - -```json -{ - "code": 500, - "msg": "修改密码失败，旧密码错误" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 系统模块/角色信息 - -## GET 角色信息列表 - -GET /system/role/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|roleName|query|string| 否 ||角色名称| -|roleKey|query|string| 否 ||权限字符| -|status|query|string| 否 ||状态 0正常 1停用| -|beginTime|query|string| 否 ||创建时间-开始| -|endTime|query|string| 否 ||创建时间-结束| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 2, - "rows": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526399", - "remark": "管理员" - }, - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» roleId|string|true|none|角色ID|none| -|»» roleName|string|true|none|名称|none| -|»» roleKey|string|true|none|键值|none| -|»» roleSort|integer|true|none|排序|none| -|»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» status|string|true|none|角色状态|0停用 1正常| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 角色分配用户列表 - -GET /system/role/authUser/allocatedList - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|userName|query|string| 否 ||用户名称| -|phonenumber|query|string| 否 ||用户手机号| -|status|query|string| 否 ||用户状态| -|roleId|query|string| 是 ||角色ID| -|allocated|query|string| 是 ||已分配角色用户 true是 false否| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "userName": "maskUser", - "nickName": "普通用户", - "email": "maskUser@qq.com", - "phonenumber": "13412341234", - "status": "1", - "createTime": "1682264526309", - "dept": { - "deptId": "105", - "deptName": "测试部门" - } - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» status|string|false|none|角色状态|0停用 1正常| -|»» createTime|string|false|none|创建时间|none| -|»» roles|[string]|false|none|角色ID数组|none| -|»» userId|string|false|none|用户ID|none| -|»» deptId|string|false|none|部门ID|none| -|»» userName|string|false|none|用户名称|none| -|»» nickName|string|false|none|用户昵称|none| -|»» email|string|false|none|邮箱|none| -|»» phonenumber|string|false|none|手机号|none| -|»» dept|object|false|none|部门信息|none| -|»»» deptId|string|false|none|部门ID|none| -|»»» deptName|string|false|none|部门名称|none| - -## GET 角色信息详情 - -GET /system/role/{roleId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|roleId|path|string| 是 ||角色ID| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526399", - "remark": "管理员" - } -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» roleId|string|true|none|角色ID|none| -|»» roleName|string|true|none|名称|none| -|»» roleKey|string|true|none|键值|none| -|»» roleSort|integer|true|none|排序|none| -|»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» status|string|true|none|角色状态|0停用 1正常| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## PUT 角色信息修改 - -PUT /system/role - -> Body 请求参数 - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» roleName|body|string| 是 | 名称|none| -|» roleKey|body|string| 是 | 键值|none| -|» roleSort|body|integer| 是 | 排序|none| -|» status|body|string| 是 | 角色状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| -|» dataScope|body|string| 是 | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» menuCheckStrictly|body|string| 是 | 菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| 是 | 菜单权限|菜单ID数组| -|» roleId|body|string| 是 | 角色ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "角色修改【xxx】失败，角色名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "角色修改【xxxx】失败，权限键值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 角色信息新增 - -POST /system/role - -> Body 请求参数 - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ] -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» roleName|body|string| 是 | 名称|none| -|» roleKey|body|string| 是 | 键值|none| -|» roleSort|body|integer| 是 | 排序|none| -|» status|body|string| 是 | 角色状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| -|» dataScope|body|string| 是 | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» menuCheckStrictly|body|string| 是 | 菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| 是 | 菜单权限|菜单ID数组| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "角色新增【xxxx】失败，角色名称已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -## DELETE 角色信息删除 - -DELETE /system/role/{roleIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|roleIds|path|string| 是 ||角色ID，多个可用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -## PUT 角色状态变更 - -PUT /system/role/changeStatus - -> Body 请求参数 - -```json -{ - "roleId": "string", - "status": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» roleId|body|string| 是 | 角色ID|none| -|» status|body|string| 否 | 状态|0停用 1正常| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 角色数据权限修改 - -PUT /system/role/dataScope - -> Body 请求参数 - -```json -{ - "dataScope": "string", - "deptCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» dataScope|body|string| 是 | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» deptCheckStrictly|body|string| 是 | 部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| 否 | 部门权限|数据范围选择2时必传，部门ID数组| -|» roleId|body|string| 是 | 角色ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 角色列表导出 - -POST /system/role/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=role_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "roleName": "string", - "roleKey": "string", - "status": "string", - "beginTime": "string", - "endTime": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» roleName|body|string| 否 | 角色名称|none| -|» roleKey|body|string| 否 | 权限字符|none| -|» status|body|string| 否 | 状态|0正常 1停用| -|» beginTime|body|string| 否 | 创建时间-开始|none| -|» endTime|body|string| 否 | 创建时间-结束|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 角色分配选择授权 - -PUT /system/role/authUser/checked - -> Body 请求参数 - -```json -{ - "roleId": "string", - "userIds": "string", - "checked": true -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» roleId|body|string| 是 | 角色ID|none| -|» userIds|body|string| 是 | 用户ID|多个可用英文逗号分隔| -|» checked|body|boolean| 是 | 选择操作|添加true 取消false| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 系统模块/用户信息 - -## POST 用户信息列表导入模板下载 - -POST /system/user/importTemplate - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=user_import_template_1684230715497.xlsx -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 用户信息列表 - -GET /system/user/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|userName|query|string| 否 ||用户名称| -|phonenumber|query|string| 否 ||手机号码| -|status|query|string| 否 ||状态| -|beginTime|query|string| 否 ||创建时间-开始| -|endTime|query|string| 否 ||创建时间-结束| -|deptId|query|string| 否 ||部门ID| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "nickName": "普通用户", - "userName": "maskUser", - "email": "maskUser@qq.com", - "avatar": "", - "phonenumber": "13412341234", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.56.1", - "loginDate": "1683364764238", - "createBy": "maskAdmin", - "createTime": "1682264526309", - "remark": "普通人员", - "dept": { - "deptId": "105", - "deptName": "测试部门", - "leader": "MASK" - } - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» roles|[string]|true|none|角色ID数组|none| -|»» userId|string|true|none|用户ID|none| -|»» deptId|string¦null|true|none|部门ID|none| -|»» nickName|string|true|none|用户昵称|none| -|»» userName|string|true|none|用户名称|none| -|»» email|string|true|none|邮箱|none| -|»» avatar|string|true|none|头像|none| -|»» phonenumber|string|true|none|电话|none| -|»» sex|string|true|none|性别|0未知 1男 2女| -|»» status|string|true|none|状态|0停用 1正常| -|»» delFlag|string|true|none|是否删除|0代表存在 1代表删除| -|»» loginIp|string|true|none|登录IP|none| -|»» loginDate|string|true|none|登录时间|none| -|»» createBy|string|true|none|创建人|none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string¦null|true|none|备注|none| -|»» dept|object|true|none|部门信息|none| -|»»» deptId|string¦null|true|none|部门ID|none| -|»»» deptName|string¦null|true|none|部门名称|none| -|»»» leader|string¦null|true|none|负责人|none| - -## GET 用户信息详情 - -GET /system/user/{userId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|userId|path|string| 是 ||用户ID，新增0| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": { - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "status": "1" - } - ], - "userId": "2", - "deptId": "105", - "userName": "maskUser", - "nickName": "普通用户", - "userType": "sys", - "email": "maskUser@qq.com", - "avatar": "", - "phonenumber": "13412341234", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.56.1", - "loginDate": "1683364764238", - "createBy": "maskAdmin", - "createTime": "1682264526309", - "remark": "普通人员", - "dept": { - "deptId": "105", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "测试部门", - "orderNum": 3, - "leader": "MASK", - "status": "1" - } - }, - "roleIds": [ - "2" - ], - "postIds": [ - "2" - ], - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ], - "posts": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] - } -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": {}, - "roleIds": [], - "postIds": [], - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ], - "posts": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] - } -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» user|object|true|none|用户信息|none| -|»»» roles|[object]|true|none|角色信息|none| -|»»»» roleId|string|false|none|角色ID|none| -|»»»» roleName|string|false|none|名称|none| -|»»»» roleKey|string|false|none|键值|none| -|»»»» roleSort|integer|false|none|排序|none| -|»»»» dataScope|string|false|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»»»» status|string|false|none|角色状态|0停用 1正常| -|»»» userId|string|true|none|用户ID|none| -|»»» deptId|string¦null|true|none|部门ID|none| -|»»» userName|string|true|none|用户名称|none| -|»»» nickName|string|true|none|用户昵称|none| -|»»» email|string|true|none|邮箱|none| -|»»» avatar|string|true|none|头像|none| -|»»» phonenumber|string|true|none|电话|none| -|»»» sex|string|true|none|性别|0未知 1男 2女| -|»»» status|string|true|none|状态|0停用 1正常| -|»»» delFlag|string|true|none|是否删除|0代表存在 1代表删除| -|»»» loginIp|string|true|none|登录IP|none| -|»»» loginDate|string|true|none|登录时间|none| -|»»» createBy|string|true|none|创建人|none| -|»»» createTime|string|true|none|创建时间|none| -|»»» remark|string¦null|true|none|备注|none| -|»»» dept|object|true|none|部门信息|none| -|»»»» deptId|string|true|none|部门ID|none| -|»»»» parentId|string|true|none|父部门ID|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|部门状态|0正常 1停用| -|»»»» phone|string|false|none|联系电话|none| -|»»»» email|string|false|none|邮箱|none| -|»» roleIds|[string]|true|none|已选角色ID|none| -|»» postIds|[string]|true|none|已选岗位ID|none| -|»» roles|[object]|true|none|角色信息数组|none| -|»»» roleId|string|true|none|角色ID|none| -|»»» roleName|string|true|none|名称|none| -|»»» roleKey|string|true|none|键值|none| -|»»» roleSort|integer|true|none|排序|none| -|»»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»»» status|string|true|none|角色状态|0停用 1正常| -|»»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none|备注|none| -|»» posts|[object]|true|none|岗位信息数组|none| -|»»» postId|string|true|none|岗位ID|none| -|»»» postCode|string|true|none|编码|none| -|»»» postName|string|true|none|名称|none| -|»»» postSort|integer|true|none|排序|none| -|»»» status|string|true|none|状态|none| -|»»» createBy|string|true|none||none| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none|备注|none| - -## POST 用户信息新增 - -POST /system/user - -> Body 请求参数 - -```json -{ - "remark": "去只传周物给", - "deptId": 102, - "nickName": "龙杰", - "email": "h.vrcjiz@qcfgqedxw.bz", - "phonenumber": "18641692257", - "sex": "0", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 1, - 2, - 3, - 4 - ], - "userName": "gijobqebs", - "password": "123456" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» userName|body|string| 是 | 用户名称|none| -|» password|body|string| 是 | 用户密码|none| -|» nickName|body|string| 是 | 用户昵称|none| -|» email|body|string| 是 | 邮箱|none| -|» phonenumber|body|string| 是 | 电话|none| -|» sex|body|string| 是 | 性别|0未知 1男 2女| -|» status|body|string| 是 | 状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| -|» deptId|body|string| 是 | 部门ID|none| -|» roleIds|body|[string]| 是 | 角色ID数组|none| -|» postIds|body|[string]| 是 | 岗位ID数组|none| -|» userType|body|string| 否 | 用户类型|sys系统用户| -|» avatar|body|string| 否 | 头像|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【xxxx】失败，登录账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【xxxx】失败，手机号码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【zwciugaw2】失败，邮箱已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -## PUT 用户信息修改 - -PUT /system/user - -> Body 请求参数 - -```json -{ - "remark": "群劳设着给王", - "deptId": 80, - "nickName": "许芳", - "email": "x.swtaf@oypeubb.tg", - "phonenumber": "18106129309", - "sex": "1", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 2 - ], - "userId": "101", - "userName": "x34bvpi" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» userId|body|string| 是 | 用户ID|none| -|» userName|body|string| 是 | 用户名称|none| -|» nickName|body|string| 是 | 用户昵称|none| -|» email|body|string| 是 | 邮箱|none| -|» phonenumber|body|string| 是 | 电话|none| -|» sex|body|string| 是 | 性别|0未知 1男 2女| -|» status|body|string| 是 | 状态|0停用 1正常| -|» remark|body|string| 是 | 备注|none| -|» deptId|body|string| 是 | 部门ID|none| -|» roleIds|body|[string]| 是 | 角色ID数组|none| -|» postIds|body|[string]| 是 | 岗位ID数组|none| -|» userType|body|string| 否 | 用户类型|sys系统用户| -|» avatar|body|string| 否 | 头像|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxx】失败，手机号码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【liming】失败，登录账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxx】失败，邮箱已存在" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 用户信息列表导出 - -POST /system/user/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=user_export_11_1684230271701.xlsx -content-length: 21499 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body 请求参数 - -```json -{ - "userName": "string", - "phonenumber": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "deptId": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» userName|body|string| 否 | 用户名称|none| -|» phonenumber|body|string| 否 | 手机号码|none| -|» status|body|string| 否 | 状态|0停用 1正常| -|» beginTime|body|string| 否 | 创建开始时间|none| -|» endTime|body|string| 否 | 创建结束时间|none| -|» deptId|body|string| 否 | 部门ID|none| -|» pageNum|body|number| 是 | 页数，默认1|none| -|» pageSize|body|number| 是 | 单页记录数，默认10|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 用户信息列表导入 - -POST /system/user/importData - -> Body 请求参数 - -```yaml -file: [] -updateSupport: "{% mock 'pick' , ['false','true'] %}" - -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» file|body|string(binary)| 否 ||导入xls、xlsx表格文件| -|» updateSupport|body|string| 否 ||是否更新已经存在的数据，默认false| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 1 条，数据如下：
序号：1 登录名称 user001 导入成功" -} -``` - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 0 条，数据如下：" -} -``` - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 1 条，数据如下：
序号：1 登录名称 user001 更新成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "很抱歉，导入失败！共 5 条数据格式不正确，错误如下：
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称" -} -``` - -```json -{ - "code": 500, - "msg": "导入用户数据不能为空！" -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，仅支持以下类型：xls,xlsx" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 用户信息删除 - -DELETE /system/user/{userIds} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|userIds|path|string| 是 ||用户ID，多个用英文逗号分隔| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 用户重置密码 - -PUT /system/user/resetPwd - -> Body 请求参数 - -```json -{ - "password": "string", - "userId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» password|body|string| 是 | 密码|none| -|» userId|body|string| 是 | 用户ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT 用户状态修改 - -PUT /system/user/changeStatus - -> Body 请求参数 - -```json -{ - "status": "string", - "userId": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» status|body|string| 是 | 状态|0停用 1正常| -|» userId|body|string| 是 | 用户ID|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 网元模块 - -## GET 网元neType和neID查询 - -GET /ne/info - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neType|query|string| 是 ||none| -|neId|query|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -# 网元模块/UDM鉴权用户 - -## GET 列表 - -GET /ne/udm/auth/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|query|string| 否 ||none| -|imsi|query|string| 否 ||none| -|msisdn|query|string| 否 ||none| -|sortField|query|string| 否 ||none| -|sortOrder|query|string| 否 ||none| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "msg": "string", - "rows": [ - { - "id": "string", - "imsi": "string", - "amf": "string", - "status": "string", - "ki": "string", - "algoIndex": "string", - "opc": "string", - "neId": "string" - } - ], - "total": 0 -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 信息 - -GET /ne/udm/auth/{neId}/{imsi} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|imsi|path|string| 是 ||none| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "data": { - "id": "string", - "imsi": "string", - "amf": "string", - "status": "string", - "ki": "string", - "algoIndex": "string", - "opc": "string", - "neId": "string" - }, - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 /ne/udm/auth/{neId}/{imsi} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|imsi|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## PUT 重载数据 for Redis - -PUT /ne/udm/auth/resetData/{neId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 37981, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 新增 - -POST /ne/udm/auth/{neId} - -> Body 请求参数 - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» algoIndex|body|string| 是 ||none| -|» amf|body|string| 是 ||none| -|» imsi|body|string| 是 ||none| -|» ki|body|string| 是 ||none| -|» opc|body|string| 是 ||none| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 修改 - -PUT /ne/udm/auth/{neId} - -> Body 请求参数 - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» algoIndex|body|string| 是 ||none| -|» amf|body|string| 是 ||none| -|» imsi|body|string| 是 ||none| -|» ki|body|string| 是 ||none| -|» opc|body|string| 是 ||none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 批量新增 - -POST /ne/udm/auth/{neId}/{num} - -> Body 请求参数 - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|num|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» algoIndex|body|string| 是 ||none| -|» amf|body|string| 是 ||none| -|» imsi|body|string| 是 ||none| -|» ki|body|string| 是 ||none| -|» opc|body|string| 是 ||none| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## DELETE 批量删除 - -DELETE /ne/udm/auth/{neId}/{imsi}/{num} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|imsi|path|string| 是 ||none| -|num|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 导出 - -POST /ne/udm/auth/export - -> Body 请求参数 - -```json -{ - "neId": "string", - "type": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» neId|body|string| 是 ||none| -|» type|body|string| 是 | csv txt|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 导入 - -POST /ne/udm/auth/import - -> Body 请求参数 - -```yaml -neId: "002" -file: string - -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» neId|body|string| 是 ||none| -|» file|body|string(binary)| 是 ||none| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 网元模块/UDM签约用户 - -## GET 信息 - -GET /ne/udm/sub/{neId}/{imsi} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|imsi|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{ - "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" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 /ne/udm/sub/{neId}/{imsi} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|imsi|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 增加 - -POST /ne/udm/sub/{neId} - -此命令可同时添加45G签约用户 - -> Body 请求参数 - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» msisdn|body|string| 是 ||none| -|» imsi|body|string| 是 ||none| -|» ambr|body|string| 是 ||none| -|» nssai|body|string| 是 ||none| -|» rat|body|string| 是 ||none| -|» arfb|body|string| 是 ||none| -|» sar|body|string| 是 ||none| -|» cn|body|string| 是 ||none| -|» smData|body|string| 是 ||none| -|» smfSel|body|string| 是 ||none| -|» epsDat|body|string| 是 ||none| -|» epsFlag|body|string| 是 ||none| -|» epsOdb|body|string| 是 ||none| -|» hplmnOdb|body|string| 是 ||none| -|» ard|body|string| 是 ||none| -|» epstpl|body|string| 是 ||none| -|» contextId|body|string| 是 ||none| -|» apnContext|body|string| 是 ||none| -|» staticIp|body|string| 是 ||static_ip指给4G UE分配的静态IP，没有可不带此字段名| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 修改 - -PUT /ne/udm/sub/{neId} - -> Body 请求参数 - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» msisdn|body|string| 是 ||none| -|» imsi|body|string| 是 ||none| -|» ambr|body|string| 是 ||none| -|» nssai|body|string| 是 ||none| -|» rat|body|string| 是 ||none| -|» arfb|body|string| 是 ||none| -|» sar|body|string| 是 ||none| -|» cn|body|string| 是 ||none| -|» smData|body|string| 是 ||none| -|» smfSel|body|string| 是 ||none| -|» epsDat|body|string| 是 ||none| -|» epsFlag|body|string| 是 ||none| -|» epsOdb|body|string| 是 ||none| -|» hplmnOdb|body|string| 是 ||none| -|» ard|body|string| 是 ||none| -|» epstpl|body|string| 是 ||none| -|» contextId|body|string| 是 ||none| -|» apnContext|body|string| 是 ||none| -|» staticIp|body|string| 是 ||static_ip指给4G UE分配的静态IP，没有可不带此字段名| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 批量添加 - -POST /ne/udm/sub/{neId}/{num} - -> Body 请求参数 - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|num|path|string| 是 ||放号数| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» msisdn|body|string| 是 ||none| -|» imsi|body|string| 是 ||none| -|» ambr|body|string| 是 ||none| -|» nssai|body|string| 是 ||none| -|» rat|body|string| 是 ||none| -|» arfb|body|string| 是 ||none| -|» sar|body|string| 是 ||none| -|» cn|body|string| 是 ||none| -|» smData|body|string| 是 ||none| -|» smfSel|body|string| 是 ||none| -|» epsDat|body|string| 是 ||none| -|» epsFlag|body|string| 是 ||none| -|» epsOdb|body|string| 是 ||none| -|» hplmnOdb|body|string| 是 ||none| -|» ard|body|string| 是 ||none| -|» epstpl|body|string| 是 ||none| -|» contextId|body|string| 是 ||none| -|» apnContext|body|string| 是 ||none| -|» staticIp|body|string| 是 ||static_ip指给4G UE分配的静态IP，没有可不带此字段名| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## DELETE 批量删除 - -DELETE /ne/udm/sub/{neId}/{imsi}/{num} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|imsi|path|string| 是 ||none| -|num|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## POST 导出 - -POST /ne/udm/sub/export - -> Body 请求参数 - -```json -{ - "neId": "string", - "type": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» neId|body|string| 是 ||none| -|» type|body|string| 是 | csv txt|none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## PUT 重载数据 for Redis - -PUT /ne/udm/sub/resetData/{neId} - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neId|path|string| 是 ||none| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none|路由数组|none| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST 导入 - -POST /ne/udm/sub/import - -> Body 请求参数 - -```yaml -neId: "002" -file: string - -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» neId|body|string| 是 ||none| -|» file|body|string(binary)| 是 ||none| - -> 返回示例 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## GET 列表 - -GET /ne/udm/sub/list - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|msisdn|query|string| 否 ||none| -|imsi|query|string| 否 ||none| -|neId|query|string| 否 ||none| -|sortField|query|string| 否 ||none| -|sortOrder|query|string| 否 ||none| -|pageNum|query|number| 否 ||页数，默认1| -|pageSize|query|number| 否 ||单页记录数，默认10| -|Authorization|header|string| 是 ||授权令牌| -|Referer|header|string| 是 ||使用指定声明的Referer| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{ - "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 -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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| - -# 跟踪模块 - -## POST 普通网元抓包PACP - -POST /tcpdump/ne - -> Body 请求参数 - -```json -{ - "neType": "string", - "neId": "string", - "timeout": 0, - "cmd": "string", - "timestamp": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» neType|body|string| 是 ||none| -|» neId|body|string| 是 ||none| -|» timeout|body|number| 是 ||none| -|» cmd|body|string| 是 ||none| -|» timestamp|body|string| 是 ||时间戳记录文件| - -> 返回示例 - -> 200 Response - -```json -{ - "code": 0, - "data": { - "cmd": "string", - "fileName": "string", - "msg": "string" - }, - "msg": "string" -} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -状态码 **200** - -|名称|类型|必选|约束|中文名|说明| -|---|---|---|---|---|---| -|» 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 UPF网元抓包PACP - -POST /tcpdump/neUPF - -> Body 请求参数 - -```json -{ - "neType": "string", - "neId": "string", - "runType": "string", - "cmd": "string", - "timestamp": "string" -} -``` - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| -|body|body|object| 否 ||none| -|» neType|body|string| 是 ||none| -|» neId|body|string| 是 ||none| -|» runType|body|string| 是 ||执行开始start还是停止stop开始telnetstart_telnet/stop_telnet脚本字符串start_str/stop_str| -|» cmd|body|string| 是 ||方法1：适合其他网元异常，UPF配合抓包的情况。包文件相对较小。| -|» timestamp|body|string| 是 ||时间戳记录文件| - -#### 详细说明 - -**» cmd**: 方法1：适合其他网元异常，UPF配合抓包的情况。包文件相对较小。 -进入命令行之后： -1）开始抓包 pcap trace rx tx max 100000 intfc any file upf_test.pcap -2）停止抓包 pcap trace rx tx off - -方法2：适合UPF异常需要抓包分析的情况。包文件相对较大。 -进入命令行之后： -1）开始抓包 pcap dispatch trace on max 100000 file upf_test.pcap -2）停止抓包 pcap dispatch trace off - -> 返回示例 - -> 200 Response - -```json -{} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -## GET PACP文件下载 - -GET /tcpdump/download - -### 请求参数 - -|名称|位置|类型|必选|中文名|说明| -|---|---|---|---|---|---| -|neType|query|string| 是 ||none| -|neId|query|string| 是 ||none| -|fileName|query|string| 是 ||none| -|User-Agent|header|string| 是 ||用户浏览器代理| -|Accept-Language|header|string| 是 ||zh_CN;q=0.9 en_US;q=0.9| - -> 返回示例 - -> 200 Response - -```json -{} -``` - -### 返回结果 - -|状态码|状态码含义|说明|数据模型| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### 返回数据结构 - -# 数据模型 - diff --git a/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.docx b/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.docx deleted file mode 100644 index a30f46f..0000000 Binary files a/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.docx and /dev/null differ diff --git a/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.md b/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.md deleted file mode 100644 index c789240..0000000 --- a/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.md +++ /dev/null @@ -1,15813 +0,0 @@ -# OMC HTTP RESTful API Interfaces - -# Authentication - -## GET Query user info - -GET /getInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": { - "permissions": [ - "*:*:*" - ], - "roles": [ - "admin" - ], - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "admin", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "manager", - "nickName": "manager", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "manager", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "R&D", - "orderNum": 1, - "leader": "", - "status": "1" - } - } - } -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------ | -------- | -------- | ------------ | ---------------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» permissions | [string] | true | none | Permissions list | -| »» roles | [string] | true | none | Roles list | -| »» user | object | true | none | none | -| »»» roles | [object] | true | none | none | -| »»»» roleId | string | false | none | none | -| »»»» roleName | string | false | none | none | -| »»»» roleKey | string | false | none | none | -| »»»» roleSort | integer | false | none | none | -| »»»» dataScope | string | false | none | none | -| »»»» status | string | false | none | none | -| »»» userId | string | true | none | none | -| »»» deptId | string | true | none | none | -| »»» userName | string | true | none | none | -| »»» nickName | string | true | none | none | -| »»» userType | string | true | none | none | -| »»» email | string | true | none | none | -| »»» avatar | string | true | none | none | -| »»» phonenumber | string | true | none | none | -| »»» sex | string | true | none | none | -| »»» status | string | true | none | none | -| »»» delFlag | string | true | none | none | -| »»» loginIp | string | true | none | none | -| »»» loginDate | string | true | none | none | -| »»» createBy | string | true | none | none | -| »»» createTime | string | true | none | none | -| »»» remark | string | true | none | none | -| »»» dept | object | false | none | none | -| »»»» deptId | string | true | none | none | -| »»»» parentId | string | true | none | none | -| »»»» ancestors | string | true | none | none | -| »»»» deptName | string | true | none | none | -| »»»» orderNum | integer | true | none | none | -| »»»» leader | string | true | none | none | -| »»»» status | string | true | none | none | - -## GET Query route info - -GET /getRouters - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "System Management", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "User Management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "Role Management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "Role assign to user", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "Menu management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "Department management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "Postion management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "Dictionary management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "Dictionary data", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Log management", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "Operation log", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "Security log", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "System monitor", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "Server monitor", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "Cache monitor", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "Cache list", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "Online users", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "Scheduling tasks", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------- | ------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» name | string | true | none | none | -| »» path | string | true | none | none | -| »» component | string | true | none | Basic layout component identification menu type - Menu D - Blank Layout - Blank Layout component identification menu type - Menu M - Link Layout - Inner link layout component identification menu type - Menu M - Button menu type - Menu B will not be read into the route | -| »» meta | object | true | none | none | -| »»» icon | string | true | none | none | -| »»» title | string | true | none | none | -| »»» hide | boolean | true | none | Default Value: false | -| »»» cache | boolean | true | none | Default Value: false | -| »»» target | string¦null | true | none | -Non link null - internal jump _self - external jump _blank | -| »» redirect | string | false | none | none | -| »» children | [object] | false | none | none | -| »»» name | string | true | none | none | -| »»» path | string | true | none | none | -| »»» component | string | true | none | none | -| »»» meta | object | true | none | none | -| »»»» icon | string | true | none | none | -| »»»» title | string | true | none | none | -| »»»» hide | boolean | true | none | none | -| »»»» cache | boolean | true | none | none | -| »»»» target | string¦null | true | none | none | - -## POST Login - -POST /login - -> Body Parameters - -```json -{ - "username": "admin", - "password": "rootaa", - "code": "{{code-text}}", - "uuid": "{{code-uuid}}" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | -------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » username | body | string | yes | User Name | -| » password | body | string | yes | Password | -| » code | body | string | no | Captcha code | -| » uuid | body | string | no | UUID of captcha code | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -```json -{ - "code": 0, - "msg": "Verification code has expired" -} -``` - -```json -{ - "code": 0, - "msg": "Verification code error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | false | none | none | -| »» access_token | string | true | none | none | - -## POST Logout - -POST /logout - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------ | -| Authorization | header | string | no | Access token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Success" -} -``` - -```json -{ - "code": 0, - "msg": "The request is too frequent, please try again later." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# Monitor & Alarm - -## GET Get OMC Local Time - -GET /api/rest/systemManagement/v1/elementType/OMC/objectType/time - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Monitor & Alarm/NE State - -## GET Get ALL NEs System State - -GET /api/rest/systemManagement/v1/elementType/ALL/objectType/systemState - -Get ALL NEs system state - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 0 Response - -```json -{} -``` - -> OK - -```json -{ - "data": [ - { - "SMF/001": { - "ipAddress": "192.168.14.13", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 24, - "sysCpuUsage": 9 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 50138, - "used": 13601 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 90620, - "sysMemUsage": 436, - "totalMem": 8167360 - }, - "serialNum": "20230905", - "version": "1.6.1" - } - } - }, - { - "AMF/001": { - "ipAddress": "192.168.14.12", - "systemState": { - "capability": 100000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 10 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 50138, - "used": 13601 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 23844, - "sysMemUsage": 436, - "totalMem": 8167360 - }, - "serialNum": "20230905", - "version": "1.6.1" - } - } - }, - { - "UPF/001": { - "ipAddress": "192.168.1.159", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 3474, - "sysCpuUsage": 2984 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 7998, - "used": 0 - }, - { - "total": 1603, - "used": 0 - }, - { - "total": 100278, - "used": 12041 - }, - { - "total": 8019, - "used": 1 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 8019, - "used": 0 - }, - { - "total": 1603, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 114940, - "sysMemUsage": 948, - "totalMem": 16424904 - }, - "serialNum": "13740272", - "version": "2.2311.8" - } - } - }, - { - "AUSF/001": { - "ipAddress": "192.168.1.186", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 564 - }, - "dbInfo": "adb v1.0.1", - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "hardwareInfo": { - "cpus": 8, - "memory": 8167360 - }, - "hostName": "5GC", - "ipAddr": [ - "192.168.1.186" - ], - "memUsage": { - "nfUsedMem": 30580, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "neId": "001", - "neName": "AUSF_001", - "neType": "AUSF", - "osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux", - "port": 3030, - "province": "GD", - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "UDM/001": { - "ipAddress": "192.168.1.187", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 14, - "sysCpuUsage": 194 - }, - "dbInfo": "adb v1.0.1", - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "hardwareInfo": { - "cpus": 8, - "memory": 8167360 - }, - "hostName": "5GC", - "ipAddr": [ - "192.168.1.187" - ], - "memUsage": { - "nfUsedMem": 29760, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "neId": "001", - "neName": "UDM_001", - "neType": "UDM", - "osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux", - "port": 3030, - "province": "GD", - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "AMF/002": { - "ipAddress": "192.168.1.172", - "systemState": { - "capability": 100000, - "cpuUsage": { - "nfCpuUsage": 24, - "sysCpuUsage": 299 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2023-12-31", - "memUsage": { - "nfUsedMem": 28092, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "IMS/001": { - "ipAddress": "192.168.13.103", - "systemState": { - "capability": 100000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 112 - }, - "diskSpace": { - "partitionInfo": [ - { - "Total": 2948, - "Used": 0 - }, - { - "Total": 596, - "Used": 1 - }, - { - "Total": 24062, - "Used": 14220 - }, - { - "Total": 2980, - "Used": 0 - }, - { - "Total": 5, - "Used": 0 - }, - { - "Total": 2980, - "Used": 0 - }, - { - "Total": 596, - "Used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-10-31", - "memUsage": { - "nfUsedMem": 23424, - "sysMemUsage": 3738, - "totalMem": 6103292 - }, - "serialNum": "00000001", - "version": "1.6.2" - } - } - }, - { - "SMF/002": { - "ipAddress": "192.168.1.173", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 25, - "sysCpuUsage": 308 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2023-12-31", - "memUsage": { - "nfUsedMem": 189188, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "NSSF/001": { - "ipAddress": "192.168.1.139", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 244, - "sysCpuUsage": 507 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 51104, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "NRF/001": { - "ipAddress": "192.168.1.138", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 523 - }, - "dbInfo": "adb v1.0.1", - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "hardwareInfo": { - "cpus": 8, - "memory": 8167360 - }, - "hostName": "5GC", - "ipAddr": [ - "192.168.1.138" - ], - "memUsage": { - "nfUsedMem": 26856, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "neId": "001", - "neName": "NRF_001", - "neType": "AUSF", - "osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux", - "port": 3030, - "province": "GD", - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "PCF/001": { - "ipAddress": "192.168.1.174", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 51, - "sysCpuUsage": 311 - }, - "dbInfo": "adb v1.0.1", - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 1559, - "used": 17000 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "hardwareInfo": { - "cpus": 8, - "memory": 8167360 - }, - "hostName": "5GC", - "ipAddr": [ - "192.168.1.174" - ], - "memUsage": { - "nfUsedMem": 35692, - "sysMemUsage": 899, - "totalMem": 8167360 - }, - "neId": "001", - "neName": "PCF_001", - "neType": "AUSF", - "osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux", - "port": 3030, - "province": "GD", - "serialNum": "13740272", - "version": "2.2311.7" - } - } - }, - { - "OMC/001": { - "ipAddress": "192.168.2.219", - "systemState": { - "hostName": "simonzhangsz", - "osInfo": "Widnows 602931718", - "dbInfo": "mysql Ver 15.1 Distrib 10.3.35-MariaDB, for Linux (aarch64) using readline 5.1", - "version": "2.2311.8", - "ipAddr": [ - "192.168.2.219" - ], - "port": 3030, - "capability": 9999999, - "serialNum": "13750650", - "expiryDate": "-", - "hardwareInfo": { - "cpus": 1, - "memory": 34029125632 - }, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 542 - }, - "memUsage": { - "totalMem": 33231568, - "nfUsedMem": 106120, - "sysMemUsage": 6400 - }, - "diskSpace": { - "partitionNum": 8, - "partitionInfo": [ - { - "total": 460605, - "used": 175411 - }, - { - "total": 513034, - "used": 38767 - }, - { - "total": 29053, - "used": 23406 - }, - { - "total": 29053, - "used": 23406 - }, - { - "total": 23486, - "used": 23458 - }, - { - "total": 59181, - "used": 24273 - }, - { - "total": 30064, - "used": 11191 - }, - { - "total": 39476, - "used": 37532 - } - ] - } - } - } - }, - { - "N3IWF/001": { - "ipAddress": "192.168.9.214", - "systemState": { - "capability": 100000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 37 - }, - "diskSpace": { - "partitionInfo": [ - { - "Total": 1899, - "Used": 0 - }, - { - "Total": 391, - "Used": 1 - }, - { - "Total": 64196, - "Used": 7980 - }, - { - "Total": 1955, - "Used": 0 - }, - { - "Total": 5, - "Used": 0 - }, - { - "Total": 112, - "Used": 112 - }, - { - "Total": 63, - "Used": 63 - }, - { - "Total": 63, - "Used": 63 - }, - { - "Total": 53, - "Used": 53 - }, - { - "Total": 40, - "Used": 40 - }, - { - "Total": 391, - "Used": 1 - }, - { - "Total": 391, - "Used": 0 - } - ], - "partitionNum": 12 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 23392, - "sysMemUsage": 706, - "totalMem": 4005412 - }, - "serialNum": "13990001", - "version": "2.2311.7" - } - } - }, - { - "MME/001": { - "error": { - "errorCode": "1", - "errorInfo": "Internal server error, NF connnect refused" - }, - "ipAddress": "192.168.1.179" - } - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ----------------------------------------------------------------------- | ------------------- | ----------- | -| 0 | Unknown | ALL NEs systemState | Inline | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | -| 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | Unauthorized | Inline | -| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | Server Error | Inline | - -### Responses Data Schema - -## GET Get All UDM System State - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/systemState - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------------- | -| ne_id | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | Use the specified declared Referer | -| User-Agent | header | string | yes | User agent | -| Accept-Language | header | string | yes | zh_CN;q=0.9 en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET Get OMC System State - -GET /api/rest/systemManagement/v1/elementType/omc/objectType/systemState - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Monitor & Alarm/Alarm - -## GET Get Alarm from NF - -GET /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - -Sync alarms from NF - -> Body Parameters - -```json -[ - { - "neType": "SMF", - "neId": "SZ_01", - "alarmId": "SMF0113", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:56:09", - "alarmCode": 10, - "alarmType": "EquipmentAlarm", - "origSeverity": "Critical", - "alarmStatus": 0, - "specificProblem": "string", - "addInfo": "string", - "locationInfo": "test" - } -] -``` - -### Params - -| Name | Location | Type | Required | Description | -| ---------------- | -------- | ------------- | -------- | ------------------- | -| elementTypeValue | path | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | array[object] | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Get Alarm from NF - -POST /api/rest/faultManagement/v1/elementType/smf/objectType/alarms - -> Body Parameters - -```json -{ - "objectId": "SMF_0", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:52:09", - "alarmCode": 10, - "alarmType": "EquipmentAlarm", - "perceivedSeverity": 3, - "alarmStatus": 1, - "specificProblem": "string", - "additionalText": "string", - "alarmSource": "test" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| -------------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » objectId | body | string | yes | none | -| » alarmTitle | body | string | yes | none | -| » eventTime | body | string | yes | none | -| » alarmCode | body | integer | yes | none | -| » alarmType | body | string | yes | none | -| » perceivedSeverity | body | integer | yes | none | -| » alarmStatus | body | integer | yes | none | -| » specificProblem | body | string | yes | none | -| » additionalText | body | string | yes | none | -| » alarmSource | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post Alarm from AMF - -POST /api/rest/faultManagement/v1/elementType/amf/objectType/alarms - -> Body Parameters - -```json -{ - "objectId": "AMF_0", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:52:09", - "alarmCode": 6, - "alarmType": "EquipmentAlarm", - "perceivedSeverity": 3, - "alarmStatus": 1, - "specificProblem": "string", - "additionalText": "string", - "alarmSource": "test" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| -------------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » objectId | body | string | yes | none | -| » alarmTitle | body | string | yes | none | -| » eventTime | body | string | yes | none | -| » alarmCode | body | integer | yes | none | -| » alarmType | body | string | yes | none | -| » perceivedSeverity | body | integer | yes | none | -| » alarmStatus | body | integer | yes | none | -| » specificProblem | body | string | yes | none | -| » additionalText | body | string | yes | none | -| » alarmSource | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Monitor & Alarm/UE Event - -## POST UE Detach from AMF - -POST /upload-ue/v1/detach - -> Body Parameters - -```json -{ - "imsi": "4600212141", - "detachTime": "2023-01-16 07:28:11", - "detachResult": 1 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » detachTime | body | string | yes | none | -| » detachResult | body | integer | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST UE CM State from AMF - -POST /upload-ue/v1/cm-state - -> Body Parameters - -```json -{ - "imsi": "4600212141", - "onlineNumber": 11, - "changeTime": "2023-01-16 07:28:11", - "status": 1 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » onlineNumber | body | integer | yes | none | -| » changeTime | body | string | yes | none | -| » status | body | integer | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST UE Auth Result from AMF - -POST /upload-ue/v1/auth-result - -> Body Parameters - -```json -{ - "imsi": "4600212141", - "imei": "2146002121413", - "tacID": "98", - "gNBID": "31", - "cellID": "17", - "onlineNumber": 11, - "authCode": "50", - "authMessage": "test", - "authTime": "2023-01-16 07:28:11" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » imei | body | string | yes | none | -| » tacID | body | string | yes | none | -| » gNBID | body | string | yes | none | -| » cellID | body | string | yes | none | -| » onlineNumber | body | integer | yes | none | -| » authCode | body | string | yes | none | -| » authMessage | body | string | yes | none | -| » authTime | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Monitor & Alarm/CDR Event - -## POST CDR Event from IMS - -POST /api/rest/cdrManagement/v1/elementType/ims/objectType/cdrEvent - -> Body Parameters - -```json -{ - "neType": "IMS", - "neName": "IMS_001", - "rmUID": "4400HX1IMS001", - "timestamp": 1705542378, - "CDR": { - "recordType": "CALL", - "seqNumber": 1, - "callReference": "X1gcbQ8zT@10.10.91.252", - "callerParty": "12307551241", - "calledParty": "12307550064", - "serviceResult": "ok", - "seizureTime": 1705542348, - "answerTime": 1705542356, - "releaseTime": 1705542378, - "callDuration": 22 - } -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| ------------------ | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » neType | body | string | yes | none | -| » neName | body | string | yes | none | -| » rmUID | body | string | yes | none | -| » timestamp | body | integer | yes | none | -| » CDR | body | object | yes | none | -| »» recordType | body | string | yes | none | -| »» seqNumber | body | integer | yes | none | -| »» callReference | body | string | yes | none | -| »» callerParty | body | string | yes | none | -| »» calledParty | body | string | yes | none | -| »» serviceResult | body | string | yes | none | -| »» seizureTime | body | integer | yes | none | -| »» answerTime | body | integer | yes | none | -| »» releaseTime | body | integer | yes | none | -| »» callDuration | body | integer | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET CDR File from IMS - -GET /api/rest/cdrManagement/v1/elementType/ims/objectType/cdrFile - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | -------------------------- | -| type | query | string | no | CDR file type: failed/full | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Performance - -## PATCH Patch Measure Task - -PATCH /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| taskId | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post Measure Task - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -> Body Parameters - -```json -{} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| id | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Performance/Performance Statistics - -## GET Statistical title - -GET /ne/kpi/title - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | -------------------- | -| neType | query | string | yes | Network element type | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "id": "28", - "neType": "UDM", - "kpiId": "UDM.01", - "titleJson": "{\"en\": \"UDR.5gActSub\"}", - "enTitle": "UDR.5gActSub" - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | [object] | true | none | none | -| »» cn_title | string | true | none | none | -| »» en_title | string | true | none | none | -| »» id | integer | true | none | none | -| »» kpi_id | string | true | none | none | -| »» ne_type | string | true | none | none | -| »» title_json | string | true | none | none | -| » msg | string | true | none | none | - -## GET Statistical data - -GET /ne/kpi/data - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------ | -| neType | query | string | yes | Network element type | -| neId | query | string | yes | Network element ID | -| startTime | query | string | yes | Starting time | -| endTime | query | string | yes | end time | -| interval | query | number | yes | Particle size/average sampling value | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "SMF.01": "1594", - "SMF.02": "1594", - "SMF.03": "1594", - "SMF.04": "1594", - "SMF.05": "1594", - "SMF.06": "1594", - "SMF.07": "1594", - "SMF.08": "1594", - "SMF.09": "1594", - "SMF.10": "1594", - "SMF.11": "1594", - "SMF.12": "1594", - "SMF.13": "1594", - "SMF.14": "797", - "neName": "0", - "startIndex": 0, - "timeGroup": "2023-09-25 00:00" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 15, - "timeGroup": "2023-09-25 00:15" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 30, - "timeGroup": "2023-09-25 00:30" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 45, - "timeGroup": "2023-09-25 00:45" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 93, - "timeGroup": "2023-09-25 01:30" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 105, - "timeGroup": "2023-09-25 01:45" - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | [object] | true | none | none | -| »» SMF.01 | string | true | none | none | -| »» SMF.02 | string | true | none | none | -| »» SMF.03 | string | true | none | none | -| »» SMF.04 | string | true | none | none | -| »» SMF.05 | string | true | none | none | -| »» SMF.06 | string | true | none | none | -| »» SMF.07 | string | true | none | none | -| »» SMF.08 | string | true | none | none | -| »» SMF.09 | string | true | none | none | -| »» SMF.10 | string | true | none | none | -| »» SMF.11 | string | true | none | none | -| »» SMF.12 | string | true | none | none | -| »» SMF.13 | string | true | none | none | -| »» SMF.14 | string | true | none | none | -| »» neName | string | true | none | none | -| »» startIndex | integer | true | none | none | -| »» timeGroup | string | true | none | none | -| » msg | string | true | none | none | - -# Trace - -## DELETE Patch Measure Task - -DELETE /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| taskId | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post Trace Task No NeType - -POST /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{ - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "", - "neId": "", - "interfaces": [ - "N8", - "N10" - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » traceType | body | string | yes | none | -| » startTime | body | string | yes | none | -| » endTime | body | string | yes | none | -| » neType | body | string | yes | none | -| » neId | body | string | yes | none | -| » interfaces | body | [string] | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## PUT Put Trace Task No NeType - -PUT /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{ - "id": 3, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "", - "neId": "", - "srcIp": "192.168.2.199", - "signalPort": 3030, - "interfaces": [ - "N8", - "N10", - "N11" - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » id | body | integer | yes | none | -| » traceType | body | string | yes | none | -| » startTime | body | string | yes | none | -| » endTime | body | string | yes | none | -| » neType | body | string | yes | none | -| » neId | body | string | yes | none | -| » srcIp | body | string | yes | none | -| » signalPort | body | integer | yes | none | -| » interfaces | body | [string] | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## DELETE Delete Trace Task No NeType - -DELETE /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------------- | -------- | ------------------- | -| id | query | array[string] | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post AMF Measure Task - -POST /api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask - -> Body Parameters - -```json -{} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| id | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post Measure Report - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport - -> Body Parameters - -```json -{ - "id": 1, - "NeType": "SMF" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » id | body | integer | yes | none | -| » NeType | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Captuer NE's PACP(exclude UPF) - -POST /tcpdump/ne - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string", - "timeout": 0, - "cmd": "string", - "timestamp": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » neType | body | string | yes | none | -| » neId | body | string | yes | none | -| » timeout | body | number | yes | none | -| » cmd | body | string | yes | none | -| » timestamp | body | string | yes | timestamp of file | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "cmd": "cd /tmp \nsudo timeout 10 tcpdump -i any sctp or tcp port 3030 or 8088 -s0 -w timestamp_UDM_001.pcap", - "fileName": "timestamp_UDM_001.pcap", - "msg": "tcpdump: listening on any, link-type LINUX_SLL (Linux cooked), capture size 262144 bytes\n10 packets captured\n10 packets received by filter\n0 packets dropped by kernel\n" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» cmd | string | true | none | none | -| »» fileName | string | true | none | none | -| »» msg | string | true | none | none | -| » msg | string | true | none | none | - -## POST Get Measurement - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measurement - -> Body Parameters - -```json -{ - "Index": 2, - "NeName": "SMFRJBJJC01", - "RmUID": "1101AGTHXSMF0000015704000100", - "NeType": "SMF", - "PmVersion": "5GC16.1.1", - "Dn": "RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456", - "Period": "15", - "TimeZone": "UTC+8", - "StartTime": "2023-05-23 22:26:28", - "Datas": [ - { - "ObjectType": "SmfFunction", - "KPIs": [ - { - "KPIID": "SMF.AttCreatePduSession._Dnn", - "KPIValues": [ - { - "Name": "cmnet", - "Value": 1 - }, - { - "Name": "ims", - "Value": 0 - } - ] - } - ] - }, - { - "ObjectType": "AddrPool", - "KPIs": [ - { - "KPIID": "SMF.MeanAllcAddr", - "KPIValues": [ - { - "Name": "Total", - "Value": 1 - } - ] - }, - { - "KPIID": "SMF.MeanAllcAddr._Ns", - "KPIValues": [ - { - "Name": "1001", - "Value": 2 - }, - { - "Name": "1002", - "Value": 1 - } - ] - } - ] - } - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| ---------------- | -------- | -------- | -------- | ------------------- | -| Content-Type | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » Index | body | integer | yes | none | -| » NeName | body | string | yes | none | -| » RmUID | body | string | yes | none | -| » NeType | body | string | yes | none | -| » PmVersion | body | string | yes | none | -| » Dn | body | string | yes | none | -| » Period | body | string | yes | none | -| » TimeZone | body | string | yes | none | -| » StartTime | body | string | yes | none | -| » Datas | body | [object] | yes | none | -| »» ObjectType | body | string | yes | none | -| »» KPIs | body | [object] | yes | none | -| »»» KPIID | body | string | yes | none | -| »»» KPIValues | body | [object] | yes | none | -| »»»» Name | body | string | yes | none | -| »»»» Value | body | integer | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST UPF capture PACP - -POST /tcpdump/neUPF - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string", - "runType": "string", - "cmd": "string", - "timestamp": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » neType | body | string | yes | none | -| » neId | body | string | yes | none | -| » runType | body | string | yes | Execute start or stop to start telnetstart_telnet/stop_telnet script string start_str/stop_str | -| » cmd | body | string | yes | Method 1: Suitable for situations where other network elements have anomalies and UPF cooperates with packet capture. The package file is relatively small. After entering the command line: 1) Start capturing pcap trace rx tx max 100000 intfc any file upf_test. pcap 2) Stop capturing pcap trace rx tx off method 2: Suitable for situations where UPF exceptions require packet capture analysis. The package file is relatively large. After entering the command line: 1) Start capturing pcap patch trace on max 100000 file upf_test. pcap 2) Stop capturing pcap patch trace off | -| » timestamp | body | string | yes | timestamp of dump file | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET PACP file download - -GET /tcpdump/download - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neType | query | string | yes | none | -| neId | query | string | yes | none | -| fileName | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Configuration/NE Management - -## PUT Put NE Info - -PUT /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -```json -{ - "pvFlag": "VNF", - "province": "GD", - "vendorName": "AGT", - "dn": "cmjicai" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » pvFlag | body | string | yes | none | -| » province | body | string | yes | none | -| » vendorName | body | string | yes | none | -| » dn | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post NE Info - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -```json -{ - "neType": "UDM", - "neId": "SZ_02", - "neName": "UDM_SZ_01", - "ip": "192.168.1.187", - "port": "8080", - "pvFlag": "VNF", - "province": "GD", - "vendorName": "AGT", - "dn": "cmjicai" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Scheme | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » neType | body | string | yes | none | -| » neId | body | string | yes | none | -| » neName | body | string | yes | none | -| » ip | body | string | yes | none | -| » port | body | string | yes | none | -| » pvFlag | body | string | yes | none | -| » province | body | string | yes | none | -| » vendorName | body | string | yes | none | -| » dn | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## DELETE Delete NE info - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -``` -string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | string | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Configuration/Export/Import NE - -## GET Get Software from OMC - -GET /api/rest/systemManagement/v1/AMF/software/123 - -> Body Parameters - -```yaml -string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------- | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | string(binary) | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Upload Software To OMC - -POST /api/rest/systemManagement/v1/AMF/software/123 - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------- | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET Export CM From NF - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```yaml -string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------- | -| ne_id | query | string | yes | none | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | string(binary) | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Import CM to NF - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```json -{ - "fileName": "udm-sz_01-etc-20230627002725.zip" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » fileName | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## DELETE Delete Software from OMC - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```json -{ - "fileName": "udm-sz_01-etc-20230615171608.zip" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » fileName | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## PUT Active Software To NF - -PUT /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01 - -> Body Parameters - -```json -{} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## PATCH Rollback Software To NF - -PATCH /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01 - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------- | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Distribute Software To NF - -POST /api/rest/systemManagement/v1/EMS/software/2.2311.8/001 - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------- | -| accessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# Configuration/Parameter config - -## GET Get System Parameter from UDM - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| ne_id | query | string | yes | none | -| loc | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## PUT Put System Parameter to UDM - -PUT /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "capacity": 1000, - "priority": 2 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| subsys_no | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » capacity | body | integer | yes | none | -| » priority | body | integer | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Post System Parameter to UDM - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "capacity": 1000, - "priority": 2 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| subsys_no | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » capacity | body | integer | yes | none | -| » priority | body | integer | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## DELETE Delete System Parameter to UDM - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| subsys_no | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET Get subsUEAmbr Parameter from UDM - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET Get UDM smfSelection - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET Get IMS system param - -GET /api/rest/systemManagement/v1/elementType/amf/objectType/config/guami - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -# UE Management/UDM Subscirber Data - -## GET Subscriber Info - -GET /ne/udm/sub/{neId}/{imsi} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| imsi | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": { - "AMBR": "def_ambr", - "ActiveTime": "1000", - "AreaForbidden": "def_arfb", - "CNType": "0x03(EPC|5GC)", - "EPS-Data": "1,64,24,65,def_eps,1,2,010200000000,-", - "MICO": "0", - "MME_id": "-", - "MSISDN": "13407550193", - "NSSAI": "def_nssai", - "ODB_PS": "1", - "RAT": "0x00(VIRTUAL|WLAN|EUTRA|NR)", - "RegTimer": "12000", - "RfspIndex": "1", - "SM-Data(snssai+dnn[1..n])": "1-000001&cmnet&ims&3gnet", - "ServiceAreaRestriction": "def_sar", - "Smf-Selection": "def_snssai", - "UEUsageType": "1", - "kdc_flag": "0" - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": { - "id": "137028", - "msisdn": "86123075529295", - "imsi": "460000100029295", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "3", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,2,010200000000,-", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "010200000000", - "staticIp": "-" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» id | string | true | none | none | -| »» msisdn | string | true | none | none | -| »» imsi | string | true | none | none | -| »» ambr | string | true | none | none | -| »» nssai | string | true | none | none | -| »» rat | string | true | none | none | -| »» arfb | string | true | none | none | -| »» sar | string | true | none | none | -| »» cn | string | true | none | none | -| »» smData | string | true | none | none | -| »» smfSel | string | true | none | none | -| »» epsDat | string | true | none | none | -| »» neId | string | true | none | none | -| »» epsFlag | string | true | none | none | -| »» epsOdb | string | true | none | none | -| »» hplmnOdb | string | true | none | none | -| »» ard | string | true | none | none | -| »» epstpl | string | true | none | none | -| »» contextId | string | true | none | none | -| »» apnContext | string | true | none | none | -| »» staticIp | string | true | none | none | -| » msg | string | true | none | none | - -## DELETE Subscriber - -DELETE /ne/udm/sub/{neId}/{imsi} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| imsi | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## POST Subscriber - -POST /ne/udm/sub/{neId} - -This API can add 4/5G subscribers at the same time - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------------------------ | -| neId | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » msisdn | body | string | yes | none | -| » imsi | body | string | yes | none | -| » ambr | body | string | yes | none | -| » nssai | body | string | yes | none | -| » rat | body | string | yes | none | -| » arfb | body | string | yes | none | -| » sar | body | string | yes | none | -| » cn | body | string | yes | none | -| » smData | body | string | yes | none | -| » smfSel | body | string | yes | none | -| » epsDat | body | string | yes | none | -| » epsFlag | body | string | yes | none | -| » epsOdb | body | string | yes | none | -| » hplmnOdb | body | string | yes | none | -| » ard | body | string | yes | none | -| » epstpl | body | string | yes | none | -| » contextId | body | string | yes | none | -| » apnContext | body | string | yes | none | -| » staticIp | body | string | yes | The static IP refers to the static IP assigned to the 4G UE. It can be omitted if not available. | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | string | true | none | none | -| » msg | string | true | none | none | - -## PUT Subscriber - -PUT /ne/udm/sub/{neId} - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------------------------ | -| neId | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » msisdn | body | string | yes | none | -| » imsi | body | string | yes | none | -| » ambr | body | string | yes | none | -| » nssai | body | string | yes | none | -| » rat | body | string | yes | none | -| » arfb | body | string | yes | none | -| » sar | body | string | yes | none | -| » cn | body | string | yes | none | -| » smData | body | string | yes | none | -| » smfSel | body | string | yes | none | -| » epsDat | body | string | yes | none | -| » epsFlag | body | string | yes | none | -| » epsOdb | body | string | yes | none | -| » hplmnOdb | body | string | yes | none | -| » ard | body | string | yes | none | -| » epstpl | body | string | yes | none | -| » contextId | body | string | yes | none | -| » apnContext | body | string | yes | none | -| » staticIp | body | string | yes | The static IP refers to the static IP assigned to the 4G UE. It can be omitted if not available. | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## POST Batch Add Subscribers - -POST /ne/udm/sub/{neId}/{num} - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------------------------ | -| neId | path | string | yes | none | -| num | path | string | yes | Subscriber number | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » msisdn | body | string | yes | none | -| » imsi | body | string | yes | none | -| » ambr | body | string | yes | none | -| » nssai | body | string | yes | none | -| » rat | body | string | yes | none | -| » arfb | body | string | yes | none | -| » sar | body | string | yes | none | -| » cn | body | string | yes | none | -| » smData | body | string | yes | none | -| » smfSel | body | string | yes | none | -| » epsDat | body | string | yes | none | -| » epsFlag | body | string | yes | none | -| » epsOdb | body | string | yes | none | -| » hplmnOdb | body | string | yes | none | -| » ard | body | string | yes | none | -| » epstpl | body | string | yes | none | -| » contextId | body | string | yes | none | -| » apnContext | body | string | yes | none | -| » staticIp | body | string | yes | The static IP refers to the static IP assigned to the 4G UE. It can be omitted if not available. | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## DELETE Batch Delete Subscriber - -DELETE /ne/udm/sub/{neId}/{imsi}/{num} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| imsi | path | string | yes | none | -| num | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | string | true | none | none | -| » msg | string | true | none | none | - -## POST Export Subscriber - -POST /ne/udm/sub/export - -> Body Parameters - -```json -{ - "neId": "string", - "type": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » neId | body | string | yes | none | -| » type | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## PUT Reload data for Redis - -PUT /ne/udm/sub/resetData/{neId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "System Management", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "User Management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "Role Management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "Role assign to user", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "Menu management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "Department management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "Postion management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "Dictionary management", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "Dictionary data", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Log management", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "Operation log", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "Security log", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "System monitor", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "Server monitor", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "Cache monitor", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "Cache list", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "Online users", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "Scheduling tasks", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» name | string | true | none | none | -| »» path | string | true | none | none | -| »» component | string | true | none | | -| »» meta | object | true | none | none | -| »»» icon | string | true | none | none | -| »»» title | string | true | none | none | -| »»» hide | boolean | true | none | none | -| »»» cache | boolean | true | none | none | -| »»» target | string¦null | true | none | none | -| »» redirect | string | false | none | none | -| »» children | [object] | false | none | none | -| »»» name | string | true | none | none | -| »»» path | string | true | none | none | -| »»» component | string | true | none | none | -| »»» meta | object | true | none | none | -| »»»» icon | string | true | none | none | -| »»»» title | string | true | none | none | -| »»»» hide | boolean | true | none | none | -| »»»» cache | boolean | true | none | none | -| »»»» target | string¦null | true | none | none | - -## POST Import subscriber list - -POST /ne/udm/sub/import - -> Body Parameters - -```yaml -neId: "002" -file: string - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » neId | body | string | yes | none | -| » file | body | string(binary) | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## GET Aquire subscriber list - -GET /ne/udm/sub/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| msisdn | query | string | no | none | -| imsi | query | string | no | none | -| neId | query | string | no | none | -| sortField | query | string | no | none | -| sortOrder | query | string | no | none | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "340065", - "msisdn": "12399999100", - "imsi": "460009999999100", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "342252", - "msisdn": "12399999099", - "imsi": "460009999999099", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "344385", - "msisdn": "12399999098", - "imsi": "460009999999098", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "344268", - "msisdn": "12399999097", - "imsi": "460009999999097", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "339149", - "msisdn": "12399999096", - "imsi": "460009999999096", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "342539", - "msisdn": "12399999095", - "imsi": "460009999999095", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "339650", - "msisdn": "12399999094", - "imsi": "460009999999094", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "342061", - "msisdn": "12399999093", - "imsi": "460009999999093", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "342845", - "msisdn": "12399999092", - "imsi": "460009999999092", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - }, - { - "id": "339595", - "msisdn": "12399999091", - "imsi": "460009999999091", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "0,64,24,65,def_eps,1,1,200000000000,010200000000", - "neId": "", - "epsFlag": "0", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "200000000000", - "staticIp": "010200000000" - } - ], - "total": 37094 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » rows | [object] | true | none | none | -| »» id | string | true | none | none | -| »» msisdn | string | true | none | none | -| »» imsi | string | true | none | none | -| »» ambr | string | true | none | none | -| »» nssai | string | true | none | none | -| »» rat | string | true | none | none | -| »» arfb | string | true | none | none | -| »» sar | string | true | none | none | -| »» cn | string | true | none | none | -| »» smData | string | true | none | none | -| »» smfSel | string | true | none | none | -| »» epsDat | string | true | none | none | -| »» neId | string | true | none | none | -| »» epsFlag | string | true | none | none | -| »» epsOdb | string | true | none | none | -| »» hplmnOdb | string | true | none | none | -| »» ard | string | true | none | none | -| »» epstpl | string | true | none | none | -| »» contextId | string | true | none | none | -| »» apnContext | string | true | none | none | -| »» staticIp | string | true | none | none | -| » total | integer | true | none | none | - -# UE Management/UDM Authentication Data - -## GET Authentication data list - -GET /ne/udm/auth/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| neId | query | string | no | none | -| imsi | query | string | no | none | -| msisdn | query | string | no | none | -| sortField | query | string | no | none | -| sortOrder | query | string | no | none | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": { - "rows": [ - { - "id": "1", - "imsi": "460000100023631", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "2", - "imsi": "460009999996296", - "amf": "8000", - "status": "0", - "ki": "12345678901234567890123456789012", - "algoIndex": "0", - "opc": "212E3B94279CB0F8095A55E8EF5569F7", - "neId": "" - }, - { - "id": "3", - "imsi": "460001100000793", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "4", - "imsi": "460000100018255", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "5", - "imsi": "460000100008970", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "6", - "imsi": "460000100019859", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "7", - "imsi": "460000100015591", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "8", - "imsi": "460119999999587", - "amf": "8000", - "status": "0", - "ki": "12345678901234567890123456789012", - "algoIndex": "0", - "opc": "212E3B94279CB0F8095A55E8EF5569F7", - "neId": "" - }, - { - "id": "9", - "imsi": "460009999992973", - "amf": "8000", - "status": "0", - "ki": "12345678901234567890123456789012", - "algoIndex": "0", - "opc": "212E3B94279CB0F8095A55E8EF5569F7", - "neId": "" - }, - { - "id": "10", - "imsi": "460000100027485", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - } - ], - "total": 37981 - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "20232", - "msisdn": "12346001956", - "imsi": "460001100001956", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "001" - }, - { - "id": "20233", - "msisdn": "13407550852", - "imsi": "460000200000852", - "amf": "8000", - "status": "1", - "ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66", - "algoIndex": "0", - "opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66", - "neId": "001" - }, - { - "id": "20234", - "msisdn": "12346001008", - "imsi": "460001100001008", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "001" - }, - { - "id": "20235", - "msisdn": "13407550581", - "imsi": "460000200000581", - "amf": "8000", - "status": "1", - "ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66", - "algoIndex": "0", - "opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66", - "neId": "001" - }, - { - "id": "20236", - "msisdn": "12346001144", - "imsi": "460001100001144", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "001" - }, - { - "id": "20237", - "msisdn": "13407550473", - "imsi": "460000200000473", - "amf": "8000", - "status": "1", - "ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66", - "algoIndex": "0", - "opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66", - "neId": "001" - }, - { - "id": "20238", - "msisdn": "13407550135", - "imsi": "460000200000135", - "amf": "8000", - "status": "1", - "ki": "d94a7a4a938a8c4e830e571e7267680a3489719b37fcbc66", - "algoIndex": "0", - "opc": "36fb9f7521c2df81d8bfbe0c1e7cd4293489719b37fcbc66", - "neId": "001" - }, - { - "id": "20239", - "msisdn": "12346001321", - "imsi": "460001100001321", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "001" - }, - { - "id": "20240", - "msisdn": "12346001754", - "imsi": "460001100001754", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "001" - }, - { - "id": "20241", - "msisdn": "12346001360", - "imsi": "460001100001360", - "amf": "8000", - "status": "0", - "ki": "1307cd53d3d0c2b2a32ab3a7decd03a93489719b37fcbc66", - "algoIndex": "0", - "opc": "-", - "neId": "001" - } - ], - "total": 2019 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| -------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » rows | [object] | true | none | none | -| »» id | string | true | none | none | -| »» imsi | string | true | none | none | -| »» amf | string | true | none | none | -| »» status | string | true | none | none | -| »» ki | string | true | none | none | -| »» algoIndex | string | true | none | none | -| »» opc | string | true | none | none | -| »» neId | string | true | none | none | -| » total | integer | true | none | none | - -## GET Auth data - -GET /ne/udm/auth/{neId}/{imsi} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| neId | path | string | yes | none | -| imsi | path | string | yes | none | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": { - "id": "", - "msisdn": "", - "imsi": "460001100001071", - "amf": "8000", - "status": "", - "ki": "*", - "algoIndex": "0", - "opc": "*", - "neId": "" - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": { - "id": "1", - "imsi": "460000100023631", - "amf": "8000", - "status": "0", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| -------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» id | string | true | none | none | -| »» imsi | string | true | none | none | -| »» amf | string | true | none | none | -| »» status | string | true | none | none | -| »» ki | string | true | none | none | -| »» algoIndex | string | true | none | none | -| »» opc | string | true | none | none | -| »» neId | string | true | none | none | -| » msg | string | true | none | none | - -## DELETE Delete auth data - -DELETE /ne/udm/auth/{neId}/{imsi} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| imsi | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## PUT Reload data from Redis - -PUT /ne/udm/auth/resetData/{neId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | integer | true | none | none | -| » msg | string | true | none | none | - -## POST Add auth data - -POST /ne/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » algoIndex | body | string | yes | none | -| » amf | body | string | yes | none | -| » imsi | body | string | yes | none | -| » ki | body | string | yes | none | -| » opc | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | string | true | none | none | -| » msg | string | true | none | none | - -## PUT Modify auth data - -PUT /ne/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » algoIndex | body | string | yes | none | -| » amf | body | string | yes | none | -| » imsi | body | string | yes | none | -| » ki | body | string | yes | none | -| » opc | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST Batch add auth data - -POST /ne/udm/auth/{neId}/{num} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| num | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » algoIndex | body | string | yes | none | -| » amf | body | string | yes | none | -| » imsi | body | string | yes | none | -| » ki | body | string | yes | none | -| » opc | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | string | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Batch delete auth data - -DELETE /ne/udm/auth/{neId}/{imsi}/{num} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | path | string | yes | none | -| imsi | path | string | yes | none | -| num | path | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST Export auth data - -POST /ne/udm/auth/export - -> Body Parameters - -```json -{ - "neId": "string", - "type": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » neId | body | string | yes | none | -| » type | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | integer | true | none | none | - -## POST Import auth data - -POST /ne/udm/auth/import - -> Body Parameters - -```yaml -neId: "002" -file: string - -``` - -### Params - -| Name | Location | Type | Required | Title | Description | -| --------------- | -------- | -------------- | -------- | ----- | ------------------- | -| Authorization | header | string | yes | | Authoirzation token | -| Referer | header | string | yes | | User Referer | -| User-Agent | header | string | yes | | User Agent | -| Accept-Language | header | string | yes | | en_US;q=0.9 | -| AccessToken | header | string | no | | Access token | -| body | body | object | no | | none | -| » neId | body | string | yes | | none | -| » file | body | string(binary) | yes | | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "msg": "import ok, succ num: 36891, fail num: 1092." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# UE Management/PCF User PCC Rules - -## GET Query PCF UE Info - -GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| imsi | query | string | no | none | -| msisdn | query | string | no | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> Success - -```json -{ - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] -} -``` - -```json -{ - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] -} -``` - -```json -{ - "data": [ - { - "hdrEnrich": "dnn", - "imsi": "460990100000006", - "msisdn": "86755900001", - "pccRules": "internet|ims_sig", - "qosAudio": "qos_audio", - "qosVideo": "qos_video", - "rfsp": 1, - "sar": "def_sar", - "sessRules": "internet|ims_sig", - "uePolicy": "uep_001" - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Add PCF UE Info - -POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -> Body Parameters - -```json -{ - "imsi": "460990100000002", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| neId | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » msisdn | body | string | yes | none | -| » rfsp | body | integer | no | none | -| » sar | body | string | no | none | -| » pccRules | body | string | no | none | -| » sessRules | body | string | no | none | -| » uePolicy | body | string | no | none | -| » qosAudio | body | string | no | none | -| » qosVideo | body | string | no | none | -| » hdrEnrich | body | string | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Modify PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -> Body Parameters - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| imsi | query | string | no | none | -| msisdn | query | string | no | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » msisdn | body | string | no | none | -| » rfsp | body | integer | no | none | -| » sar | body | string | no | none | -| » pccRules | body | string | no | none | -| » sessRules | body | string | no | none | -| » uePolicy | body | string | no | none | -| » qosAudio | body | string | no | none | -| » qosVideo | body | string | no | none | -| » hdrEnrich | body | string | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete PCF UE Info - -DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| imsi | query | string | yes | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> Record Not Found - -```json -{ - "cause": "DATA_NOT_FOUND", - "status": 404 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ----------------------------------------------------------- | ---------------- | ----------- | -| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Record Not Found | Inline | - -### Responses Data Schema - -HTTP Status Code **404** - -| Name | Type | Required | Restrictions | description | -| --------- | ------- | -------- | ------------ | ----------- | -| » cause | string | true | none | none | -| » status | integer | true | none | none | - -## POST Batch Add PCF UE Info - -POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number} - -> Body Parameters - -```json -{ - "num": 11, - "imsi": "260990100000001", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video", - "neId": "001" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| number | path | string | yes | none | -| neId | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » msisdn | body | string | yes | none | -| » rfsp | body | integer | no | none | -| » sar | body | string | no | none | -| » pccRules | body | string | no | none | -| » sessRules | body | string | no | none | -| » uePolicy | body | string | no | none | -| » qosAudio | body | string | no | none | -| » qosVideo | body | string | no | none | -| » hdrEnrich | body | string | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Batch Modify PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number} - -> Body Parameters - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| number | path | string | yes | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » msisdn | body | string | yes | none | -| » rfsp | body | integer | yes | none | -| » sar | body | string | yes | none | -| » pccRules | body | string | yes | none | -| » sessRules | body | string | yes | none | -| » uePolicy | body | string | yes | none | -| » qosAudio | body | string | yes | none | -| » qosVideo | body | string | yes | none | -| » hdrEnrich | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Batch Delete PCF UE Info - -DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| number | path | string | yes | none | -| neId | query | string | yes | none | -| imsi | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "cause": "no imsi", - "status": 400 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Export PCF UE Info - -GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/export - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | query | string | yes | none | -| fileType | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Import PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/import - -> Body Parameters - -```json -{ - "neId": "001", - "type": "txt", - "filePath": "xxx.txt" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| neId | query | string | yes | none | -| filePath | query | string | yes | none | -| fileType | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » imsi | body | string | yes | none | -| » msisdn | body | string | yes | none | -| » rfsp | body | integer | yes | none | -| » sar | body | string | yes | none | -| » pccRules | body | string | yes | none | -| » sessRules | body | string | yes | none | -| » uePolicy | body | string | yes | none | -| » qosAudio | body | string | yes | none | -| » qosVideo | body | string | yes | none | -| » hdrEnrich | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "detail": "[Request Body] unexpected end of JSON input", - "status": 400, - "title": "Malformed request syntax" -} -``` - -```json -{ - "neId": "001", - "fileType": "txt", - "filePath": "/home/agtuser/PCF_001_1701420431873_zsda89.txt" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------- | ------ | -------- | ------------ | ----------- | -| » neId | string | true | none | none | -| » fileType | string | true | none | none | -| » filePath | string | true | none | none | - -# UE Management/N3IWF Online User - -## GET Query N3IWF UE Info - -GET /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| imsi | query | string | no | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> OK - -```json -{ - "data": [ - { - "activeTime": "2023-11-29 06:35:43", - "imsi": "460302072701181", - "nai": "0460302072701181@nai.epc.mnc030.mcc460.3gppnetwork.org", - "regState": 1 - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » data | [object] | true | none | none | -| »» activeTime | string | false | none | none | -| »» imsi | string | false | none | none | -| »» nai | string | false | none | none | -| »» regState | integer | false | none | none | - -# UE Management/NodeB Information - -## GET Get NB Info from AMF - -GET /api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| nbId | query | string | yes | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/IMS Online User - -## GET Get UE Info from IMS - -GET /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| imsi | query | string | yes | none | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/SMF Online User - -## GET Get UE Info from SMF - -GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------- | -| neId | query | string | yes | Only required sent to OMC | -| imsi | query | string | no | none | -| msisdn | query | string | no | none | -| upstate | query | string | no | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get UE Number from SMF - -GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neId | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/General APIs - -## GET Aquire NE info by neType neID - -GET /ne/info - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| neType | query | string | yes | none | -| neId | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Send files to the network element. - -POST /ne/action/pushFile - -> Body Parameters - -```json -{ - "uploadPath": "string", - "neType": "string", - "neId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------ | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » uploadPath | body | string | yes | Upload a file through the general interface to obtain the address. | -| » neType | body | string | yes | NE type | -| » neId | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": "/home/agtuser/5GC.pdf", - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | string | true | none | none | -| » msg | string | true | none | none | - -# MML - -## POST Post UDM subscriber MML - -POST /api/rest/operationManagement/v1/elementType/udm/objectType/mml - -> Body Parameters - -```json -{ - "mml": [ - "date", - "dsp authdat:imsi=460000100000030" - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | ------------------- | -| ne_id | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » mml | body | [string] | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post OMC MMLs - -POST /api/rest/operationManagement/v1/elementType/omc/objectType/mml - -> Body Parameters - -```json -{ - "mml": [ - "date", - "date" - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | ------------------- | -| ne_id | query | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » mml | body | [string] | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# Security/Department Management - -## GET Department List - -GET /system/dept/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| status | query | string | no | Status (0 Inactive 1Active） | -| deptName | query | string | no | Department name | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "System Maintenance Department", - "orderNum": 0, - "leader": "supervisor", - "phone": "", - "email": "", - "status": "1", - "delFlag": "0", - "createBy": "supervisor", - "createTime": 1699348237468, - "updateBy": "", - "updateTime": 0 - }, - { - "deptId": "101", - "parentId": "100", - "ancestors": "0,100", - "deptName": "Operation and Maintenance Department One", - "orderNum": 1, - "leader": "supervisor", - "phone": "", - "email": "", - "status": "1", - "delFlag": "0", - "createBy": "supervisor", - "createTime": 1699348237468, - "updateBy": "", - "updateTime": 0 - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | [object] | true | none | none | -| »» deptId | string | true | none | none | -| »» parentId | string | true | none | none | -| »» ancestors | string | true | none | none | -| »» deptName | string | true | none | none | -| »» orderNum | integer | true | none | none | -| »» leader | string | true | none | none | -| »» phone | string | true | none | none | -| »» email | string | true | none | none | -| »» status | string | true | none | 0 1 | -| »» delFlag | string | true | none | 0 1 | -| »» createBy | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Department List (Excluding) - -GET /system/dept/list/exclude/{deptId} - -When performing update operations, optional superiors should exclude all nodes under the current department - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| deptId | path | string | yes | Department ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "System Maintenance Department", - "orderNum": 0, - "leader": "supervisor", - "phone": "", - "email": "", - "status": "1", - "delFlag": "0", - "createBy": "supervisor", - "createTime": 1699348237468, - "updateBy": "", - "updateTime": 0 - }, - { - "deptId": "101", - "parentId": "100", - "ancestors": "0,100", - "deptName": "Operation and Maintenance Department One", - "orderNum": 1, - "leader": "supervisor", - "phone": "", - "email": "", - "status": "1", - "delFlag": "0", - "createBy": "supervisor", - "createTime": 1699348237468, - "updateBy": "", - "updateTime": 0 - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | [object] | true | none | none | -| »» deptId | string | true | none | none | -| »» parentId | string | true | none | none | -| »» ancestors | string | true | none | none | -| »» deptName | string | true | none | none | -| »» orderNum | integer | true | none | none | -| »» leader | string | true | none | none | -| »» phone | string | true | none | none | -| »» email | string | true | none | none | -| »» status | string | true | none | none | -| »» delFlag | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Department Tree List - -GET /system/dept/treeSelect - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------- | -| status | query | string | no | Status (0 Inactive 1 Active) | -| deptName | query | string | no | Department Name | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "id": "100", - "label": "System Maintenance Department", - "children": [ - { - "id": "101", - "label": "Operation and Maintenance Department One", - "children": [] - } - ] - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | [object] | true | none | none | -| »» id | string | false | none | none | -| »» label | string | false | none | none | -| »» children | [object] | false | none | none | -| »»» id | string | false | none | none | -| »»» label | string | false | none | none | -| »»» children | [string] | false | none | none | -| » msg | string | true | none | none | - -## GET Department Tree List (specified roles) - -GET /system/dept/roleDeptTreeSelect/{roleId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| roleId | path | string | yes | Role ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "checkedKeys": [], - "depts": [ - { - "id": "100", - "label": "System Maintenance Department", - "children": [ - { - "id": "101", - "label": "Operation and Maintenance Department One", - "children": [] - } - ] - } - ] - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» checkedKeys | [string] | true | none | none | -| »» depts | [object] | true | none | none | -| »»» id | string | false | none | none | -| »»» label | string | false | none | none | -| »»» children | [object] | false | none | none | -| »»»» id | string | false | none | none | -| »»»» label | string | false | none | none | -| »»»» children | [string] | false | none | none | -| » msg | string | true | none | none | - -## POST New Departmnt - -POST /system/dept - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible department data!" -} -``` - -```json -{ - "code": 0, - "msg": "Manipulate department [Jcmgc Qinimfn Axrfrd Xbjdczfoe] failed, department name already exists!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT Department Modification - -PUT /system/dept - -> Body Parameters - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string", - "deptId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » orderNum | body | integer | yes | none | -| » deptName | body | string | yes | none | -| » leader | body | string | yes | none | -| » phone | body | string | yes | none | -| » email | body | string | yes | none | -| » status | body | string | yes | 0 Inactive 1 Active | -| » parentId | body | string | yes | none | -| » parentName | body | string | no | none | -| » deptId | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible department data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE Department Deletion - -DELETE /system/dept/{deptId} - -### Params - -| Name | Location | Type | Required | Title | Description | -| --------------- | -------- | ------ | -------- | ----- | ------------------- | -| deptId | path | string | yes | | Department ID | -| Authorization | header | string | yes | | Authoirzation token | -| Referer | header | string | yes | | User Referer | -| User-Agent | header | string | yes | | User Agent | -| Accept-Language | header | string | yes | | en_US;q=0.9 | -| AccessToken | header | string | no | | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible department data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Department Info - -GET /system/dept/{deptId} - -### Params - -| Name | Location | Type | Required | Title | Description | -| --------------- | -------- | ------ | -------- | ----- | ------------------- | -| deptId | path | string | yes | | Department ID | -| Authorization | header | string | yes | | Authoirzation token | -| Referer | header | string | yes | | User Referer | -| User-Agent | header | string | yes | | User Agent | -| Accept-Language | header | string | yes | | en_US;q=0.9 | -| AccessToken | header | string | no | | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "deptId": "107", - "parentId": "0", - "ancestors": "0", - "deptName": "Jcmgc Qinimfn Axrfrd Xbjdczfoe", - "orderNum": 516, - "leader": "Kimberly Lewis", - "phone": "19845657348", - "email": "h.cwijngubul@pijpufk.sr", - "status": "0", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» deptId | string | true | none | none | -| »» parentId | string | true | none | none | -| »» ancestors | string | true | none | none | -| »» deptName | string | true | none | none | -| »» orderNum | integer | true | none | none | -| »» leader | string | true | none | none | -| »» phone | string | true | none | none | -| »» email | string | true | none | none | -| »» status | string | true | none | 0 1 | -| »» parentName | string | true | none | none | - -# Security/Menu Management - -## GET Menu List - -GET /system/menu/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------- | -| menuName | query | string | no | Menu Name | -| status | query | string | no | Menu status 0 Inactive 1 Active | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": [ - { - "menuId": "111", - "menuName": "System Log", - "parentId": "1", - "menuSort": 11, - "path": "log", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "0", - "status": "0", - "perms": "", - "icon": "#", - "createBy": "", - "createTime": 1700000000000, - "updateBy": "", - "updateTime": 0, - "remark": "System Log Catalog" - }, - { - "menuId": "2102", - "menuName": "Performance Reports", - "parentId": "2099", - "menuSort": 3, - "path": "perfReport", - "component": "perfManage/perfReport/index", - "isFrame": "1", - "isCache": "0", - "menuType": "M", - "visible": "0", - "status": "0", - "perms": "perfManage:perfReport:index", - "icon": "icon-gonggaodayi", - "createBy": "", - "createTime": 1700000000000, - "updateBy": "", - "updateTime": 0, - "remark": "Performance Report Menu" - }, - { - "menuId": "2105", - "menuName": "Custom Metrics", - "parentId": "2099", - "menuSort": 6, - "path": "customTarget", - "component": "perfManage/customTarget/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "0", - "perms": "perfManage:customTarget:index", - "icon": "icon-fanhui1", - "createBy": "", - "createTime": 1700000000000, - "updateBy": "", - "updateTime": 0, - "remark": "Custom Metrics Menu" - }, - { - "menuId": "2106", - "menuName": "Performance General Settings", - "parentId": "2099", - "menuSort": 7, - "path": "perfSet", - "component": "perfManage/perfSet/index", - "isFrame": "1", - "isCache": "0", - "menuType": "M", - "visible": "0", - "status": "0", - "perms": "perfManage:perfSet:index", - "icon": "icon-gonggao", - "createBy": "", - "createTime": 1700000000000, - "updateBy": "", - "updateTime": 0, - "remark": "Performance General Settings Menu" - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» menuId | string | true | none | none | -| »» menuName | string | true | none | none | -| »» parentId | string | true | none | none | -| »» menuSort | integer | true | none | none | -| »» path | string | true | none | none | -| »» component | string | true | none | none | -| »» isFrame | string | true | none | none | -| »» isCache | string | true | none | none | -| »» menuType | string | true | none | none | -| »» visible | string | true | none | none | -| »» status | string | true | none | none | -| »» perms | string | true | none | none | -| »» icon | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## GET Menu Info - -GET /system/menu/{menuId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| menuId | path | string | yes | Menu ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» menuId | string | true | none | none | -| »» menuName | string | true | none | none | -| »» parentId | string | true | none | none | -| »» menuSort | integer | true | none | none | -| »» path | string | true | none | none | -| »» component | string | true | none | none | -| »» isFrame | string | true | none | none | -| »» isCache | string | true | none | none | -| »» menuType | string | true | none | none | -| »» visible | string | true | none | none | -| »» status | string | true | none | none | -| »» perms | string | true | none | none | -| »» icon | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## DELETE Menu Deletion - -DELETE /system/menu/{menuId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| menuId | path | string | yes | Menu ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT Menu Modification - -PUT /system/menu - -> Body Parameters - -```json -{ - "menuId": "string", - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | --------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » menuId | body | string | yes | none | -| » parentId | body | string | yes | none | -| » menuName | body | string | yes | none | -| » menuType | body | string | yes | D Directory M Menu B Button | -| » menuSort | body | integer | yes | Defatult 0 | -| » isFrame | body | string | no | Required by menu and directory, 0 No 1 Yes | -| » isCache | body | string | no | Required by menu and directory, 0 No cache 1 Cached | -| » visible | body | string | no | Required by menu and directory, 0 Hidden 1 Show | -| » status | body | string | no | Required by menu and directory | -| » icon | body | string | no | Required by menu and directory, #No icon | -| » path | body | string | no | Required by menu and directory, | -| » component | body | string | no | Required by menu, | -| » perms | body | string | no | Required by menu and button, | -| » remark | body | string | no | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST New Menu - -POST /system/menu - -> Body Parameters - -```json -{ - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » parentId | body | string | yes | | -| » menuName | body | string | yes | none | -| » menuType | body | string | yes | | -| » menuSort | body | integer | yes | | -| » isFrame | body | string | no | | -| » isCache | body | string | no | | -| » visible | body | string | no | | -| » status | body | string | no | | -| » icon | body | string | no | | -| » path | body | string | no | | -| » component | body | string | no | | -| » perms | body | string | no | | -| » remark | body | string | no | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Menu Tree List (specifying roles) - -GET /system/menu/roleMenuTreeSelect/{roleId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| roleId | path | string | yes | Role ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» menus | [object] | true | none | none | -| »»» id | string | true | none | none | -| »»» label | string | true | none | none | -| »»» children | [object] | true | none | none | -| »»»» id | string | false | none | none | -| »»»» label | string | false | none | none | -| »»»» children | [object] | false | none | none | -| »» checkedKeys | [object] | true | none | none | - -## GET Menu Tree List - -GET /system/menu/treeSelect - -Using the menu permission list in role addition and modification - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------------- | -| menuName | query | string | no | Menu name | -| status | query | string | no | Menu Status (0 Inactive 1 Active) | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» menus | [object] | true | none | none | -| »»» id | string | true | none | none | -| »»» label | string | true | none | none | -| »»» children | [object] | true | none | none | -| »»»» id | string | false | none | none | -| »»»» label | string | false | none | none | -| »»»» children | [object] | false | none | none | -| »» checkedKeys | [object] | true | none | none | - -# Security/Position Management - -## GET Position List - -GET /system/post/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| postCode | query | string | no | Position Code | -| postName | query | string | no | Position Name | -| status | query | string | no | Status (0 Inactive 1 Active) | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» postId | string | true | none | none | -| »» postCode | string | true | none | none | -| »» postName | string | true | none | none | -| »» postSort | integer | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## POST Position List Export - -POST /system/post/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=post_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "postCode": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » configName | body | string | no | none | -| » postCode | body | string | no | none | -| » status | body | string | no | (0 Inactive 1 Active) | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 0, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Position Info - -GET /system/post/{postId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| postId | path | string | yes | Position ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» postId | string | true | none | none | -| »» postCode | string | true | none | none | -| »» postName | string | true | none | none | -| »» postSort | integer | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## POST New Position - -POST /system/post - -> Body Parameters - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": 0, - "phone": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | --------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » postCode | body | string | yes | none | -| » postName | body | string | yes | none | -| » postSort | body | integer | yes | none | -| » phone | body | string | yes | (0 Inactive 1 Active) | -| » remark | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "Success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT Position Modification - -PUT /system/post - -> Body Parameters - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": 0, - "phone": "string", - "remark": "string", - "postId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | --------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » postCode | body | string | yes | none | -| » postName | body | string | yes | none | -| » postSort | body | integer | yes | none | -| » phone | body | string | yes | (0 Inactive 1 Active) | -| » remark | body | string | yes | none | -| » postId | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "Success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE Position Deletion - -DELETE /system/post/{postIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | -------------------------------- | -| postIds | path | string | yes | Position ID, separated by commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access position data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# Security/User Profile - -## GET User profile - -GET /system/user/profile - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "postGroup": [], - "roleGroup": [ - "Managers" - ], - "user": { - "userId": "2", - "deptId": "", - "userName": "admin", - "nickName": "admin", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "", - "avatar": "", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.2.219", - "loginDate": 1712053821001, - "createBy": "admin", - "createTime": 1697091656500, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "", - "parentId": "", - "ancestors": "", - "deptName": "", - "orderNum": 0, - "leader": "", - "phone": "", - "email": "", - "status": "", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [ - { - "roleId": "2", - "roleName": "Managers", - "roleKey": "administrator", - "roleSort": 2, - "dataScope": "1", - "menuCheckStrictly": "", - "deptCheckStrictly": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ] - } - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| -------------------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» postGroup | [string] | true | none | none | -| »» roleGroup | [string] | true | none | none | -| »» user | object | true | none | none | -| »»» userId | string | true | none | none | -| »»» deptId | string | true | none | none | -| »»» userName | string | true | none | none | -| »»» nickName | string | true | none | none | -| »»» userType | string | true | none | none | -| »»» email | string | true | none | none | -| »»» phonenumber | string | true | none | none | -| »»» sex | string | true | none | none | -| »»» avatar | string | true | none | none | -| »»» status | string | true | none | none | -| »»» delFlag | string | true | none | none | -| »»» loginIp | string | true | none | none | -| »»» loginDate | integer | true | none | none | -| »»» createBy | string | true | none | none | -| »»» createTime | integer | true | none | none | -| »»» updateBy | string | true | none | none | -| »»» updateTime | integer | true | none | none | -| »»» remark | string | true | none | none | -| »»» dept | object | true | none | none | -| »»»» deptId | string | true | none | none | -| »»»» parentId | string | true | none | none | -| »»»» ancestors | string | true | none | none | -| »»»» deptName | string | true | none | none | -| »»»» orderNum | integer | true | none | none | -| »»»» leader | string | true | none | none | -| »»»» phone | string | true | none | none | -| »»»» email | string | true | none | none | -| »»»» status | string | true | none | none | -| »»»» delFlag | string | true | none | none | -| »»»» createBy | string | true | none | none | -| »»»» createTime | integer | true | none | none | -| »»»» updateBy | string | true | none | none | -| »»»» updateTime | integer | true | none | none | -| »»» roles | [object] | true | none | none | -| »»»» roleId | string | false | none | none | -| »»»» roleName | string | false | none | none | -| »»»» roleKey | string | false | none | none | -| »»»» roleSort | integer | false | none | none | -| »»»» dataScope | string | false | none | none | -| »»»» menuCheckStrictly | string | false | none | none | -| »»»» deptCheckStrictly | string | false | none | none | -| »»»» status | string | false | none | none | -| »»»» delFlag | string | false | none | none | -| »»»» createBy | string | false | none | none | -| »»»» createTime | integer | false | none | none | -| »»»» updateBy | string | false | none | none | -| »»»» updateTime | integer | false | none | none | -| »»»» remark | string | false | none | none | -| » msg | string | true | none | none | - -## PUT Modify user profile - -PUT /system/user/profile - -> Body Parameters - -```json -{ - "nickName": "Jack", - "sex": "1", - "phonenumber": "12113313131", - "email": "t.eknevzfl@htejfppo.so" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » nickName | body | string | yes | none | -| » email | body | string | no | none | -| » phonenumber | body | string | no | none | -| » sex | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "Failed to operate user [admin], cell phone number format is wrong." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## POST modify avatar - -POST /system/user/profile/avatar - -> Body Parameters - -```yaml -file: file://D:\Downloads\lightning1.svg - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ----------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | yes | Please choose a proportionally sized image as your avatar, such as 200x200, 400x400 | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": "/upload/avatar/2024/04/earth3d-1_yfz5yx.png", - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "the upload file type is not supported, only the following types are supported: .jpg,.jpeg,.png" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | string | true | none | none | -| » msg | string | true | none | none | - -## PUT Modify password - -PUT /system/user/profile/updatePwd - -> Body Parameters - -```json -{ - "oldPassword": "admin@1234", - "newPassword": "Admin@1234" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » oldPassword | body | string | yes | none | -| » newPassword | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "New password cannot be the same as the old one" -} -``` - -```json -{ - "code": 0, - "msg": "Change password failed, old password is wrong" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# Security/Role Management - -## GET Role list - -GET /system/role/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------- | -| roleName | query | string | no | role name | -| roleKey | query | string | no | role key | -| status | query | string | no | status 0 Inactive 1 Active | -| beginTime | query | string | no | begin time | -| endTime | query | string | no | end time | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» roleId | string | true | none | none | -| »» roleName | string | true | none | none | -| »» roleKey | string | true | none | none | -| »» roleSort | integer | true | none | none | -| »» dataScope | string | true | none | none | -| »» menuCheckStrictly | string | true | none | none | -| »» deptCheckStrictly | string | true | none | none | -| »» status | string | true | none | none | -| »» delFlag | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## GET user list assigned role - -GET /system/role/authUser/allocatedList - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------------------- | -| userName | query | string | no | user name | -| phonenumber | query | string | no | user phone | -| status | query | string | no | user status | -| roleId | query | string | yes | role id | -| allocated | query | string | yes | Has the user been assigned? true/false | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "userName": "user", - "nickName": "general user", - "email": "user@113.sd", - "phonenumber": "13131313", - "status": "1", - "createTime": "1682264526309", - "dept": { - "deptId": "105", - "deptName": "test" - } - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» status | string | false | none | 0 1 | -| »» createTime | string | false | none | none | -| »» roles | [string] | false | none | none | -| »» userId | string | false | none | none | -| »» deptId | string | false | none | none | -| »» userName | string | false | none | none | -| »» nickName | string | false | none | none | -| »» email | string | false | none | none | -| »» phonenumber | string | false | none | none | -| »» dept | object | false | none | none | -| »»» deptId | string | false | none | none | -| »»» deptName | string | false | none | none | - -## GET Role info - -GET /system/role/{roleId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| roleId | path | string | yes | rold ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "roleId": "5", - "roleName": "General Users", - "roleKey": "vistor", - "roleSort": 5, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createBy": "", - "createTime": 1698486975779, - "updateBy": "", - "updateTime": 0, - "remark": "Ordinary users can only see system-related information" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» roleId | string | true | none | none | -| »» roleName | string | true | none | none | -| »» roleKey | string | true | none | none | -| »» roleSort | integer | true | none | none | -| »» dataScope | string | true | none | none | -| »» menuCheckStrictly | string | true | none | none | -| »» deptCheckStrictly | string | true | none | none | -| »» status | string | true | none | none | -| »» delFlag | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | integer | true | none | none | -| »» remark | string | true | none | none | -| » msg | string | true | none | none | - -## PUT modify role - -PUT /system/role - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| -------------------- | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » roleName | body | string | yes | Role name | -| » roleKey | body | string | yes | Role Key | -| » roleSort | body | integer | yes | Role sort | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | Remark | -| » dataScope | body | string | yes | 1: All data permissions 2: Custom data permissions 3: Data permissions for this department 4: Data permissions for this department and below 5: Only personal data permissions) | -| » menuCheckStrictly | body | string | yes | 0: Father and son are not related to each other display 1: Father and son are related to each other display | -| » menuIds | body | [string] | yes | Menu ID list | -| » roleId | body | string | yes | Role ID | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible role data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## POST add role - -POST /system/role - -> Body Parameters - -```json -{ - "roleName": "Khcekcmgb Ewotb Pcy Llsionms Ywolzf Qjin", - "roleKey": "ggggk", - "roleSort": 20, - "status": "0", - "remark": "Rwxr nxs eyxmnydhqq kuuvc tkstmuh lioguto uvfs dcnj egkle ehsvmywb bdmwu nqsncxcwd ofrun wbhnainsl.", - "dataScope": "1", - "menuCheckStrictly": "0", - "menuIds": [ - "250" - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| -------------------- | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » roleName | body | string | yes | Role name | -| » roleKey | body | string | yes | Role key | -| » roleSort | body | integer | yes | Role sort | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | -| » dataScope | body | string | yes | 1: All data permissions 2: Custom data permissions 3: Data permissions for this department 4: Data permissions for this department and below 5: Only personal data permissions) | -| » menuCheckStrictly | body | string | yes | 0: Father and son are not related to each other display 1: Father and son are related to each other display | -| » menuIds | body | [string] | yes | Menu ID list | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## DELETE delete role - -DELETE /system/role/{roleIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------------------------------- | -| roleIds | path | string | yes | Role ID, multiple can be separated by English commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "there is no accessible role data" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## PUT modify role status - -PUT /system/role/changeStatus - -> Body Parameters - -```json -{ - "roleId": "string", - "status": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » roleId | body | string | yes | none | -| » status | body | string | no | 0 Inactive 1 Active | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible role data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify role data scope - -PUT /system/role/dataScope - -> Body Parameters - -```json -{ - "dataScope": "string", - "deptCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| -------------------- | -------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dataScope | body | string | yes | 1: All data permissions 2: Custom data permissions 3: Data permissions for this department 4: Data permissions for this department and below 5: Only personal data permissions) | -| » deptCheckStrictly | body | string | yes | 0: Father and son are not related to each other display 1: Father and son are related to each other display | -| » menuIds | body | [string] | no | Must be passed when selecting data range 2, department ID array | -| » roleId | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible role data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## POST export role data list - -POST /system/role/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=role_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "status": "string", - "beginTime": "string", - "endTime": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » roleName | body | string | no | none | -| » roleKey | body | string | no | none | -| » status | body | string | no | 0 Inactive 1 Active | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | - -> Response Examples - -> OK - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT Role assignment selection authorization - -PUT /system/role/authUser/checked - -> Body Parameters - -```json -{ - "roleId": "string", - "userIds": "string", - "checked": true -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » roleId | body | string | yes | none | -| » userIds | body | string | yes | Multiple can be separated by English commas | -| » checked | body | boolean | yes | true/false(Add/Cancel) | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible role data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# Security/User infomation - -## GET user info - -GET /system/user/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| userName | query | string | no | name | -| phonenumber | query | string | no | phone number | -| status | query | string | no | status | -| beginTime | query | string | no | begin time | -| endTime | query | string | no | end time | -| deptId | query | string | no | department ID | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "userId": "1", - "deptId": "", - "userName": "supervisor", - "nickName": "supervisor", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "", - "avatar": "", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.2.219", - "loginDate": 1712118084711, - "createBy": "admin", - "createTime": 1697091656500, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "", - "parentId": "", - "ancestors": "", - "deptName": "", - "orderNum": 0, - "leader": "", - "phone": "", - "email": "", - "status": "", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [ - { - "roleId": "1", - "roleName": "Super Administrator", - "roleKey": "supervisor", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "", - "deptCheckStrictly": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ] - }, - { - "userId": "2", - "deptId": "", - "userName": "admin", - "nickName": "Admin", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "", - "avatar": "/upload/avatar/2024/04/lightning1_guoolm.png", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.2.219", - "loginDate": 1712124820223, - "createBy": "admin", - "createTime": 1697091656500, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "", - "parentId": "", - "ancestors": "", - "deptName": "", - "orderNum": 0, - "leader": "", - "phone": "", - "email": "", - "status": "", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [ - { - "roleId": "2", - "roleName": "Managers", - "roleKey": "administrator", - "roleSort": 2, - "dataScope": "1", - "menuCheckStrictly": "", - "deptCheckStrictly": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ] - }, - { - "userId": "103", - "deptId": "", - "userName": "manager", - "nickName": "manager", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "", - "avatar": "", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.2.219", - "loginDate": 1701425631740, - "createBy": "admin", - "createTime": 1698661521780, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "", - "parentId": "", - "ancestors": "", - "deptName": "", - "orderNum": 0, - "leader": "", - "phone": "", - "email": "", - "status": "", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [ - { - "roleId": "3", - "roleName": "Operators", - "roleKey": "operator", - "roleSort": 3, - "dataScope": "1", - "menuCheckStrictly": "", - "deptCheckStrictly": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ] - }, - { - "userId": "104", - "deptId": "", - "userName": "monitor", - "nickName": "monitor", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "", - "avatar": "", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.2.219", - "loginDate": 1699345510602, - "createBy": "admin", - "createTime": 1698661684898, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "", - "parentId": "", - "ancestors": "", - "deptName": "", - "orderNum": 0, - "leader": "", - "phone": "", - "email": "", - "status": "", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [ - { - "roleId": "4", - "roleName": "Monitor", - "roleKey": "monitor", - "roleSort": 4, - "dataScope": "1", - "menuCheckStrictly": "", - "deptCheckStrictly": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ] - }, - { - "userId": "106", - "deptId": "100", - "userName": "admin1", - "nickName": "admin1", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "1", - "avatar": "", - "status": "0", - "delFlag": "0", - "loginIp": "", - "loginDate": 0, - "createBy": "admin", - "createTime": 1701424142061, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "System Maintenance Department", - "orderNum": 0, - "leader": "supervisor", - "phone": "", - "email": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [] - } - ], - "total": 5 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------------ | -------- | -------- | ------------ | ------------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » rows | [object] | true | none | none | -| »» userId | string | true | none | none | -| »» deptId | string | true | none | none | -| »» userName | string | true | none | none | -| »» nickName | string | true | none | none | -| »» userType | string | true | none | none | -| »» email | string | true | none | none | -| »» phonenumber | string | true | none | none | -| »» sex | string | true | none | 1male 2female | -| »» avatar | string | true | none | none | -| »» status | string | true | none | none | -| »» delFlag | string | true | none | none | -| »» loginIp | string | true | none | none | -| »» loginDate | integer | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | integer | true | none | none | -| »» remark | string | true | none | none | -| »» dept | object | true | none | none | -| »»» deptId | string | true | none | none | -| »»» parentId | string | true | none | none | -| »»» ancestors | string | true | none | none | -| »»» deptName | string | true | none | none | -| »»» orderNum | integer | true | none | none | -| »»» leader | string | true | none | none | -| »»» phone | string | true | none | none | -| »»» email | string | true | none | none | -| »»» status | string | true | none | none | -| »»» delFlag | string | true | none | none | -| »»» createBy | string | true | none | none | -| »»» createTime | integer | true | none | none | -| »»» updateBy | string | true | none | none | -| »»» updateTime | integer | true | none | none | -| »» roles | [object] | true | none | none | -| »»» roleId | string | true | none | none | -| »»» roleName | string | true | none | none | -| »»» roleKey | string | true | none | none | -| »»» roleSort | integer | true | none | none | -| »»» dataScope | string | true | none | none | -| »»» menuCheckStrictly | string | true | none | none | -| »»» deptCheckStrictly | string | true | none | none | -| »»» status | string | true | none | none | -| »»» delFlag | string | true | none | none | -| »»» createBy | string | true | none | none | -| »»» createTime | integer | true | none | none | -| »»» updateBy | string | true | none | none | -| »»» updateTime | integer | true | none | none | -| »»» remark | string | true | none | none | -| » total | integer | true | none | none | - -## GET user info by id - -GET /system/user/{userId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| userId | path | string | yes | User ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "postIds": [], - "posts": [ - { - "postId": "1", - "postCode": "administator", - "postName": "Systems", - "postSort": 1, - "status": "1", - "createBy": "supervisor", - "createTime": 1697110106499, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "postId": "2", - "postCode": "operator", - "postName": "Management", - "postSort": 2, - "status": "1", - "createBy": "supervisor", - "createTime": 1697110106499, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "postId": "3", - "postCode": "monitor", - "postName": "Operation & Maintenance", - "postSort": 3, - "status": "1", - "createBy": "supervisor", - "createTime": 1697110106499, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "postId": "4", - "postCode": "visitor", - "postName": "Monitoring", - "postSort": 4, - "status": "1", - "createBy": "supervisor", - "createTime": 1697110106499, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "postId": "5", - "postCode": "111", - "postName": "test1", - "postSort": 7, - "status": "0", - "createBy": "admin", - "createTime": 1701766022383, - "updateBy": "", - "updateTime": 0, - "remark": "remark" - } - ], - "roleIds": [ - "2" - ], - "roles": [ - { - "roleId": "2", - "roleName": "Managers", - "roleKey": "administrator", - "roleSort": 2, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createBy": "", - "createTime": 1698486915894, - "updateBy": "", - "updateTime": 0, - "remark": "Administrators can perform any operation on the device" - }, - { - "roleId": "3", - "roleName": "Operators", - "roleKey": "operator", - "roleSort": 3, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createBy": "", - "createTime": 1698486934900, - "updateBy": "", - "updateTime": 0, - "remark": "Operation and maintenance personnel can read data from the device and configure the device, but cannot perform software upgrade operations on the device." - }, - { - "roleId": "4", - "roleName": "Monitor", - "roleKey": "monitor", - "roleSort": 4, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createBy": "", - "createTime": 1698486950714, - "updateBy": "", - "updateTime": 0, - "remark": "Monitoring personnel Can only read data from the device, but cannot make any settings on the device" - }, - { - "roleId": "5", - "roleName": "General Users", - "roleKey": "vistor", - "roleSort": 5, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createBy": "", - "createTime": 1698486975779, - "updateBy": "", - "updateTime": 0, - "remark": "Ordinary users can only see system-related information" - } - ], - "user": { - "userId": "2", - "deptId": "", - "userName": "admin", - "nickName": "Admin", - "userType": "sys", - "email": "", - "phonenumber": "", - "sex": "", - "avatar": "/upload/avatar/2024/04/lightning1_guoolm.png", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.2.219", - "loginDate": 1712124820223, - "createBy": "admin", - "createTime": 1697091656500, - "updateBy": "", - "updateTime": 0, - "remark": "", - "dept": { - "deptId": "", - "parentId": "", - "ancestors": "", - "deptName": "", - "orderNum": 0, - "leader": "", - "phone": "", - "email": "", - "status": "", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "roles": [ - { - "roleId": "2", - "roleName": "Managers", - "roleKey": "administrator", - "roleSort": 2, - "dataScope": "1", - "menuCheckStrictly": "", - "deptCheckStrictly": "", - "status": "1", - "delFlag": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ] - } - }, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "No accessible user data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------------ | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» user | object | true | none | none | -| »»» roles | [object] | true | none | none | -| »»»» roleId | string | false | none | none | -| »»»» roleName | string | false | none | none | -| »»»» roleKey | string | false | none | none | -| »»»» roleSort | integer | false | none | none | -| »»»» dataScope | string | false | none | none | -| »»»» status | string | false | none | none | -| »»» userId | string | true | none | none | -| »»» deptId | string¦null | true | none | none | -| »»» userName | string | true | none | none | -| »»» nickName | string | true | none | none | -| »»» email | string | true | none | none | -| »»» avatar | string | true | none | none | -| »»» phonenumber | string | true | none | none | -| »»» sex | string | true | none | none | -| »»» status | string | true | none | none | -| »»» delFlag | string | true | none | none | -| »»» loginIp | string | true | none | none | -| »»» loginDate | string | true | none | none | -| »»» createBy | string | true | none | none | -| »»» createTime | string | true | none | none | -| »»» remark | string¦null | true | none | none | -| »»» dept | object | true | none | none | -| »»»» deptId | string | true | none | none | -| »»»» parentId | string | true | none | none | -| »»»» ancestors | string | true | none | none | -| »»»» deptName | string | true | none | none | -| »»»» orderNum | integer | true | none | none | -| »»»» leader | string | true | none | none | -| »»»» status | string | true | none | none | -| »»»» phone | string | false | none | none | -| »»»» email | string | false | none | none | -| »» roleIds | [string] | true | none | none | -| »» postIds | [string] | true | none | none | -| »» roles | [object] | true | none | none | -| »»» roleId | string | true | none | none | -| »»» roleName | string | true | none | none | -| »»» roleKey | string | true | none | none | -| »»» roleSort | integer | true | none | none | -| »»» dataScope | string | true | none | none | -| »»» menuCheckStrictly | string | true | none | none | -| »»» deptCheckStrictly | string | true | none | none | -| »»» status | string | true | none | none | -| »»» delFlag | string | true | none | none | -| »»» createTime | string | true | none | none | -| »»» remark | string | true | none | none | -| »» posts | [object] | true | none | none | -| »»» postId | string | true | none | none | -| »»» postCode | string | true | none | none | -| »»» postName | string | true | none | none | -| »»» postSort | integer | true | none | none | -| »»» status | string | true | none | none | -| »»» createBy | string | true | none | none | -| »»» createTime | string | true | none | none | -| »»» remark | string | true | none | none | - -## POST add user - -POST /system/user - -> Body Parameters - -```json -{ - "remark": "", - "deptId": 102, - "nickName": "", - "email": "h.vrcjiz@qcfgqedxw.bz", - "phonenumber": "18641692257", - "sex": "0", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 1, - 2, - 3, - 4 - ], - "userName": "gijobqebs", - "password": "123456" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | --------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » userName | body | string | yes | user name | -| » password | body | string | yes | user paasword | -| » nickName | body | string | yes | nick name | -| » email | body | string | yes | email address | -| » phonenumber | body | string | yes | phone number | -| » sex | body | string | yes | 0not selected 1male 2female | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | remark | -| » deptId | body | string | yes | department ID | -| » roleIds | body | [string] | yes | role id list | -| » postIds | body | [string] | yes | none | -| » userType | body | string | no | system user | -| » avatar | body | string | no | user avatar | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "Failed to operate user [maskUKolpoeu], login account already exists." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## PUT modify user - -PUT /system/user - -> Body Parameters - -```json -{ - "remark": "", - "deptId": 80, - "nickName": "", - "email": "x.swtaf@oypeubb.tg", - "phonenumber": "18106129309", - "sex": "1", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 2 - ], - "userId": "101", - "userName": "x34bvpi" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | --------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » userId | body | string | yes | none | -| » userName | body | string | yes | none | -| » nickName | body | string | yes | none | -| » email | body | string | yes | none | -| » phonenumber | body | string | yes | none | -| » sex | body | string | yes | 0not selected 1male 2female | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | -| » deptId | body | string | yes | none | -| » roleIds | body | [string] | yes | none | -| » postIds | body | [string] | yes | none | -| » userType | body | string | no | system user | -| » avatar | body | string | no | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## POST export user list - -POST /system/user/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=user_export_11_1684230271701.xlsx -content-length: 21499 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "userName": "string", - "phonenumber": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "deptId": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » userName | body | string | no | none | -| » phonenumber | body | string | no | none | -| » status | body | string | no | 0 Inactive 1 Active | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | -| » deptId | body | string | no | none | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## POST import user data list - -POST /system/user/importData - -> Body Parameters - -```yaml -file: file://D:\Downloads\user_1712127865098.xlsx -updateSupport: "{% mock 'pick' , ['false','true'] %}" - -``` - -### Params - -| Name | Location | Type | Required | Description | -| ---------------- | -------- | -------------- | -------- | -------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | no | Support xls/xlsx excel file | -| » updateSupport | body | string | no | Update existing data, default to false | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Congratulations, the data has been imported successfully! There are 1 entries with the following data:
User ID: user001 Import Successful" -} -``` - -```json -{ - "code": 1, - "msg": "Sorry, the import failed! A total of 2 entries were not formatted correctly, the error is below:
User ID: 107 cell phone number 18105438570 Existing
User ID: 108 cell phone number 18178533158 Existing" -} -``` - -```json -{ - "code": 0, - "msg": "the upload file type is not supported, only the following types are supported: .xls,.xlsx" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete user - -DELETE /system/user/{userIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------ | -| userIds | path | string | yes | User ID, multiple separated by commas in English | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -```json -{ - "code": 0, - "msg": "there is no accessible user data" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT reset user password - -PUT /system/user/resetPwd - -> Body Parameters - -```json -{ - "password": "string", - "userId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » password | body | string | yes | none | -| » userId | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "No accessible user data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify user status - -PUT /system/user/changeStatus - -> Body Parameters - -```json -{ - "status": "string", - "userId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » status | body | string | yes | 0 Inactive 1 Active | -| » userId | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "The change status is equal to the old value!" -} -``` - -```json -{ - "code": 0, - "msg": "No accessible user data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# Security/Online user information - -## GET aquire online user - -GET /monitor/online/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------- | -| userName | query | string | no | user name (login user) | -| ipaddr | query | string | no | logiin host ip address | -| Authorization | header | string | yes | none | -| Referer | header | string | yes | Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "tokenId": "yowsej8nqdnb3t8r", - "deptName": "", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "loginTime": 1712457573298 - }, - { - "tokenId": "o517m9ms5x7m3ohc", - "deptName": "", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "loginTime": 1712457614560 - } - ], - "total": 2 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------ | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » rows | [object] | true | none | none | -| »» tokenId | string | true | none | none | -| »» userName | string | true | none | none | -| »» ipaddr | string | true | none | none | -| »» loginLocation | string | true | none | none | -| »» browser | string | true | none | none | -| »» os | string | true | none | none | -| »» loginTime | integer | true | none | none | -| »» deptName | string | true | none | none | -| » total | integer | true | none | none | - -## DELETE force users to log out - -DELETE /monitor/online/{tokenId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------- | -| tokenId | path | string | yes | access token ID | -| Authorization | header | string | yes | Authorization | -| Referer | header | string | no | Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Dictionary type information - -## GET Dictionary type list - -GET /system/dict/type/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------- | -| dictName | query | string | no | Name | -| dictType | query | string | no | Type | -| status | query | string | no | Status（0 Inactive 1 Active） | -| beginTime | query | string | no | Begin time | -| endTime | query | string | no | End time | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "dictId": "1", - "dictName": "User Gender", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "User gender list" - }, - { - "dictId": "2", - "dictName": "Menu Status", - "dictType": "sys_show_hide", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Menu Status List" - }, - { - "dictId": "3", - "dictName": "System switches", - "dictType": "sys_normal_disable", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "System switch list" - }, - { - "dictId": "4", - "dictName": "Task Status", - "dictType": "sys_job_status", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Task Status List" - }, - { - "dictId": "5", - "dictName": "Task Grouping", - "dictType": "sys_job_group", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Task Grouping List" - }, - { - "dictId": "6", - "dictName": "System or not", - "dictType": "sys_yes_no", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "System whether list" - }, - { - "dictId": "9", - "dictName": "Operation Type", - "dictType": "sys_oper_type", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Operation type list" - }, - { - "dictId": "10", - "dictName": "System Status", - "dictType": "sys_common_status", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Login Status List" - }, - { - "dictId": "100", - "dictName": "Trace Types", - "dictType": "trace_type", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Trace Types" - }, - { - "dictId": "101", - "dictName": "Operation Log Type", - "dictType": "operation_log_type", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "Operation log type" - } - ], - "total": 31 -} -``` - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "dictId": "1", - "dictName": "User Gender", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "User gender list" - } - ], - "total": 1 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » rows | [object] | true | none | none | -| »» dictId | string | true | none | none | -| »» dictName | string | true | none | none | -| »» dictType | string | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | integer | true | none | none | -| »» remark | string | true | none | none | -| » total | integer | true | none | none | - -## GET Dictionary type details - -GET /system/dict/type/{dictId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| dictId | path | string | yes | dictonary ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "dictId": "1", - "dictName": "User Gender", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "User gender list" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | object | true | none | none | -| »» dictId | string | true | none | none | -| »» dictName | string | true | none | none | -| »» dictType | string | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | integer | true | none | none | -| »» remark | string | true | none | none | -| » msg | string | true | none | none | - -## POST Export dictonary type list - -POST /system/dict/type/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=dict_type_export_12_1684240671183.xlsx -content-length: 18246 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dictName | body | string | no | none | -| » dictType | body | string | no | none | -| » status | body | string | no | 0 Active 1 Inactive | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## POST Add dictonary type - -POST /system/dict/type - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dictName | body | string | yes | none | -| » dictType | body | string | yes | none | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to add dictionary entry for [xxx], the dictionary name already exists." -} -``` - -```json -"{\r\n \"code\": 500,\r\n \"msg\": \"Failed to add the dictionary entry for \"xxxx\", as the dictionary type already exists.\"\r\n}" -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT Modify dictonary type - -PUT /system/dict/type - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "remark": "string", - "status": "string", - "dictId": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dictName | body | string | yes | none | -| » dictType | body | string | yes | none | -| » remark | body | string | yes | none | -| » status | body | string | yes | 0 Inactive 1 Active | -| » dictId | body | string | no | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "Success" -} -``` - -br - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE Delete dictonary type - -DELETE /system/dict/type/{dictIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------------- | -| dictIds | path | string | yes | Dictionary ID, separated by commas. | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 500, - "msg": "Access to dictionary type data is not authorized!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Dropdown list of dictionary types - -GET /system/dict/type/getDictOptionselect - -Dropdown selection in dictionary data - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "label": "User Gender", - "value": "sys_user_sex" - }, - { - "label": "Menu Status", - "value": "sys_show_hide" - }, - { - "label": "System switches", - "value": "sys_normal_disable" - }, - { - "label": "Task Status", - "value": "sys_job_status" - }, - { - "label": "Task Grouping", - "value": "sys_job_group" - }, - { - "label": "System or not", - "value": "sys_yes_no" - }, - { - "label": "Operation Type", - "value": "sys_oper_type" - }, - { - "label": "System Status", - "value": "sys_common_status" - }, - { - "label": "Trace Types", - "value": "trace_type" - }, - { - "label": "Operation Log Type", - "value": "operation_log_type" - }, - { - "label": "Alarm Log Type", - "value": "alarm_status" - }, - { - "label": "Security Log Type", - "value": "security_log_type" - }, - { - "label": "Network element software version status", - "value": "ne_version_status" - }, - { - "label": "Multi-language - English", - "value": "i18n_en" - }, - { - "label": "Multi-language - Chinese", - "value": "i18n_zh" - }, - { - "label": "System Role Data Range", - "value": "sys_role_datascope" - }, - { - "label": "Event Alarm Types", - "value": "active_alarm_type" - }, - { - "label": "Alarm Clearing Types", - "value": "active_clear_type" - }, - { - "label": "Alarm Acknowledgement Types", - "value": "active_ack_state" - }, - { - "label": "Severity", - "value": "active_alarm_severity" - }, - { - "label": "Home Status", - "value": "index_status" - }, - { - "label": "CDR SIP Response Code Category Type", - "value": "cdr_sip_code" - }, - { - "label": "CDR Call Type", - "value": "cdr_call_type" - }, - { - "label": "UE Event Authentication Code Type", - "value": "ue_auth_code" - }, - { - "label": "UE Event Type", - "value": "ue_event_type" - }, - { - "label": "UE Event CM Status", - "value": "ue_event_cm_state" - }, - { - "label": "Network element host connection type", - "value": "ne_host_type" - }, - { - "label": "Network element host grouping", - "value": "ne_host_groupId" - }, - { - "label": "Network element host authentication mode", - "value": "ne_host_authMode" - }, - { - "label": "Network element host command grouping", - "value": "ne_host_cmd_groupId" - }, - { - "label": "NE Info State", - "value": "ne_info_status" - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » data | [object] | true | none | none | -| »» label | string | true | none | none | -| »» value | string | true | none | none | -| » msg | string | true | none | none | - -## PUT Refresh dictonary type cache - -PUT /system/dict/type/refreshCache - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Dictionary data information - -## POST Export dictonary data list - -POST /system/dict/data/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=dict_data_export_10_1684245668586.xlsx -content-length: 18236 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "dictLabel": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dictLabel | body | string | no | none | -| » dictType | body | string | no | none | -| » status | body | string | no | 0 Inactive1 Active | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET dictonary data list - -GET /system/dict/data/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------- | -| dictType | query | string | no | type | -| dictLabel | query | string | no | label | -| status | query | string | no | status（0 Inactive 1 Active） | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "dictCode": "67", - "dictSort": 0, - "dictLabel": "Not cleared", - "dictValue": "0", - "dictType": "active_clear_type", - "tagClass": "", - "tagType": "processing", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "70", - "dictSort": 0, - "dictLabel": "Not Confirm", - "dictValue": "0", - "dictType": "active_ack_state", - "tagClass": "", - "tagType": "processing", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "108", - "dictSort": 0, - "dictLabel": "Other", - "dictValue": "0", - "dictType": "cdr_sip_code", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1706610000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "109", - "dictSort": 0, - "dictLabel": "SSH", - "dictValue": "ssh", - "dictType": "ne_host_type", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1706620000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "111", - "dictSort": 0, - "dictLabel": "Other", - "dictValue": "0", - "dictType": "ne_host_groupId", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1706620000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "114", - "dictSort": 0, - "dictLabel": "Password Authentication", - "dictValue": "0", - "dictType": "ne_host_authMode", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1706620000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "116", - "dictSort": 0, - "dictLabel": "Default", - "dictValue": "0", - "dictType": "ne_host_cmd_groupId", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1706620000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "118", - "dictSort": 0, - "dictLabel": "Online", - "dictValue": "0", - "dictType": "ne_info_status", - "tagClass": "", - "tagType": "processing", - "status": "1", - "createBy": "supervisor", - "createTime": 1706620000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "Not selected", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "4", - "dictSort": 1, - "dictLabel": "Show", - "dictValue": "1", - "dictType": "sys_show_hide", - "tagClass": "", - "tagType": "success", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ], - "total": 1359 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» dictCode | string | true | none | none | -| »» dictSort | integer | true | none | none | -| »» dictLabel | string | true | none | none | -| »» dictValue | string | true | none | none | -| »» dictType | string | true | none | none | -| »» tagClass | string | true | none | none | -| »» tagType | string | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## GET dictonary data info detail - -GET /system/dict/data/{dictCode} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| dictCode | path | string | yes | dictonary code | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "dictCode": "38", - "dictSort": 11, - "dictLabel": "Update", - "dictValue": "UPDATE", - "dictType": "operation_log_type", - "tagClass": "", - "tagType": "magenta", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» dictCode | string | true | none | none | -| »» dictSort | integer | true | none | none | -| »» dictLabel | string | true | none | none | -| »» dictValue | string | true | none | none | -| »» dictType | string | true | none | none | -| »» tagClass | string | true | none | none | -| »» tagType | string | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## GET dictionary data list (specify dictionary type) - -GET /system/dict/data/type/{dictType} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------- | -| dictType | path | string | yes | Dictionary type, obtained from the dictionary type list | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "Not selected", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "Male", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "Female", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "supervisor", - "createTime": 1699350000000, - "updateBy": "", - "updateTime": 0, - "remark": "" - } - ], - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» dictCode | string | false | none | none | -| »» dictSort | integer | false | none | none | -| »» dictLabel | string | false | none | none | -| »» dictValue | string | false | none | none | -| »» dictType | string | false | none | none | -| »» tagClass | string | false | none | none | -| »» tagType | string | false | none | none | -| »» status | string | false | none | none | -| »» createBy | string | false | none | none | -| »» createTime | string | false | none | none | -| »» remark | string | false | none | none | - -## POST add dictonary data - -POST /system/dict/data - -> Body Parameters - -```json -{ - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------------ | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dictType | body | string | yes | dictonary type | -| » dictLabel | body | string | yes | dictonary label | -| » dictValue | body | string | yes | dictonary value | -| » dictSort | body | integer | yes | dictonary sort | -| » tagClass | body | string | yes | The preset class style | -| » tagType | body | string | yes | default data fixed items | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "dictType.errLabelExists" -} -``` - -```json -{ - "code": 500, - "msg": "【x】，" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible dictionary type data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify dictonary data - -PUT /system/dict/data - -> Body Parameters - -```json -{ - "dictCode": "string", - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ----------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » dictCode | body | string | yes | dictonary code | -| » dictType | body | string | yes | get from dictionary type list | -| » dictLabel | body | string | yes | none | -| » dictValue | body | string | yes | none | -| » dictSort | body | integer | yes | none | -| » tagClass | body | string | yes | the preset class style | -| » tagType | body | string | yes | default data fixed items | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible dictionary type data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete dictonary data - -DELETE /system/dict/data/{dictCodes} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | -------------------------------------------------------- | -| dictCodes | path | string | yes | Dictionary code ID, multiple separated by English commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -```json -{ - "code": 0, - "msg": "there is no accessible dictionary-encoded data" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Parameter configuration Information - -## GET aquire parameter configuration list - -GET /system/config/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------------------- | -| configName | query | string | no | configuration name | -| configKey | query | string | no | configuration key | -| configType | query | string | no | Is it built-in in the system-Yes/No:Y/N | -| beginTime | query | string | no | begin time | -| endTime | query | string | no | end time | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» configId | integer | true | none | none | -| »» configName | string | true | none | none | -| »» configKey | string | true | none | none | -| »» configValue | string | true | none | none | -| »» configType | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | string | true | none | none | -| »» remark | string | true | none | none | - -## POST export parameter cofniguration list - -POST /system/config/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=config_export_10_1684131509100.xlsx -content-length: 18337 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » configName | body | string | no | none | -| » configKey | body | string | no | none | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 0, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET aquire value from parameter config key - -GET /system/config/configKey/{configKey} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| configKey | path | string | yes | cofnig key | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": "true" -} -``` - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | string | true | none | none | - -## GET aquire parameter configuration info - -GET /system/config/{configId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| configId | path | string | yes | config ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "configId": "1", - "configName": "User Management-Account Initial Password", - "configKey": "sys.user.initPassword", - "configValue": "Abcd@1234..", - "configType": "Y", - "createBy": "supervisor", - "createTime": 1700000000000, - "updateBy": "", - "updateTime": 0, - "remark": "Import user initialization password 123456" - }, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» configId | integer | true | none | none | -| »» configName | string | true | none | none | -| »» configKey | string | true | none | none | -| »» configValue | string | true | none | none | -| »» configType | string | true | none | Y N | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» updateBy | string | true | none | none | -| »» updateTime | string | true | none | none | -| »» remark | string | true | none | none | - -## POST add parameter configuration - -POST /system/config - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » configName | body | string | yes | config name | -| » configKey | body | string | yes | config key | -| » configValue | body | string | yes | config value | -| » configType | body | string | yes | Y/N: yes/no | -| » remark | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "Failed to manipulate parameter configuration [sys.user.initPassword], parameter key name already exists!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify parameter configuration - -PUT /system/config - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string", - "configId": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------- | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » configName | body | string | yes | none | -| » configKey | body | string | yes | none | -| » configValue | body | string | yes | none | -| » configType | body | string | yes | Y/N: yes/no | -| » remark | body | string | yes | none | -| » configId | body | integer | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "No permission to access parameter configuration data！" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify parameter value by config key - -PUT /system/config/changeValue - -> Body Parameters - -```json -{ - "key": "sys.logo.filePathIcon", - "value": "" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » key | body | string | yes | none | -| » value | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "Failed to manipulate parameter configuration [sys.user.initPassword], parameter key name already exists!" -} -``` - -```json -{ - "code": 0, - "msg": "！" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete parameter configuration - -DELETE /system/config/{configIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------------------------------------- | -| configIds | path | string | yes | Configuration ID, multiple separated by commas in English | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "The built-in parameter [xxx] cannot be deleted" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT refresh parameter configuration cache - -PUT /system/config/refreshCache - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Cache information - -## GET cache monitor information - -GET /monitor/cache - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "commandStats": [ - { - "name": "exists", - "value": "5559" - }, - { - "name": "set", - "value": "637154" - }, - { - "name": "select", - "value": "474" - }, - { - "name": "mget", - "value": "3" - }, - { - "name": "hello", - "value": "572" - }, - { - "name": "dbsize", - "value": "2" - }, - { - "name": "expire", - "value": "1" - }, - { - "name": "evalsha", - "value": "2" - }, - { - "name": "ping", - "value": "190" - }, - { - "name": "info", - "value": "3" - }, - { - "name": "del", - "value": "3341" - }, - { - "name": "eval", - "value": "1" - }, - { - "name": "ttl", - "value": "383" - }, - { - "name": "incr", - "value": "2" - }, - { - "name": "scan", - "value": "386" - }, - { - "name": "get", - "value": "672017" - } - ], - "dbSize": 66, - "info": { - "clients": { - "blocked_clients": "0", - "client_recent_max_input_buffer": "20480", - "client_recent_max_output_buffer": "0", - "clients_in_timeout_table": "0", - "cluster_connections": "0", - "connected_clients": "4", - "maxclients": "10000", - "total_blocking_keys": "0", - "total_blocking_keys_on_nokey": "0", - "tracking_clients": "0" - }, - "cluster": { - "cluster_enabled": "0" - }, - "cpu": { - "used_cpu_sys": "568.391106", - "used_cpu_sys_children": "1.305536", - "used_cpu_sys_main_thread": "568.376221", - "used_cpu_user": "671.263046", - "used_cpu_user_children": "6.089575", - "used_cpu_user_main_thread": "671.221030" - }, - "errorstats": { - "errorstat_NOSCRIPT": "count=1" - }, - "keyspace": { - "db10": "keys=66,expires=2,avg_ttl=1739604", - "db11": "keys=50,expires=0,avg_ttl=0" - }, - "memory": { - "active_defrag_running": "0", - "allocator_active": "2736128", - "allocator_allocated": "2434312", - "allocator_frag_bytes": "301816", - "allocator_frag_ratio": "1.12", - "allocator_resident": "8257536", - "allocator_rss_bytes": "5521408", - "allocator_rss_ratio": "3.02", - "lazyfree_pending_objects": "0", - "lazyfreed_objects": "0", - "maxmemory": "0", - "maxmemory_human": "0B", - "maxmemory_policy": "noeviction", - "mem_allocator": "jemalloc-5.3.0", - "mem_aof_buffer": "0", - "mem_clients_normal": "7712", - "mem_clients_slaves": "0", - "mem_cluster_links": "0", - "mem_fragmentation_bytes": "14006312", - "mem_fragmentation_ratio": "7.74", - "mem_not_counted_for_evict": "0", - "mem_replication_backlog": "0", - "mem_total_replication_buffers": "0", - "number_of_cached_scripts": "1", - "number_of_functions": "0", - "number_of_libraries": "0", - "rss_overhead_bytes": "7827456", - "rss_overhead_ratio": "1.95", - "total_system_memory": "16607678464", - "total_system_memory_human": "15.47G", - "used_memory": "2100976", - "used_memory_dataset": "1220328", - "used_memory_dataset_perc": "98.81%", - "used_memory_functions": "184", - "used_memory_human": "2.00M", - "used_memory_lua": "34816", - "used_memory_lua_human": "34.00K", - "used_memory_overhead": "880648", - "used_memory_peak": "2549640", - "used_memory_peak_human": "2.43M", - "used_memory_peak_perc": "82.40%", - "used_memory_rss": "16084992", - "used_memory_rss_human": "15.34M", - "used_memory_scripts": "688", - "used_memory_scripts_eval": "504", - "used_memory_scripts_human": "688B", - "used_memory_startup": "865928", - "used_memory_vm_eval": "34816", - "used_memory_vm_functions": "32768", - "used_memory_vm_total": "67584", - "used_memory_vm_total_human": "66.00K" - }, - "modules": {}, - "persistence": { - "aof_current_rewrite_time_sec": "-1", - "aof_enabled": "0", - "aof_last_bgrewrite_status": "ok", - "aof_last_cow_size": "0", - "aof_last_rewrite_time_sec": "-1", - "aof_last_write_status": "ok", - "aof_rewrite_in_progress": "0", - "aof_rewrite_scheduled": "0", - "aof_rewrites": "0", - "aof_rewrites_consecutive_failures": "0", - "async_loading": "0", - "current_cow_peak": "0", - "current_cow_size": "0", - "current_cow_size_age": "0", - "current_fork_perc": "0.00", - "current_save_keys_processed": "0", - "current_save_keys_total": "0", - "loading": "0", - "module_fork_in_progress": "0", - "module_fork_last_cow_size": "0", - "rdb_bgsave_in_progress": "0", - "rdb_changes_since_last_save": "215", - "rdb_current_bgsave_time_sec": "-1", - "rdb_last_bgsave_status": "ok", - "rdb_last_bgsave_time_sec": "0", - "rdb_last_cow_size": "962560", - "rdb_last_load_keys_expired": "1", - "rdb_last_load_keys_loaded": "114", - "rdb_last_save_time": "1712568097", - "rdb_saves": "2172" - }, - "replication": { - "connected_slaves": "0", - "master_failover_state": "no-failover", - "master_repl_offset": "57", - "master_replid": "a8df674e95bb3a24d37a800f3e54fec532cbdc94", - "master_replid2": "0000000000000000000000000000000000000000", - "repl_backlog_active": "0", - "repl_backlog_first_byte_offset": "0", - "repl_backlog_histlen": "0", - "repl_backlog_size": "1048576", - "role": "master", - "second_repl_offset": "-1" - }, - "server": { - "arch_bits": "64", - "atomicvar_api": "c11-builtin", - "config_file": "", - "configured_hz": "10", - "executable": "/data/redis-server", - "gcc_version": "12.2.0", - "hz": "10", - "io_threads_active": "0", - "listener0": "*,port=6379", - "lru_clock": "1292262", - "monotonic_clock": "POSIX clock_gettime", - "multiplexing_api": "epoll", - "os": "Linux 5.15.90.1-microsoft-standard-WSL2 x86_64", - "process_id": "1", - "process_supervised": "no", - "redis_build_id": "9b0796a828280810", - "redis_git_dirty": "0", - "redis_git_sha1": "00000000", - "redis_mode": "standalone", - "redis_version": "7.2.3", - "run_id": "2831087f076f4f96810773e0207f5d19ec0d57ba", - "server_time_usec": "1712568294458826", - "tcp_port": "6379", - "uptime_in_days": "11", - "uptime_in_seconds": "956181" - }, - "stats": { - "acl_access_denied_auth": "0", - "acl_access_denied_channel": "0", - "acl_access_denied_cmd": "0", - "acl_access_denied_key": "0", - "active_defrag_hits": "0", - "active_defrag_key_hits": "0", - "active_defrag_key_misses": "0", - "active_defrag_misses": "0", - "current_active_defrag_time": "0", - "current_eviction_exceeded_time": "0", - "dump_payload_sanitizations": "0", - "eventloop_cycles": "10833780", - "eventloop_duration_cmd_sum": "6980386", - "eventloop_duration_sum": "993148545", - "evicted_clients": "0", - "evicted_keys": "0", - "expire_cycle_cpu_milliseconds": "17711", - "expired_keys": "86", - "expired_stale_perc": "0.00", - "expired_time_cap_reached_count": "0", - "instantaneous_eventloop_cycles_per_sec": "9", - "instantaneous_eventloop_duration_usec": "87", - "instantaneous_input_kbps": "0.00", - "instantaneous_input_repl_kbps": "0.00", - "instantaneous_ops_per_sec": "0", - "instantaneous_output_kbps": "0.00", - "instantaneous_output_repl_kbps": "0.00", - "io_threaded_reads_processed": "0", - "io_threaded_writes_processed": "0", - "keyspace_hits": "656615", - "keyspace_misses": "21349", - "latest_fork_usec": "284", - "migrate_cached_sockets": "0", - "pubsub_channels": "0", - "pubsub_patterns": "0", - "pubsubshard_channels": "0", - "rejected_connections": "0", - "reply_buffer_expands": "3799", - "reply_buffer_shrinks": "3912", - "slave_expires_tracked_keys": "0", - "sync_full": "0", - "sync_partial_err": "0", - "sync_partial_ok": "0", - "total_active_defrag_time": "0", - "total_commands_processed": "1320088", - "total_connections_received": "572", - "total_error_replies": "1", - "total_eviction_exceeded_time": "0", - "total_forks": "2172", - "total_net_input_bytes": "119768993", - "total_net_output_bytes": "67614465", - "total_net_repl_input_bytes": "0", - "total_net_repl_output_bytes": "0", - "total_reads_processed": "1321850", - "total_writes_processed": "1320083", - "tracking_total_items": "0", - "tracking_total_keys": "0", - "tracking_total_prefixes": "0", - "unexpected_error_replies": "0" - } - } - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------------------------------ | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» info | object | true | none | none | -| »»» server | object | true | none | none | -| »»»» redis_version | string | true | none | none | -| »»»» redis_git_sha1 | string | true | none | none | -| »»»» redis_git_dirty | string | true | none | none | -| »»»» redis_build_id | string | true | none | none | -| »»»» redis_mode | string | true | none | none | -| »»»» os | string | true | none | none | -| »»»» arch_bits | string | true | none | none | -| »»»» monotonic_clock | string | true | none | none | -| »»»» multiplexing_api | string | true | none | none | -| »»»» atomicvar_api | string | true | none | none | -| »»»» gcc_version | string | true | none | none | -| »»»» process_id | string | true | none | none | -| »»»» process_supervised | string | true | none | none | -| »»»» run_id | string | true | none | none | -| »»»» tcp_port | string | true | none | none | -| »»»» server_time_usec | string | true | none | none | -| »»»» uptime_in_seconds | string | true | none | none | -| »»»» uptime_in_days | string | true | none | none | -| »»»» hz | string | true | none | none | -| »»»» configured_hz | string | true | none | none | -| »»»» lru_clock | string | true | none | none | -| »»»» executable | string | true | none | none | -| »»»» config_file | string | true | none | none | -| »»»» io_threads_active | string | true | none | none | -| »»» clients | object | true | none | none | -| »»»» connected_clients | string | true | none | none | -| »»»» cluster_connections | string | true | none | none | -| »»»» maxclients | string | true | none | none | -| »»»» client_recent_max_input_buffer | string | true | none | none | -| »»»» client_recent_max_output_buffer | string | true | none | none | -| »»»» blocked_clients | string | true | none | none | -| »»»» tracking_clients | string | true | none | none | -| »»»» clients_in_timeout_table | string | true | none | none | -| »»» memory | object | true | none | none | -| »»»» used_memory | string | true | none | none | -| »»»» used_memory_human | string | true | none | none | -| »»»» used_memory_rss | string | true | none | none | -| »»»» used_memory_rss_human | string | true | none | none | -| »»»» used_memory_peak | string | true | none | none | -| »»»» used_memory_peak_human | string | true | none | none | -| »»»» used_memory_peak_perc | string | true | none | none | -| »»»» used_memory_overhead | string | true | none | none | -| »»»» used_memory_startup | string | true | none | none | -| »»»» used_memory_dataset | string | true | none | none | -| »»»» used_memory_dataset_perc | string | true | none | none | -| »»»» allocator_allocated | string | true | none | none | -| »»»» allocator_active | string | true | none | none | -| »»»» allocator_resident | string | true | none | none | -| »»»» total_system_memory | string | true | none | none | -| »»»» total_system_memory_human | string | true | none | none | -| »»»» used_memory_lua | string | true | none | none | -| »»»» used_memory_vm_eval | string | true | none | none | -| »»»» used_memory_lua_human | string | true | none | none | -| »»»» used_memory_scripts_eval | string | true | none | none | -| »»»» number_of_cached_scripts | string | true | none | none | -| »»»» number_of_functions | string | true | none | none | -| »»»» number_of_libraries | string | true | none | none | -| »»»» used_memory_vm_functions | string | true | none | none | -| »»»» used_memory_vm_total | string | true | none | none | -| »»»» used_memory_vm_total_human | string | true | none | none | -| »»»» used_memory_functions | string | true | none | none | -| »»»» used_memory_scripts | string | true | none | none | -| »»»» used_memory_scripts_human | string | true | none | none | -| »»»» maxmemory | string | true | none | none | -| »»»» maxmemory_human | string | true | none | none | -| »»»» maxmemory_policy | string | true | none | none | -| »»»» allocator_frag_ratio | string | true | none | none | -| »»»» allocator_frag_bytes | string | true | none | none | -| »»»» allocator_rss_ratio | string | true | none | none | -| »»»» allocator_rss_bytes | string | true | none | none | -| »»»» rss_overhead_ratio | string | true | none | none | -| »»»» rss_overhead_bytes | string | true | none | none | -| »»»» mem_fragmentation_ratio | string | true | none | none | -| »»»» mem_fragmentation_bytes | string | true | none | none | -| »»»» mem_not_counted_for_evict | string | true | none | none | -| »»»» mem_replication_backlog | string | true | none | none | -| »»»» mem_total_replication_buffers | string | true | none | none | -| »»»» mem_clients_slaves | string | true | none | none | -| »»»» mem_clients_normal | string | true | none | none | -| »»»» mem_cluster_links | string | true | none | none | -| »»»» mem_aof_buffer | string | true | none | none | -| »»»» mem_allocator | string | true | none | none | -| »»»» active_defrag_running | string | true | none | none | -| »»»» lazyfree_pending_objects | string | true | none | none | -| »»»» lazyfreed_objects | string | true | none | none | -| »»» persistence | object | true | none | none | -| »»»» loading | string | true | none | none | -| »»»» async_loading | string | true | none | none | -| »»»» current_cow_peak | string | true | none | none | -| »»»» current_cow_size | string | true | none | none | -| »»»» current_cow_size_age | string | true | none | none | -| »»»» current_fork_perc | string | true | none | none | -| »»»» current_save_keys_processed | string | true | none | none | -| »»»» current_save_keys_total | string | true | none | none | -| »»»» rdb_changes_since_last_save | string | true | none | none | -| »»»» rdb_bgsave_in_progress | string | true | none | none | -| »»»» rdb_last_save_time | string | true | none | none | -| »»»» rdb_last_bgsave_status | string | true | none | none | -| »»»» rdb_last_bgsave_time_sec | string | true | none | none | -| »»»» rdb_current_bgsave_time_sec | string | true | none | none | -| »»»» rdb_saves | string | true | none | none | -| »»»» rdb_last_cow_size | string | true | none | none | -| »»»» rdb_last_load_keys_expired | string | true | none | none | -| »»»» rdb_last_load_keys_loaded | string | true | none | none | -| »»»» aof_enabled | string | true | none | none | -| »»»» aof_rewrite_in_progress | string | true | none | none | -| »»»» aof_rewrite_scheduled | string | true | none | none | -| »»»» aof_last_rewrite_time_sec | string | true | none | none | -| »»»» aof_current_rewrite_time_sec | string | true | none | none | -| »»»» aof_last_bgrewrite_status | string | true | none | none | -| »»»» aof_rewrites | string | true | none | none | -| »»»» aof_rewrites_consecutive_failures | string | true | none | none | -| »»»» aof_last_write_status | string | true | none | none | -| »»»» aof_last_cow_size | string | true | none | none | -| »»»» module_fork_in_progress | string | true | none | none | -| »»»» module_fork_last_cow_size | string | true | none | none | -| »»»» aof_current_size | string | true | none | none | -| »»»» aof_base_size | string | true | none | none | -| »»»» aof_pending_rewrite | string | true | none | none | -| »»»» aof_buffer_length | string | true | none | none | -| »»»» aof_pending_bio_fsync | string | true | none | none | -| »»»» aof_delayed_fsync | string | true | none | none | -| »»» stats | object | true | none | none | -| »»»» total_connections_received | string | true | none | none | -| »»»» total_commands_processed | string | true | none | none | -| »»»» instantaneous_ops_per_sec | string | true | none | none | -| »»»» total_net_input_bytes | string | true | none | none | -| »»»» total_net_output_bytes | string | true | none | none | -| »»»» total_net_repl_input_bytes | string | true | none | none | -| »»»» total_net_repl_output_bytes | string | true | none | none | -| »»»» instantaneous_input_kbps | string | true | none | none | -| »»»» instantaneous_output_kbps | string | true | none | none | -| »»»» instantaneous_input_repl_kbps | string | true | none | none | -| »»»» instantaneous_output_repl_kbps | string | true | none | none | -| »»»» rejected_connections | string | true | none | none | -| »»»» sync_full | string | true | none | none | -| »»»» sync_partial_ok | string | true | none | none | -| »»»» sync_partial_err | string | true | none | none | -| »»»» expired_keys | string | true | none | none | -| »»»» expired_stale_perc | string | true | none | none | -| »»»» expired_time_cap_reached_count | string | true | none | none | -| »»»» expire_cycle_cpu_milliseconds | string | true | none | none | -| »»»» evicted_keys | string | true | none | none | -| »»»» evicted_clients | string | true | none | none | -| »»»» total_eviction_exceeded_time | string | true | none | none | -| »»»» current_eviction_exceeded_time | string | true | none | none | -| »»»» keyspace_hits | string | true | none | none | -| »»»» keyspace_misses | string | true | none | none | -| »»»» pubsub_channels | string | true | none | none | -| »»»» pubsub_patterns | string | true | none | none | -| »»»» pubsubshard_channels | string | true | none | none | -| »»»» latest_fork_usec | string | true | none | none | -| »»»» total_forks | string | true | none | none | -| »»»» migrate_cached_sockets | string | true | none | none | -| »»»» slave_expires_tracked_keys | string | true | none | none | -| »»»» active_defrag_hits | string | true | none | none | -| »»»» active_defrag_misses | string | true | none | none | -| »»»» active_defrag_key_hits | string | true | none | none | -| »»»» active_defrag_key_misses | string | true | none | none | -| »»»» total_active_defrag_time | string | true | none | none | -| »»»» current_active_defrag_time | string | true | none | none | -| »»»» tracking_total_keys | string | true | none | none | -| »»»» tracking_total_items | string | true | none | none | -| »»»» tracking_total_prefixes | string | true | none | none | -| »»»» unexpected_error_replies | string | true | none | none | -| »»»» total_error_replies | string | true | none | none | -| »»»» dump_payload_sanitizations | string | true | none | none | -| »»»» total_reads_processed | string | true | none | none | -| »»»» total_writes_processed | string | true | none | none | -| »»»» io_threaded_reads_processed | string | true | none | none | -| »»»» io_threaded_writes_processed | string | true | none | none | -| »»»» reply_buffer_shrinks | string | true | none | none | -| »»»» reply_buffer_expands | string | true | none | none | -| »»» replication | object | true | none | none | -| »»»» role | string | true | none | none | -| »»»» connected_slaves | string | true | none | none | -| »»»» master_failover_state | string | true | none | none | -| »»»» master_replid | string | true | none | none | -| »»»» master_replid2 | string | true | none | none | -| »»»» master_repl_offset | string | true | none | none | -| »»»» second_repl_offset | string | true | none | none | -| »»»» repl_backlog_active | string | true | none | none | -| »»»» repl_backlog_size | string | true | none | none | -| »»»» repl_backlog_first_byte_offset | string | true | none | none | -| »»»» repl_backlog_histlen | string | true | none | none | -| »»» cpu | object | true | none | none | -| »»»» used_cpu_sys | string | true | none | none | -| »»»» used_cpu_user | string | true | none | none | -| »»»» used_cpu_sys_children | string | true | none | none | -| »»»» used_cpu_user_children | string | true | none | none | -| »»»» used_cpu_sys_main_thread | string | true | none | none | -| »»»» used_cpu_user_main_thread | string | true | none | none | -| »»» modules | object | true | none | none | -| »»» errorstats | object | true | none | none | -| »»» cluster | object | true | none | none | -| »»»» cluster_enabled | string | true | none | none | -| »»» keyspace | object | true | none | none | -| »»»» db0 | string | true | none | none | -| »»»» db1 | string | true | none | none | -| »» dbSize | integer | true | none | none | -| »» commandStats | [object] | true | none | none | -| »»» name | string | true | none | none | -| »»» value | string | true | none | none | - -## GET aquire cache name list - -GET /monitor/cache/getNames - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> Success - -```json - -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» cacheName | string | true | none | none | -| »» cacheKey | string | true | none | none | -| »» cacheValue | string | true | none | none | -| »» remark | string | true | none | none | - -## GET key name list by cache name - -GET /monitor/cache/getKeys/{cacheName} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| cacheName | path | string | yes | Cache Name | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Success", - "data": [ - { - "cacheName": "sys_config", - "cacheKey": "sys.user.initPassword", - "cacheValue": "", - "remark": "" - }, - { - "cacheName": "sys_config", - "cacheKey": "sys.account.captchaEnabled", - "cacheValue": "", - "remark": "" - }, - { - "cacheName": "sys_config", - "cacheKey": "sys.account.registerUser", - "cacheValue": "", - "remark": "" - }, - { - "cacheName": "sys_config", - "cacheKey": "sys.account.captchaType", - "cacheValue": "", - "remark": "" - } - ] -} -``` - -```json -{ - "code": 403, - "msg": "Unauthorized access GET /monitor/cache/getKeys/epsgajtqg" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» cacheName | string | true | none | none | -| »» cacheKey | string | true | none | none | -| »» cacheValue | string | true | none | none | -| »» remark | string | true | none | none | - -## GET aquire cache value by name or key - -GET /monitor/cache/getValue/{cacheName}/{cacheKey} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------------------------- | -| cacheName | path | string | yes | Cache name obtained from key name list | -| cacheKey | path | string | yes | Cache key names obtained from the key name list | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": { - "cacheName": "sys_config", - "cacheKey": "sys.account.captchaType", - "cacheValue": "math", - "remark": "" - } -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» cacheName | string | true | none | none | -| »» cacheKey | string | true | none | none | -| »» cacheValue | string | true | none | none | -| »» remark | string | true | none | | - -## DELETE delete cache key name - -DELETE /monitor/cache/clearCacheKey/{cacheName}/{cacheKey} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------------------------- | -| cacheName | path | string | yes | Cache name obtained from key name list | -| cacheKey | path | string | yes | Cache key names obtained from the key name list | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 403, - "msg": "Unauthorized access DELETE /monitor/cache/clearCacheKey/mjhq/f22367b5-1547-4372-9a0f-2381a75a2148" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete cache name - -DELETE /monitor/cache/clearCacheName/{cacheName} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------ | -| cacheName | path | string | yes | The cache name obtained from the cache name list | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE clear cache name safety - -DELETE /monitor/cache/clearCacheSafe - -Specify cache key names that can be cleared - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Scheduling task log information - -## POST export scheduling task log - -POST /monitor/jobLog/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx -content-length: 17079 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0, - "beginTime": "string", - "endTime": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » jobName | body | string | no | none | -| » jobGroup | body | string | no | none | -| » status | body | string | no | none | -| » pageNum | body | number | no | none | -| » pageSize | body | number | no | none | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | - -> Response Examples - -> OK - -```json -{ - "code": 0, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET aquire scheduling task log list - -GET /monitor/jobLog/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| jobName | query | string | no | job name | -| jobGroup | query | string | no | job group name | -| status | query | string | no | status | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "jobLogId": "246", - "jobName": "Delete Expired NE State Record", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":1,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":1223,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714407900038, - "costTime": 38 - }, - { - "jobLogId": "245", - "jobName": "Delete expired NE etc backup file", - "jobGroup": "SYSTEM", - "invokeTarget": "delExpiredNeBackup", - "targetParams": "{\"duration\":60}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714407600001, - "costTime": 1 - }, - { - "jobLogId": "244", - "jobName": "Delete expired KPI records", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":30,\"tableName\":\"gold_kpi\",\"colName\":\"date\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714407301671, - "costTime": 1671 - }, - { - "jobLogId": "243", - "jobName": "Delete expired historical alarm", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":90,\"tableName\":\"alarm\",\"colName\":\"event_time\",\"extras\":\"alarm_status='0'\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":26,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714407000095, - "costTime": 95 - }, - { - "jobLogId": "242", - "jobName": "Delete Expired NE State Record", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":1,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}", - "jobMsg": "{\"crom\":false,\"message\":{\"affected\":30093,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714383034113, - "costTime": 27321 - }, - { - "jobLogId": "241", - "jobName": "Delete Expired NE State Record", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":7,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714321501402, - "costTime": 1402 - }, - { - "jobLogId": "240", - "jobName": "Delete expired NE etc backup file", - "jobGroup": "SYSTEM", - "invokeTarget": "delExpiredNeBackup", - "targetParams": "{\"duration\":60}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714321200002, - "costTime": 2 - }, - { - "jobLogId": "239", - "jobName": "Delete expired KPI records", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":30,\"tableName\":\"gold_kpi\",\"colName\":\"date\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714320901523, - "costTime": 1523 - }, - { - "jobLogId": "238", - "jobName": "Delete expired historical alarm", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":90,\"tableName\":\"alarm\",\"colName\":\"event_time\",\"extras\":\"alarm_status='0'\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":384,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714320600186, - "costTime": 185 - }, - { - "jobLogId": "237", - "jobName": "Delete Expired NE State Record", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":7,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}", - "jobMsg": "{\"crom\":true,\"message\":{\"affected\":0,\"msg\":\"sucess\"},\"name\":\"completed\"}", - "status": "1", - "createTime": 1714235100585, - "costTime": 585 - } - ], - "total": 246 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » rows | [object] | true | none | none | -| »» jobLogId | string | true | none | none | -| »» jobName | string | true | none | none | -| »» jobGroup | string | true | none | none | -| »» invokeTarget | string | true | none | none | -| »» targetParams | string | true | none | none | -| »» jobMsg | string | true | none | none | -| »» status | string | true | none | none | -| »» createTime | integer | true | none | none | -| »» costTime | integer | true | none | none | -| » total | integer | true | none | none | - -## GET aquire scheduling task log - -GET /monitor/jobLog/{jobLogId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| jobLogId | path | string | yes | log ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "jobLogId": "44", - "jobName": "job.genNeStateAlarm", - "jobGroup": "SYSTEM", - "invokeTarget": "genNeStateAlarm", - "targetParams": "{\"alarmID\":\"HXEMSSM10000\",\"alarmCode\":10000,\"alarmTitle\":\"The system state is abnormal\",\"neType\":\"OMC\",\"alarmType\":\"EquipmentAlarm\",\"origSeverity\": \"Major\",\"objectName\":\"EMS;SystemManagement;Heartbeat\",\"objectType\":\"SystemState\",\"specificProblem\":\"Alarm cause: the system state of target NE has not been received for {threshold} seconds\", \"specificProblemID\":\"AC10000\",\"threshold\":30}", - "jobMsg": "{\"crom\":true,\"message\":null,\"name\":\"completed\"}", - "status": "1", - "createTime": 1704450000000, - "costTime": 0 - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» jobLogId | string | true | none | none | -| »» jobName | string | true | none | none | -| »» jobGroup | string | true | none | none | -| »» invokeTarget | string | true | none | none | -| »» targetParams | string | true | none | none | -| »» jobMsg | string | true | none | none | -| »» status | string | true | none | none | -| »» createTime | string | true | none | none | - -## DELETE delete scheduling task log - -DELETE /monitor/jobLog/{jobLogIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------------------------------- | -| jobLogIds | path | string | yes | Log ID, multiple can be separated by English commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE clear scheduling task log - -DELETE /monitor/jobLog/clean - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Scheduling task information - -## POST export scheduling task list - -POST /monitor/job/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=job_export_6_1684058991890.xlsx -content-length: 19346 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » jobName | body | string | no | none | -| » jobGroup | body | string | no | none | -| » status | body | string | no | none | -| » pageNum | body | number | no | none | -| » pageSize | body | number | no | none | - -> Response Examples - -> OK - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET aquire scheduling task list - -GET /monitor/job/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| jobName | query | string | no | job name | -| jobGroup | query | string | no | job group name | -| status | query | string | no | status | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "jobId": "1", - "jobName": "Monitor-System Resources", - "jobGroup": "SYSTEM", - "invokeTarget": "monitor_sys_resource", - "targetParams": "{\"interval\":5}", - "cronExpression": "0 0/5 * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "0", - "createBy": "supervisor", - "createTime": 1698478134839, - "updateBy": "", - "updateTime": 0, - "remark": "System Resource CPU/IO/Netword Collection\r\ninterval unit minutes, average minute resource situation\r\nNote: Please pass the value of the parameter interva according to the time unit minutes of the cron expression" - }, - { - "jobId": "4", - "jobName": "Delete expired NE etc backup file", - "jobGroup": "SYSTEM", - "invokeTarget": "delExpiredNeBackup", - "targetParams": "{\"duration\":60}", - "cronExpression": "0 20 0 * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "1", - "createBy": "supervisor", - "createTime": 1698478134840, - "updateBy": "", - "updateTime": 0, - "remark": "Delete expired network element etc backup file, pass in the parameter to keep the backup file for {duration} days, default is 60 days." - }, - { - "jobId": "5", - "jobName": "Delete expired historical alarm", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":90,\"tableName\":\"alarm\",\"colName\":\"event_time\",\"extras\":\"alarm_status='0'\"}", - "cronExpression": "0 10 0 * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "1", - "createBy": "supervisor", - "createTime": 1698478134841, - "updateBy": "", - "updateTime": 0, - "remark": "Delete expired history alarm records, pass in the parameter to keep the history alarm records for {duration} days." - }, - { - "jobId": "6", - "jobName": "Delete expired KPI records", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":30,\"tableName\":\"gold_kpi\",\"colName\":\"date\"}", - "cronExpression": "0 15 0 * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "1", - "createBy": "supervisor", - "createTime": 1698478134842, - "updateBy": "", - "updateTime": 0, - "remark": "KPI record retention for {duration} days" - }, - { - "jobId": "7", - "jobName": "Network Element Configuration Auto Backup Task", - "jobGroup": "SYSTEM", - "invokeTarget": "backupEtcFromNE", - "targetParams": "", - "cronExpression": "0 30 0 * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "1", - "createBy": "supervisor", - "createTime": 1698478134843, - "updateBy": "", - "updateTime": 0, - "remark": "Automatically backs up the configuration files in the network element's etc directory." - }, - { - "jobId": "8", - "jobName": "Delete Expired NE State Record", - "jobGroup": "SYSTEM", - "invokeTarget": "deleteExpiredRecord", - "targetParams": "{\"duration\":7,\"tableName\":\"ne_state\",\"colName\":\"timestamp\"}", - "cronExpression": "0 25 0 * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "1", - "createBy": "supervisor", - "createTime": 1698478134842, - "updateBy": "", - "updateTime": 0, - "remark": "Delete expired NE state records regularly and keep them for {duration} days by default." - }, - { - "jobId": "9", - "jobName": "Get state from NEs", - "jobGroup": "SYSTEM", - "invokeTarget": "getStateFromNE", - "targetParams": "", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "0", - "createBy": "supervisor", - "createTime": 1698478134842, - "updateBy": "", - "updateTime": 0, - "remark": "Get state information from all NEs" - }, - { - "jobId": "10", - "jobName": "Network Element Health Check", - "jobGroup": "SYSTEM", - "invokeTarget": "genNeStateAlarm", - "targetParams": "{\"alarmID\":\"HXEMSSM10000\",\"alarmCode\":10000,\"alarmTitle\":\"The system state is abnormal\",\"neType\":\"OMC\",\"alarmType\":\"EquipmentAlarm\",\"origSeverity\": \"Major\",\"objectName\":\"EMS;SystemManagement;Heartbeat\",\"objectType\":\"SystemState\",\"specificProblem\":\"Alarm cause: the system state of target NE has not been received for {threshold} seconds\", \"specificProblemID\":\"AC10000\",\"threshold\":30}", - "cronExpression": "0/5 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "0", - "createBy": "supervisor", - "createTime": 1698478134842, - "updateBy": "", - "updateTime": 0, - "remark": "Health status inspection of network elements, generating alarms in case of abnormalities." - } - ], - "total": 8 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» jobId | string | true | none | none | -| »» jobName | string | true | none | none | -| »» jobGroup | string | true | none | none | -| »» invokeTarget | string | true | none | none | -| »» targetParams | string | true | none | none | -| »» cronExpression | string | true | none | none | -| »» misfirePolicy | string | true | none | none | -| »» concurrent | string | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## GET aquire scheduling task by ID - -GET /monitor/job/{jobId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| jobId | path | string | yes | task ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "jobId": "1", - "jobName": "Monitor-System Resources", - "jobGroup": "SYSTEM", - "invokeTarget": "monitor_sys_resource", - "targetParams": "{\"interval\":5}", - "cronExpression": "0 0/5 * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "1", - "saveLog": "0", - "createBy": "supervisor", - "createTime": 1698478134839, - "updateBy": "", - "updateTime": 0, - "remark": "System Resource CPU/IO/Netword Collection\r\ninterval unit minutes, average minute resource situation\r\nNote: Please pass the value of the parameter interva according to the time unit minutes of the cron expression" - }, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object¦null | true | none | none | -| »» jobId | string | true | none | none | -| »» jobName | string | true | none | none | -| »» jobGroup | string | true | none | none | -| »» invokeTarget | string | true | none | none | -| »» targetParams | string | true | none | none | -| »» cronExpression | string | true | none | none | -| »» misfirePolicy | string | true | none | none | -| »» concurrent | string | true | none | none | -| »» status | string | true | none | none | -| »» createBy | string | true | none | none | -| »» createTime | string | true | none | none | -| »» remark | string | true | none | none | - -## POST add scheduling task - -POST /monitor/job - -> Body Parameters - -```json -{ - "jobName": "task1", - "invokeTarget": "test1", - "cronExpression": "0/22 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "jobGroup": "DEFAULT", - "status": "ullamco minim Ut", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "asdf" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| ----------------- | -------- | ------ | -------- | ----------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » jobName | body | string | yes | Scheduling task name | -| » jobGroup | body | string | yes | Group name | -| » invokeTarget | body | string | yes | Invoke target, callback function | -| » targetParams | body | string | yes | Standard JSON format string | -| » cronExpression | body | string | yes | Cron expression, last '?' char not used | -| » misfirePolicy | body | string | yes | 1. Execute immediately 2. Execute once 3. Abandon execution | -| » concurrent | body | string | yes | 0 prohibited 1 allowed | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "Scheduled task [Monitor-System Resources] failed with incorrect Cron expression!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify scheduling task - -PUT /monitor/job - -> Body Parameters - -```json -{ - "jobName": "", - "invokeTarget": "test", - "cronExpression": "0/40 * * * * ?", - "misfirePolicy": "3", - "concurrent": "1", - "jobGroup": "SYSTEM", - "status": "0", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "。", - "jobId": "2" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| ----------------- | -------- | ------ | -------- | ----------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » jobId | body | string | yes | Scheduling task ID | -| » jobName | body | string | yes | Scheduling task name | -| » jobGroup | body | string | yes | Group name | -| » invokeTarget | body | string | yes | Invoke target, callback function | -| » targetParams | body | string | yes | Standard JSON format string | -| » cronExpression | body | string | yes | Cron expression, last '?' char not used | -| » misfirePolicy | body | string | yes | 1. Execute immediately 2. Execute once 3. Abandon execution | -| » concurrent | body | string | yes | 0 prohibited 1 allowed | -| » status | body | string | yes | 0 Inactive 1 Active | -| » remark | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "Scheduled task [Monitor-System Resources] failed with incorrect Cron expression!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete scheduling task - -DELETE /monitor/job/{jobIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------------------------------- | -| jobIds | path | string | yes | Task ID, multiple can be separated by English commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "there is no accessible scheduling task data" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT modify scheduling task status - -PUT /monitor/job/changeStatus - -> Body Parameters - -```json -{ - "jobId": "22", - "status": "0" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » jobId | body | string | yes | none | -| » status | body | string | yes | 0 Inactive 1 Active | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible scheduling task data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT schedule task to be executed immediately once - -PUT /monitor/job/run/{jobId} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| jobId | path | string | yes | Task ID | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "There is no accessible scheduling task data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT reset schedule tasks queue - -PUT /monitor/job/resetQueueJob - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Operation log information - -## GET aquire operation log list - -GET /system/log/operate/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------- | -| title | query | string | no | operation module name | -| operName | query | string | no | operator name | -| businessType | query | string | no | operation type | -| status | query | string | no | status | -| beginTime | query | string | no | begin time | -| endTime | query | string | no | end time | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "operId": "4274", - "title": "Operation Logging", - "businessType": "5", - "method": "controller.(*SysLogOperateController).Export-fm", - "requestMethod": "POST", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/system/log/operate/export", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"beginTime\":\"\",\"endTime\":\"\",\"operName\":\"\",\"pageNum\":1,\"pageSize\":20,\"title\":\"\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"8912\",\"content-type\":\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheetattachment; filename=\"sys_log_operate_export_20_1712650224134.xlsx\"\"}", - "status": "1", - "operTime": 1712650224177, - "costTime": 47 - }, - { - "operId": "4273", - "title": "Operation Logging", - "businessType": "5", - "method": "controller.(*SysLogOperateController).Export-fm", - "requestMethod": "POST", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/system/log/operate/export", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"beginTime\":\"\",\"endTime\":\"\",\"operName\":\"\",\"pageNum\":1,\"pageSize\":20,\"title\":\"\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"8798\",\"content-type\":\"application/vnd.openxmlformats-officedocument.spreadsheetml.sheetattachment; filename=\"sys_log_operate_export_20_1712650216901.xlsx\"\"}", - "status": "1", - "operTime": 1712650216926, - "costTime": 38 - }, - { - "operId": "4272", - "title": "WS Sessions", - "businessType": "0", - "method": "controller.(*WSController).WS-fm", - "requestMethod": "GET", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/ws", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2NDI3ODk4NjksImV4cCI6MTcxMjY0OTk4OTg2OSwibG9naW5fa2V5IjoiMHFpd2kxcDJiaWR4Njc3MSIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.l-yIhxzVj1DGTGWr5AwcLE0guh8pIRqG7Pu4SfHshJmV3Lx3hCtwp_KTsV14wKgpO8phscD2FNObFvE4Y0sDxA\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}", - "status": "1", - "operTime": 1712649765251, - "costTime": 35009 - }, - { - "operId": "4271", - "title": "WS Sessions", - "businessType": "0", - "method": "controller.(*WSController).WS-fm", - "requestMethod": "GET", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/ws", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}", - "status": "1", - "operTime": 1712629470304, - "costTime": 1801 - }, - { - "operId": "4270", - "title": "WS Sessions", - "businessType": "0", - "method": "controller.(*WSController).WS-fm", - "requestMethod": "GET", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/ws", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}", - "status": "1", - "operTime": 1712629466870, - "costTime": 3371 - }, - { - "operId": "4269", - "title": "WS Sessions", - "businessType": "0", - "method": "controller.(*WSController).WS-fm", - "requestMethod": "GET", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/ws", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}", - "status": "1", - "operTime": 1712629453525, - "costTime": 9957 - }, - { - "operId": "4268", - "title": "WS Sessions", - "businessType": "0", - "method": "controller.(*WSController).WS-fm", - "requestMethod": "GET", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/ws", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}", - "status": "1", - "operTime": 1712629439209, - "costTime": 551 - }, - { - "operId": "4267", - "title": "WS Sessions", - "businessType": "0", - "method": "controller.(*WSController).WS-fm", - "requestMethod": "GET", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/ws", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{\"access_token\":\"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhaXQiOjE3MTI2MjcxMTUyMjgsImV4cCI6MTcxMjYzNDMxNTIyOCwibG9naW5fa2V5IjoiOHRsb2Z2OHVkaHYyb3QyNiIsInVzZXJfaWQiOiIyIiwidXNlcl9uYW1lIjoiYWRtaW4ifQ.tF0VH1X556kQZpTcf9j1xK1Rgdwc416alDIvFUF1gfnZkXzXT4CDFM8CMLX48IpS-tz51edIMCOhWViG5uqLZQ\",\"language\":\"en_US\",\"subGroupID\":\"12,1010,1005\"}", - "operMsg": "{\"status\":\"200\",\"size\":\"0\",\"content-type\":\"\"}", - "status": "1", - "operTime": 1712629148548, - "costTime": 3581 - }, - { - "operId": "4266", - "title": "Scheduling Tasks", - "businessType": "8", - "method": "controller.(*SysJobController).ResetQueueJob-fm", - "requestMethod": "PUT", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/monitor/job/resetQueueJob", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{}", - "operMsg": "{\"status\":\"200\",\"size\":\"26\",\"content-type\":\"application/json; charset=utf-8\"}", - "status": "1", - "operTime": 1712628578539, - "costTime": 1 - }, - { - "operId": "4265", - "title": "Scheduling Tasks", - "businessType": "2", - "method": "controller.(*SysJobController).Run-fm", - "requestMethod": "PUT", - "operatorType": "1", - "operName": "admin", - "deptName": "", - "operUrl": "/monitor/job/run/8", - "operIp": "192.168.2.219", - "operLocation": "Intranet", - "operParam": "{}", - "operMsg": "{\"status\":\"200\",\"size\":\"26\",\"content-type\":\"application/json; charset=utf-8\"}", - "status": "1", - "operTime": 1712628417006, - "costTime": 0 - } - ], - "total": 4274 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------ | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» operId | string | true | none | none | -| »» title | string | true | none | none | -| »» businessType | string | true | none | none | -| »» method | string | true | none | none | -| »» requestMethod | string | true | none | none | -| »» operatorType | string | true | none | none | -| »» operName | string | true | none | none | -| »» deptName | string | true | none | none | -| »» operUrl | string | true | none | none | -| »» operIp | string | true | none | none | -| »» operLocation | string | true | none | none | -| »» operParam | string | true | none | none | -| »» operMsg | string | true | none | none | -| »» status | string | true | none | none | -| »» operTime | string | true | none | none | -| »» costTime | string | true | none | none | - -## POST export operation log list - -POST /system/log/operate/export - -， - -```text -content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx -content-length: 36500 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "title": "string", - "operName": "string", - "businessType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » title | body | string | no | none | -| » operName | body | string | no | none | -| » businessType | body | string | no | none | -| » status | body | string | no | none | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 500, - "msg": "" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE clean operation log - -DELETE /system/log/operate/clean - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete operation log - -DELETE /system/log/operate/{operIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------------- | -| operIds | path | string | yes | Operation log ID, multiple can be separated by English commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Security log information - -## GET login access list - -GET /system/log/login/list - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------ | -| ipaddr | query | string | no | login ip address | -| userName | query | string | no | login name | -| status | query | string | no | login status: 0 failed 1 successful | -| beginTime | query | string | no | begin time | -| endTime | query | string | no | end time | -| pageNum | query | number | no | Page number，default 1 | -| pageSize | query | number | no | Size of one page，default 10 | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "loginId": "1228", - "userName": "supervisor", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712654593452 - }, - { - "loginId": "1227", - "userName": "supervisor", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "status": "1", - "msg": "Logout Successful", - "loginTime": 1712654578672 - }, - { - "loginId": "1226", - "userName": "supervisor", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712654055458 - }, - { - "loginId": "1225", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "status": "1", - "msg": "Logout Successful", - "loginTime": 1712654052696 - }, - { - "loginId": "1224", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712650911235 - }, - { - "loginId": "1223", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712642789872 - }, - { - "loginId": "1222", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Edge 123.0.0.0", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712627115231 - }, - { - "loginId": "1221", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712627080393 - }, - { - "loginId": "1220", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712568712553 - }, - { - "loginId": "1219", - "userName": "admin", - "ipaddr": "192.168.2.219", - "loginLocation": "Intranet", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "Login Success", - "loginTime": 1712562773610 - } - ], - "total": 1228 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------------------ | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » total | integer | true | none | none | -| » rows | [object] | true | none | none | -| »» infoId | string | true | none | none | -| »» userName | string | true | none | none | -| »» ipaddr | string | true | none | none | -| »» loginLocation | string | true | none | none | -| »» browser | string | true | none | none | -| »» os | string | true | none | none | -| »» status | string | true | none | 0 1Success | -| »» msg | string | true | none | none | -| »» loginTime | string | true | none | none | - -## POST export login access list - -POST /system/log/login/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx -content-length: 24305 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "ipaddr": "string", - "userName": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » ipaddr | body | string | no | none | -| » userName | body | string | no | none | -| » status | body | string | no | 0 failed 1 successful | -| » beginTime | body | string | no | none | -| » endTime | body | string | no | none | -| » pageNum | body | number | yes | none | -| » pageSize | body | number | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE clean login access list - -DELETE /system/log/login/clean - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## PUT unlock login user - -PUT /system/log/login/unlock/{userName} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| userName | path | string | yes | login name | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "The user is not locked" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## DELETE delete login user - -DELETE /system/log/login/{infoIds} - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | --------------------------------------------------- | -| infoIds | path | string | yes | log ID, multiple can be separated by English commas | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 500, - "msg": "" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# System/Server monitoring information - -## GET server service information - -GET /monitor/system-info - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "cpu": { - "core": 20, - "coreUsed": [ - "3.47", - "1.48", - "3.97", - "1.62", - "4.06", - "2.07", - "54.30", - "1.85", - "6.01", - "0.02", - "6.06", - "0.02", - "8.89", - "22.90", - "21.61", - "23.85", - "3.98", - "3.40", - "2.77", - "3.22" - ], - "model": "13th Gen Intel(R) Core(TM) i7-1370P", - "speed": "1900MHz" - }, - "disk": [ - { - "avail": "228.95GB", - "pcent": "49.1%", - "size": "449.81GB", - "target": "C:", - "used": "220.86GB" - }, - { - "avail": "449.88GB", - "pcent": "10.2%", - "size": "501.01GB", - "target": "D:", - "used": "51.13GB" - }, - { - "avail": "2.99GB", - "pcent": "89.5%", - "size": "28.37GB", - "target": "T:", - "used": "25.38GB" - }, - { - "avail": "2.99GB", - "pcent": "89.5%", - "size": "28.37GB", - "target": "U:", - "used": "25.38GB" - }, - { - "avail": "2.99GB", - "pcent": "89.5%", - "size": "28.37GB", - "target": "V:", - "used": "25.38GB" - }, - { - "avail": "3.63GB", - "pcent": "84.2%", - "size": "22.94GB", - "target": "W:", - "used": "19.31GB" - }, - { - "avail": "25.12GB", - "pcent": "56.5%", - "size": "57.79GB", - "target": "X:", - "used": "32.68GB" - }, - { - "avail": "14.61GB", - "pcent": "50.3%", - "size": "29.36GB", - "target": "Y:", - "used": "14.75GB" - }, - { - "avail": "4.40GB", - "pcent": "84.2%", - "size": "27.86GB", - "target": "Z:", - "used": "23.46GB" - } - ], - "memory": { - "external": "16.66MB", - "freemem": "5.25GB", - "heapTotal": "105.09MB", - "heapUsed": "32.09MB", - "rss": "121.76MB", - "totalmem": "31.69GB", - "usage": "83.00" - }, - "network": { - "Bluetooth network connection": "IPv6 fe80::8f77:9546:473a:6147 / IPv4 169.254.232.174", - "Ethernet": "IPv6 fd01:9495:228f::411 / IPv6 fd0e:192:168:4::119 / IPv6 fe80::f6bb:7d5f:bcb2:763b / IPv4 192.168.2.219", - "Loopback Pseudo-Interface 1": "IPv6 ::1 / IPv4 127.0.0.1", - "WLAN": "IPv6 fe80::cb34:45d6:7f13:a4a4 / IPv4 192.168.30.59", - "vEthernet (WSL)": "IPv6 fe80::f3c2:72b3:9809:26dc / IPv4 172.20.144.1", - "Local connection* 1": "IPv6 fe80::aef3:2c79:784e:8b21 / IPv4 169.254.40.119", - "Local connection* 2": "IPv6 fe80::8a02:620c:ecf7:5622 / IPv4 169.254.114.138" - }, - "system": { - "arch": "x86_64", - "archVersion": "10.0.22631.3374 Build 22631.3374", - "bootTime": 1052280, - "hostname": "simonzhangsz", - "os": "windows", - "platform": "Microsoft Windows 11 Home China", - "platformVersion": "10.0.22631.3374 Build 22631.3374", - "processId": 46412, - "runArch": "amd64", - "runTime": 206594, - "runVersion": "go1.21.0" - }, - "time": { - "current": "2024-04-09 19:55:24", - "timezone": "+0800 CST", - "timezoneName": "CST" - } - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------------------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» project | object | true | none | none | -| »»» appDir | string | true | none | none | -| »»» env | string | true | none | none | -| »»» name | string | true | none | none | -| »»» version | string | true | none | none | -| »»» dependencies | object | false | none | none | -| »»»» xlsx | string | true | none | none | -| »» cpu | object | true | none | none | -| »»» model | string | true | none | none | -| »»» speed | string | true | none | none | -| »»» core | integer | true | none | none | -| »»» coreUsed | [string] | true | none | none | -| »» memory | object | true | none | none | -| »»» usage | string | true | none | none | -| »»» freemem | string | true | none | none | -| »»» totalmem | string | true | none | none | -| »»» rss | string | true | none | none | -| »»» heapTotal | string | true | none | none | -| »»» heapUsed | string | true | none | none | -| »»» external | string | true | none | none | -| »» network | object | false | none | none | -| »»» Ethernet 2 | string | false | none | none | -| »»» Ethernet | string | false | none | none | -| »»» VirtualBox Host-Only Network | string | false | none | none | -| »»» Loopback Pseudo-Interface 1 | string | false | none | none | -| »» time | object | true | none | none | -| »»» current | string | true | none | none | -| »»» uptime | string | true | none | none | -| »»» timezone | string | true | none | none | -| »»» timezoneName | string | true | none | none | -| »» system | object | true | none | none | -| »»» platform | string | true | none | none | -| »»» node | string | true | none | none | -| »»» v8 | string | true | none | none | -| »»» processId | integer | true | none | none | -| »»» arch | string | true | none | none | -| »»» uname | string | true | none | none | -| »»» release | string | true | none | none | -| »»» hostname | string | true | none | none | -| »»» homeDir | string | true | none | none | -| »»» cmd | string | true | none | none | -| »»» execCommand | string | true | none | none | -| »» disk | [object] | true | none | none | -| »»» size | string | true | none | none | -| »»» used | string | true | none | none | -| »»» avail | string | true | none | none | -| »»» pcent | string | true | none | none | -| »»» target | string | true | none | none | - -## GET load resource monitoring information - -GET /monitor/load - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------- | -| type | query | string | yes | type: all/cpu/memory/io/network | -| startTime | query | number | yes | start time - (milliseconds) | -| endTime | query | number | yes | end time - (milliseconds) | -| neType | query | string | no | ne type | -| neId | query | string | no | ne ID | -| name | query | string | no | names, valid for network and io | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "Ethernet": "IPv4 192.168.1.54 / IPv6 fe80::9906:92e5:b85e:3943", - "VirtualBox Host-Only Network": "IPv4 192.168.56.1 / IPv6 fe80::74da:97e8:b5e8:2c78", - "Loopback Pseudo-Interface 1": "IPv4 127.0.0.1 / IPv6 ::1" - }, - "time": { - "current": "2023-02-01 17:20:07", - "uptime": "8h", - "timezone": "GMT+0800", - "timezoneName": "China Standard Time" - }, - "system": { - "platform": "win32", - "node": "18.11.0", - "v8": "10.2.154.15-node.12", - "processId": 19988, - "arch": "x64", - "uname": "Windows_NT", - "release": "10.0.19045", - "hostname": "DESKTOP-QFRQUSF", - "homeDir": "C:\\Users\\LC1234", - "cmd": "E:\\Self\\Projects\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------------------------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» project | object | true | none | none | -| »»» appDir | string | true | none | none | -| »»» env | string | true | none | none | -| »»» name | string | true | none | none | -| »»» version | string | true | none | none | -| »»» dependencies | object | false | none | none | -| »»»» xlsx | string | true | none | none | -| »» cpu | object | true | none | none | -| »»» model | string | true | none | none | -| »»» speed | string | true | none | none | -| »»» core | integer | true | none | none | -| »»» coreUsed | [string] | true | none | none | -| »» memory | object | true | none | none | -| »»» usage | string | true | none | none | -| »»» freemem | string | true | none | none | -| »»» totalmem | string | true | none | none | -| »»» rss | string | true | none | none | -| »»» heapTotal | string | true | none | none | -| »»» heapUsed | string | true | none | none | -| »»» external | string | true | none | none | -| »» network | object | false | none | none | -| »»» Ethernet 2 | string | false | none | none | -| »»» Ethernet | string | false | none | none | -| »»» VirtualBox Host-Only Network | string | false | none | none | -| »»» Loopback Pseudo-Interface 1 | string | false | none | none | -| »» time | object | true | none | none | -| »»» current | string | true | none | none | -| »»» uptime | string | true | none | none | -| »»» timezone | string | true | none | none | -| »»» timezoneName | string | true | none | none | -| »» system | object | true | none | none | -| »»» platform | string | true | none | none | -| »»» node | string | true | none | none | -| »»» v8 | string | true | none | none | -| »»» processId | integer | true | none | none | -| »»» arch | string | true | none | none | -| »»» uname | string | true | none | none | -| »»» release | string | true | none | none | -| »»» hostname | string | true | none | none | -| »»» homeDir | string | true | none | none | -| »»» cmd | string | true | none | none | -| »»» execCommand | string | true | none | none | -| »» disk | [object] | true | none | none | -| »»» size | string | true | none | none | -| »»» used | string | true | none | none | -| »»» avail | string | true | none | none | -| »»» pcent | string | true | none | none | -| »»» target | string | true | none | none | - -# General APIs - -## GET Default Home Page - -GET / - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------ | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "Welcome to the CN EMS Core Network Management Platform, current version: 2.2404.6, please access via the frontend address." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -## GET Captcha Code - -GET /captchaImage - -Captcha code valid for 2 minutes - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "captchaEnabled": true, - "uuid": "os0t2l1532dhuvqv", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%2364e6e6' d='M62.19 26.62L62.24 26.67L62.16 26.59Q65.43 27.87 69.20 27.87L69.20 27.88L69.26 27.94Q70.89 27.97 72.45 27.75L72.42 27.71L72.32 27.61Q71.98 28.18 71.33 29.36L71.26 29.29L71.29 29.32Q71.92 29.46 72.60 29.23L72.65 29.27L72.49 29.11Q72.23 30.03 72.23 30.83L72.28 30.89L72.19 30.79Q72.19 31.52 72.46 32.24L72.54 32.32L72.51 32.29Q70.98 31.95 69.20 31.99L69.29 32.08L69.23 32.02Q67.58 32.12 66.17 32.39L66.17 32.39L66.03 32.25Q66.46 31.46 66.35 30.47L66.36 30.48L66.36 30.49Q66.19 30.62 65.97 30.58L65.86 30.48L65.87 30.49Q65.69 30.47 65.39 30.47L65.37 30.44L65.49 30.57Q65.20 28.71 62.15 26.58ZM65.45 29.99L65.54 30.08L65.51 30.05Q67.04 30.25 68.18 30.21L68.22 30.25L68.13 30.16Q70.97 30.30 70.97 30.30L70.96 30.28L70.83 30.16Q71.02 29.20 71.74 28.18L71.68 28.11L71.59 28.03Q70.56 28.29 69.38 28.29L69.45 28.36L69.38 28.29Q66.36 28.35 63.47 27.40L63.43 27.36L63.37 27.30Q65.24 28.64 65.62 30.17ZM65.12 30.77L65.19 30.84L65.23 30.87Q65.53 30.79 66.21 30.83L66.19 30.81L66.15 30.77Q66.09 31.89 65.56 32.65L65.56 32.66L65.59 32.69Q67.19 32.57 67.03 32.57L67.07 32.60L67.07 32.60Q66.49 33.54 65.73 34.31L65.65 34.22L65.68 34.26Q67.75 33.97 69.69 33.97L69.55 33.83L69.64 33.91Q74.20 33.87 78.31 35.58L78.40 35.67L75.97 34.31L75.83 34.16Q73.52 32.73 73.52 30.52L73.38 30.39L73.46 30.46Q73.14 30.45 72.88 30.45L72.98 30.55L72.52 30.63L72.40 30.51Q72.58 29.78 73.15 28.83L73.13 28.81L73.05 28.72Q72.58 28.75 71.63 28.94L71.80 29.11L71.65 28.96Q72.26 28.05 73.25 27.29L73.21 27.25L73.11 27.15Q71.26 27.58 69.24 27.58L69.32 27.66L69.18 27.52Q64.54 27.64 60.77 25.77L60.70 25.70L60.78 25.78Q65.14 28.39 65.25 30.90ZM66.06 29.73L66.15 29.82L65.84 29.78L65.93 29.86Q65.64 29.61 65.53 29.61L65.71 29.79L65.72 29.80Q65.53 29.23 65.15 28.82L64.97 28.64L64.22 27.77L64.27 27.82Q66.75 28.66 69.49 28.66L69.36 28.54L69.46 28.64Q70.16 28.50 71.03 28.42L71.14 28.52L70.96 28.84L70.75 29.05L70.74 29.04Q69.46 29.09 68.17 29.06L68.18 29.06L68.33 29.22Q66.91 29.10 65.62 28.83L65.53 28.74L65.68 28.88Q66.05 29.26 66.20 29.87Z'/%3e%3cpath fill='%2371ade8' d='M44.80 18.31L44.89 18.39L44.82 18.33Q41.80 18.50 39.97 17.43L39.85 17.31L39.91 17.37Q42.41 15.99 47.28 11.77L47.20 11.68L47.21 11.69Q47.93 11.50 49.23 10.89L49.37 11.03L49.19 10.85Q47.99 16.93 47.88 23.28L47.82 23.23L47.74 23.15Q47.66 29.54 48.72 35.63L48.88 35.78L48.77 35.68Q47.12 34.97 44.98 34.86L45.00 34.87L44.91 34.78Q44.95 30.79 44.95 26.71L44.85 26.62L44.84 26.60Q44.89 22.55 44.93 18.43ZM44.49 20.62L44.51 35.22L44.60 35.31Q45.66 35.15 46.61 35.34L46.63 35.36L46.75 35.48Q46.71 36.05 46.90 37.42L46.91 37.43L46.92 37.44Q49.78 37.98 52.21 40.22L52.28 40.29L52.29 40.30Q49.82 33.19 49.79 25.73L49.66 25.60L49.66 25.60Q49.66 18.22 51.49 10.98L51.52 11.02L51.56 11.05Q50.92 11.37 49.32 12.47L49.37 12.52L49.39 12.53Q49.53 11.73 49.84 10.21L49.89 10.26L49.86 10.23Q48.47 10.94 47.02 11.32L47.11 11.40L47.16 11.45Q43.30 14.94 39.00 17.22L39.01 17.23L38.93 17.16Q40.33 18.25 42.69 18.59L42.75 18.65L42.72 18.62Q42.05 19.13 40.76 20.20L40.80 20.24L40.77 20.21Q42.38 20.71 44.58 20.71L44.48 20.61Z'/%3e%3cpath fill='%23328ce5' d='M21.38 18.49L21.29 18.40L21.25 18.35Q18.06 18.36 16.23 17.29L16.30 17.36L16.32 17.39Q18.86 16.04 23.73 11.82L23.69 11.77L23.72 11.80Q24.32 11.48 25.61 10.87L25.68 10.95L25.67 10.93Q24.27 16.80 24.15 23.16L24.27 23.28L24.25 23.25Q24.08 29.55 25.14 35.65L25.24 35.75L25.26 35.76Q23.44 34.90 21.31 34.78L21.45 34.93L21.33 34.80Q21.30 30.73 21.30 26.66L21.32 26.68L21.30 26.66Q21.18 22.44 21.22 18.33ZM21.01 20.74L20.85 35.16L20.88 35.19Q22.20 35.29 23.15 35.48L23.18 35.51L23.02 35.35Q23.15 36.09 23.34 37.46L23.40 37.53L23.34 37.46Q26.25 38.05 28.68 40.29L28.73 40.34L28.57 40.18Q26.18 33.15 26.15 25.69L26.07 25.61L26.20 25.74Q26.00 18.15 27.82 10.92L27.83 10.92L27.98 11.08Q27.25 11.30 25.65 12.40L25.78 12.53L25.79 12.54Q25.94 11.73 26.24 10.21L26.19 10.16L26.21 10.19Q24.96 11.03 23.51 11.41L23.43 11.32L23.48 11.37Q19.71 14.95 15.41 17.23L15.40 17.22L15.37 17.19Q16.80 18.32 19.16 18.66L19.09 18.60L19.19 18.70Q18.48 19.16 17.18 20.22L17.13 20.18L17.27 20.32Q18.61 20.55 20.82 20.55L20.86 20.59Z'/%3e%3cpath fill='%23ea5b7f' d='M99.33 32.82L99.48 32.98L99.49 32.99Q99.70 33.88 100.23 35.90L100.26 35.93L100.19 35.86Q95.96 34.53 91.36 34.79L91.43 34.87L91.36 34.79Q86.86 35.13 82.86 37.11L82.93 37.18L82.77 37.02Q83.04 36.37 83.08 36.45L83.03 36.40L83.12 36.49Q86.76 32.44 90.68 28.03L90.81 28.15L90.75 28.10Q95.13 23.07 96.31 18.39L96.27 18.35L96.37 18.45Q96.79 16.66 95.52 15.48L95.57 15.53L95.51 15.48Q94.32 14.38 92.53 14.53L92.55 14.55L92.54 14.55Q92.19 14.49 91.85 14.49L91.78 14.43L91.82 14.47Q90.33 14.50 89.08 15.42L88.92 15.26L89.03 15.38Q87.75 16.75 87.97 19.42L87.92 19.37L88.00 19.44Q86.06 18.95 84.84 18.50L84.84 18.49L84.86 18.51Q84.76 17.19 84.68 15.75L84.69 15.75L84.77 15.83Q84.61 14.11 85.22 12.97L85.20 12.95L85.12 12.87Q87.02 11.61 90.37 11.61L90.36 11.60L92.10 11.59L92.14 11.63Q94.30 11.54 95.25 11.66L95.24 11.65L95.25 11.65Q99.69 12.18 99.96 14.61L99.85 14.51L99.95 14.61Q100.04 15.19 99.96 15.99L99.88 15.90L100.03 16.05Q99.98 16.69 99.83 17.37L99.82 17.37L99.67 17.22Q98.08 25.38 90.51 32.23L90.53 32.26L90.51 32.23Q91.96 32.12 93.33 32.12L93.30 32.09L93.29 32.08Q96.57 32.13 99.43 32.93ZM98.92 12.16L98.80 12.04L98.93 12.17Q97.17 11.37 95.46 11.29L95.53 11.37L92.18 11.25L92.06 11.13Q87.59 10.85 85.38 11.96L85.41 11.98L85.34 11.91Q84.31 13.32 84.31 15.38L84.34 15.40L84.44 15.51Q84.32 16.07 84.63 18.89L84.76 19.02L84.72 18.98Q85.24 19.19 86.42 19.50L86.39 19.47L86.47 20.58L86.37 20.48Q86.42 21.03 86.50 21.56L86.48 21.54L86.42 21.48Q87.75 21.67 90.23 21.90L90.24 21.92L90.11 21.79Q90.23 21.56 90.23 21.22L90.21 21.20L90.17 21.16Q90.16 19.32 91.37 17.96L91.45 18.04L91.47 18.06Q92.64 16.66 94.43 16.78L94.36 16.71L94.33 16.67Q95.20 16.82 95.96 16.97L95.93 16.94L95.93 16.94Q95.99 17.27 96.06 17.69L96.08 17.71L96.00 17.62Q96.11 18.11 96.03 18.46L95.97 18.39L96.15 18.57Q94.71 23.15 90.30 27.99L90.36 28.05L90.40 28.09Q88.21 30.27 82.76 36.33L82.77 36.33L82.78 36.35Q82.53 37.12 82.18 37.69L82.19 37.70L82.23 37.73Q83.92 36.95 85.45 36.42L85.31 36.28L85.46 36.43Q84.62 36.88 83.67 38.37L83.80 38.50L83.77 38.47Q83.69 38.85 83.57 39.19L83.52 39.14L83.49 39.10Q88.27 36.96 93.76 37.15L93.88 37.28L93.90 37.29Q99.62 37.50 104.19 39.86L104.12 39.79L103.17 37.70L103.03 37.56Q102.53 36.37 102.26 35.57L102.12 35.43L102.24 35.55Q101.46 35.08 100.24 34.66L100.30 34.71L100.21 34.63Q100.03 33.87 99.65 32.50L99.78 32.63L99.64 32.49Q97.40 31.89 95.12 31.70L95.17 31.75L95.13 31.71Q99.98 27.32 101.51 19.05L101.48 19.03L101.62 16.09L101.67 16.13Q101.59 14.34 100.37 13.66L100.31 13.59L100.27 13.59L100.27 13.59Q100.18 13.47 100.11 13.47L100.09 13.45L100.11 13.47Q100.01 12.76 98.91 12.15Z'/%3e%3cpath d='M14 30 C59 18%2c65 9%2c110 17' stroke='%2363dddd' fill='none'/%3e%3cpath d='M13 24 C48 26%2c39 6%2c107 9' stroke='%23de77c4' fill='none'/%3e%3cpath d='M12 11 C50 25%2c80 39%2c113 8' stroke='%23e593bc' fill='none'/%3e%3cpath d='M19 17 C43 30%2c51 8%2c109 8' stroke='%23ddc16d' fill='none'/%3e%3c/svg%3e" -} -``` - -```json -{ - "code": 1, - "msg": "success", - "text": "9", - "captchaEnabled": true, - "uuid": "s7hf2j3erfpritqy", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%23ec73ce' d='M85.44 24.04L85.53 24.13L85.51 24.11Q83.59 23.90 82.35 25.33L82.43 25.40L82.43 25.41Q81.15 26.79 80.96 28.70L81.02 28.76L81.00 28.73Q80.82 30.84 81.91 31.81L81.97 31.87L81.87 31.78Q83.04 32.83 85.13 32.72L84.98 32.56L85.02 32.61Q87.16 32.50 88.26 31.81L88.29 31.84L88.27 31.82Q89.38 30.68 89.38 29.12L89.37 29.11L89.44 29.19Q89.37 28.73 89.30 28.35L89.35 28.41L89.39 28.44Q89.39 26.69 88.28 25.34L88.23 25.29L88.35 25.40Q87.20 24.01 85.52 24.12ZM85.09 35.22L85.17 35.31L85.10 35.24Q80.72 35.24 79.32 34.48L79.34 34.50L79.28 34.44Q78.32 33.75 78.13 32.04L78.05 31.96L78.03 31.93Q78.01 31.27 78.05 30.55L78.11 30.61L78.16 30.65Q78.27 29.66 78.27 29.21L78.24 29.17L78.13 29.06Q78.70 26.32 78.85 25.64L78.79 25.57L78.85 25.64Q79.36 23.75 80.20 22.34L80.18 22.33L80.01 22.15Q82.70 17.80 88.64 11.44L88.62 11.42L88.67 11.48Q91.34 11.17 93.55 10.37L93.58 10.41L93.62 10.44Q86.67 17.81 83.47 22.04L83.47 22.03L83.48 22.04Q84.46 21.53 85.75 21.53L85.86 21.64L85.82 21.60Q89.14 21.61 90.67 23.56L90.71 23.60L90.75 23.64Q91.92 25.12 92.26 28.66L92.27 28.66L92.29 28.68Q92.39 29.43 92.39 30.04L92.36 30.01L92.47 30.12Q92.44 33.21 90.23 34.28L90.23 34.28L90.26 34.30Q88.98 34.86 85.10 35.24ZM87.47 37.72L87.43 37.68L87.35 37.60Q88.60 37.52 90.58 37.60L90.71 37.72L90.71 37.73Q92.28 37.73 93.84 37.01L93.93 37.09L93.82 36.99Q94.99 36.26 94.99 34.47L94.96 34.43L95.01 34.49Q95.03 34.01 94.86 33.02L94.88 33.04L94.82 32.98Q94.56 31.91 94.56 31.45L94.60 31.49L94.54 31.43Q93.75 26.79 92.15 24.88L92.04 24.78L92.07 24.81Q92.00 24.70 91.85 24.47L91.90 24.52L91.66 24.36L91.50 24.24L91.51 24.25Q91.11 23.69 90.50 22.74L90.55 22.79L90.49 22.74Q89.69 21.89 87.71 21.44L87.64 21.36L87.62 21.35Q88.95 19.86 91.92 16.17L91.82 16.07L96.16 10.89L96.12 10.85Q94.61 11.77 92.21 12.53L92.15 12.47L92.19 12.52Q93.08 11.51 94.87 9.53L94.82 9.48L94.81 9.46Q92.46 10.58 88.58 11.15L88.59 11.17L88.58 11.16Q82.94 17.12 79.97 22.07L79.85 21.95L79.89 21.99Q78.41 24.55 77.84 30.79L77.84 30.79L77.72 30.67Q77.67 31.27 77.74 32.22L77.69 32.17L77.72 32.20Q77.90 34.05 79.00 34.96L78.95 34.91L78.92 34.88Q79.37 35.10 79.33 35.14L79.29 35.10L79.36 35.17Q79.71 36.05 80.51 36.47L80.42 36.38L80.50 36.46Q81.90 37.10 83.84 37.29L83.84 37.29L83.85 37.30Q83.79 37.24 87.30 37.54ZM87.11 26.36L87.10 26.35L87.17 26.41Q87.77 26.33 88.72 26.83L88.63 26.74L88.77 26.87Q88.99 27.71 88.99 28.36L88.94 28.30L89.00 28.37Q89.12 30.16 88.17 31.15L88.28 31.26L88.28 31.26Q87.16 31.92 85.06 32.23L85.15 32.32L85.11 32.28Q83.59 32.20 83.05 31.93L83.20 32.08L83.03 31.91Q82.84 31.45 82.84 31.15L82.85 31.16L83.00 31.31Q82.76 28.03 85.69 26.73L85.62 26.66L85.62 26.65Q86.45 26.39 87.22 26.46Z'/%3e%3cpath d='M10 16 C70 25%2c49 8%2c114 10' stroke='%2378c4dd' fill='none'/%3e%3cpath fill='%23d24065' d='M23.39 35.44L23.31 35.35L23.31 35.35Q21.80 35.33 20.24 34.91L20.24 34.91L20.26 34.93Q19.14 34.12 18.99 32.48L18.89 32.38L18.88 32.38Q18.97 32.31 19.16 29.68L19.17 29.69L19.07 29.59Q20.06 29.37 22.08 28.99L22.06 28.97L21.89 29.75L22.00 29.86Q21.69 31.57 23.10 32.14L23.15 32.19L23.18 32.22Q23.98 32.57 26.08 32.57L26.01 32.50L25.93 32.42Q27.52 32.26 27.71 32.18L27.87 32.35L27.76 32.23Q28.67 32.08 29.39 31.58L29.52 31.71L29.51 31.70Q30.85 30.68 30.66 28.59L30.61 28.54L30.60 28.52Q30.46 26.14 28.73 24.58L28.78 24.63L28.81 24.66Q27.08 23.10 24.61 23.10L24.60 23.09L24.53 22.79L24.55 22.81Q24.82 22.67 25.69 22.59L25.87 22.76L25.67 22.57Q27.66 22.53 29.03 21.30L29.07 21.34L28.97 21.24Q30.46 20.12 30.61 18.26L30.65 18.29L30.63 18.27Q30.61 17.84 30.61 17.50L30.70 17.58L30.61 17.49Q30.67 16.03 29.29 15.11L29.30 15.12L29.23 15.05Q28.02 14.25 26.42 14.37L26.39 14.34L26.38 14.33Q25.06 14.15 23.84 14.57L23.94 14.67L23.85 14.58Q22.55 15.25 22.24 16.40L22.11 16.26L22.21 16.37Q21.98 17.09 22.06 17.85L22.16 17.96L22.17 17.96Q21.02 17.62 18.97 16.89L18.89 16.82L18.91 16.83Q18.81 15.28 18.85 14.45L18.82 14.42L18.84 14.44Q18.83 12.80 19.90 12.11L20.08 12.29L19.99 12.20Q21.48 11.67 23.08 11.67L22.93 11.53L22.93 11.53Q26.17 11.57 29.33 11.84L29.29 11.79L29.34 11.85Q34.43 12.29 34.12 16.06L34.06 16.00L34.04 15.97Q34.00 17.50 33.51 19.06L33.59 19.14L33.55 19.10Q32.65 22.20 30.29 23.12L30.22 23.04L30.14 22.97Q32.90 23.63 33.51 26.98L33.50 26.97L33.50 26.97Q33.63 28.02 33.71 30.03L33.80 30.12L33.74 30.06Q33.91 34.53 29.30 34.99L29.30 34.99L29.40 35.09Q28.57 35.06 23.28 35.33ZM28.53 37.60L28.57 37.65L28.41 37.49Q29.16 37.66 32.01 37.74L31.88 37.61L32.06 37.79Q33.81 37.86 35.45 37.22L35.45 37.22L35.35 37.11Q36.46 36.10 36.27 34.35L36.41 34.49L36.29 34.36Q36.31 33.16 36.00 31.41L35.88 31.29L35.94 31.36Q35.18 26.82 33.24 25.19L33.21 25.16L33.10 24.86L33.06 24.78L32.98 24.69Q34.87 23.39 35.63 19.01L35.50 18.88L35.45 18.84Q35.57 18.46 35.69 17.51L35.78 17.61L35.65 17.47Q35.78 16.76 35.70 16.08L35.80 16.17L35.71 16.08Q35.63 14.48 34.33 13.79L34.34 13.80L34.17 13.71L34.22 13.76Q33.85 12.70 32.71 12.17L32.80 12.26L32.68 12.14Q31.11 11.41 25.97 11.11L26.08 11.21L25.99 11.12Q24.41 11.14 22.81 11.14L22.83 11.16L22.87 11.20Q21.14 11.07 19.62 11.72L19.76 11.86L19.73 11.83Q18.52 12.60 18.52 14.35L18.51 14.34L18.41 14.24Q18.40 13.81 18.67 17.16L18.78 17.28L18.69 17.19Q18.99 17.26 20.63 17.87L20.60 17.84L20.62 17.86Q20.76 18.53 20.72 19.02L20.54 18.84L20.73 19.03Q20.54 19.34 20.58 19.87L20.63 19.93L20.66 19.95Q22.51 20.39 24.53 20.51L24.57 20.55L24.39 20.37Q24.38 18.42 25.48 17.58L25.50 17.59L25.44 17.54Q26.27 16.89 28.29 16.66L28.41 16.78L28.39 16.76Q29.52 16.75 30.09 16.94L30.06 16.90L30.08 16.92Q30.15 17.07 30.19 17.19L30.05 17.05L30.20 17.39L30.27 17.92L30.23 17.88Q30.30 18.13 30.26 18.28L30.18 18.21L30.31 18.34Q30.19 20.01 28.67 21.19L28.59 21.10L28.57 21.09Q27.71 22.06 25.69 22.25L25.72 22.28L25.69 22.24Q25.04 22.47 24.17 22.47L24.11 22.42L24.00 22.30Q24.03 22.64 24.19 23.33L24.35 23.49L24.35 23.50Q26.11 23.50 27.56 24.23L27.50 24.16L27.36 24.14L25.79 24.32L25.76 24.29Q25.76 24.59 25.87 25.20L26.02 25.36L25.90 25.23Q28.07 25.19 29.78 26.53L29.72 26.46L29.85 26.59Q30.02 26.92 30.33 28.55L30.36 28.59L30.35 28.58Q30.47 31.44 27.54 31.85L27.69 32.01L27.61 31.92Q25.48 32.16 24.91 32.12L24.88 32.09L24.98 32.19Q24.46 32.02 23.93 31.94L23.99 32.00L23.91 31.47L24.12 31.10L24.16 30.73L24.16 30.38L24.18 30.40Q23.17 30.42 22.37 30.61L22.44 30.68L22.41 30.65Q22.35 30.40 22.35 30.21L22.43 30.29L22.42 30.28Q22.46 30.09 22.46 29.86L22.33 29.73L22.34 29.74Q22.44 29.39 22.59 28.67L22.57 28.64L22.66 28.73Q20.80 28.96 18.93 29.30L18.88 29.26L18.80 29.18Q18.85 29.72 18.74 30.84L18.80 30.91L18.66 30.76Q18.64 31.99 18.64 32.59L18.55 32.50L18.55 32.50Q18.70 34.63 20.07 35.39L20.08 35.40L20.01 35.33Q21.56 37.68 26.28 37.49L26.31 37.52L26.24 37.45Q27.06 37.51 28.59 37.66Z'/%3e%3cpath d='M13 4 C51 9%2c65 6%2c110 4' stroke='%237590df' fill='none'/%3e%3cpath fill='%23d24b4b' d='M57.55 34.48L57.61 34.54L57.53 34.46Q56.76 34.34 56.08 34.38L56.14 34.44L56.20 34.50Q55.53 34.63 54.85 34.63L54.68 34.47L54.66 34.45Q55.13 31.03 55.13 27.61L55.18 27.66L55.14 27.61Q53.29 27.63 52.37 27.63L52.57 27.82L52.48 27.73Q51.54 27.64 49.72 27.56L49.69 27.54L49.80 27.64Q49.90 27.44 49.71 24.97L49.65 24.91L49.57 24.82Q52.15 25.39 55.12 25.39L55.18 25.45L55.19 25.46Q54.81 20.93 54.39 18.34L54.48 18.43L54.56 18.51Q55.36 18.62 56.16 18.62L56.03 18.49L57.67 18.50L57.78 18.61Q57.44 22.76 57.44 25.35L57.58 25.49L57.45 25.36Q59.72 25.46 62.92 25.12L62.84 25.04L62.84 25.03Q62.75 26.40 62.75 27.61L62.81 27.68L62.69 27.56Q62.58 27.71 61.78 27.75L61.75 27.72L61.70 27.66Q60.68 27.63 60.07 27.67L60.01 27.62L60.07 27.68Q60.10 27.71 57.44 27.71L57.51 27.78L57.34 31.04L57.51 31.21Q57.46 32.79 57.57 34.50ZM63.36 24.64L63.33 24.62L63.27 24.55Q61.46 24.95 59.59 25.03L59.54 24.98L59.53 24.97Q59.78 21.82 60.19 19.96L60.18 19.94L60.22 19.98Q59.51 20.03 58.10 20.18L58.10 20.18L58.31 18.15L58.19 18.03Q55.69 18.15 54.01 18.04L54.01 18.04L54.02 18.05Q54.54 21.12 54.73 25.00L54.70 24.97L54.67 24.94Q52.99 24.97 49.30 24.36L49.20 24.27L49.30 24.37Q49.53 25.51 49.53 28.14L49.55 28.16L51.02 28.11L50.96 28.05Q51.07 28.88 50.92 30.29L50.86 30.23L54.76 29.90L54.85 29.99Q54.64 33.17 54.34 35.00L54.38 35.04L54.33 34.99Q55.05 34.95 56.45 34.83L56.56 34.93L56.49 34.86Q56.55 35.62 56.52 36.95L56.41 36.85L56.39 36.83Q56.88 36.78 60.50 36.93L60.59 37.02L60.50 36.94Q59.71 33.98 59.48 30.02L59.38 29.92L59.45 29.99Q62.82 30.12 64.91 30.50L64.93 30.52L64.79 30.38Q64.61 29.43 64.61 28.48L64.58 28.46L64.74 26.71L64.69 26.66Q64.46 26.66 63.93 26.70L63.98 26.75L63.08 26.65L63.05 26.62Q63.09 25.86 63.20 24.49Z'/%3e%3cpath d='M6 19 C52 21%2c78 16%2c107 21' stroke='%2383ebb7' fill='none'/%3e%3cpath d='M8 38 C57 34%2c69 37%2c109 30' stroke='%237baddf' fill='none'/%3e%3c/svg%3e" -} -``` - -```json -{ - "captchaEnabled": false, - "code": 1, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ----------------- | ------- | -------- | ------------ | ------------------------------- | -| » code | number | true | none | none | -| » msg | string | true | none | none | -| » text | string | false | none | Only return in development mode | -| » captchaEnabled | boolean | true | none | none | -| » uuid | string | true | none | none | -| » img | string | true | none | none | - -## GET System Configuration - -GET /sys-conf - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": { - "buildTime": "-", - "copyright": "Copyright ©2023 AGrandTech", - "filePathBrand": "/static/logo/{language}_brand.png", - "filePathIcon": "/static/logo/{language}_icon.png", - "goVer": "-", - "helpDoc": "/static/helpDoc/{language}_doc.pdf", - "i18nDefault": "en_US", - "i18nOpen": "true", - "loginBackground": "#", - "logoType": "icon", - "officialUrl": "#", - "registerUser": "false", - "serialNum": "-", - "title": "AGrandEMS", - "version": "-" - }, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ---------------- | ------------ | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [object] | true | none | none | -| »» name | string | true | none | none | -| »» path | string | true | none | none | -| »» component | string | true | none | none | -| »» meta | object | true | none | none | -| »»» icon | string | true | none | none | -| »»» title | string | true | none | none | -| »»» hide | boolean | true | none | none | -| »»» cache | boolean | true | none | none | -| »»» target | string¦null | true | nonenone | | -| »» redirect | string | false | none | none | -| »» children | [object] | false | none | none | -| »»» name | string | true | none | none | -| »»» path | string | true | none | none | -| »»» component | string | true | none | none | -| »»» meta | object | true | none | none | -| »»»» icon | string | true | none | none | -| »»»» title | string | true | none | none | -| »»»» hide | boolean | true | none | none | -| »»»» cache | boolean | true | none | none | -| »»»» target | string¦null | true | none | none | - -## POST Upload help document - -POST /helpDoc - -> Body Parameters - -```json -{ - "uploadPath": "string", - "language": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » uploadPath | body | string | yes | none | -| » language | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": "/static/helpDoc/omc_guide.pdf", - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# General APIs/File operation - -## POST upload file - -POST /file/upload - -> Body Parameters - -```yaml -file: file://D:\Downloads\WPS_Setup_16417.exe -subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common', - 'download', 'chunk'] %}" - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ---------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | yes | upload file | -| » subPath | body | string | yes | sub path: ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk'] | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": { - "url": "http://127.0.0.1:6275/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61miiq526uqv.png", - "fileName": "/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mi1_iq526uqv.png", - "newFileName": "o_1d2bofn8f19dh5s11okpje611_iq526uqv.png", - "originalFileName": "o_1d2bofn8f19dh5s11okpje61mi1.png" - } -} -``` - -```json -{ - "code": 0, - "msg": "maximum upload file size 10.00MB" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| --------------------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | object | true | none | none | -| »» url | string | true | none | none | -| »» fileName | string | true | none | none | -| »» newFileName | string | true | none | none | -| »» originalFileName | string | true | none | none | - -## POST check chunk file - -POST /file/chunkCheck - -> Body Parameters - -```json -{ - "identifier": "string", - "fileName": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ----------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » identifier | body | string | yes | MD5 | -| » fileName | body | string | yes | check if file types allow uploading | - -> Response Examples - -> Ok - -```json -{ - "code": 1, - "msg": "success", - "data": [] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Ok | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [string] | true | none | none | - -## POST upload chunk file - -POST /file/chunkUpload - -```js -// upload form data -const formData = new FormData(); -formData.append('file', chunk, 'xxx.pdf'); -formData.append('index', chunksIndex); -formData.append('identifier', fileIdentifier); -``` - -Chunk is the data for file blocks, and the name of the uploaded file needs to be suffixed - -> Body Parameters - -```yaml -file: string -index: "{% mock 'increment' %}" -identifier: "{% mock 'id' %}" - -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------------- | -------- | ------------------------------------------------------ | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » file | body | string(binary) | yes | file block Blob object, file name needs to be suffixed | -| » index | body | string | yes | number of file blocks | -| » identifier | body | string | yes | file block directory identifier | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": "/upload/chunk/2023/06/identifier/index" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | --------------------------------------------------------------- | ----------- | ----------- | -| 206 | [Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **206** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | string | true | none | none | - -## POST Merge chunk file - -POST /file/chunkMerge - -> Body Parameters - -```json -{ - "identifier": "string", - "fileName": "string", - "subPath": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------------------------------------------------------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » identifier | body | string | yes | MD5(file name + file size) | -| » fileName | body | string | yes | Check if the suffix allows uploading | -| » subPath | body | string | yes | option ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk'] | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success", - "data": { - "url": "http://127.0.0.1:6275/upload/avatar/2023/06/gmircbr_48xqb8.png", - "fileName": "/upload/avatar/2023/06/gmircbr_48xqb8.png", - "newFileName": "gmircbr_48xqb8.png", - "originalFileName": "gmircbr.png" - } -} -``` - -```json -{ - "code": 0, - "msg": "failed to read merge target file" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | -------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | -| » data | [string] | true | none | none | - -## GET Download file - -GET /file/download/{filePath} - -The file Path parameter requires base64 encoding, base64 ("file storage resource path, URL relative address") -Breakpoint continuation can include a range for downloading data blocks in the request header, for example, a single block size of 5M ` Range: bytes=0-5242879` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------------------------------------- | -| filePath | path | string | yes | base64("file storage resource path, URL relative address") | -| Range | header | string | no | | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | - -> Response Examples - -> file block - -> 206 Response - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | --------------------------------------------------------------- | ---------------------------------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | file block | Inline | -| 206 | [Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1) | Breakpoint continuation file block | Inline | - -### Responses Data Schema - -# General APIs/Account Registration - -## POST Registration - -POST /register - -> Body Parameters - -```json -{ - "username": "string", - "password": "string", - "confirmPassword": "string", - "code": "string", - "uuid": "string" -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| ------------------ | -------- | ------ | -------- | ------------------- | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| AccessToken | header | string | no | Access token | -| body | body | object | no | none | -| » username | body | string | yes | none | -| » password | body | string | yes | none | -| » confirmPassword | body | string | yes | none | -| » code | body | string | yes | none | -| » uuid | body | string | yes | none | - -> Response Examples - -> OK - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "The current system has not enabled registration function!" -} -``` - -```json -{ - "code": 0, - "msg": "failed to register user [manager]. Sorry, the system has closed the external user registration channel" -} -``` - -```json -{ - "code": 0, - "msg": "The account number cannot start with a number, but can contain upper and lower case letters, numbers, and not less than 5 digits." -} -``` - -```json -{ - "code": 0, - "msg": "The password must contain at least 6 upper and lower case letters, numbers, and special symbols." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | description | -| ------- | ------- | -------- | ------------ | ----------- | -| » code | integer | true | none | none | -| » msg | string | true | none | none | - -# Data Management - -## GET Fuzzy query with '%' - -GET /api/rest/dataManagement/v1/omc_db/alarm - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| SQL | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Query by where condition - -GET /api/rest/databaseManagement/v1/omc_db/ne_info - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| WHERE | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Multiple SQL query - -GET /api/rest/databaseManagement/v1/omc_db/ne_state - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------------- | -------- | ------------------- | -| SQL | query | array[string] | yes | none | -| PAGE | query | string | yes | none | -| LIMIT | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Insert multiple record into table alarm_log - -POST /api/rest/dataManagement/v1/omc_db/alarm_log - -> Body Parameters - -```json -{ - "alarm_log": [ - { - "ne_type": "AMF", - "ne_id": "001", - "alarm_id": "2", - "alarm_code": "2", - "alarm_seq": "3", - "event_time": "2023-10-29 15:52:09" - }, - { - "ne_type": "SMF", - "ne_id": "001", - "alarm_id": "4", - "alarm_code": "2", - "alarm_seq": "3", - "event_time": "2023-10-29 16:52:09" - } - ] -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | -------- | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » alarm_log | body | [object] | yes | none | -| »» ne_type | body | string | yes | none | -| »» ne_id | body | string | yes | none | -| »» alarm_id | body | string | yes | none | -| »» alarm_code | body | string | yes | none | -| »» alarm_seq | body | string | yes | none | -| »» event_time | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Update single record - -PUT /api/rest/dataManagement/v1/omc_db/user - -> Body Parameters - -```json -{ - "user": { - "name": "test3" - } -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| WHERE | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » user | body | object | yes | none | -| »» name | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT UPDATE MeasureTask - -PUT /api/rest/databaseManagement/v1/omc_db/measure_task - -> Body Parameters - -```json -{ - "measure_task": { - "id": "28", - "ne_type": "SMF", - "ne_ids": "[\"SZ_01\"]", - "kpi_set": "[{\"Code\":\"SMFHA01\",\"KPIs\":[\"SMF.AttCreatePduSession\",\"SMF.AttCreatePduSession._Dnn\"]}]", - "schedule": "[{\"Type\":\"\",\"Days\":[]}]", - "start_time": "", - "end_time": "", - "granul_option": "30M", - "status": "Inactive", - "create_time": "2023-5-25 21:59:9", - "periods": "[]" - } -} -``` - -### Params - -| Name | Location | Type | Required | Description | -| ------------------ | -------- | ------ | -------- | ------------------- | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | -| » measure_task | body | object | yes | none | -| »» id | body | string | yes | none | -| »» ne_type | body | string | yes | none | -| »» ne_ids | body | string | yes | none | -| »» kpi_set | body | string | yes | none | -| »» schedule | body | string | yes | none | -| »» start_time | body | string | yes | none | -| »» end_time | body | string | yes | none | -| »» granul_option | body | string | yes | none | -| »» status | body | string | yes | none | -| »» create_time | body | string | yes | none | -| »» periods | body | string | yes | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete historical alarm exceeding 90 days - -DELETE /api/rest/databaseManagement/v1/delete/omc_db/alarm - -> Body Parameters - -```json -{} -``` - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ------------------- | -| WHERE | query | string | yes | none | -| AccessToken | header | string | yes | none | -| Authorization | header | string | yes | Authoirzation token | -| Referer | header | string | yes | User Referer | -| User-Agent | header | string | yes | User Agent | -| Accept-Language | header | string | yes | en_US;q=0.9 | -| body | body | object | no | none | - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# Data Schema diff --git a/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.pdf b/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.pdf deleted file mode 100644 index 22649ec..0000000 Binary files a/docs/interfaces/08-OMC HTTP RESTful API Interfaces v1.10.pdf and /dev/null differ diff --git a/docs/interfaces/08-OMC HTTP RESTful API 服务接口.md b/docs/interfaces/08-OMC HTTP RESTful API 服务接口.md deleted file mode 100644 index 25f153d..0000000 --- a/docs/interfaces/08-OMC HTTP RESTful API 服务接口.md +++ /dev/null @@ -1,17738 +0,0 @@ ---- -title: OMC v1.0.0 -language_tabs: - - shell: Shell - - http: HTTP - - javascript: JavaScript - - ruby: Ruby - - python: Python - - php: PHP - - java: Java - - go: Go -toc_footers: [] -includes: [] -search: true -code_clipboard: true -highlight_theme: darkula -headingLevel: 2 -generator: "@tarslib/widdershins v4.0.17" - ---- - -# OMC - -> v1.0.0 - -OMC HTTP Restful API Interfaces - -Base URLs: - -# Authentication - -# OMC HTTP RESTful API Interfaces/Monitor & Alarm - -## GET Get ALL NEs System State - -GET /api/rest/systemManagement/v1/elementType/ALL/objectType/systemState - -Get ALL NEs system state - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -> OK - -```json -{ - "data": [ - { - "SMF/001": { - "ipAddress": "192.168.14.13", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 24, - "sysCpuUsage": 9 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 50138, - "used": 13601 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 90620, - "sysMemUsage": 436, - "totalMem": 8167360 - }, - "serialNum": "20230905", - "version": "1.6.1" - } - } - }, - { - "AMF/001": { - "ipAddress": "192.168.14.12", - "systemState": { - "capability": 100000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 10 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 50138, - "used": 13601 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 23844, - "sysMemUsage": 436, - "totalMem": 8167360 - }, - "serialNum": "20230905", - "version": "1.6.1" - } - } - }, - { - "UPF/001": { - "ipAddress": "192.168.1.159", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 3474, - "sysCpuUsage": 2984 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 7998, - "used": 0 - }, - { - "total": 1603, - "used": 0 - }, - { - "total": 100278, - "used": 12041 - }, - { - "total": 8019, - "used": 1 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 8019, - "used": 0 - }, - { - "total": 1603, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 114940, - "sysMemUsage": 948, - "totalMem": 16424904 - }, - "serialNum": "13740272", - "version": "2.2311.8" - } - } - }, - { - "AUSF/001": { - "ipAddress": "192.168.1.186", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 564 - }, - "dbInfo": "adb v1.0.1", - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline| -|500|[Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)|Server Error|Inline| - -### Responses Data Schema - -## GET Get Alarm from NF - -GET /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - -Sync alarms from NF - -> Body Parameters - -```json -[ - { - "neType": "SMF", - "neId": "SZ_01", - "alarmId": "SMF0113", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:56:09", - "alarmCode": 10, - "alarmType": "EquipmentAlarm", - "origSeverity": "Critical", - "alarmStatus": 0, - "specificProblem": "string", - "addInfo": "string", - "locationInfo": "test" - } -] -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|elementTypeValue|path|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -## GET Get OMC Local Time - -GET /api/rest/systemManagement/v1/elementType/OMC/objectType/time - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Get All UDM System State - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/systemState - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |Use the specified declared Referer| -|User-Agent|header|string| yes |User agent| -|Accept-Language|header|string| yes |zh_CN;q=0.9 en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -## POST Get Alarm from NF - -POST /api/rest/faultManagement/v1/elementType/smf/objectType/alarms - -> Body Parameters - -```json -{ - "objectId": "SMF_0", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:52:09", - "alarmCode": 10, - "alarmType": "EquipmentAlarm", - "perceivedSeverity": 3, - "alarmStatus": 1, - "specificProblem": "string", - "additionalText": "string", - "alarmSource": "test" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Get OMC System State - -GET /api/rest/systemManagement/v1/elementType/omc/objectType/systemState - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post Alarm from AMF - -POST /api/rest/faultManagement/v1/elementType/amf/objectType/alarms - -> Body Parameters - -```json -{ - "objectId": "AMF_0", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:52:09", - "alarmCode": 6, - "alarmType": "EquipmentAlarm", - "perceivedSeverity": 3, - "alarmStatus": 1, - "specificProblem": "string", - "additionalText": "string", - "alarmSource": "test" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/Performance - -## PATCH Patch Measure Task - -PATCH /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|taskId|query|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post Measure Task - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -> Body Parameters - -```json -{} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|id|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/Performance/Performance Statistics - -## GET Statistical title - -GET /ne/kpi/title - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neType|query|string| yes |Network element type| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{ - "code": 1, - "data": [ - { - "id": "28", - "neType": "UDM", - "kpiId": "UDM.01", - "titleJson": "{\"cn\": \"5G注册用户数\", \"en\": \"UDR.5gActSub\"}", - "cnTitle": "5G注册用户数", - "enTitle": "UDR.5gActSub" - } - ], - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» cn_title|string|true|none||none| -|»» en_title|string|true|none||none| -|»» id|integer|true|none||none| -|»» kpi_id|string|true|none||none| -|»» ne_type|string|true|none||none| -|»» title_json|string|true|none||none| -|» msg|string|true|none||none| - -## GET Statistical data - -GET /ne/kpi/data - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neType|query|string| yes |Network element type| -|neId|query|string| yes |Network element ID| -|startTime|query|string| yes |Starting time| -|endTime|query|string| yes |end time| -|interval|query|number| yes |Particle size/average sampling value| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{ - "code": 1, - "data": [ - { - "SMF.01": "1594", - "SMF.02": "1594", - "SMF.03": "1594", - "SMF.04": "1594", - "SMF.05": "1594", - "SMF.06": "1594", - "SMF.07": "1594", - "SMF.08": "1594", - "SMF.09": "1594", - "SMF.10": "1594", - "SMF.11": "1594", - "SMF.12": "1594", - "SMF.13": "1594", - "SMF.14": "797", - "neName": "0", - "startIndex": 0, - "timeGroup": "2023-09-25 00:00" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 15, - "timeGroup": "2023-09-25 00:15" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 30, - "timeGroup": "2023-09-25 00:30" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 45, - "timeGroup": "2023-09-25 00:45" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 93, - "timeGroup": "2023-09-25 01:30" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 105, - "timeGroup": "2023-09-25 01:45" - } - ], - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» SMF.01|string|true|none||none| -|»» SMF.02|string|true|none||none| -|»» SMF.03|string|true|none||none| -|»» SMF.04|string|true|none||none| -|»» SMF.05|string|true|none||none| -|»» SMF.06|string|true|none||none| -|»» SMF.07|string|true|none||none| -|»» SMF.08|string|true|none||none| -|»» SMF.09|string|true|none||none| -|»» SMF.10|string|true|none||none| -|»» SMF.11|string|true|none||none| -|»» SMF.12|string|true|none||none| -|»» SMF.13|string|true|none||none| -|»» SMF.14|string|true|none||none| -|»» neName|string|true|none||none| -|»» startIndex|integer|true|none||none| -|»» timeGroup|string|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/Trace - -## DELETE Patch Measure Task - -DELETE /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|taskId|query|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post Trace Task No NeType - -POST /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{ - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "", - "neId": "", - "interfaces": [ - "N8", - "N10" - ] -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Put Trace Task No NeType - -PUT /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{ - "id": 3, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "", - "neId": "", - "srcIp": "192.168.2.199", - "signalPort": 3030, - "interfaces": [ - "N8", - "N10", - "N11" - ] -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Delete Trace Task No NeType - -DELETE /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|id|query|array[string]| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post AMF Measure Task - -POST /api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask - -> Body Parameters - -```json -{} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|id|query|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post Measure Report - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport - -> Body Parameters - -```json -{ - "id": 1, - "NeType": "SMF" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Captuer NE's PACP(exclude UPF) - -POST /tcpdump/ne - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string", - "timeout": 0, - "cmd": "string", - "timestamp": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 |时间戳记录文件| - -> Response Examples - -> 成功 - -```json -{ - "code": 1, - "data": { - "cmd": "cd /tmp \nsudo timeout 10 tcpdump -i any sctp or tcp port 3030 or 8088 -s0 -w timestamp_UDM_001.pcap", - "fileName": "timestamp_UDM_001.pcap", - "msg": "tcpdump: listening on any, link-type LINUX_SLL (Linux cooked), capture size 262144 bytes\n10 packets captured\n10 packets received by filter\n0 packets dropped by kernel\n" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» cmd|string|true|none||none| -|»» fileName|string|true|none||none| -|»» msg|string|true|none||none| -|» msg|string|true|none||none| - -## POST Get Measurement - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measurement - -> Body Parameters - -```json -{ - "Index": 2, - "NeName": "SMFRJBJJC01", - "RmUID": "1101AGTHXSMF0000015704000100", - "NeType": "SMF", - "PmVersion": "5GC16.1.1", - "Dn": "RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456", - "Period": "15", - "TimeZone": "UTC+8", - "StartTime": "2023-05-23 22:26:28", - "Datas": [ - { - "ObjectType": "SmfFunction", - "KPIs": [ - { - "KPIID": "SMF.AttCreatePduSession._Dnn", - "KPIValues": [ - { - "Name": "cmnet", - "Value": 1 - }, - { - "Name": "ims", - "Value": 0 - } - ] - } - ] - }, - { - "ObjectType": "AddrPool", - "KPIs": [ - { - "KPIID": "SMF.MeanAllcAddr", - "KPIValues": [ - { - "Name": "Total", - "Value": 1 - } - ] - }, - { - "KPIID": "SMF.MeanAllcAddr._Ns", - "KPIValues": [ - { - "Name": "1001", - "Value": 2 - }, - { - "Name": "1002", - "Value": 1 - } - ] - } - ] - } - ] -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Content-Type|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST UPF capture PACP - -POST /tcpdump/neUPF - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string", - "runType": "string", - "cmd": "string", - "timestamp": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 |执行开始start还是停止stop开始telnetstart_telnet/stop_telnet脚本字符串start_str/stop_str| -|» cmd|body|string| yes |方法1：适合其他网元异常，UPF配合抓包的情况。包文件相对较小。| -|» timestamp|body|string| yes |时间戳记录文件| - -#### Description - -**» cmd**: 方法1：适合其他网元异常，UPF配合抓包的情况。包文件相对较小。 -进入命令行之后： -1）开始抓包 pcap trace rx tx max 100000 intfc any file upf_test.pcap -2）停止抓包 pcap trace rx tx off - -方法2：适合UPF异常需要抓包分析的情况。包文件相对较大。 -进入命令行之后： -1）开始抓包 pcap dispatch trace on max 100000 file upf_test.pcap -2）停止抓包 pcap dispatch trace off - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET PACP file download - -GET /tcpdump/download - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neType|query|string| yes |none| -|neId|query|string| yes |none| -|fileName|query|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/Configuration/NE Management - -## PUT Put NE Info - -PUT /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -```json -{ - "pvFlag": "VNF", - "province": "GD", - "vendorName": "AGT", - "dn": "cmjicai" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post NE Info - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -```json -{ - "neType": "UDM", - "neId": "SZ_02", - "neName": "UDM_SZ_01", - "ip": "192.168.1.187", - "port": "8080", - "pvFlag": "VNF", - "province": "GD", - "vendorName": "AGT", - "dn": "cmjicai" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Scheme|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Delete NE info - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -``` -string - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/Configuration/Export/Import NE - -## GET Get Software from OMC - -GET /api/rest/systemManagement/v1/AMF/software/123 - -> Body Parameters - -```yaml -string - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Upload Software To OMC - -POST /api/rest/systemManagement/v1/AMF/software/123 - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Export CM From NF - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```yaml -string - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Import CM to NF - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```json -{ - "fileName": "udm-sz_01-etc-20230627002725.zip" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Delete Software from OMC - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```json -{ - "fileName": "udm-sz_01-etc-20230615171608.zip" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Active Software To NF - -PUT /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01 - -> Body Parameters - -```json -{} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PATCH Rollback Software To NF - -PATCH /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01 - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Distribute Software To NF - -POST /api/rest/systemManagement/v1/EMS/software/2.2311.8/001 - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|accessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/Configuration/Parameter config - -## GET Get System Parameter from UDM - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|ne_id|query|string| yes |none| -|loc|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Put System Parameter to UDM - -PUT /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "capacity": 1000, - "priority": 2 -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|subsys_no|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post System Parameter to UDM - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "capacity": 1000, - "priority": 2 -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|subsys_no|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Delete System Parameter to UDM - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|subsys_no|query|string| yes |none| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Get subsUEAmbr Parameter from UDM - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Get UDM smfSelection - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Get IMS system param - -GET /api/rest/systemManagement/v1/elementType/amf/objectType/config/guami - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|AccessToken|header|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/UE Management/UDM Subscirber Data - -## GET 信息 - -GET /ne/udm/sub/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|path|string| yes |none| -|imsi|path|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 /ne/udm/sub/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|path|string| yes |none| -|imsi|path|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 增加 - -POST /ne/udm/sub/{neId} - -此命令可同时添加45G签约用户 - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|path|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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指给4G UE分配的静态IP，没有可不带此字段名| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 修改 - -PUT /ne/udm/sub/{neId} - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|path|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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指给4G UE分配的静态IP，没有可不带此字段名| - -> Response Examples - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 批量添加 - -POST /ne/udm/sub/{neId}/{num} - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|path|string| yes |none| -|num|path|string| yes |放号数| -|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指给4G UE分配的静态IP，没有可不带此字段名| - -> Response Examples - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## DELETE 批量删除 - -DELETE /ne/udm/sub/{neId}/{imsi}/{num} - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|neId|path|string| yes |none| -|imsi|path|string| yes |none| -|num|path|string| yes |none| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## POST 导出 - -POST /ne/udm/sub/export - -> Body Parameters - -```json -{ - "neId": "string", - "type": "string" -} -``` - -### Params - -|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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## PUT 重载数据 for Redis - -PUT /ne/udm/sub/resetData/{neId} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST 导入 - -POST /ne/udm/sub/import - -> Body Parameters - -```yaml -neId: "002" -file: string - -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## GET 列表 - -GET /ne/udm/sub/list - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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| - -# OMC HTTP RESTful API Interfaces/UE Management/UDM Authentication Data - -## GET 列表 - -GET /ne/udm/auth/list - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 信息 - -GET /ne/udm/auth/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 /ne/udm/auth/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## PUT 重载数据 for Redis - -PUT /ne/udm/auth/resetData/{neId} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 1, - "data": 37981, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 新增 - -POST /ne/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 修改 - -PUT /ne/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 批量新增 - -POST /ne/udm/auth/{neId}/{num} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## DELETE 批量删除 - -DELETE /ne/udm/auth/{neId}/{imsi}/{num} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 导出 - -POST /ne/udm/auth/export - -> Body Parameters - -```json -{ - "neId": "string", - "type": "string" -} -``` - -### Params - -|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 - -> 成功 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST 导入 - -POST /ne/udm/auth/import - -> Body Parameters - -```yaml -neId: "002" -file: string - -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/UE Management/PCF User PCC Rules - -## GET Query PCF UE Info - -GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] -} -``` - -```json -{ - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] -} -``` - -```json -{ - "data": [ - { - "hdrEnrich": "dnn", - "imsi": "460990100000006", - "msisdn": "86755900001", - "pccRules": "internet|ims_sig", - "qosAudio": "qos_audio", - "qosVideo": "qos_video", - "rfsp": 1, - "sar": "def_sar", - "sessRules": "internet|ims_sig", - "uePolicy": "uep_001" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Add PCF UE Info - -POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -> Body Parameters - -```json -{ - "imsi": "460990100000002", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Modify PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -> Body Parameters - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Delete PCF UE Info - -DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "cause": "DATA_NOT_FOUND", - "status": 404 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Record Not Found|Inline| - -### Responses Data Schema - -HTTP Status Code **404** - -|Name|Type|Required|Restrictions|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/batch/{number} - -> Body Parameters - -```json -{ - "num": 11, - "imsi": "260990100000001", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video", - "neId": "001" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Batch Modify PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number} - -> Body Parameters - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Batch Delete PCF UE Info - -DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|number|path|string| yes ||none| -|neId|query|string| yes ||none| -|imsi|query|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -> 成功 - -```json -{ - "cause": "no imsi", - "status": 400 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Export PCF UE Info - -GET /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/export - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|query|string| yes ||none| -|fileType|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Import PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/import - -> Body Parameters - -```json -{ - "neId": "001", - "type": "txt", - "filePath": "xxx.txt" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|query|string| yes ||none| -|filePath|query|string| yes ||none| -|fileType|query|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -> OK - -```json -{ - "detail": "[Request Body] unexpected end of JSON input", - "status": 400, - "title": "Malformed request syntax" -} -``` - -```json -{ - "neId": "001", - "fileType": "txt", - "filePath": "/home/agtuser/PCF_001_1701420431873_zsda89.txt" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» neId|string|true|none||none| -|» fileType|string|true|none||none| -|» filePath|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/UE Management/N3IWF Online User - -## GET Query N3IWF UE Info - -GET /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "data": [ - { - "activeTime": "2023-11-29 06:35:43", - "imsi": "460302072701181", - "nai": "0460302072701181@nai.epc.mnc030.mcc460.3gppnetwork.org", - "regState": 1 - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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| - -# OMC HTTP RESTful API Interfaces/UE Management/NodeB Information - -## GET Get NB Info from AMF - -GET /api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/UE Management/IMS Online User - -## GET Get UE Info from IMS - -GET /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/UE Management/SMF Online User - -## GET Get UE Info from SMF - -GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Get UE Number from SMF - -GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/UE Management/General APIs - -## GET 网元neType和neID查询 - -GET /ne/info - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST 发送文件到网元端 - -POST /ne/action/pushFile - -> Body Parameters - -```json -{ - "uploadPath": "string", - "neType": "string", - "neId": "string" -} -``` - -### Params - -|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| -|» uploadPath|body|string| yes ||通过通用接口上传文件得到地址| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||none| - -> Response Examples - -> OK - -```json -{ - "code": 1, - "data": "/home/agtuser/5GC网管操作手册V1.2_5z8ssk.pdf", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/MML - -## POST Post UDM subscriber MML - -POST /api/rest/opeartionManagement/v1/elementType/udm/objectType/mml - -> Body Parameters - -```json -{ - "mml": [ - "date", - "dsp authdat:imsi=460000100000030" - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Post OMC MMLs - -POST /api/rest/opeartionManagement/v1/elementType/omc/objectType/mml - -> Body Parameters - -```json -{ - "mml": [ - "date", - "date" - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/Security/Department Management - -## GET Department List - -GET /system/dept/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|status|query|string| no ||Status (0 Inactive 1Active）| -|deptName|query|string| no ||Department name| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "MASK科技", - "orderNum": 0, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526241" - }, - { - "deptId": "101", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广西总公司", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526245" - }, - { - "deptId": "102", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广东分公司", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526248" - }, - { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526251" - }, - { - "deptId": "104", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "市场部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526254" - }, - { - "deptId": "105", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "测试部门", - "orderNum": 3, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526257" - }, - { - "deptId": "106", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "财务部门", - "orderNum": 4, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526261" - }, - { - "deptId": "107", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "运维部门", - "orderNum": 5, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526264" - }, - { - "deptId": "108", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "市场部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526268" - }, - { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526271" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| - -## GET Department List (Excluding {deptId}) - -GET /system/dept/list/exclude/{deptId} - -When performing update operations, optional superiors should exclude all nodes under the current department - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "MASK科技", - "orderNum": 0, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526241" - }, - { - "deptId": "102", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广东分公司", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526248" - }, - { - "deptId": "108", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "市场部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526268" - }, - { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526271" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| - -## GET Department Tree List - -GET /system/dept/treeSelect - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "id": "100", - "label": "MASK科技", - "children": [ - { - "id": "101", - "label": "广西总公司", - "children": [ - { - "id": "103", - "label": "研发部门", - "children": [] - }, - { - "id": "104", - "label": "市场部门", - "children": [] - }, - { - "id": "105", - "label": "测试部门", - "children": [] - }, - { - "id": "106", - "label": "财务部门", - "children": [] - }, - { - "id": "107", - "label": "运维部门", - "children": [] - } - ] - }, - { - "id": "102", - "label": "广东分公司", - "children": [ - { - "id": "108", - "label": "市场部门", - "children": [] - }, - { - "id": "109", - "label": "财务部门", - "children": [] - } - ] - } - ] - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» 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 List (specified roles) - -GET /system/dept/roleDeptTreeSelect/{roleId} - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "code": 200, - "msg": "成功", - "depts": [ - { - "id": "100", - "label": "MASK科技", - "children": [ - { - "id": "101", - "label": "广西总公司", - "children": [ - { - "id": "103", - "label": "研发部门", - "children": [] - }, - { - "id": "104", - "label": "市场部门", - "children": [] - }, - { - "id": "105", - "label": "测试部门", - "children": [] - }, - { - "id": "106", - "label": "财务部门", - "children": [] - }, - { - "id": "107", - "label": "运维部门", - "children": [] - } - ] - }, - { - "id": "102", - "label": "广东分公司", - "children": [ - { - "id": "108", - "label": "市场部门", - "children": [] - }, - { - "id": "109", - "label": "财务部门", - "children": [] - } - ] - } - ] - } - ], - "checkedKeys": [] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» depts|[object]|true|none|部门节点|none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -## POST New Departmnt - -POST /system/dept - -> Body Parameters - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string" -} -``` - -### Params - -|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 | 显示顺序|none| -|» deptName|body|string| yes | 部门名称|none| -|» leader|body|string| yes | 负责人|none| -|» phone|body|string| yes | 联系电话|none| -|» email|body|string| yes | 邮箱|none| -|» status|body|string| yes | 部门状态|0 Inactive 1 Active| -|» parentId|body|string| yes | 父部门ID|0 root ID| -|» parentName|body|string| no | 父部门名称|none| - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "部门新增【xxx】失败，部门名称已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT Department Modification - -PUT /system/dept - -> Body Parameters - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string", - "deptId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 显示顺序|none| -|» deptName|body|string| yes | 部门名称|none| -|» leader|body|string| yes | 负责人|none| -|» phone|body|string| yes | 联系电话|none| -|» email|body|string| yes | 邮箱|none| -|» status|body|string| yes | 部门状态|0 Inactive 1 Active| -|» parentId|body|string| yes | 父部门ID|none| -|» parentName|body|string| no | 父部门名称|none| -|» deptId|body|string| yes | 部门ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问部门数据" -} -``` - -```json -{ - "code": 500, - "msg": "部门修改【拉高济查】失败，上级部门不能是自己" -} -``` - -```json -{ - "code": 500, - "msg": "该部门包含未停用的子部门！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问部门数据" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 Department Info - -GET /system/dept/{deptId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|deptId|path|string| yes ||Department ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "parentName": "广东分公司" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» deptId|string|true|none|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» parentName|string|true|none|父部门名称|none| - -# OMC HTTP RESTful API Interfaces/Security/Menu Management - -## GET Menu List - -GET /system/menu/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuName|query|string| no ||Menu Name| -|status|query|string| no ||Menu status 0 Inactive 1 Active| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "menuId": "1", - "menuName": "系统管理", - "parentId": "0", - "menuSort": 1, - "path": "system", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526443", - "remark": "系统管理目录" - }, - { - "menuId": "2", - "menuName": "系统监控", - "parentId": "0", - "menuSort": 2, - "path": "monitor", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526448", - "remark": "系统监控目录" - }, - { - "menuId": "3", - "menuName": "系统工具", - "parentId": "0", - "menuSort": 3, - "path": "tool", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526452", - "remark": "系统工具目录" - }, - { - "menuId": "4", - "menuName": "开源仓库", - "parentId": "0", - "menuSort": 4, - "path": "https://gitee.com/TsMask", - "component": "", - "isFrame": "0", - "isCache": "0", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526456", - "remark": "开源仓库跳转外部链接打开新窗口" - }, - { - "menuId": "100", - "menuName": "用户管理", - "parentId": "1", - "menuSort": 1, - "path": "user", - "component": "system/user/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:user:list", - "icon": "#", - "createTime": "1682264526459", - "remark": "用户管理菜单" - }, - { - "menuId": "101", - "menuName": "角色管理", - "parentId": "1", - "menuSort": 2, - "path": "role", - "component": "system/role/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:role:list", - "icon": "#", - "createTime": "1682264526463", - "remark": "角色管理菜单" - }, - { - "menuId": "102", - "menuName": "分配角色", - "parentId": "1", - "menuSort": 3, - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "system:role:auth", - "icon": "#", - "createTime": "1682264526467", - "remark": "分配角色内嵌隐藏菜单" - }, - { - "menuId": "103", - "menuName": "菜单管理", - "parentId": "1", - "menuSort": 4, - "path": "menu", - "component": "system/menu/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:menu:list", - "icon": "#", - "createTime": "1682264526471", - "remark": "菜单管理菜单" - }, - { - "menuId": "104", - "menuName": "部门管理", - "parentId": "1", - "menuSort": 5, - "path": "dept", - "component": "system/dept/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:dept:list", - "icon": "#", - "createTime": "1682264526475", - "remark": "部门管理菜单" - }, - { - "menuId": "105", - "menuName": "岗位管理", - "parentId": "1", - "menuSort": 6, - "path": "post", - "component": "system/post/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:post:list", - "icon": "#", - "createTime": "1682264526479", - "remark": "岗位管理菜单" - }, - { - "menuId": "106", - "menuName": "字典管理", - "parentId": "1", - "menuSort": 7, - "path": "dict", - "component": "system/dict/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:dict:list", - "icon": "#", - "createTime": "1682264526484", - "remark": "字典管理菜单" - }, - { - "menuId": "107", - "menuName": "字典数据", - "parentId": "1", - "menuSort": 8, - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "system:dict:data", - "icon": "#", - "createTime": "1682264526488", - "remark": "字典数据内嵌隐藏菜单" - }, - { - "menuId": "108", - "menuName": "参数设置", - "parentId": "1", - "menuSort": 9, - "path": "config", - "component": "system/config/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:config:list", - "icon": "#", - "createTime": "1682264526491", - "remark": "参数设置菜单" - }, - { - "menuId": "109", - "menuName": "通知公告", - "parentId": "1", - "menuSort": 10, - "path": "notice", - "component": "system/notice/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:notice:list", - "icon": "#", - "createTime": "1682264526495", - "remark": "通知公告菜单" - }, - { - "menuId": "111", - "menuName": "日志管理", - "parentId": "1", - "menuSort": 11, - "path": "log", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526498", - "remark": "日志管理菜单" - }, - { - "menuId": "112", - "menuName": "服务监控", - "parentId": "2", - "menuSort": 1, - "path": "server-info", - "component": "monitor/server/info", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:server:info", - "icon": "#", - "createTime": "1682264526502", - "remark": "服务监控菜单" - }, - { - "menuId": "113", - "menuName": "缓存监控", - "parentId": "2", - "menuSort": 2, - "path": "cache-info", - "component": "monitor/cache/info", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:cache:info", - "icon": "#", - "createTime": "1682264526505", - "remark": "缓存监控菜单" - }, - { - "menuId": "114", - "menuName": "缓存列表", - "parentId": "2", - "menuSort": 3, - "path": "cache", - "component": "monitor/cache/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:cache:list", - "icon": "#", - "createTime": "1682264526509", - "remark": "缓存列表菜单" - }, - { - "menuId": "115", - "menuName": "在线用户", - "parentId": "2", - "menuSort": 4, - "path": "online", - "component": "monitor/online/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:online:list", - "icon": "#", - "createTime": "1682264526513", - "remark": "在线用户菜单" - }, - { - "menuId": "116", - "menuName": "调度任务", - "parentId": "2", - "menuSort": 5, - "path": "job", - "component": "monitor/job/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:job:list", - "icon": "#", - "createTime": "1682264526517", - "remark": "调度任务菜单" - }, - { - "menuId": "117", - "menuName": "调度日志", - "parentId": "2", - "menuSort": 6, - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "monitor:job:log", - "icon": "#", - "createTime": "1682264526520", - "remark": "调度日志内嵌隐藏菜单" - }, - { - "menuId": "118", - "menuName": "系统接口", - "parentId": "3", - "menuSort": 1, - "path": "swagger", - "component": "tool/swagger/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:swagger:list", - "icon": "#", - "createTime": "1682264526524", - "remark": "系统接口菜单" - }, - { - "menuId": "1000", - "menuName": "用户查询", - "parentId": "100", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:query", - "icon": "#", - "createTime": "1682264526537", - "remark": "" - }, - { - "menuId": "1001", - "menuName": "用户新增", - "parentId": "100", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:add", - "icon": "#", - "createTime": "1682264526540", - "remark": "" - }, - { - "menuId": "1002", - "menuName": "用户修改", - "parentId": "100", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:edit", - "icon": "#", - "createTime": "1682264526545", - "remark": "" - }, - { - "menuId": "1003", - "menuName": "用户删除", - "parentId": "100", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:remove", - "icon": "#", - "createTime": "1682264526549", - "remark": "" - }, - { - "menuId": "1004", - "menuName": "用户导出", - "parentId": "100", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:export", - "icon": "#", - "createTime": "1682264526552", - "remark": "" - }, - { - "menuId": "1005", - "menuName": "用户导入", - "parentId": "100", - "menuSort": 6, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:import", - "icon": "#", - "createTime": "1682264526556", - "remark": "" - }, - { - "menuId": "1006", - "menuName": "重置密码", - "parentId": "100", - "menuSort": 7, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:resetPwd", - "icon": "#", - "createTime": "1682264526561", - "remark": "" - }, - { - "menuId": "1007", - "menuName": "角色查询", - "parentId": "101", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:query", - "icon": "#", - "createTime": "1682264526564", - "remark": "" - }, - { - "menuId": "1008", - "menuName": "角色新增", - "parentId": "101", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:add", - "icon": "#", - "createTime": "1682264526567", - "remark": "" - }, - { - "menuId": "1009", - "menuName": "角色修改", - "parentId": "101", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:edit", - "icon": "#", - "createTime": "1682264526571", - "remark": "" - }, - { - "menuId": "1010", - "menuName": "角色删除", - "parentId": "101", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:remove", - "icon": "#", - "createTime": "1682264526575", - "remark": "" - }, - { - "menuId": "1011", - "menuName": "角色导出", - "parentId": "101", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:export", - "icon": "#", - "createTime": "1682264526579", - "remark": "" - }, - { - "menuId": "1012", - "menuName": "菜单查询", - "parentId": "103", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:query", - "icon": "#", - "createTime": "1682264526583", - "remark": "" - }, - { - "menuId": "1013", - "menuName": "菜单新增", - "parentId": "103", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:add", - "icon": "#", - "createTime": "1682264526586", - "remark": "" - }, - { - "menuId": "1014", - "menuName": "菜单修改", - "parentId": "103", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:edit", - "icon": "#", - "createTime": "1682264526589", - "remark": "" - }, - { - "menuId": "1015", - "menuName": "菜单删除", - "parentId": "103", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:remove", - "icon": "#", - "createTime": "1682264526592", - "remark": "" - }, - { - "menuId": "1016", - "menuName": "部门查询", - "parentId": "104", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:query", - "icon": "#", - "createTime": "1682264526595", - "remark": "" - }, - { - "menuId": "1017", - "menuName": "部门新增", - "parentId": "104", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:add", - "icon": "#", - "createTime": "1682264526598", - "remark": "" - }, - { - "menuId": "1018", - "menuName": "部门修改", - "parentId": "104", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:edit", - "icon": "#", - "createTime": "1682264526600", - "remark": "" - }, - { - "menuId": "1019", - "menuName": "部门删除", - "parentId": "104", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:remove", - "icon": "#", - "createTime": "1682264526603", - "remark": "" - }, - { - "menuId": "1020", - "menuName": "岗位查询", - "parentId": "105", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:query", - "icon": "#", - "createTime": "1682264526606", - "remark": "" - }, - { - "menuId": "1021", - "menuName": "岗位新增", - "parentId": "105", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:add", - "icon": "#", - "createTime": "1682264526609", - "remark": "" - }, - { - "menuId": "1022", - "menuName": "岗位修改", - "parentId": "105", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:edit", - "icon": "#", - "createTime": "1682264526612", - "remark": "" - }, - { - "menuId": "1023", - "menuName": "岗位删除", - "parentId": "105", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:remove", - "icon": "#", - "createTime": "1682264526616", - "remark": "" - }, - { - "menuId": "1024", - "menuName": "岗位导出", - "parentId": "105", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:export", - "icon": "#", - "createTime": "1682264526618", - "remark": "" - }, - { - "menuId": "1025", - "menuName": "字典查询", - "parentId": "106", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:query", - "icon": "#", - "createTime": "1682264526621", - "remark": "" - }, - { - "menuId": "1026", - "menuName": "字典新增", - "parentId": "106", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:add", - "icon": "#", - "createTime": "1682264526623", - "remark": "" - }, - { - "menuId": "1027", - "menuName": "字典修改", - "parentId": "106", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:edit", - "icon": "#", - "createTime": "1682264526627", - "remark": "" - }, - { - "menuId": "1028", - "menuName": "字典删除", - "parentId": "106", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:remove", - "icon": "#", - "createTime": "1682264526630", - "remark": "" - }, - { - "menuId": "1029", - "menuName": "字典导出", - "parentId": "106", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:export", - "icon": "#", - "createTime": "1682264526632", - "remark": "" - }, - { - "menuId": "1030", - "menuName": "参数查询", - "parentId": "108", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:query", - "icon": "#", - "createTime": "1682264526635", - "remark": "" - }, - { - "menuId": "1031", - "menuName": "参数新增", - "parentId": "108", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:add", - "icon": "#", - "createTime": "1682264526638", - "remark": "" - }, - { - "menuId": "1032", - "menuName": "参数修改", - "parentId": "108", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:edit", - "icon": "#", - "createTime": "1682264526640", - "remark": "" - }, - { - "menuId": "1033", - "menuName": "参数删除", - "parentId": "108", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:remove", - "icon": "#", - "createTime": "1682264526643", - "remark": "" - }, - { - "menuId": "1034", - "menuName": "参数导出", - "parentId": "108", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:export", - "icon": "#", - "createTime": "1682264526646", - "remark": "" - }, - { - "menuId": "1035", - "menuName": "公告查询", - "parentId": "109", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:query", - "icon": "#", - "createTime": "1682264526650", - "remark": "" - }, - { - "menuId": "1036", - "menuName": "公告新增", - "parentId": "109", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:add", - "icon": "#", - "createTime": "1682264526654", - "remark": "" - }, - { - "menuId": "1037", - "menuName": "公告修改", - "parentId": "109", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:edit", - "icon": "#", - "createTime": "1682264526658", - "remark": "" - }, - { - "menuId": "1038", - "menuName": "公告删除", - "parentId": "109", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:remove", - "icon": "#", - "createTime": "1682264526662", - "remark": "" - }, - { - "menuId": "500", - "menuName": "操作日志", - "parentId": "111", - "menuSort": 1, - "path": "operlog", - "component": "monitor/operlog/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:list", - "icon": "#", - "createTime": "1682264526528", - "remark": "操作日志菜单" - }, - { - "menuId": "501", - "menuName": "登录日志", - "parentId": "111", - "menuSort": 2, - "path": "logininfor", - "component": "monitor/logininfor/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:list", - "icon": "#", - "createTime": "1682264526532", - "remark": "登录日志菜单" - }, - { - "menuId": "1046", - "menuName": "缓存查询", - "parentId": "114", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:cache:query", - "icon": "#", - "createTime": "1682264526692", - "remark": "" - }, - { - "menuId": "1047", - "menuName": "缓存删除", - "parentId": "114", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:cache:remove", - "icon": "#", - "createTime": "1682264526696", - "remark": "" - }, - { - "menuId": "1048", - "menuName": "在线查询", - "parentId": "115", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:query", - "icon": "#", - "createTime": "1682264526700", - "remark": "" - }, - { - "menuId": "1049", - "menuName": "批量强退", - "parentId": "115", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:batchLogout", - "icon": "#", - "createTime": "1682264526704", - "remark": "" - }, - { - "menuId": "1050", - "menuName": "单条强退", - "parentId": "115", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:forceLogout", - "icon": "#", - "createTime": "1682264526707", - "remark": "" - }, - { - "menuId": "1051", - "menuName": "任务查询", - "parentId": "116", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:query", - "icon": "#", - "createTime": "1682264526713", - "remark": "" - }, - { - "menuId": "1052", - "menuName": "任务新增", - "parentId": "116", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:add", - "icon": "#", - "createTime": "1682264526717", - "remark": "" - }, - { - "menuId": "1053", - "menuName": "任务修改", - "parentId": "116", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:edit", - "icon": "#", - "createTime": "1682264526721", - "remark": "" - }, - { - "menuId": "1054", - "menuName": "任务删除", - "parentId": "116", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:remove", - "icon": "#", - "createTime": "1682264526725", - "remark": "" - }, - { - "menuId": "1055", - "menuName": "状态修改", - "parentId": "116", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:changeStatus", - "icon": "#", - "createTime": "1682264526730", - "remark": "" - }, - { - "menuId": "1056", - "menuName": "任务导出", - "parentId": "116", - "menuSort": 6, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:export", - "icon": "#", - "createTime": "1682264526735", - "remark": "" - }, - { - "menuId": "1039", - "menuName": "操作查询", - "parentId": "500", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:query", - "icon": "#", - "createTime": "1682264526665", - "remark": "" - }, - { - "menuId": "1040", - "menuName": "操作删除", - "parentId": "500", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:remove", - "icon": "#", - "createTime": "1682264526670", - "remark": "" - }, - { - "menuId": "1041", - "menuName": "日志导出", - "parentId": "500", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:export", - "icon": "#", - "createTime": "1682264526673", - "remark": "" - }, - { - "menuId": "1042", - "menuName": "登录查询", - "parentId": "501", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:query", - "icon": "#", - "createTime": "1682264526677", - "remark": "" - }, - { - "menuId": "1043", - "menuName": "登录删除", - "parentId": "501", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:remove", - "icon": "#", - "createTime": "1682264526681", - "remark": "" - }, - { - "menuId": "1044", - "menuName": "日志导出", - "parentId": "501", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:export", - "icon": "#", - "createTime": "1682264526684", - "remark": "" - }, - { - "menuId": "1045", - "menuName": "账户解锁", - "parentId": "501", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:unlock", - "icon": "#", - "createTime": "1682264526688", - "remark": "" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|[object]|true|none||none| -|»» menuId|string|true|none|菜单ID|none| -|»» menuName|string|true|none|菜单名称|none| -|»» parentId|string|true|none|父菜单ID|none| -|»» menuSort|integer|true|none|显示顺序|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件路径|none| -|»» isFrame|string|true|none|是否内部跳转|0否 1是| -|»» isCache|string|true|none|是否缓存|0不缓存 1缓存| -|»» menuType|string|true|none|菜单类型|D目录 M菜单 B按钮| -|»» visible|string|true|none|是否显示|0隐藏 1显示| -|»» status|string|true|none|状态|0停用 1正常| -|»» perms|string|true|none|权限标识|none| -|»» icon|string|true|none|图标|无图标要#号或空字符串| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET Menu Info - -GET /system/menu/{menuId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuId|path|string| yes ||Menu 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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "menuId": "100", - "menuName": "用户管理", - "parentId": "1", - "menuSort": 1, - "path": "user", - "component": "system/user/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:user:list", - "icon": "#", - "createTime": "1682264526459", - "remark": "用户管理菜单" - } -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "data": null -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» menuId|string|true|none|菜单ID|none| -|»» menuName|string|true|none|菜单名称|none| -|»» parentId|string|true|none|父菜单ID|none| -|»» menuSort|integer|true|none|显示顺序|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件路径|none| -|»» isFrame|string|true|none|是否内部跳转|0否 1是| -|»» isCache|string|true|none|是否缓存|0不缓存 1缓存| -|»» menuType|string|true|none|菜单类型|D目录 M菜单 B按钮| -|»» visible|string|true|none|是否显示|0隐藏 1显示| -|»» status|string|true|none|状态|0停用 1正常| -|»» perms|string|true|none|权限标识|none| -|»» icon|string|true|none|图标|无图标要#号或空字符串| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## DELETE Menu Deletion - -DELETE /system/menu/{menuId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuId|path|string| yes ||Menu 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 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问菜单数据" -} -``` - -```json -{ - "code": 500, - "msg": "存在子菜单,不允许删除" -} -``` - -```json -{ - "code": 500, - "msg": "菜单已分配给角色,不允许删除" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT Menu Modification - -PUT /system/menu - -> Body Parameters - -```json -{ - "menuId": "string", - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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| -|» menuId|body|string| yes | 菜单ID|none| -|» parentId|body|string| yes | 父菜单ID|none| -|» menuName|body|string| yes | 菜单名称|none| -|» menuType|body|string| yes | 菜单类型|D Directory M Menu B Button| -|» menuSort|body|integer| yes | 显示顺序|Defatult 0| -|» isFrame|body|string| no | 是否内部跳转|Required by menu and directory, 0 No 1 Yes| -|» isCache|body|string| no | 是否缓存|Required by menu and directory, 0 No cache 1 Cached| -|» visible|body|string| no | 是否显示|Required by menu and directory, 0 Hidden 1 Show| -|» status|body|string| no | 状态|Required by menu and directory, 0停用 1正常| -|» icon|body|string| no | 图标|Required by menu and directory, #No icon| -|» path|body|string| no | 路由地址|Required by menu and directory,| -|» component|body|string| no | 组件路径|Required by menu,| -|» perms|body|string| no | 权限标识|Required by menu and button,| -|» remark|body|string| no | 备注|none| - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问菜单数据" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxxx】失败，非内部地址必须以http(s)://开头" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxxx】失败，菜单路由地址已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxx】失败，菜单名称已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -## POST New Menu - -POST /system/menu - -> Body Parameters - -```json -{ - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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| -|» parentId|body|string| yes | 父菜单ID|根据菜单ID| -|» menuName|body|string| yes | 菜单名称|none| -|» menuType|body|string| yes | 菜单类型|D目录 M菜单 B按钮| -|» menuSort|body|integer| yes | 显示顺序|默认0| -|» isFrame|body|string| no | 是否内部跳转|目录和菜单必传，0否 1是| -|» isCache|body|string| no | 是否缓存|目录和菜单必传，0不缓存 1缓存| -|» visible|body|string| no | 是否显示|目录和菜单必传，0隐藏 1显示| -|» status|body|string| no | 状态|目录和菜单必传，0停用 1正常| -|» icon|body|string| no | 图标|目录和菜单必传，#无图标| -|» path|body|string| no | 路由地址|目录和菜单必传| -|» component|body|string| no | 组件路径|菜单必传| -|» perms|body|string| no | 权限标识|菜单和按钮必传| -|» remark|body|string| no | 备注|none| - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxx】失败，菜单路由地址已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxxx】失败，菜单名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxxx】失败，非内部地址必须以http(s)://开头" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET Menu Tree List (specifying roles) - -GET /system/menu/roleMenuTreeSelect/{roleId} - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "menus": [ - { - "id": "1", - "label": "系统管理", - "children": [ - { - "id": "100", - "label": "用户管理", - "children": [ - { - "id": "1000", - "label": "用户查询", - "children": [] - }, - { - "id": "1001", - "label": "用户新增", - "children": [] - }, - { - "id": "1002", - "label": "用户修改", - "children": [] - }, - { - "id": "1003", - "label": "用户删除", - "children": [] - }, - { - "id": "1004", - "label": "用户导出", - "children": [] - }, - { - "id": "1005", - "label": "用户导入", - "children": [] - }, - { - "id": "1006", - "label": "重置密码", - "children": [] - } - ] - }, - { - "id": "101", - "label": "角色管理", - "children": [ - { - "id": "1007", - "label": "角色查询", - "children": [] - }, - { - "id": "1008", - "label": "角色新增", - "children": [] - }, - { - "id": "1009", - "label": "角色修改", - "children": [] - }, - { - "id": "1010", - "label": "角色删除", - "children": [] - }, - { - "id": "1011", - "label": "角色导出", - "children": [] - } - ] - }, - { - "id": "102", - "label": "分配角色", - "children": [] - }, - { - "id": "103", - "label": "菜单管理", - "children": [ - { - "id": "1012", - "label": "菜单查询", - "children": [] - }, - { - "id": "1013", - "label": "菜单新增", - "children": [] - }, - { - "id": "1014", - "label": "菜单修改", - "children": [] - }, - { - "id": "1015", - "label": "菜单删除", - "children": [] - } - ] - }, - { - "id": "104", - "label": "部门管理", - "children": [ - { - "id": "1016", - "label": "部门查询", - "children": [] - }, - { - "id": "1017", - "label": "部门新增", - "children": [] - }, - { - "id": "1018", - "label": "部门修改", - "children": [] - }, - { - "id": "1019", - "label": "部门删除", - "children": [] - } - ] - }, - { - "id": "105", - "label": "岗位管理", - "children": [ - { - "id": "1020", - "label": "岗位查询", - "children": [] - }, - { - "id": "1021", - "label": "岗位新增", - "children": [] - }, - { - "id": "1022", - "label": "岗位修改", - "children": [] - }, - { - "id": "1023", - "label": "岗位删除", - "children": [] - }, - { - "id": "1024", - "label": "岗位导出", - "children": [] - } - ] - }, - { - "id": "106", - "label": "字典管理", - "children": [ - { - "id": "1025", - "label": "字典查询", - "children": [] - }, - { - "id": "1026", - "label": "字典新增", - "children": [] - }, - { - "id": "1027", - "label": "字典修改", - "children": [] - }, - { - "id": "1028", - "label": "字典删除", - "children": [] - }, - { - "id": "1029", - "label": "字典导出", - "children": [] - } - ] - }, - { - "id": "107", - "label": "字典数据", - "children": [] - }, - { - "id": "108", - "label": "参数设置", - "children": [ - { - "id": "1030", - "label": "参数查询", - "children": [] - }, - { - "id": "1031", - "label": "参数新增", - "children": [] - }, - { - "id": "1032", - "label": "参数修改", - "children": [] - }, - { - "id": "1033", - "label": "参数删除", - "children": [] - }, - { - "id": "1034", - "label": "参数导出", - "children": [] - } - ] - }, - { - "id": "109", - "label": "通知公告", - "children": [ - { - "id": "1035", - "label": "公告查询", - "children": [] - }, - { - "id": "1036", - "label": "公告新增", - "children": [] - }, - { - "id": "1037", - "label": "公告修改", - "children": [] - }, - { - "id": "1038", - "label": "公告删除", - "children": [] - } - ] - }, - { - "id": "111", - "label": "日志管理", - "children": [ - { - "id": "500", - "label": "操作日志", - "children": [ - { - "id": "1039", - "label": "操作查询", - "children": "[Object]" - }, - { - "id": "1040", - "label": "操作删除", - "children": "[Object]" - }, - { - "id": "1041", - "label": "日志导出", - "children": "[Object]" - } - ] - }, - { - "id": "501", - "label": "登录日志", - "children": [ - { - "id": "1042", - "label": "登录查询", - "children": "[Object]" - }, - { - "id": "1043", - "label": "登录删除", - "children": "[Object]" - }, - { - "id": "1044", - "label": "日志导出", - "children": "[Object]" - }, - { - "id": "1045", - "label": "账户解锁", - "children": "[Object]" - } - ] - } - ] - } - ] - }, - { - "id": "2", - "label": "系统监控", - "children": [ - { - "id": "112", - "label": "服务监控", - "children": [] - }, - { - "id": "113", - "label": "缓存监控", - "children": [] - }, - { - "id": "114", - "label": "缓存列表", - "children": [ - { - "id": "1046", - "label": "缓存查询", - "children": [] - }, - { - "id": "1047", - "label": "缓存删除", - "children": [] - } - ] - }, - { - "id": "115", - "label": "在线用户", - "children": [ - { - "id": "1048", - "label": "在线查询", - "children": [] - }, - { - "id": "1049", - "label": "批量强退", - "children": [] - }, - { - "id": "1050", - "label": "单条强退", - "children": [] - } - ] - }, - { - "id": "116", - "label": "调度任务", - "children": [ - { - "id": "1051", - "label": "任务查询", - "children": [] - }, - { - "id": "1052", - "label": "任务新增", - "children": [] - }, - { - "id": "1053", - "label": "任务修改", - "children": [] - }, - { - "id": "1054", - "label": "任务删除", - "children": [] - }, - { - "id": "1055", - "label": "状态修改", - "children": [] - }, - { - "id": "1056", - "label": "任务导出", - "children": [] - } - ] - }, - { - "id": "117", - "label": "调度日志", - "children": [] - } - ] - }, - { - "id": "3", - "label": "系统工具", - "children": [ - { - "id": "118", - "label": "系统接口", - "children": [] - } - ] - }, - { - "id": "4", - "label": "开源仓库", - "children": [] - }, - { - "id": "2002", - "label": "备千验白儿这", - "children": [] - }, - { - "id": "2001", - "label": "要形存做情式2史", - "children": [] - } - ], - "checkedKeys": [] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» menus|[object]|true|none|菜单节点|none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -## GET Menu Tree List - -GET /system/menu/treeSelect - -Using the menu permission list in role addition and modification - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuName|query|string| no ||Menu name| -|status|query|string| no ||Menu Status (0 Inactive 1 Active)| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "id": "1", - "label": "系统管理", - "children": [ - { - "id": "100", - "label": "用户管理", - "children": [ - { - "id": "1000", - "label": "用户查询", - "children": [] - }, - { - "id": "1001", - "label": "用户新增", - "children": [] - }, - { - "id": "1002", - "label": "用户修改", - "children": [] - }, - { - "id": "1003", - "label": "用户删除", - "children": [] - }, - { - "id": "1004", - "label": "用户导出", - "children": [] - }, - { - "id": "1005", - "label": "用户导入", - "children": [] - }, - { - "id": "1006", - "label": "重置密码", - "children": [] - } - ] - }, - { - "id": "101", - "label": "角色管理", - "children": [ - { - "id": "1007", - "label": "角色查询", - "children": [] - }, - { - "id": "1008", - "label": "角色新增", - "children": [] - }, - { - "id": "1009", - "label": "角色修改", - "children": [] - }, - { - "id": "1010", - "label": "角色删除", - "children": [] - }, - { - "id": "1011", - "label": "角色导出", - "children": [] - } - ] - }, - { - "id": "102", - "label": "分配角色", - "children": [] - }, - { - "id": "103", - "label": "菜单管理", - "children": [ - { - "id": "1012", - "label": "菜单查询", - "children": [] - }, - { - "id": "1013", - "label": "菜单新增", - "children": [] - }, - { - "id": "1014", - "label": "菜单修改", - "children": [] - }, - { - "id": "1015", - "label": "菜单删除", - "children": [] - } - ] - }, - { - "id": "104", - "label": "部门管理", - "children": [ - { - "id": "1016", - "label": "部门查询", - "children": [] - }, - { - "id": "1017", - "label": "部门新增", - "children": [] - }, - { - "id": "1018", - "label": "部门修改", - "children": [] - }, - { - "id": "1019", - "label": "部门删除", - "children": [] - } - ] - }, - { - "id": "105", - "label": "岗位管理", - "children": [ - { - "id": "1020", - "label": "岗位查询", - "children": [] - }, - { - "id": "1021", - "label": "岗位新增", - "children": [] - }, - { - "id": "1022", - "label": "岗位修改", - "children": [] - }, - { - "id": "1023", - "label": "岗位删除", - "children": [] - }, - { - "id": "1024", - "label": "岗位导出", - "children": [] - } - ] - }, - { - "id": "106", - "label": "字典管理", - "children": [ - { - "id": "1025", - "label": "字典查询", - "children": [] - }, - { - "id": "1026", - "label": "字典新增", - "children": [] - }, - { - "id": "1027", - "label": "字典修改", - "children": [] - }, - { - "id": "1028", - "label": "字典删除", - "children": [] - }, - { - "id": "1029", - "label": "字典导出", - "children": [] - } - ] - }, - { - "id": "107", - "label": "字典数据", - "children": [] - }, - { - "id": "108", - "label": "参数设置", - "children": [ - { - "id": "1030", - "label": "参数查询", - "children": [] - }, - { - "id": "1031", - "label": "参数新增", - "children": [] - }, - { - "id": "1032", - "label": "参数修改", - "children": [] - }, - { - "id": "1033", - "label": "参数删除", - "children": [] - }, - { - "id": "1034", - "label": "参数导出", - "children": [] - } - ] - }, - { - "id": "109", - "label": "通知公告", - "children": [ - { - "id": "1035", - "label": "公告查询", - "children": [] - }, - { - "id": "1036", - "label": "公告新增", - "children": [] - }, - { - "id": "1037", - "label": "公告修改", - "children": [] - }, - { - "id": "1038", - "label": "公告删除", - "children": [] - } - ] - }, - { - "id": "111", - "label": "日志管理", - "children": [ - { - "id": "500", - "label": "操作日志", - "children": [ - { - "id": "1039", - "label": "操作查询", - "children": [] - }, - { - "id": "1040", - "label": "操作删除", - "children": [] - }, - { - "id": "1041", - "label": "日志导出", - "children": [] - } - ] - }, - { - "id": "501", - "label": "登录日志", - "children": [ - { - "id": "1042", - "label": "登录查询", - "children": [] - }, - { - "id": "1043", - "label": "登录删除", - "children": [] - }, - { - "id": "1044", - "label": "日志导出", - "children": [] - }, - { - "id": "1045", - "label": "账户解锁", - "children": [] - } - ] - } - ] - } - ] - }, - { - "id": "2", - "label": "系统监控", - "children": [ - { - "id": "112", - "label": "服务监控", - "children": [] - }, - { - "id": "113", - "label": "缓存监控", - "children": [] - }, - { - "id": "114", - "label": "缓存列表", - "children": [ - { - "id": "1046", - "label": "缓存查询", - "children": [] - }, - { - "id": "1047", - "label": "缓存删除", - "children": [] - } - ] - }, - { - "id": "115", - "label": "在线用户", - "children": [ - { - "id": "1048", - "label": "在线查询", - "children": [] - }, - { - "id": "1049", - "label": "批量强退", - "children": [] - }, - { - "id": "1050", - "label": "单条强退", - "children": [] - } - ] - }, - { - "id": "116", - "label": "调度任务", - "children": [ - { - "id": "1051", - "label": "任务查询", - "children": [] - }, - { - "id": "1052", - "label": "任务新增", - "children": [] - }, - { - "id": "1053", - "label": "任务修改", - "children": [] - }, - { - "id": "1054", - "label": "任务删除", - "children": [] - }, - { - "id": "1055", - "label": "状态修改", - "children": [] - }, - { - "id": "1056", - "label": "任务导出", - "children": [] - } - ] - }, - { - "id": "117", - "label": "调度日志", - "children": [] - } - ] - }, - { - "id": "3", - "label": "系统工具", - "children": [ - { - "id": "118", - "label": "系统接口", - "children": [] - } - ] - }, - { - "id": "4", - "label": "开源仓库", - "children": [] - }, - { - "id": "2002", - "label": "备千验白儿这", - "children": [] - }, - { - "id": "2001", - "label": "要形存做情式2史", - "children": [] - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object|true|none||none| -|»» menus|[object]|true|none||none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -# OMC HTTP RESTful API Interfaces/Security/Position Management - -## GET Position List - -GET /system/post/list - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» total|integer|true|none||none| -|» rows|[object]|true|none||none| -|»» postId|string|true|none|岗位ID|none| -|»» postCode|string|true|none|编码|none| -|»» postName|string|true|none|名称|none| -|»» postSort|integer|true|none|排序|none| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST Position List Export - -POST /system/post/export - -The file stream is returned normally, and the response header is as follows - -```text -content-disposition: attachment;filename=post_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "postCode": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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 | 岗位名称|none| -|» postCode|body|string| no | 岗位编码|none| -|» status|body|string| no | 状态|(0 Inactive 1 Active)| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> Success - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## GET Position Info - -GET /system/post/{postId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|postId|path|string| yes ||Position 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 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|object¦null|true|none||none| -|»» postId|string|true|none|岗位ID|none| -|»» postCode|string|true|none|编码|none| -|»» postName|string|true|none|名称|none| -|»» postSort|integer|true|none|排序|none| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST New Position - -POST /system/post - -> Body Parameters - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": 0, - "phone": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 岗位编码|none| -|» postName|body|string| yes | 岗位名称|none| -|» postSort|body|integer| yes | 排序|none| -|» phone|body|string| yes | 状态|(0 Inactive 1 Active)| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "岗位新增【xxx】失败，岗位名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "岗位新增【xxx】失败，岗位编码已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## PUT Position Modification - -PUT /system/post - -> Body Parameters - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": 0, - "phone": "string", - "remark": "string", - "postId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 岗位编码|none| -|» postName|body|string| yes | 岗位名称|none| -|» postSort|body|integer| yes | 排序|none| -|» phone|body|string| yes | 状态|(0 Inactive 1 Active)| -|» remark|body|string| yes | 备注|none| -|» postId|body|string| yes | 岗位ID|none| - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "岗位修改【xxx】失败，岗位名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "岗位修改【xxx】失败，岗位编码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE Position Deletion - -DELETE /system/post/{postIds} - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access position data!" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/Security/User Profile - -## GET 基础信息获取 - -GET /system/user/profile - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "maskAdmin", - "nickName": "管理员", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "管理员", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "status": "1" - } - }, - "roleGroup": [ - "管理员" - ], - "postGroup": [ - "董事长" - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» user|object|true|none|用户信息|none| -|»»» roles|[object]|true|none|角色信息|none| -|»»»» roleId|string|false|none||none| -|»»»» roleName|string|false|none||none| -|»»»» roleKey|string|false|none||none| -|»»»» roleSort|integer|false|none||none| -|»»»» dataScope|string|false|none||none| -|»»»» status|string|false|none||none| -|»»» userId|string|true|none||none| -|»»» deptId|string|true|none||none| -|»»» userName|string|true|none||none| -|»»» nickName|string|true|none||none| -|»»» userType|string|true|none||none| -|»»» email|string|true|none||none| -|»»» avatar|string|true|none||none| -|»»» phonenumber|string|true|none||none| -|»»» sex|string|true|none||none| -|»»» status|string|true|none||none| -|»»» delFlag|string|true|none||none| -|»»» loginIp|string|true|none||none| -|»»» loginDate|string|true|none||none| -|»»» createBy|string|true|none||none| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none||none| -|»»» dept|object|false|none|岗位|none| -|»»»» deptId|string|true|none||none| -|»»»» parentId|string|true|none||none| -|»»»» ancestors|string|true|none||none| -|»»»» deptName|string|true|none||none| -|»»»» orderNum|integer|true|none||none| -|»»»» leader|string|true|none||none| -|»»»» status|string|true|none||none| -|»» roleGroup|[string]|true|none|角色|字符数组| -|»» postGroup|[string]|true|none|岗位|字符数组| - -## PUT 基础信息修改 - -PUT /system/user/profile - -> Body Parameters - -```json -{ - "nickName": "阎秀兰", - "sex": "1", - "phonenumber": "18169338391", - "email": "t.eknevzfl@htejfppo.so" -} -``` - -### Params - -|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 | 昵称|none| -|» email|body|string| no | 邮箱|none| -|» phonenumber|body|string| no | 手机|none| -|» sex|body|string| yes | 性别|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxxx】失败，手机号码格式错误" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 修改头像 - -POST /system/user/profile/avatar - -> Body Parameters - -```yaml -file: string - -``` - -### Params - -|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| -|» file|body|string(binary)| yes ||请选择等比大小图片作为头像，如200x200、400x400| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "/upload/avatar/2023/04/o_1d2bofn8f19dh5s11okpje61mipg_画板1_bf3wq4h6.png" -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，仅支持以下类型：jpg,jpeg,png" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|图片地址|none| - -## PUT 修改密码 - -PUT /system/user/profile/updatePwd - -> Body Parameters - -```json -{ - "oldPassword": "admin@1234", - "newPassword": "Admin@1234" -} -``` - -### Params - -|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 | 旧密码|none| -|» newPassword|body|string| yes | 新密码|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "新密码不能与旧密码相同" -} -``` - -```json -{ - "code": 500, - "msg": "修改密码失败，旧密码错误" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/Security/角色信息 - -## GET 角色信息列表 - -GET /system/role/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleName|query|string| no ||角色名称| -|roleKey|query|string| no ||权限字符| -|status|query|string| no ||状态 0正常 1停用| -|beginTime|query|string| no ||创建时间-开始| -|endTime|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 2, - "rows": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526399", - "remark": "管理员" - }, - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|角色ID|none| -|»» roleName|string|true|none|名称|none| -|»» roleKey|string|true|none|键值|none| -|»» roleSort|integer|true|none|排序|none| -|»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» status|string|true|none|角色状态|0停用 1正常| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 角色分配用户列表 - -GET /system/role/authUser/allocatedList - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|query|string| no ||用户名称| -|phonenumber|query|string| no ||用户手机号| -|status|query|string| no ||用户状态| -|roleId|query|string| yes ||角色ID| -|allocated|query|string| yes ||已分配角色用户 true是 false否| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "userName": "maskUser", - "nickName": "普通用户", - "email": "maskUser@qq.com", - "phonenumber": "13412341234", - "status": "1", - "createTime": "1682264526309", - "dept": { - "deptId": "105", - "deptName": "测试部门" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|角色状态|0停用 1正常| -|»» createTime|string|false|none|创建时间|none| -|»» roles|[string]|false|none|角色ID数组|none| -|»» userId|string|false|none|用户ID|none| -|»» deptId|string|false|none|部门ID|none| -|»» userName|string|false|none|用户名称|none| -|»» nickName|string|false|none|用户昵称|none| -|»» email|string|false|none|邮箱|none| -|»» phonenumber|string|false|none|手机号|none| -|»» dept|object|false|none|部门信息|none| -|»»» deptId|string|false|none|部门ID|none| -|»»» deptName|string|false|none|部门名称|none| - -## GET 角色信息详情 - -GET /system/role/{roleId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleId|path|string| yes ||角色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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526399", - "remark": "管理员" - } -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|角色ID|none| -|»» roleName|string|true|none|名称|none| -|»» roleKey|string|true|none|键值|none| -|»» roleSort|integer|true|none|排序|none| -|»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» status|string|true|none|角色状态|0停用 1正常| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## PUT 角色信息修改 - -PUT /system/role - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 名称|none| -|» roleKey|body|string| yes | 键值|none| -|» roleSort|body|integer| yes | 排序|none| -|» status|body|string| yes | 角色状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» dataScope|body|string| yes | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» menuCheckStrictly|body|string| yes | 菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| yes | 菜单权限|菜单ID数组| -|» roleId|body|string| yes | 角色ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "角色修改【xxx】失败，角色名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "角色修改【xxxx】失败，权限键值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 角色信息新增 - -POST /system/role - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ] -} -``` - -### Params - -|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 | 名称|none| -|» roleKey|body|string| yes | 键值|none| -|» roleSort|body|integer| yes | 排序|none| -|» status|body|string| yes | 角色状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» dataScope|body|string| yes | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» menuCheckStrictly|body|string| yes | 菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| yes | 菜单权限|菜单ID数组| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "角色新增【xxxx】失败，角色名称已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE 角色信息删除 - -DELETE /system/role/{roleIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleIds|path|string| yes ||角色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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT 角色状态变更 - -PUT /system/role/changeStatus - -> Body Parameters - -```json -{ - "roleId": "string", - "status": "string" -} -``` - -### Params - -|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 | 角色ID|none| -|» status|body|string| no | 状态|0停用 1正常| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 角色数据权限修改 - -PUT /system/role/dataScope - -> Body Parameters - -```json -{ - "dataScope": "string", - "deptCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### Params - -|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 | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» deptCheckStrictly|body|string| yes | 部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| no | 部门权限|数据范围选择2时必传，部门ID数组| -|» roleId|body|string| yes | 角色ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 角色列表导出 - -POST /system/role/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=role_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "status": "string", - "beginTime": "string", - "endTime": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 角色名称|none| -|» roleKey|body|string| no | 权限字符|none| -|» status|body|string| no | 状态|0正常 1停用| -|» beginTime|body|string| no | 创建时间-开始|none| -|» endTime|body|string| no | 创建时间-结束|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 角色分配选择授权 - -PUT /system/role/authUser/checked - -> Body Parameters - -```json -{ - "roleId": "string", - "userIds": "string", - "checked": true -} -``` - -### Params - -|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 | 角色ID|none| -|» userIds|body|string| yes | 用户ID|多个可用英文逗号分隔| -|» checked|body|boolean| yes | 选择操作|添加true 取消false| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/Security/用户信息 - -## POST 用户信息列表导入模板下载 - -POST /system/user/importTemplate - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=user_import_template_1684230715497.xlsx -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -### Params - -|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| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 用户信息列表 - -GET /system/user/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|query|string| no ||用户名称| -|phonenumber|query|string| no ||手机号码| -|status|query|string| no ||状态| -|beginTime|query|string| no ||创建时间-开始| -|endTime|query|string| no ||创建时间-结束| -|deptId|query|string| no ||部门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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "nickName": "普通用户", - "userName": "maskUser", - "email": "maskUser@qq.com", - "avatar": "", - "phonenumber": "13412341234", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.56.1", - "loginDate": "1683364764238", - "createBy": "maskAdmin", - "createTime": "1682264526309", - "remark": "普通人员", - "dept": { - "deptId": "105", - "deptName": "测试部门", - "leader": "MASK" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|角色ID数组|none| -|»» userId|string|true|none|用户ID|none| -|»» deptId|string¦null|true|none|部门ID|none| -|»» nickName|string|true|none|用户昵称|none| -|»» userName|string|true|none|用户名称|none| -|»» email|string|true|none|邮箱|none| -|»» avatar|string|true|none|头像|none| -|»» phonenumber|string|true|none|电话|none| -|»» sex|string|true|none|性别|0未知 1男 2女| -|»» status|string|true|none|状态|0停用 1正常| -|»» delFlag|string|true|none|是否删除|0代表存在 1代表删除| -|»» loginIp|string|true|none|登录IP|none| -|»» loginDate|string|true|none|登录时间|none| -|»» createBy|string|true|none|创建人|none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string¦null|true|none|备注|none| -|»» dept|object|true|none|部门信息|none| -|»»» deptId|string¦null|true|none|部门ID|none| -|»»» deptName|string¦null|true|none|部门名称|none| -|»»» leader|string¦null|true|none|负责人|none| - -## GET 用户信息详情 - -GET /system/user/{userId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userId|path|string| yes ||用户ID，新增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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": { - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "status": "1" - } - ], - "userId": "2", - "deptId": "105", - "userName": "maskUser", - "nickName": "普通用户", - "userType": "sys", - "email": "maskUser@qq.com", - "avatar": "", - "phonenumber": "13412341234", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.56.1", - "loginDate": "1683364764238", - "createBy": "maskAdmin", - "createTime": "1682264526309", - "remark": "普通人员", - "dept": { - "deptId": "105", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "测试部门", - "orderNum": 3, - "leader": "MASK", - "status": "1" - } - }, - "roleIds": [ - "2" - ], - "postIds": [ - "2" - ], - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ], - "posts": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] - } -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": {}, - "roleIds": [], - "postIds": [], - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ], - "posts": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] - } -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|用户信息|none| -|»»» roles|[object]|true|none|角色信息|none| -|»»»» roleId|string|false|none|角色ID|none| -|»»»» roleName|string|false|none|名称|none| -|»»»» roleKey|string|false|none|键值|none| -|»»»» roleSort|integer|false|none|排序|none| -|»»»» dataScope|string|false|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»»»» status|string|false|none|角色状态|0停用 1正常| -|»»» userId|string|true|none|用户ID|none| -|»»» deptId|string¦null|true|none|部门ID|none| -|»»» userName|string|true|none|用户名称|none| -|»»» nickName|string|true|none|用户昵称|none| -|»»» email|string|true|none|邮箱|none| -|»»» avatar|string|true|none|头像|none| -|»»» phonenumber|string|true|none|电话|none| -|»»» sex|string|true|none|性别|0未知 1男 2女| -|»»» status|string|true|none|状态|0停用 1正常| -|»»» delFlag|string|true|none|是否删除|0代表存在 1代表删除| -|»»» loginIp|string|true|none|登录IP|none| -|»»» loginDate|string|true|none|登录时间|none| -|»»» createBy|string|true|none|创建人|none| -|»»» createTime|string|true|none|创建时间|none| -|»»» remark|string¦null|true|none|备注|none| -|»»» dept|object|true|none|部门信息|none| -|»»»» deptId|string|true|none|部门ID|none| -|»»»» parentId|string|true|none|父部门ID|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|部门状态|0正常 1停用| -|»»»» phone|string|false|none|联系电话|none| -|»»»» email|string|false|none|邮箱|none| -|»» roleIds|[string]|true|none|已选角色ID|none| -|»» postIds|[string]|true|none|已选岗位ID|none| -|»» roles|[object]|true|none|角色信息数组|none| -|»»» roleId|string|true|none|角色ID|none| -|»»» roleName|string|true|none|名称|none| -|»»» roleKey|string|true|none|键值|none| -|»»» roleSort|integer|true|none|排序|none| -|»»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»»» status|string|true|none|角色状态|0停用 1正常| -|»»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none|备注|none| -|»» posts|[object]|true|none|岗位信息数组|none| -|»»» postId|string|true|none|岗位ID|none| -|»»» postCode|string|true|none|编码|none| -|»»» postName|string|true|none|名称|none| -|»»» postSort|integer|true|none|排序|none| -|»»» status|string|true|none|状态|none| -|»»» createBy|string|true|none||none| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none|备注|none| - -## POST 用户信息新增 - -POST /system/user - -> Body Parameters - -```json -{ - "remark": "去只传周物给", - "deptId": 102, - "nickName": "龙杰", - "email": "h.vrcjiz@qcfgqedxw.bz", - "phonenumber": "18641692257", - "sex": "0", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 1, - 2, - 3, - 4 - ], - "userName": "gijobqebs", - "password": "123456" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 用户名称|none| -|» password|body|string| yes | 用户密码|none| -|» nickName|body|string| yes | 用户昵称|none| -|» email|body|string| yes | 邮箱|none| -|» phonenumber|body|string| yes | 电话|none| -|» sex|body|string| yes | 性别|0未知 1男 2女| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» deptId|body|string| yes | 部门ID|none| -|» roleIds|body|[string]| yes | 角色ID数组|none| -|» postIds|body|[string]| yes | 岗位ID数组|none| -|» userType|body|string| no | 用户类型|sys系统用户| -|» avatar|body|string| no | 头像|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【xxxx】失败，登录账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【xxxx】失败，手机号码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【zwciugaw2】失败，邮箱已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT 用户信息修改 - -PUT /system/user - -> Body Parameters - -```json -{ - "remark": "群劳设着给王", - "deptId": 80, - "nickName": "许芳", - "email": "x.swtaf@oypeubb.tg", - "phonenumber": "18106129309", - "sex": "1", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 2 - ], - "userId": "101", - "userName": "x34bvpi" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 用户ID|none| -|» userName|body|string| yes | 用户名称|none| -|» nickName|body|string| yes | 用户昵称|none| -|» email|body|string| yes | 邮箱|none| -|» phonenumber|body|string| yes | 电话|none| -|» sex|body|string| yes | 性别|0未知 1男 2女| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» deptId|body|string| yes | 部门ID|none| -|» roleIds|body|[string]| yes | 角色ID数组|none| -|» postIds|body|[string]| yes | 岗位ID数组|none| -|» userType|body|string| no | 用户类型|sys系统用户| -|» avatar|body|string| no | 头像|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxx】失败，手机号码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【liming】失败，登录账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxx】失败，邮箱已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 用户信息列表导出 - -POST /system/user/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=user_export_11_1684230271701.xlsx -content-length: 21499 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "userName": "string", - "phonenumber": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "deptId": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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 | 用户名称|none| -|» phonenumber|body|string| no | 手机号码|none| -|» status|body|string| no | 状态|0停用 1正常| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» deptId|body|string| no | 部门ID|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 用户信息列表导入 - -POST /system/user/importData - -> Body Parameters - -```yaml -file: [] -updateSupport: "{% mock 'pick' , ['false','true'] %}" - -``` - -### Params - -|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| -|» file|body|string(binary)| no ||导入xls、xlsx表格文件| -|» updateSupport|body|string| no ||是否更新已经存在的数据，默认false| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 1 条，数据如下：
序号：1 登录名称 user001 导入成功" -} -``` - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 0 条，数据如下：" -} -``` - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 1 条，数据如下：
序号：1 登录名称 user001 更新成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "很抱歉，导入失败！共 5 条数据格式不正确，错误如下：
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称" -} -``` - -```json -{ - "code": 500, - "msg": "导入用户数据不能为空！" -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，仅支持以下类型：xls,xlsx" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /system/user/{userIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userIds|path|string| yes ||用户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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 用户重置密码 - -PUT /system/user/resetPwd - -> Body Parameters - -```json -{ - "password": "string", - "userId": "string" -} -``` - -### Params - -|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 | 密码|none| -|» userId|body|string| yes | 用户ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 用户状态修改 - -PUT /system/user/changeStatus - -> Body Parameters - -```json -{ - "status": "string", - "userId": "string" -} -``` - -### Params - -|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 | 状态|0停用 1正常| -|» userId|body|string| yes | 用户ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/Security/在线用户信息 - -## GET 在线用户列表 - -GET /monitor/online/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|query|string| no ||用户名称（登录账号）| -|ipaddr|query|string| no ||登录主机| -|Authorization|header|string| yes ||授权令牌| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "rows": [ - { - "tokenId": "vikufxmx625271bnddbe9t79p4pik5kv", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "未知 未知", - "os": "未知 未知", - "loginTime": 1684046645462, - "deptName": "研发部门" - }, - { - "tokenId": "lpatqefeohnxsnjpp28radugp0bovwt1", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "loginTime": 1684046560517, - "deptName": "研发部门" - } - ], - "total": 2 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 强退用户 - -DELETE /monitor/online/{tokenId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|tokenId|path|string| yes ||授权标识| -|Authorization|header|string| yes ||授权令牌| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/字典类型信息 - -## GET 字典类型列表 - -GET /system/dict/type/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictName|query|string| no ||名称| -|dictType|query|string| no ||类型| -|status|query|string| no ||状态（0正常 1停用）| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 10, - "rows": [ - { - "dictId": "1", - "dictName": "用户性别", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526985", - "remark": "用户性别列表" - }, - { - "dictId": "2", - "dictName": "菜单状态", - "dictType": "sys_show_hide", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526992", - "remark": "菜单状态列表" - }, - { - "dictId": "3", - "dictName": "系统开关", - "dictType": "sys_normal_disable", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526999", - "remark": "系统开关列表" - }, - { - "dictId": "4", - "dictName": "任务状态", - "dictType": "sys_job_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527005", - "remark": "任务状态列表" - }, - { - "dictId": "5", - "dictName": "任务分组", - "dictType": "sys_job_group", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527010", - "remark": "任务分组列表" - }, - { - "dictId": "6", - "dictName": "系统是否", - "dictType": "sys_yes_no", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527016", - "remark": "系统是否列表" - }, - { - "dictId": "7", - "dictName": "通知类型", - "dictType": "sys_notice_type", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527023", - "remark": "通知类型列表" - }, - { - "dictId": "8", - "dictName": "通知状态", - "dictType": "sys_notice_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527029", - "remark": "通知状态列表" - }, - { - "dictId": "9", - "dictName": "操作类型", - "dictType": "sys_oper_type", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527035", - "remark": "操作类型列表" - }, - { - "dictId": "10", - "dictName": "系统状态", - "dictType": "sys_common_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527042", - "remark": "登录状态列表" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» dictId|string|true|none|字典ID|none| -|»» dictName|string|true|none|名称|none| -|»» dictType|string|true|none|类型|none| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典类型详细 - -GET /system/dict/type/{dictId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictId|path|string| yes ||字典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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "dictId": "1", - "dictName": "用户性别", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526985", - "remark": "用户性别列表" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» dictId|string|true|none|字典ID|none| -|»» dictName|string|true|none|名称|none| -|»» dictType|string|true|none|类型|none| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 字典类型列表导出 - -POST /system/dict/type/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=dict_type_export_12_1684240671183.xlsx -content-length: 18246 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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| -|» dictName|body|string| no | 名称|none| -|» dictType|body|string| no | 类型|none| -|» status|body|string| no | 状态|0正常 1停用| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 字典类型新增 - -POST /system/dict/type - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -|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| -|» dictName|body|string| yes | 名称|none| -|» dictType|body|string| yes | 类型|none| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "字典新增【xxx】失败，字典名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "字典新增【xxxx】失败，字典类型已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 字典类型修改 - -PUT /system/dict/type - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "remark": "string", - "status": "string", - "dictId": "string" -} -``` - -### Params - -|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| -|» dictName|body|string| yes | 名称|none| -|» dictType|body|string| yes | 类型|none| -|» remark|body|string| yes | 备注|none| -|» status|body|string| yes | 状态|0停用 1正常| -|» dictId|body|string| no | 字典ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "字典修改【xxxx】失败，字典名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "字典修改【xxxx】失败，字典类型已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /system/dict/type/{dictIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictIds|path|string| yes ||字典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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 字典类型选择框列表 - -GET /system/dict/type/getDictOptionselect - -在字典数据中进行下拉项选择 - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "label": "用户性别", - "value": "sys_user_sex" - }, - { - "label": "菜单状态", - "value": "sys_show_hide" - }, - { - "label": "系统开关", - "value": "sys_normal_disable" - }, - { - "label": "任务状态", - "value": "sys_job_status" - }, - { - "label": "任务分组", - "value": "sys_job_group" - }, - { - "label": "系统是否", - "value": "sys_yes_no" - }, - { - "label": "通知类型", - "value": "sys_notice_type" - }, - { - "label": "通知状态", - "value": "sys_notice_status" - }, - { - "label": "操作类型", - "value": "sys_oper_type" - }, - { - "label": "系统状态", - "value": "sys_common_status" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» label|string|true|none|标签名称|none| -|»» value|string|true|none|标签值|none| - -## PUT 字典类型刷新缓存 - -PUT /system/dict/type/refreshCache - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/字典数据信息 - -## POST 字典数据列表导出 - -POST /system/dict/data/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=dict_data_export_10_1684245668586.xlsx -content-length: 18236 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "dictLabel": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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| -|» dictLabel|body|string| no | 数据标签|none| -|» dictType|body|string| no | 字典类型|none| -|» status|body|string| no | 状态|0正常 1停用| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 字典数据列表 - -GET /system/dict/data/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictType|query|string| no ||字典类型| -|dictLabel|query|string| no ||数据标签| -|status|query|string| no ||状态（0正常 1停用）| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 3, - "rows": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "未知", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527109", - "remark": "性别男" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "男", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527118", - "remark": "性别女" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "女", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527126", - "remark": "性别未知" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» dictCode|string|true|none|编码ID|none| -|»» dictSort|integer|true|none|排序|none| -|»» dictLabel|string|true|none|标签名称|none| -|»» dictValue|string|true|none|标签值|none| -|»» dictType|string|true|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|true|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|true|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典数据详情 - -GET /system/dict/data/{dictCode} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictCode|path|string| yes ||编码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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "dictCode": "15", - "dictSort": 2, - "dictLabel": "公告", - "dictValue": "2", - "dictType": "sys_notice_type", - "tagClass": "", - "tagType": "processing", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527183", - "remark": "公告" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» dictCode|string|true|none|编码ID|none| -|»» dictSort|integer|true|none|排序|none| -|»» dictLabel|string|true|none|标签名称|none| -|»» dictValue|string|true|none|标签值|none| -|»» dictType|string|true|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|true|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|true|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典数据列表（指定字典类型） - -GET /system/dict/data/type/{dictType} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictType|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "未知", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527109", - "remark": "性别男" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "男", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527118", - "remark": "性别女" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "女", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527126", - "remark": "性别未知" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» dictCode|string|false|none|编码ID|none| -|»» dictSort|integer|false|none|排序|none| -|»» dictLabel|string|false|none|标签名称|none| -|»» dictValue|string|false|none|标签值|none| -|»» dictType|string|false|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|false|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|false|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|false|none|状态|0停用 1正常| -|»» createBy|string|false|none||none| -|»» createTime|string|false|none||none| -|»» remark|string|false|none|备注|none| - -## POST 字典数据新增 - -POST /system/dict/data - -> Body Parameters - -```json -{ - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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| -|» dictType|body|string| yes | 字典类型|从字典类型列表中获取| -|» dictLabel|body|string| yes | 标签名称|none| -|» dictValue|body|string| yes | 标签值|none| -|» dictSort|body|integer| yes | 排序|none| -|» tagClass|body|string| yes | 样式属性（样式扩展）|预设的class样式| -|» tagType|body|string| yes | 标签类型（预设颜色）|预设数据固定项| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "数据新增【xxxx】失败，该字典类型下标签名已存在" -} -``` - -```json -{ - "code": 500, - "msg": "数据新增【x】失败，该字典类型下标签值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 字典数据修改 - -PUT /system/dict/data - -> Body Parameters - -```json -{ - "dictCode": "string", - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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| -|» dictCode|body|string| yes | 编码ID|none| -|» dictType|body|string| yes | 字典类型|从字典类型列表中获取| -|» dictLabel|body|string| yes | 标签名称|none| -|» dictValue|body|string| yes | 标签值|none| -|» dictSort|body|integer| yes | 排序|none| -|» tagClass|body|string| yes | 样式属性（样式扩展）|预设的class样式| -|» tagType|body|string| yes | 标签类型（预设颜色）|预设数据固定项| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典编码数据！" -} -``` - -```json -{ - "code": 500, - "msg": "数据修改【x】失败，该字典类型下标签值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "数据修改【xxxx】失败，该字典类型下标签名已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /system/dict/data/{dictCodes} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictCodes|path|string| yes ||字典编码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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典编码数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/参数配置信息 - -## GET 参数配置列表 - -GET /system/config/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configName|query|string| no ||参数名称| -|configKey|query|string| no ||参数键名| -|configType|query|string| no ||系统内置-是Y 否N| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "configId": 1, - "configName": "用户管理-账号初始密码", - "configKey": "sys.user.initPassword", - "configValue": "123456", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527266", - "updateBy": "", - "updateTime": "0", - "remark": "导入用户初始化密码 123456" - }, - { - "configId": 2, - "configName": "账号自助-验证码开关", - "configKey": "sys.account.captchaEnabled", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527271", - "updateBy": "", - "updateTime": "0", - "remark": "是否开启验证码功能（true开启，false关闭）" - }, - { - "configId": 3, - "configName": "账号自助-验证码类型", - "configKey": "sys.account.captchaType", - "configValue": "math", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527277", - "updateBy": "", - "updateTime": "0", - "remark": "使用验证码类型（math数值计算，char字符验证）" - }, - { - "configId": 4, - "configName": "账号自助-是否开启用户注册功能", - "configKey": "sys.account.registerUser", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527280", - "updateBy": "maskAdmin", - "updateTime": "1683291796123", - "remark": "是否开启注册用户功能（true开启，false关闭）" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» configId|integer|true|none|配置ID|none| -|»» configName|string|true|none|配置名称|none| -|»» configKey|string|true|none|参数键名|none| -|»» configValue|string|true|none|配置值|none| -|»» configType|string|true|none|系统内置|Y是 N否| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 参数配置列表导出 - -POST /system/config/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=config_export_10_1684131509100.xlsx -content-length: 18337 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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 | 参数名称|none| -|» configKey|body|string| no | 参数键名|none| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 根据参数键名取值 - -GET /system/config/configKey/{configKey} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configKey|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "true" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|配置值|none| - -## GET 参数配置信息 - -GET /system/config/{configId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configId|path|string| yes ||配置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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "configId": 4, - "configName": "账号自助-是否开启用户注册功能", - "configKey": "sys.account.registerUser", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527280", - "updateBy": "maskAdmin", - "updateTime": "1683291796123", - "remark": "是否开启注册用户功能（true开启，false关闭）" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» configId|integer|true|none|配置ID|none| -|»» configName|string|true|none|配置名称|none| -|»» configKey|string|true|none|参数键名|none| -|»» configValue|string|true|none|配置值|none| -|»» configType|string|true|none|系统内置|Y是 N否| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 参数配置新增 - -POST /system/config - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string" -} -``` - -### Params - -|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| yes | 配置名称|none| -|» configKey|body|string| yes | 参数键名|none| -|» configValue|body|string| yes | 配置值|none| -|» configType|body|string| yes | 系统内置|Y是 N否| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "参数配置新增【xxxx】失败，参数键名已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 参数配置修改 - -PUT /system/config - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string", - "configId": 0 -} -``` - -### Params - -|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| yes | 配置名称|none| -|» configKey|body|string| yes | 参数键名|none| -|» configValue|body|string| yes | 配置值|none| -|» configType|body|string| yes | 系统内置|Y是 N否| -|» remark|body|string| yes | 备注|none| -|» configId|body|integer| yes | 配置ID|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问参数配置数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 根据参数键名改值 - -PUT /system/config/changeValue - -> Body Parameters - -```json -{ - "key": "sys.logo.filePathIcon", - "value": "核心网" -} -``` - -### Params - -|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| -|» key|body|string| yes ||none| -|» value|body|string| yes ||none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "参数配置新增【xxxx】失败，参数键名已存在" -} -``` - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "变更状态与旧值相等！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /system/config/{configIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configIds|path|string| yes ||配置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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "内置参数 xxx 不能删除" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 参数缓存刷新 - -PUT /system/config/refreshCache - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/缓存信息 - -## GET 缓存监控信息 - -GET /monitor/cache - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "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" - }, - "memory": { - "used_memory": "1664304", - "used_memory_human": "1.59M", - "used_memory_rss": "9228288", - "used_memory_rss_human": "8.80M", - "used_memory_peak": "1917352", - "used_memory_peak_human": "1.83M", - "used_memory_peak_perc": "86.80%", - "used_memory_overhead": "978099", - "used_memory_startup": "863272", - "used_memory_dataset": "686205", - "used_memory_dataset_perc": "85.67%", - "allocator_allocated": "1851152", - "allocator_active": "2396160", - "allocator_resident": "4734976", - "total_system_memory": "2079748096", - "total_system_memory_human": "1.94G", - "used_memory_lua": "59392", - "used_memory_vm_eval": "59392", - "used_memory_lua_human": "58.00K", - "used_memory_scripts_eval": "5608", - "number_of_cached_scripts": "3", - "number_of_functions": "0", - "number_of_libraries": "0", - "used_memory_vm_functions": "32768", - "used_memory_vm_total": "92160", - "used_memory_vm_total_human": "90.00K", - "used_memory_functions": "184", - "used_memory_scripts": "5792", - "used_memory_scripts_human": "5.66K", - "maxmemory": "0", - "maxmemory_human": "0B", - "maxmemory_policy": "noeviction", - "allocator_frag_ratio": "1.29", - "allocator_frag_bytes": "545008", - "allocator_rss_ratio": "1.98", - "allocator_rss_bytes": "2338816", - "rss_overhead_ratio": "1.95", - "rss_overhead_bytes": "4493312", - "mem_fragmentation_ratio": "5.55", - "mem_fragmentation_bytes": "7565808", - "mem_not_counted_for_evict": "3584", - "mem_replication_backlog": "0", - "mem_total_replication_buffers": "0", - "mem_clients_slaves": "0", - "mem_clients_normal": "102107", - "mem_cluster_links": "0", - "mem_aof_buffer": "3584", - "mem_allocator": "jemalloc-5.2.1", - "active_defrag_running": "0", - "lazyfree_pending_objects": "0", - "lazyfreed_objects": "0" - }, - "persistence": { - "loading": "0", - "async_loading": "0", - "current_cow_peak": "0", - "current_cow_size": "0", - "current_cow_size_age": "0", - "current_fork_perc": "0.00", - "current_save_keys_processed": "0", - "current_save_keys_total": "0", - "rdb_changes_since_last_save": "28", - "rdb_bgsave_in_progress": "0", - "rdb_last_save_time": "1683985267", - "rdb_last_bgsave_status": "ok", - "rdb_last_bgsave_time_sec": "0", - "rdb_current_bgsave_time_sec": "-1", - "rdb_saves": "18", - "rdb_last_cow_size": "901120", - "rdb_last_load_keys_expired": "0", - "rdb_last_load_keys_loaded": "0", - "aof_enabled": "1", - "aof_rewrite_in_progress": "0", - "aof_rewrite_scheduled": "0", - "aof_last_rewrite_time_sec": "-1", - "aof_current_rewrite_time_sec": "-1", - "aof_last_bgrewrite_status": "ok", - "aof_rewrites": "0", - "aof_rewrites_consecutive_failures": "0", - "aof_last_write_status": "ok", - "aof_last_cow_size": "0", - "module_fork_in_progress": "0", - "module_fork_last_cow_size": "0", - "aof_current_size": "52707266", - "aof_base_size": "88", - "aof_pending_rewrite": "0", - "aof_buffer_length": "0", - "aof_pending_bio_fsync": "0", - "aof_delayed_fsync": "0" - }, - "stats": { - "total_connections_received": "139", - "total_commands_processed": "215944", - "instantaneous_ops_per_sec": "5", - "total_net_input_bytes": "6096966", - "total_net_output_bytes": "546971", - "total_net_repl_input_bytes": "0", - "total_net_repl_output_bytes": "0", - "instantaneous_input_kbps": "0.60", - "instantaneous_output_kbps": "0.01", - "instantaneous_input_repl_kbps": "0.00", - "instantaneous_output_repl_kbps": "0.00", - "rejected_connections": "0", - "sync_full": "0", - "sync_partial_ok": "0", - "sync_partial_err": "0", - "expired_keys": "1270", - "expired_stale_perc": "0.00", - "expired_time_cap_reached_count": "0", - "expire_cycle_cpu_milliseconds": "712", - "evicted_keys": "0", - "evicted_clients": "0", - "total_eviction_exceeded_time": "0", - "current_eviction_exceeded_time": "0", - "keyspace_hits": "1580", - "keyspace_misses": "27951", - "pubsub_channels": "3", - "pubsub_patterns": "0", - "pubsubshard_channels": "0", - "latest_fork_usec": "275", - "total_forks": "18", - "migrate_cached_sockets": "0", - "slave_expires_tracked_keys": "0", - "active_defrag_hits": "0", - "active_defrag_misses": "0", - "active_defrag_key_hits": "0", - "active_defrag_key_misses": "0", - "total_active_defrag_time": "0", - "current_active_defrag_time": "0", - "tracking_total_keys": "0", - "tracking_total_items": "0", - "tracking_total_prefixes": "0", - "unexpected_error_replies": "0", - "total_error_replies": "0", - "dump_payload_sanitizations": "0", - "total_reads_processed": "29542", - "total_writes_processed": "29425", - "io_threaded_reads_processed": "0", - "io_threaded_writes_processed": "0", - "reply_buffer_shrinks": "135", - "reply_buffer_expands": "9" - }, - "replication": { - "role": "master", - "connected_slaves": "0", - "master_failover_state": "no-failover", - "master_replid": "08e7cd72f9ecda6c4fd3e1e8504571203bb61290", - "master_replid2": "0000000000000000000000000000000000000000", - "master_repl_offset": "0", - "second_repl_offset": "-1", - "repl_backlog_active": "0", - "repl_backlog_size": "1048576", - "repl_backlog_first_byte_offset": "0", - "repl_backlog_histlen": "0" - }, - "cpu": { - "used_cpu_sys": "21.297760", - "used_cpu_user": "30.032301", - "used_cpu_sys_children": "0.033118", - "used_cpu_user_children": "0.030797", - "used_cpu_sys_main_thread": "20.252124", - "used_cpu_user_main_thread": "30.825211" - }, - "modules": {}, - "errorstats": {}, - "cluster": { - "cluster_enabled": "0" - }, - "keyspace": { - "db0": "keys=19,expires=0,avg_ttl=0", - "db1": "keys=22,expires=3,avg_ttl=21492323" - } - }, - "dbSize": 22, - "commandStats": [ - { - "name": "brpoplpush", - "value": "12044" - }, - { - "name": "get", - "value": "545" - }, - { - "name": "incr", - "value": "144" - }, - { - "name": "smembers", - "value": "1207" - }, - { - "name": "scan", - "value": "13" - }, - { - "name": "subscribe", - "value": "36" - }, - { - "name": "del", - "value": "147" - }, - { - "name": "auth", - "value": "139" - }, - { - "name": "exists", - "value": "2145" - }, - { - "name": "lrange", - "value": "1207" - }, - { - "name": "type", - "value": "28" - }, - { - "name": "ttl", - "value": "189" - }, - { - "name": "quit", - "value": "51" - }, - { - "name": "keys", - "value": "22" - }, - { - "name": "evalsha", - "value": "14200" - }, - { - "name": "select", - "value": "139" - }, - { - "name": "expire", - "value": "44" - }, - { - "name": "info", - "value": "61" - }, - { - "name": "zrevrange", - "value": "36" - }, - { - "name": "config|get", - "value": "9" - }, - { - "name": "zrangebyscore", - "value": "12087" - }, - { - "name": "client|setname", - "value": "37" - }, - { - "name": "ping", - "value": "1765" - }, - { - "name": "zrange", - "value": "12087" - }, - { - "name": "set", - "value": "1420" - }, - { - "name": "dbsize", - "value": "2" - }, - { - "name": "eval", - "value": "83" - } - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|Redis版本|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|RDB是否成功|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|AOF是否开启|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|Key数量|none| -|»» commandStats|[object]|true|none|命令统计|none| -|»»» name|string|true|none||none| -|»»» value|string|true|none||none| - -## GET 缓存名称列表 - -GET /monitor/cache/getNames - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "cacheName": "login_tokens", - "cacheKey": "", - "cacheValue": "", - "remark": "用户信息" - }, - { - "cacheName": "sys_config", - "cacheKey": "", - "cacheValue": "", - "remark": "配置信息" - }, - { - "cacheName": "sys_dict", - "cacheKey": "", - "cacheValue": "", - "remark": "数据字典" - }, - { - "cacheName": "captcha_codes", - "cacheKey": "", - "cacheValue": "", - "remark": "验证码" - }, - { - "cacheName": "repeat_submit", - "cacheKey": "", - "cacheValue": "", - "remark": "防重提交" - }, - { - "cacheName": "rate_limit", - "cacheKey": "", - "cacheValue": "", - "remark": "限流处理" - }, - { - "cacheName": "pwd_err_cnt", - "cacheKey": "", - "cacheValue": "", - "remark": "密码错误次数" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|备注|none| - -## GET 缓存名称下键名列表 - -GET /monitor/cache/getKeys/{cacheName} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|缓存名称|缓存名称列表中得到的缓存名称| -|»» cacheKey|string|true|none|缓存键名|none| -|»» cacheValue|string|true|none|缓存内容|空字符串| -|»» remark|string|true|none|备注|空字符串| - -## GET 缓存内容 - -GET /monitor/cache/getValue/{cacheName}/{cacheKey} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "cacheName": "sys_config", - "cacheKey": "sys.account.captchaType", - "cacheValue": "math", - "remark": "" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|缓存名称|键名列表中得到的缓存名称| -|»» cacheKey|string|true|none|缓存名称|键名列表中得到的缓存键名| -|»» cacheValue|string|true|none|缓存内容|none| -|»» remark|string|true|none|备注|空字符串| - -## DELETE 删除缓存键名 - -DELETE /monitor/cache/clearCacheKey/{cacheName}/{cacheKey} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/cache/clearCacheName/{cacheName} - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/cache/clearCacheSafe - -指定可清理的缓存键名 - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/调度任务日志信息 - -## POST 调度任务日志列表导出 - -POST /monitor/jobLog/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx -content-length: 17079 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0, - "beginTime": "string", - "endTime": "string" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 页数，默认1|none| -|» pageSize|body|number| no | 单页记录数，默认10|none| -|» beginTime|body|string| no | 操作开始时间|none| -|» endTime|body|string| no | 操作结束时间|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 调度任务日志列表 - -GET /monitor/jobLog/list - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "jobLogId": "4", - "jobName": "2-20个字符", - "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个字符", - "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个字符", - "jobGroup": "DEFAULT", - "invokeTarget": "test", - "targetParams": "{\"a\":1,\"b\":1}", - "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}", - "status": "1", - "createTime": "1684056090490" - }, - { - "jobLogId": "1", - "jobName": "异常执行", - "jobGroup": "SYSTEM", - "invokeTarget": "bar", - "targetParams": "字符串参数", - "jobMsg": "{\"name\":\"Error\",\"message\":\"程序中途执行错误\"}", - "status": "0", - "createTime": "1683901320750" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|日志ID|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|none| -|»» invokeTarget|string|true|none|任务目标|none| -|»» targetParams|string|true|none|任务参数|none| -|»» jobMsg|string|true|none|日志记录|none| -|»» status|string|true|none|状态|none| -|»» createTime|string|true|none|记录时间|none| - -## GET 调度任务日志信息 - -GET /monitor/jobLog/{jobLogId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobLogId|path|string| yes ||日志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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "jobLogId": "3", - "jobName": "2-20个字符", - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|日志ID|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|none| -|»» invokeTarget|string|true|none|任务目标|none| -|»» targetParams|string|true|none|任务参数|none| -|»» jobMsg|string|true|none|日志记录|none| -|»» status|string|true|none|状态|none| -|»» createTime|string|true|none|记录时间|none| - -## DELETE 调度任务日志删除 - -DELETE /monitor/jobLog/{jobLogIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobLogIds|path|string| yes ||日志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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/jobLog/clean - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/调度任务信息 - -## POST 调度任务列表导出 - -POST /monitor/job/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=job_export_6_1684058991890.xlsx -content-length: 19346 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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 | 页数，默认1|none| -|» pageSize|body|number| no | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 调度任务列表 - -GET /monitor/job/list - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 3, - "rows": [ - { - "jobId": "1", - "jobName": "触发执行", - "jobGroup": "SYSTEM", - "invokeTarget": "test", - "targetParams": "字符串参数", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527348", - "remark": "" - }, - { - "jobId": "2", - "jobName": "缓慢执行", - "jobGroup": "SYSTEM", - "invokeTarget": "foo", - "targetParams": "字符串参数", - "cronExpression": "0/15 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527355", - "remark": "" - }, - { - "jobId": "3", - "jobName": "异常执行", - "jobGroup": "SYSTEM", - "invokeTarget": "bar", - "targetParams": "字符串参数", - "cronExpression": "0/20 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527364", - "remark": "" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|任务id|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|同组内不可同任务名| -|»» invokeTarget|string|true|none|调用目标|需要代码中通过 @Processor('xxx') 注册任务目标| -|»» targetParams|string|true|none|传入参数|标准json格式字符串| -|»» cronExpression|string|true|none|cron表达式|6位，最后?号不使用| -|»» misfirePolicy|string|true|none|执行策略|计划执行错误策略（1立即执行 2执行一次 3放弃执行）| -|»» concurrent|string|true|none|是否并发|是否并发执行（0禁止 1允许）| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string|true|none|备注|none| - -## GET 调度任务信息 - -GET /monitor/job/{jobId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobId|path|string| yes ||任务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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "jobId": "1", - "jobName": "触发执行", - "jobGroup": "SYSTEM", - "invokeTarget": "test", - "targetParams": "字符串参数", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527348", - "remark": "" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|任务id|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|同组内不可同任务名| -|»» invokeTarget|string|true|none|调用目标|需要代码中通过 @Processor('xxx') 注册任务目标| -|»» targetParams|string|true|none|传入参数|标准json格式字符串| -|»» cronExpression|string|true|none|cron表达式|6位，最后?号不使用| -|»» misfirePolicy|string|true|none|执行策略|计划执行错误策略（1立即执行 2执行一次 3放弃执行）| -|»» concurrent|string|true|none|是否并发|是否并发执行（0禁止 1允许）| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string|true|none|备注|none| - -## POST 调度任务新增 - -POST /monitor/job - -> Body Parameters - -```json -{ - "jobName": "2-20个字符", - "invokeTarget": "test1", - "cronExpression": "0/22 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "jobGroup": "DEFAULT", - "status": "ullamco minim Ut", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "asdf" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 调用目标字符串|需要代码中通过 @Processor('xxx') 注册任务目标| -|» targetParams|body|string| yes | 调用目标传入参数|标准json格式字符串| -|» cronExpression|body|string| yes | cron执行表达式|6位，最后?号不使用| -|» misfirePolicy|body|string| yes | 计划执行错误策略|1立即执行 2执行一次 3放弃执行| -|» concurrent|body|string| yes | 是否并发执行|0禁止 1允许| -|» status|body|string| yes | 任务状态|0正常 1暂停| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务新增【xxx】失败，同任务组内有相同任务名称" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务新增【xxxx】失败，Cron表达式不正确" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 调度任务修改 - -PUT /monitor/job - -> Body Parameters - -```json -{ - "jobName": "大但任", - "invokeTarget": "test", - "cronExpression": "0/40 * * * * ?", - "misfirePolicy": "3", - "concurrent": "1", - "jobGroup": "SYSTEM", - "status": "0", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "据连思过维存斗维动南子听。", - "jobId": "2" -} -``` - -### Params - -|Name|Location|Type|Required|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 | 任务ID|none| -|» jobName|body|string| yes | 任务名称|none| -|» jobGroup|body|string| yes | 任务组名|none| -|» invokeTarget|body|string| yes | 调用目标字符串|需要代码中通过 @Processor('xxx') 注册任务目标| -|» targetParams|body|string| yes | 调用目标传入参数|标准json格式字符串| -|» cronExpression|body|string| yes | cron执行表达式|6位，最后?号不使用| -|» misfirePolicy|body|string| yes | 计划执行错误策略|1立即执行 2执行一次 3放弃执行| -|» concurrent|body|string| yes | 是否并发执行|0禁止 1允许| -|» status|body|string| yes | 任务状态|0正常 1暂停| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务修改【xxxx】失败，Cron表达式不正确" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/job/{jobIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobIds|path|string| yes ||任务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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 调度任务修改状态 - -PUT /monitor/job/changeStatus - -> Body Parameters - -```json -{ - "jobId": "22", - "status": "0" -} -``` - -### Params - -|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 | 任务ID|none| -|» status|body|string| yes | 变更的状态|0正常 1暂停| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 调度任务立即执行一次 - -PUT /monitor/job/run/{jobId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobId|path|string| yes ||任务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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 调度任务重置刷新队列 - -PUT /monitor/job/resetQueueJob - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/操作日志信息 - -## GET 操作日志列表 - -GET /monitor/operlog/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|title|query|string| no ||操作模块名称| -|operName|query|string| no ||操作人员名称| -|businessType|query|string| no ||操作类型| -|status|query|string| no ||操作状态| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 125, - "rows": [ - { - "operId": "224", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/17", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071705357" - }, - { - "operId": "223", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071683254" - }, - { - "operId": "222", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071682157" - }, - { - "operId": "221", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/201", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":500,\"msg\":\"失败\"}", - "status": "0", - "operTime": "1684071669833" - }, - { - "operId": "220", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/11,12,13", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071570065" - }, - { - "operId": "219", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/7,58,96,8,45", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":500,\"msg\":\"失败\"}", - "status": "0", - "operTime": "1684071537536" - }, - { - "operId": "218", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071459926" - }, - { - "operId": "217", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071429311" - }, - { - "operId": "216", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071426784" - }, - { - "operId": "215", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071419755" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|IP地址|none| -|»» operLocation|string|true|none|IP地区|none| -|»» operParam|string|true|none|请求参数|none| -|»» operMsg|string|true|none|操作信息|none| -|»» status|string|true|none|状态|none| -|»» operTime|string|true|none|时间|none| -|»» costTime|string|true|none|消耗时间（毫秒）|none| - -## POST 操作日志列表导出 - -POST /monitor/operlog/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx -content-length: 36500 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "title": "string", - "operName": "string", - "businessType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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 | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/operlog/clean - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/operlog/{operIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|operIds|path|string| yes ||操作日志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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/登录访问信息 - -## GET 登录访问列表 - -GET /monitor/logininfor/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|ipaddr|query|string| no ||登录地址ip| -|userName|query|string| no ||用户名称| -|status|query|string| no ||登录状态 0失败 1成功| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "total": 130, - "rows": [ - { - "infoId": "119", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683370928996" - }, - { - "infoId": "118", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683370924042" - }, - { - "infoId": "117", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683370402328" - }, - { - "infoId": "116", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "注册成功", - "loginTime": "1683370382877" - }, - { - "infoId": "115", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683370352406" - }, - { - "infoId": "114", - "userName": "maskAdmin", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683364801882" - }, - { - "infoId": "113", - "userName": "maskUser", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683364794403" - }, - { - "infoId": "112", - "userName": "maskUser", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683364764244" - }, - { - "infoId": "111", - "userName": "wangdf", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "注册成功", - "loginTime": "1683364746502" - }, - { - "infoId": "110", - "userName": "maskAdmin", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683364727385" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|登录记录ID|none| -|»» userName|string|true|none|登录用户名称|none| -|»» ipaddr|string|true|none|IP地址|none| -|»» loginLocation|string|true|none|IP地区|none| -|»» browser|string|true|none|浏览器|none| -|»» os|string|true|none|操作系统|none| -|»» status|string|true|none|状态|0失败 1成功| -|»» msg|string|true|none|操作行为|none| -|»» loginTime|string|true|none|登录时间|none| - -## POST 登录访问列表导出 - -POST /monitor/logininfor/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx -content-length: 24305 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "ipaddr": "string", - "userName": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|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 | 登录地址ip|none| -|» userName|body|string| no | 用户名称|none| -|» status|body|string| no | 登录状态|0失败 1成功| -|» beginTime|body|string| no | 登录开始时间|none| -|» endTime|body|string| no | 登录结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/logininfor/clean - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 登录访问账户解锁 - -PUT /monitor/logininfor/unlock/{userName} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 /monitor/logininfor/{infoIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|infoIds|path|string| yes ||访问日志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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/System/服务器监控信息 - -## GET 服务器服务信息 - -GET /monitor/system-info - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "以太网 2": "IPv4 1.251.212.178", - "以太网": "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\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»»» 以太网 2|string|false|none||none| -|»»» 以太网|string|false|none||none| -|»»» VirtualBox Host-Only Network|string|false|none||none| -|»»» Loopback Pseudo-Interface 1|string|false|none||none| -|»» time|object|true|none|时间|none| -|»»» current|string|true|none||none| -|»»» uptime|string|true|none||none| -|»»» timezone|string|true|none||none| -|»»» timezoneName|string|true|none||none| -|»» system|object|true|none|系统|none| -|»»» platform|string|true|none||none| -|»»» node|string|true|none||none| -|»»» v8|string|true|none||none| -|»»» processId|integer|true|none||none| -|»»» arch|string|true|none||none| -|»»» uname|string|true|none||none| -|»»» release|string|true|none||none| -|»»» hostname|string|true|none||none| -|»»» homeDir|string|true|none||none| -|»»» cmd|string|true|none||none| -|»»» execCommand|string|true|none||none| -|»» disk|[object]|true|none|磁盘|none| -|»»» size|string|true|none||none| -|»»» used|string|true|none||none| -|»»» avail|string|true|none||none| -|»»» pcent|string|true|none||none| -|»»» target|string|true|none||none| - -## GET 资源监控信息加载 - -GET /monitor/load - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|type|query|string| yes ||数据类型all/cpu/memory/io/network| -|startTime|query|number| yes ||开始时间-时间戳毫秒| -|endTime|query|number| yes ||结束时间-时间戳毫秒| -|neType|query|string| no ||网元类型| -|neId|query|string| no ||网元ID| -|name|query|string| no ||名称，networ和iok时有效| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "以太网 2": "IPv4 1.251.212.178", - "以太网": "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\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»»» 以太网 2|string|false|none||none| -|»»» 以太网|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| - -# OMC HTTP RESTful API Interfaces/General APIs - -## GET 默认主页 - -GET / - -### Params - -|Name|Location|Type|Required|Title|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "欢迎使用mask_api_midwayjs后台管理框架，当前版本：0.0.5，请通过前端管理地址访问。" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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 获取验证码 - -GET /captchaImage - -验证码有效期2分钟 - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "captchaEnabled": true, - "uuid": "os0t2l1532dhuvqv", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%2364e6e6' d='M62.19 26.62L62.24 26.67L62.16 26.59Q65.43 27.87 69.20 27.87L69.20 27.88L69.26 27.94Q70.89 27.97 72.45 27.75L72.42 27.71L72.32 27.61Q71.98 28.18 71.33 29.36L71.26 29.29L71.29 29.32Q71.92 29.46 72.60 29.23L72.65 29.27L72.49 29.11Q72.23 30.03 72.23 30.83L72.28 30.89L72.19 30.79Q72.19 31.52 72.46 32.24L72.54 32.32L72.51 32.29Q70.98 31.95 69.20 31.99L69.29 32.08L69.23 32.02Q67.58 32.12 66.17 32.39L66.17 32.39L66.03 32.25Q66.46 31.46 66.35 30.47L66.36 30.48L66.36 30.49Q66.19 30.62 65.97 30.58L65.86 30.48L65.87 30.49Q65.69 30.47 65.39 30.47L65.37 30.44L65.49 30.57Q65.20 28.71 62.15 26.58ZM65.45 29.99L65.54 30.08L65.51 30.05Q67.04 30.25 68.18 30.21L68.22 30.25L68.13 30.16Q70.97 30.30 70.97 30.30L70.96 30.28L70.83 30.16Q71.02 29.20 71.74 28.18L71.68 28.11L71.59 28.03Q70.56 28.29 69.38 28.29L69.45 28.36L69.38 28.29Q66.36 28.35 63.47 27.40L63.43 27.36L63.37 27.30Q65.24 28.64 65.62 30.17ZM65.12 30.77L65.19 30.84L65.23 30.87Q65.53 30.79 66.21 30.83L66.19 30.81L66.15 30.77Q66.09 31.89 65.56 32.65L65.56 32.66L65.59 32.69Q67.19 32.57 67.03 32.57L67.07 32.60L67.07 32.60Q66.49 33.54 65.73 34.31L65.65 34.22L65.68 34.26Q67.75 33.97 69.69 33.97L69.55 33.83L69.64 33.91Q74.20 33.87 78.31 35.58L78.40 35.67L75.97 34.31L75.83 34.16Q73.52 32.73 73.52 30.52L73.38 30.39L73.46 30.46Q73.14 30.45 72.88 30.45L72.98 30.55L72.52 30.63L72.40 30.51Q72.58 29.78 73.15 28.83L73.13 28.81L73.05 28.72Q72.58 28.75 71.63 28.94L71.80 29.11L71.65 28.96Q72.26 28.05 73.25 27.29L73.21 27.25L73.11 27.15Q71.26 27.58 69.24 27.58L69.32 27.66L69.18 27.52Q64.54 27.64 60.77 25.77L60.70 25.70L60.78 25.78Q65.14 28.39 65.25 30.90ZM66.06 29.73L66.15 29.82L65.84 29.78L65.93 29.86Q65.64 29.61 65.53 29.61L65.71 29.79L65.72 29.80Q65.53 29.23 65.15 28.82L64.97 28.64L64.22 27.77L64.27 27.82Q66.75 28.66 69.49 28.66L69.36 28.54L69.46 28.64Q70.16 28.50 71.03 28.42L71.14 28.52L70.96 28.84L70.75 29.05L70.74 29.04Q69.46 29.09 68.17 29.06L68.18 29.06L68.33 29.22Q66.91 29.10 65.62 28.83L65.53 28.74L65.68 28.88Q66.05 29.26 66.20 29.87Z'/%3e%3cpath fill='%2371ade8' d='M44.80 18.31L44.89 18.39L44.82 18.33Q41.80 18.50 39.97 17.43L39.85 17.31L39.91 17.37Q42.41 15.99 47.28 11.77L47.20 11.68L47.21 11.69Q47.93 11.50 49.23 10.89L49.37 11.03L49.19 10.85Q47.99 16.93 47.88 23.28L47.82 23.23L47.74 23.15Q47.66 29.54 48.72 35.63L48.88 35.78L48.77 35.68Q47.12 34.97 44.98 34.86L45.00 34.87L44.91 34.78Q44.95 30.79 44.95 26.71L44.85 26.62L44.84 26.60Q44.89 22.55 44.93 18.43ZM44.49 20.62L44.51 35.22L44.60 35.31Q45.66 35.15 46.61 35.34L46.63 35.36L46.75 35.48Q46.71 36.05 46.90 37.42L46.91 37.43L46.92 37.44Q49.78 37.98 52.21 40.22L52.28 40.29L52.29 40.30Q49.82 33.19 49.79 25.73L49.66 25.60L49.66 25.60Q49.66 18.22 51.49 10.98L51.52 11.02L51.56 11.05Q50.92 11.37 49.32 12.47L49.37 12.52L49.39 12.53Q49.53 11.73 49.84 10.21L49.89 10.26L49.86 10.23Q48.47 10.94 47.02 11.32L47.11 11.40L47.16 11.45Q43.30 14.94 39.00 17.22L39.01 17.23L38.93 17.16Q40.33 18.25 42.69 18.59L42.75 18.65L42.72 18.62Q42.05 19.13 40.76 20.20L40.80 20.24L40.77 20.21Q42.38 20.71 44.58 20.71L44.48 20.61Z'/%3e%3cpath fill='%23328ce5' d='M21.38 18.49L21.29 18.40L21.25 18.35Q18.06 18.36 16.23 17.29L16.30 17.36L16.32 17.39Q18.86 16.04 23.73 11.82L23.69 11.77L23.72 11.80Q24.32 11.48 25.61 10.87L25.68 10.95L25.67 10.93Q24.27 16.80 24.15 23.16L24.27 23.28L24.25 23.25Q24.08 29.55 25.14 35.65L25.24 35.75L25.26 35.76Q23.44 34.90 21.31 34.78L21.45 34.93L21.33 34.80Q21.30 30.73 21.30 26.66L21.32 26.68L21.30 26.66Q21.18 22.44 21.22 18.33ZM21.01 20.74L20.85 35.16L20.88 35.19Q22.20 35.29 23.15 35.48L23.18 35.51L23.02 35.35Q23.15 36.09 23.34 37.46L23.40 37.53L23.34 37.46Q26.25 38.05 28.68 40.29L28.73 40.34L28.57 40.18Q26.18 33.15 26.15 25.69L26.07 25.61L26.20 25.74Q26.00 18.15 27.82 10.92L27.83 10.92L27.98 11.08Q27.25 11.30 25.65 12.40L25.78 12.53L25.79 12.54Q25.94 11.73 26.24 10.21L26.19 10.16L26.21 10.19Q24.96 11.03 23.51 11.41L23.43 11.32L23.48 11.37Q19.71 14.95 15.41 17.23L15.40 17.22L15.37 17.19Q16.80 18.32 19.16 18.66L19.09 18.60L19.19 18.70Q18.48 19.16 17.18 20.22L17.13 20.18L17.27 20.32Q18.61 20.55 20.82 20.55L20.86 20.59Z'/%3e%3cpath fill='%23ea5b7f' d='M99.33 32.82L99.48 32.98L99.49 32.99Q99.70 33.88 100.23 35.90L100.26 35.93L100.19 35.86Q95.96 34.53 91.36 34.79L91.43 34.87L91.36 34.79Q86.86 35.13 82.86 37.11L82.93 37.18L82.77 37.02Q83.04 36.37 83.08 36.45L83.03 36.40L83.12 36.49Q86.76 32.44 90.68 28.03L90.81 28.15L90.75 28.10Q95.13 23.07 96.31 18.39L96.27 18.35L96.37 18.45Q96.79 16.66 95.52 15.48L95.57 15.53L95.51 15.48Q94.32 14.38 92.53 14.53L92.55 14.55L92.54 14.55Q92.19 14.49 91.85 14.49L91.78 14.43L91.82 14.47Q90.33 14.50 89.08 15.42L88.92 15.26L89.03 15.38Q87.75 16.75 87.97 19.42L87.92 19.37L88.00 19.44Q86.06 18.95 84.84 18.50L84.84 18.49L84.86 18.51Q84.76 17.19 84.68 15.75L84.69 15.75L84.77 15.83Q84.61 14.11 85.22 12.97L85.20 12.95L85.12 12.87Q87.02 11.61 90.37 11.61L90.36 11.60L92.10 11.59L92.14 11.63Q94.30 11.54 95.25 11.66L95.24 11.65L95.25 11.65Q99.69 12.18 99.96 14.61L99.85 14.51L99.95 14.61Q100.04 15.19 99.96 15.99L99.88 15.90L100.03 16.05Q99.98 16.69 99.83 17.37L99.82 17.37L99.67 17.22Q98.08 25.38 90.51 32.23L90.53 32.26L90.51 32.23Q91.96 32.12 93.33 32.12L93.30 32.09L93.29 32.08Q96.57 32.13 99.43 32.93ZM98.92 12.16L98.80 12.04L98.93 12.17Q97.17 11.37 95.46 11.29L95.53 11.37L92.18 11.25L92.06 11.13Q87.59 10.85 85.38 11.96L85.41 11.98L85.34 11.91Q84.31 13.32 84.31 15.38L84.34 15.40L84.44 15.51Q84.32 16.07 84.63 18.89L84.76 19.02L84.72 18.98Q85.24 19.19 86.42 19.50L86.39 19.47L86.47 20.58L86.37 20.48Q86.42 21.03 86.50 21.56L86.48 21.54L86.42 21.48Q87.75 21.67 90.23 21.90L90.24 21.92L90.11 21.79Q90.23 21.56 90.23 21.22L90.21 21.20L90.17 21.16Q90.16 19.32 91.37 17.96L91.45 18.04L91.47 18.06Q92.64 16.66 94.43 16.78L94.36 16.71L94.33 16.67Q95.20 16.82 95.96 16.97L95.93 16.94L95.93 16.94Q95.99 17.27 96.06 17.69L96.08 17.71L96.00 17.62Q96.11 18.11 96.03 18.46L95.97 18.39L96.15 18.57Q94.71 23.15 90.30 27.99L90.36 28.05L90.40 28.09Q88.21 30.27 82.76 36.33L82.77 36.33L82.78 36.35Q82.53 37.12 82.18 37.69L82.19 37.70L82.23 37.73Q83.92 36.95 85.45 36.42L85.31 36.28L85.46 36.43Q84.62 36.88 83.67 38.37L83.80 38.50L83.77 38.47Q83.69 38.85 83.57 39.19L83.52 39.14L83.49 39.10Q88.27 36.96 93.76 37.15L93.88 37.28L93.90 37.29Q99.62 37.50 104.19 39.86L104.12 39.79L103.17 37.70L103.03 37.56Q102.53 36.37 102.26 35.57L102.12 35.43L102.24 35.55Q101.46 35.08 100.24 34.66L100.30 34.71L100.21 34.63Q100.03 33.87 99.65 32.50L99.78 32.63L99.64 32.49Q97.40 31.89 95.12 31.70L95.17 31.75L95.13 31.71Q99.98 27.32 101.51 19.05L101.48 19.03L101.62 16.09L101.67 16.13Q101.59 14.34 100.37 13.66L100.31 13.59L100.27 13.59L100.27 13.59Q100.18 13.47 100.11 13.47L100.09 13.45L100.11 13.47Q100.01 12.76 98.91 12.15Z'/%3e%3cpath d='M14 30 C59 18%2c65 9%2c110 17' stroke='%2363dddd' fill='none'/%3e%3cpath d='M13 24 C48 26%2c39 6%2c107 9' stroke='%23de77c4' fill='none'/%3e%3cpath d='M12 11 C50 25%2c80 39%2c113 8' stroke='%23e593bc' fill='none'/%3e%3cpath d='M19 17 C43 30%2c51 8%2c109 8' stroke='%23ddc16d' fill='none'/%3e%3c/svg%3e" -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "text": "9", - "captchaEnabled": true, - "uuid": "s7hf2j3erfpritqy", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%23ec73ce' d='M85.44 24.04L85.53 24.13L85.51 24.11Q83.59 23.90 82.35 25.33L82.43 25.40L82.43 25.41Q81.15 26.79 80.96 28.70L81.02 28.76L81.00 28.73Q80.82 30.84 81.91 31.81L81.97 31.87L81.87 31.78Q83.04 32.83 85.13 32.72L84.98 32.56L85.02 32.61Q87.16 32.50 88.26 31.81L88.29 31.84L88.27 31.82Q89.38 30.68 89.38 29.12L89.37 29.11L89.44 29.19Q89.37 28.73 89.30 28.35L89.35 28.41L89.39 28.44Q89.39 26.69 88.28 25.34L88.23 25.29L88.35 25.40Q87.20 24.01 85.52 24.12ZM85.09 35.22L85.17 35.31L85.10 35.24Q80.72 35.24 79.32 34.48L79.34 34.50L79.28 34.44Q78.32 33.75 78.13 32.04L78.05 31.96L78.03 31.93Q78.01 31.27 78.05 30.55L78.11 30.61L78.16 30.65Q78.27 29.66 78.27 29.21L78.24 29.17L78.13 29.06Q78.70 26.32 78.85 25.64L78.79 25.57L78.85 25.64Q79.36 23.75 80.20 22.34L80.18 22.33L80.01 22.15Q82.70 17.80 88.64 11.44L88.62 11.42L88.67 11.48Q91.34 11.17 93.55 10.37L93.58 10.41L93.62 10.44Q86.67 17.81 83.47 22.04L83.47 22.03L83.48 22.04Q84.46 21.53 85.75 21.53L85.86 21.64L85.82 21.60Q89.14 21.61 90.67 23.56L90.71 23.60L90.75 23.64Q91.92 25.12 92.26 28.66L92.27 28.66L92.29 28.68Q92.39 29.43 92.39 30.04L92.36 30.01L92.47 30.12Q92.44 33.21 90.23 34.28L90.23 34.28L90.26 34.30Q88.98 34.86 85.10 35.24ZM87.47 37.72L87.43 37.68L87.35 37.60Q88.60 37.52 90.58 37.60L90.71 37.72L90.71 37.73Q92.28 37.73 93.84 37.01L93.93 37.09L93.82 36.99Q94.99 36.26 94.99 34.47L94.96 34.43L95.01 34.49Q95.03 34.01 94.86 33.02L94.88 33.04L94.82 32.98Q94.56 31.91 94.56 31.45L94.60 31.49L94.54 31.43Q93.75 26.79 92.15 24.88L92.04 24.78L92.07 24.81Q92.00 24.70 91.85 24.47L91.90 24.52L91.66 24.36L91.50 24.24L91.51 24.25Q91.11 23.69 90.50 22.74L90.55 22.79L90.49 22.74Q89.69 21.89 87.71 21.44L87.64 21.36L87.62 21.35Q88.95 19.86 91.92 16.17L91.82 16.07L96.16 10.89L96.12 10.85Q94.61 11.77 92.21 12.53L92.15 12.47L92.19 12.52Q93.08 11.51 94.87 9.53L94.82 9.48L94.81 9.46Q92.46 10.58 88.58 11.15L88.59 11.17L88.58 11.16Q82.94 17.12 79.97 22.07L79.85 21.95L79.89 21.99Q78.41 24.55 77.84 30.79L77.84 30.79L77.72 30.67Q77.67 31.27 77.74 32.22L77.69 32.17L77.72 32.20Q77.90 34.05 79.00 34.96L78.95 34.91L78.92 34.88Q79.37 35.10 79.33 35.14L79.29 35.10L79.36 35.17Q79.71 36.05 80.51 36.47L80.42 36.38L80.50 36.46Q81.90 37.10 83.84 37.29L83.84 37.29L83.85 37.30Q83.79 37.24 87.30 37.54ZM87.11 26.36L87.10 26.35L87.17 26.41Q87.77 26.33 88.72 26.83L88.63 26.74L88.77 26.87Q88.99 27.71 88.99 28.36L88.94 28.30L89.00 28.37Q89.12 30.16 88.17 31.15L88.28 31.26L88.28 31.26Q87.16 31.92 85.06 32.23L85.15 32.32L85.11 32.28Q83.59 32.20 83.05 31.93L83.20 32.08L83.03 31.91Q82.84 31.45 82.84 31.15L82.85 31.16L83.00 31.31Q82.76 28.03 85.69 26.73L85.62 26.66L85.62 26.65Q86.45 26.39 87.22 26.46Z'/%3e%3cpath d='M10 16 C70 25%2c49 8%2c114 10' stroke='%2378c4dd' fill='none'/%3e%3cpath fill='%23d24065' d='M23.39 35.44L23.31 35.35L23.31 35.35Q21.80 35.33 20.24 34.91L20.24 34.91L20.26 34.93Q19.14 34.12 18.99 32.48L18.89 32.38L18.88 32.38Q18.97 32.31 19.16 29.68L19.17 29.69L19.07 29.59Q20.06 29.37 22.08 28.99L22.06 28.97L21.89 29.75L22.00 29.86Q21.69 31.57 23.10 32.14L23.15 32.19L23.18 32.22Q23.98 32.57 26.08 32.57L26.01 32.50L25.93 32.42Q27.52 32.26 27.71 32.18L27.87 32.35L27.76 32.23Q28.67 32.08 29.39 31.58L29.52 31.71L29.51 31.70Q30.85 30.68 30.66 28.59L30.61 28.54L30.60 28.52Q30.46 26.14 28.73 24.58L28.78 24.63L28.81 24.66Q27.08 23.10 24.61 23.10L24.60 23.09L24.53 22.79L24.55 22.81Q24.82 22.67 25.69 22.59L25.87 22.76L25.67 22.57Q27.66 22.53 29.03 21.30L29.07 21.34L28.97 21.24Q30.46 20.12 30.61 18.26L30.65 18.29L30.63 18.27Q30.61 17.84 30.61 17.50L30.70 17.58L30.61 17.49Q30.67 16.03 29.29 15.11L29.30 15.12L29.23 15.05Q28.02 14.25 26.42 14.37L26.39 14.34L26.38 14.33Q25.06 14.15 23.84 14.57L23.94 14.67L23.85 14.58Q22.55 15.25 22.24 16.40L22.11 16.26L22.21 16.37Q21.98 17.09 22.06 17.85L22.16 17.96L22.17 17.96Q21.02 17.62 18.97 16.89L18.89 16.82L18.91 16.83Q18.81 15.28 18.85 14.45L18.82 14.42L18.84 14.44Q18.83 12.80 19.90 12.11L20.08 12.29L19.99 12.20Q21.48 11.67 23.08 11.67L22.93 11.53L22.93 11.53Q26.17 11.57 29.33 11.84L29.29 11.79L29.34 11.85Q34.43 12.29 34.12 16.06L34.06 16.00L34.04 15.97Q34.00 17.50 33.51 19.06L33.59 19.14L33.55 19.10Q32.65 22.20 30.29 23.12L30.22 23.04L30.14 22.97Q32.90 23.63 33.51 26.98L33.50 26.97L33.50 26.97Q33.63 28.02 33.71 30.03L33.80 30.12L33.74 30.06Q33.91 34.53 29.30 34.99L29.30 34.99L29.40 35.09Q28.57 35.06 23.28 35.33ZM28.53 37.60L28.57 37.65L28.41 37.49Q29.16 37.66 32.01 37.74L31.88 37.61L32.06 37.79Q33.81 37.86 35.45 37.22L35.45 37.22L35.35 37.11Q36.46 36.10 36.27 34.35L36.41 34.49L36.29 34.36Q36.31 33.16 36.00 31.41L35.88 31.29L35.94 31.36Q35.18 26.82 33.24 25.19L33.21 25.16L33.10 24.86L33.06 24.78L32.98 24.69Q34.87 23.39 35.63 19.01L35.50 18.88L35.45 18.84Q35.57 18.46 35.69 17.51L35.78 17.61L35.65 17.47Q35.78 16.76 35.70 16.08L35.80 16.17L35.71 16.08Q35.63 14.48 34.33 13.79L34.34 13.80L34.17 13.71L34.22 13.76Q33.85 12.70 32.71 12.17L32.80 12.26L32.68 12.14Q31.11 11.41 25.97 11.11L26.08 11.21L25.99 11.12Q24.41 11.14 22.81 11.14L22.83 11.16L22.87 11.20Q21.14 11.07 19.62 11.72L19.76 11.86L19.73 11.83Q18.52 12.60 18.52 14.35L18.51 14.34L18.41 14.24Q18.40 13.81 18.67 17.16L18.78 17.28L18.69 17.19Q18.99 17.26 20.63 17.87L20.60 17.84L20.62 17.86Q20.76 18.53 20.72 19.02L20.54 18.84L20.73 19.03Q20.54 19.34 20.58 19.87L20.63 19.93L20.66 19.95Q22.51 20.39 24.53 20.51L24.57 20.55L24.39 20.37Q24.38 18.42 25.48 17.58L25.50 17.59L25.44 17.54Q26.27 16.89 28.29 16.66L28.41 16.78L28.39 16.76Q29.52 16.75 30.09 16.94L30.06 16.90L30.08 16.92Q30.15 17.07 30.19 17.19L30.05 17.05L30.20 17.39L30.27 17.92L30.23 17.88Q30.30 18.13 30.26 18.28L30.18 18.21L30.31 18.34Q30.19 20.01 28.67 21.19L28.59 21.10L28.57 21.09Q27.71 22.06 25.69 22.25L25.72 22.28L25.69 22.24Q25.04 22.47 24.17 22.47L24.11 22.42L24.00 22.30Q24.03 22.64 24.19 23.33L24.35 23.49L24.35 23.50Q26.11 23.50 27.56 24.23L27.50 24.16L27.36 24.14L25.79 24.32L25.76 24.29Q25.76 24.59 25.87 25.20L26.02 25.36L25.90 25.23Q28.07 25.19 29.78 26.53L29.72 26.46L29.85 26.59Q30.02 26.92 30.33 28.55L30.36 28.59L30.35 28.58Q30.47 31.44 27.54 31.85L27.69 32.01L27.61 31.92Q25.48 32.16 24.91 32.12L24.88 32.09L24.98 32.19Q24.46 32.02 23.93 31.94L23.99 32.00L23.91 31.47L24.12 31.10L24.16 30.73L24.16 30.38L24.18 30.40Q23.17 30.42 22.37 30.61L22.44 30.68L22.41 30.65Q22.35 30.40 22.35 30.21L22.43 30.29L22.42 30.28Q22.46 30.09 22.46 29.86L22.33 29.73L22.34 29.74Q22.44 29.39 22.59 28.67L22.57 28.64L22.66 28.73Q20.80 28.96 18.93 29.30L18.88 29.26L18.80 29.18Q18.85 29.72 18.74 30.84L18.80 30.91L18.66 30.76Q18.64 31.99 18.64 32.59L18.55 32.50L18.55 32.50Q18.70 34.63 20.07 35.39L20.08 35.40L20.01 35.33Q21.56 37.68 26.28 37.49L26.31 37.52L26.24 37.45Q27.06 37.51 28.59 37.66Z'/%3e%3cpath d='M13 4 C51 9%2c65 6%2c110 4' stroke='%237590df' fill='none'/%3e%3cpath fill='%23d24b4b' d='M57.55 34.48L57.61 34.54L57.53 34.46Q56.76 34.34 56.08 34.38L56.14 34.44L56.20 34.50Q55.53 34.63 54.85 34.63L54.68 34.47L54.66 34.45Q55.13 31.03 55.13 27.61L55.18 27.66L55.14 27.61Q53.29 27.63 52.37 27.63L52.57 27.82L52.48 27.73Q51.54 27.64 49.72 27.56L49.69 27.54L49.80 27.64Q49.90 27.44 49.71 24.97L49.65 24.91L49.57 24.82Q52.15 25.39 55.12 25.39L55.18 25.45L55.19 25.46Q54.81 20.93 54.39 18.34L54.48 18.43L54.56 18.51Q55.36 18.62 56.16 18.62L56.03 18.49L57.67 18.50L57.78 18.61Q57.44 22.76 57.44 25.35L57.58 25.49L57.45 25.36Q59.72 25.46 62.92 25.12L62.84 25.04L62.84 25.03Q62.75 26.40 62.75 27.61L62.81 27.68L62.69 27.56Q62.58 27.71 61.78 27.75L61.75 27.72L61.70 27.66Q60.68 27.63 60.07 27.67L60.01 27.62L60.07 27.68Q60.10 27.71 57.44 27.71L57.51 27.78L57.34 31.04L57.51 31.21Q57.46 32.79 57.57 34.50ZM63.36 24.64L63.33 24.62L63.27 24.55Q61.46 24.95 59.59 25.03L59.54 24.98L59.53 24.97Q59.78 21.82 60.19 19.96L60.18 19.94L60.22 19.98Q59.51 20.03 58.10 20.18L58.10 20.18L58.31 18.15L58.19 18.03Q55.69 18.15 54.01 18.04L54.01 18.04L54.02 18.05Q54.54 21.12 54.73 25.00L54.70 24.97L54.67 24.94Q52.99 24.97 49.30 24.36L49.20 24.27L49.30 24.37Q49.53 25.51 49.53 28.14L49.55 28.16L51.02 28.11L50.96 28.05Q51.07 28.88 50.92 30.29L50.86 30.23L54.76 29.90L54.85 29.99Q54.64 33.17 54.34 35.00L54.38 35.04L54.33 34.99Q55.05 34.95 56.45 34.83L56.56 34.93L56.49 34.86Q56.55 35.62 56.52 36.95L56.41 36.85L56.39 36.83Q56.88 36.78 60.50 36.93L60.59 37.02L60.50 36.94Q59.71 33.98 59.48 30.02L59.38 29.92L59.45 29.99Q62.82 30.12 64.91 30.50L64.93 30.52L64.79 30.38Q64.61 29.43 64.61 28.48L64.58 28.46L64.74 26.71L64.69 26.66Q64.46 26.66 63.93 26.70L63.98 26.75L63.08 26.65L63.05 26.62Q63.09 25.86 63.20 24.49Z'/%3e%3cpath d='M6 19 C52 21%2c78 16%2c107 21' stroke='%2383ebb7' fill='none'/%3e%3cpath d='M8 38 C57 34%2c69 37%2c109 30' stroke='%237baddf' fill='none'/%3e%3c/svg%3e" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|验证码值|仅开发模式返回显示| -|» captchaEnabled|boolean|true|none|是否启用|none| -|» uuid|string|true|none|uuid|none| -|» img|string|true|none|base64图片|none| - -## GET 获取系统可暴露的配置信息 - -GET /sys-conf - -### Params - -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST 转存帮助文档 - -POST /helpDoc - -> Body Parameters - -```json -{ - "uploadPath": "string", - "language": "string" -} -``` - -### Params - -|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| -|» uploadPath|body|string| yes ||none| -|» language|body|string| yes ||none| - -> Response Examples - -> 成功 - -```json -{ - "code": 1, - "data": "/static/helpDoc/zh_doc.pdf", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/General APIs/文件操作 - -## POST 上传文件 - -POST /file/upload - -> Body Parameters - -```yaml -file: string -subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common', - 'download', 'chunk'] %}" - -``` - -### Params - -|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| -|» file|body|string(binary)| yes ||上传文件对象| -|» subPath|body|string| yes ||子路径，可选范围 ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "url": "http://127.0.0.1:6275/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "fileName": "/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "newFileName": "o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "originalFileName": "o_1d2bofn8f19dh5s11okpje61mipg_画板1.png" - } -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，支持以下类型：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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» url|string|true|none||none| -|»» fileName|string|true|none||none| -|»» newFileName|string|true|none||none| -|»» originalFileName|string|true|none||none| - -## POST 切片文件检查 - -POST /file/chunkCheck - -> Body Parameters - -```json -{ - "identifier": "string", - "fileName": "string" -} -``` - -### Params - -|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 | 切片文件目录标识符|MD5(文件名+文件大小)| -|» fileName|body|string| yes | 原始文件名称|检查格式是否允许上传| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|已上传切片数据块的编号|none| - -## POST 切片文件上传 - -POST /file/chunkUpload - -```js -// 上传数据块 -const formData = new FormData(); -formData.append('file', chunk, 'xxx.pdf'); -formData.append('index', chunksIndex); -formData.append('identifier', fileIdentifier); -``` - -chunk是切片块的数据需要给上传文件的名称带后缀 - -> Body Parameters - -```yaml -file: string -index: "{% mock 'increment' %}" -identifier: "{% mock 'id' %}" - -``` - -### Params - -|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| -|» file|body|string(binary)| yes ||数据块Blob对象，需要给文件名称带后缀| -|» index|body|string| yes ||数据块的编号| -|» identifier|body|string| yes ||切片文件目录标识符| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "/upload/chunk/2023/06/identifier/index" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|206|[Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)|成功|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|上传资源地址|none| - -## POST 切片文件合并 - -POST /file/chunkMerge - -> Body Parameters - -```json -{ - "identifier": "string", - "fileName": "string", - "subPath": "string" -} -``` - -### Params - -|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 | 切片文件目录标识符|MD5(文件名+文件大小)| -|» fileName|body|string| yes | 原始文件名称|检查格式是否允许上传| -|» subPath|body|string| yes | 子路径|可选范围 ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "url": "http://127.0.0.1:6275/upload/avatar/2023/06/gmircbr_48xqb8.png", - "fileName": "/upload/avatar/2023/06/gmircbr_48xqb8.png", - "newFileName": "gmircbr_48xqb8.png", - "originalFileName": "gmircbr.png" - } -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，支持以下类型：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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|已上传切片数据块的编号|none| - -## GET 下载文件 - -GET /file/download/{filePath} - -filePath参数需要进行base64编码，base64("文件存放资源路径，URL相对地址") - -断点续传可以在请求头中加入下载数据块的区间，示例如单块5M大小 `Range: bytes=0-5242879` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|filePath|path|string| yes ||base64("文件存放资源路径，URL相对地址")| -|Range|header|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 - -> 文件数据 - -> 206 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|文件数据|Inline| -|206|[Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)|断点续传数据块|Inline| - -### Responses Data Schema - -# OMC HTTP RESTful API Interfaces/General APIs/通用请求 - -## POST 哈希加密 - -POST /common/hash - -> Body Parameters - -```json -{ - "type": "string", - "str": "string" -} -``` - -### Params - -|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 | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| yes | 加密字符串|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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||none| - -## GET 多语言处理 - -GET /common/i18n - -> Body Parameters - -```json -{ - "type": "string", - "str": "string" -} -``` - -### Params - -|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 | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| yes | 加密字符串|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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||none| - -## POST 哈希加盐加密 - -POST /common/hmac - -> Body Parameters - -```json -{ - "type": "string", - "str": "string" -} -``` - -### Params - -|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 | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| yes | 加密字符串|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": "6c44dbdf8d759c97dfd8c43a2974ba22" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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||none| - -# OMC HTTP RESTful API Interfaces/General APIs/账号身份操作 - -## GET 登录用户信息 - -GET /getInfo - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "permissions": [ - "*:*:*" - ], - "roles": [ - "admin" - ], - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "maskAdmin", - "nickName": "管理员", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "管理员", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "status": "1" - } - } - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|权限|字符数组| -|»» roles|[string]|true|none|角色|字符数组| -|»» user|object|true|none|用户信息|none| -|»»» roles|[object]|true|none||none| -|»»»» roleId|string|false|none||none| -|»»»» roleName|string|false|none||none| -|»»»» roleKey|string|false|none||none| -|»»»» roleSort|integer|false|none||none| -|»»»» dataScope|string|false|none||none| -|»»»» status|string|false|none||none| -|»»» userId|string|true|none||none| -|»»» deptId|string|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 登录路由信息 - -GET /getRouters - -### Params - -|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| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST 系统登录 - -POST /login - -> Body Parameters - -```json -{ - "username": "admin", - "password": "rootaa", - "code": "{{code-text}}", - "uuid": "{{code-uuid}}" -} -``` - -### Params - -|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 | 登录名|none| -|» password|body|string| yes | 密码|none| -|» code|body|string| yes | 验证码值|none| -|» uuid|body|string| yes | 验证码唯一标识|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -```json -{ - "code": 500, - "msg": "验证码已失效" -} -``` - -```json -{ - "code": 500, - "msg": "验证码错误" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|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|授权令牌|none| - -## POST 系统登出 - -POST /logout - -对IP进行限流 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| no ||授权令牌，可有可无| -|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 - -> 成功 - -```json -{ - "code": 200, - "msg": "退出成功" -} -``` - -```json -{ - "code": 500, - "msg": "访问过于频繁，请稍候再试" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none|固定值|none| -|» msg|string|true|none|固定值|none| - -# OMC HTTP RESTful API Interfaces/General APIs/账号注册操作 - -## POST 系统注册 - -POST /register - -> Body Parameters - -```json -{ - "username": "string", - "password": "string", - "confirmPassword": "string", - "code": "string", - "uuid": "string" -} -``` - -### Params - -|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 | 用户名|none| -|» password|body|string| yes | 密码|none| -|» confirmPassword|body|string| yes | 确认密码|none| -|» code|body|string| yes | 验证码值|none| -|» uuid|body|string| yes | 验证码唯一标识|none| - -> Response Examples - -> 成功 - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "当前系统没有开启注册功能！" -} -``` - -```json -{ - "code": 500, - "msg": "注册用户【xxxx】失败，注册账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "账号不能以数字开头，可包含大写小写字母，数字，且不少于5位" -} -``` - -```json -{ - "code": 500, - "msg": "密码至少包含大小写字母、数字、特殊符号，且不少于6位" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# OMC HTTP RESTful API Interfaces/Data Management - -## GET Fuzzy query with '%' - -GET /api/rest/dataManagement/v1/omc_db/alarm - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Query by where condition - -GET /api/rest/databaseManagement/v1/omc_db/ne_info - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## GET Multiple SQL query - -GET /api/rest/databaseManagement/v1/omc_db/ne_state - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## POST Insert multiple record into table alarm_log - -POST /api/rest/dataManagement/v1/omc_db/alarm_log - -> Body Parameters - -```json -{ - "alarm_log": [ - { - "ne_type": "AMF", - "ne_id": "001", - "alarm_id": "2", - "alarm_code": "2", - "alarm_seq": "3", - "event_time": "2023-10-29 15:52:09" - }, - { - "ne_type": "SMF", - "ne_id": "001", - "alarm_id": "4", - "alarm_code": "2", - "alarm_seq": "3", - "event_time": "2023-10-29 16:52:09" - } - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT Update single record - -PUT /api/rest/dataManagement/v1/omc_db/user - -> Body Parameters - -```json -{ - "user": { - "name": "test3" - } -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## PUT UPDATE MeasureTask - -PUT /api/rest/databaseManagement/v1/omc_db/measure_task - -> Body Parameters - -```json -{ - "measure_task": { - "id": "28", - "ne_type": "SMF", - "ne_ids": "[\"SZ_01\"]", - "kpi_set": "[{\"Code\":\"SMFHA01\",\"KPIs\":[\"SMF.AttCreatePduSession\",\"SMF.AttCreatePduSession._Dnn\"]}]", - "schedule": "[{\"Type\":\"\",\"Days\":[]}]", - "start_time": "", - "end_time": "", - "granul_option": "30M", - "status": "Inactive", - "create_time": "2023-5-25 21:59:9", - "periods": "[]" - } -} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -## DELETE Delete historical alarm exceeding 90 days - -DELETE /api/rest/databaseManagement/v1/delete/omc_db/alarm - -> Body Parameters - -```json -{} -``` - -### Params - -|Name|Location|Type|Required|Title|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 - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|成功|Inline| - -### Responses Data Schema - -# Data Schema - diff --git a/docs/interfaces/08-OMC HTTP Restful API Interfaces V1.01.pdf b/docs/interfaces/08-OMC HTTP Restful API Interfaces V1.01.pdf deleted file mode 100644 index 512ec37..0000000 Binary files a/docs/interfaces/08-OMC HTTP Restful API Interfaces V1.01.pdf and /dev/null differ diff --git a/docs/interfaces/08-OMC HTTP Restful API Interfaces v1.02.pdf b/docs/interfaces/08-OMC HTTP Restful API Interfaces v1.02.pdf deleted file mode 100644 index 1b55bff..0000000 Binary files a/docs/interfaces/08-OMC HTTP Restful API Interfaces v1.02.pdf and /dev/null differ diff --git a/docs/interfaces/08-OMC HTTP Restful API Interfaces.docx b/docs/interfaces/08-OMC HTTP Restful API Interfaces.docx deleted file mode 100644 index 22a422a..0000000 Binary files a/docs/interfaces/08-OMC HTTP Restful API Interfaces.docx and /dev/null differ diff --git a/docs/interfaces/08-OMC HTTP Restful API Interfaces.md b/docs/interfaces/08-OMC HTTP Restful API Interfaces.md deleted file mode 100644 index 3d6a23d..0000000 --- a/docs/interfaces/08-OMC HTTP Restful API Interfaces.md +++ /dev/null @@ -1,11777 +0,0 @@ ---- -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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 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 - -POST /login - -> Body Request Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -```json -{ - "code": 500, - "msg": "Verification code has expired" -} -``` - -```json -{ - "code": 500, - "msg": "Verification code error" -} -``` - -### Response - -| HTTP Status Code | Meaning | Description | Data Schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 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 | Title | 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 - -```json -{ - "code": 200, - "msg": "Logout Success" -} -``` - -```json -{ - "code": 500, - "msg": "The access is too frequent, please try again later." -} -``` - -### Response - -| HTTP Status Code | Meaning | Description | Data Schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 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 - -```json -{} -``` - -> OK - -```json -{ - "data": [ - { - "SMF/001": { - "ipAddress": "192.168.14.13", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 24, - "sysCpuUsage": 9 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 50138, - "used": 13601 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 90620, - "sysMemUsage": 436, - "totalMem": 8167360 - }, - "serialNum": "20230905", - "version": "1.6.1" - } - } - }, - { - "AMF/001": { - "ipAddress": "192.168.14.12", - "systemState": { - "capability": 100000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 10 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 50138, - "used": 13601 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 23844, - "sysMemUsage": 436, - "totalMem": 8167360 - }, - "serialNum": "20230905", - "version": "1.6.1" - } - } - }, - { - "UPF/001": { - "ipAddress": "192.168.1.159", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 3474, - "sysCpuUsage": 2984 - }, - "diskSpace": { - "partitionInfo": [ - { - "total": 7998, - "used": 0 - }, - { - "total": 1603, - "used": 0 - }, - { - "total": 100278, - "used": 12041 - }, - { - "total": 8019, - "used": 1 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 8019, - "used": 0 - }, - { - "total": 1603, - "used": 0 - } - ], - "partitionNum": 7 - }, - "expiryDate": "2024-12-31", - "memUsage": { - "nfUsedMem": 114940, - "sysMemUsage": 948, - "totalMem": 16424904 - }, - "serialNum": "13740272", - "version": "2.2311.8" - } - } - }, - { - "AUSF/001": { - "ipAddress": "192.168.1.186", - "systemState": { - "capability": 50000, - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 564 - }, - "dbInfo": "adb v1.0.1", - "diskSpace": { - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | -| 401 | [Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1) | Unauthorized | Inline | -| 500 | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | Server Error | Inline | - -### Responses Data Schema - -## GET Get Alarm from NF - -GET /api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms - -Sync alarms from NF - -> Body Parameters - -```json -[ - { - "neType": "SMF", - "neId": "SZ_01", - "alarmId": "SMF0113", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:56:09", - "alarmCode": 10, - "alarmType": "EquipmentAlarm", - "origSeverity": "Critical", - "alarmStatus": 0, - "specificProblem": "string", - "addInfo": "string", - "locationInfo": "test" - } -] -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## GET Get OMC 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -## POST Get Alarm from NF - -POST /api/rest/faultManagement/v1/elementType/smf/objectType/alarms - -> Body Parameters - -```json -{ - "objectId": "SMF_0", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:52:09", - "alarmCode": 10, - "alarmType": "EquipmentAlarm", - "perceivedSeverity": 3, - "alarmStatus": 1, - "specificProblem": "string", - "additionalText": "string", - "alarmSource": "test" -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post Alarm from AMF - -POST /api/rest/faultManagement/v1/elementType/amf/objectType/alarms - -> Body Parameters - -```json -{ - "objectId": "AMF_0", - "alarmTitle": "test", - "eventTime": "2023-03-29 15:52:09", - "alarmCode": 6, - "alarmType": "EquipmentAlarm", - "perceivedSeverity": 3, - "alarmStatus": 1, - "specificProblem": "string", - "additionalText": "string", - "alarmSource": "test" -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post Measure Task - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask - -> Body Parameters - -```json -{} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post Trace Task No NeType - -POST /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{ - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "", - "neId": "", - "interfaces": [ - "N8", - "N10" - ] -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Put Trace Task No NeType - -PUT /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{ - "id": 3, - "traceType": "Interface", - "startTime": "2023-07-04 13:00:00", - "endTime": "2023-07-04 19:00:00", - "neType": "", - "neId": "", - "srcIp": "192.168.2.199", - "signalPort": 3030, - "interfaces": [ - "N8", - "N10", - "N11" - ] -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete Trace Task No NeType - -DELETE /api/rest/traceManagement/v1/subscriptions - -> Body Parameters - -```json -{} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post AMF Measure Task - -POST /api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask - -> Body Parameters - -```json -{} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST - -POST /tcpdump/ne - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 0, - "data": { - "cmd": "string", - "fileName": "string", - "msg": "string" - }, - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post Measurement - -POST /api/rest/performanceManagement/v1/elementType/smf/objectType/measurement - -> Body Parameters - -```json -{ - "Index": 2, - "NeName": "SMFRJBJJC01", - "RmUID": "1101AGTHXSMF0000015704000100", - "NeType": "SMF", - "PmVersion": "5GC16.1.1", - "Dn": "RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456", - "Period": "15", - "TimeZone": "UTC+8", - "StartTime": "2023-05-23 22:26:28", - "Datas": [ - { - "ObjectType": "SmfFunction", - "KPIs": [ - { - "KPIID": "SMF.AttCreatePduSession._Dnn", - "KPIValues": [ - { - "Name": "cmnet", - "Value": 1 - }, - { - "Name": "ims", - "Value": 0 - } - ] - } - ] - }, - { - "ObjectType": "AddrPool", - "KPIs": [ - { - "KPIID": "SMF.MeanAllcAddr", - "KPIValues": [ - { - "Name": "Total", - "Value": 1 - } - ] - }, - { - "KPIID": "SMF.MeanAllcAddr._Ns", - "KPIValues": [ - { - "Name": "1001", - "Value": 2 - }, - { - "Name": "1002", - "Value": 1 - } - ] - } - ] - } - ] -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST UPF Capture PACP - -POST /tcpdump/neUPF - -> Body Parameters - -```json -{ - "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: - -1) Start capturing packets pcap trace rx tx max 100000 intfc any file upf_test.pcap -2) 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: - -1) Start capturing packets pcap dispatch trace on max 100000 file upf_test.pcap -2) Stop capturing packets pcap dispatch trace off - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# Configuration/Export/Import NE - -## POST Post MML UDM - -POST /api/rest/opeartionManagement/v1/elementType/udm/objectType/mml - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get Software from OMC - -GET /api/rest/systemManagement/v1/AMF/software/123 - -> Body Parameters - -```yaml -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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Upload Software To OMC - -POST /api/rest/systemManagement/v1/AMF/software/123 - -> Body Parameters - -```yaml -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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Export CM From NF - -GET /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```yaml -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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Import CM to NF - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete Software from OMC - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/cm - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Active Software To NF - -PUT /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01 - -> Body Parameters - -```json -{} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PATCH Rollback Software To NF - -PATCH /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01 - -> Body Parameters - -```yaml -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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Distribute Software To NF - -POST /api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230621/SZ_T01 - -> Body Parameters - -```yaml -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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post MML - -POST /api/rest/opeartionManagement/v1/elementType/udm/objectType/MML - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# Configuration/NE Management - -## PUT Put NE Info - -PUT /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -```json -{ - "pvFlag": "VNF", - "province": "GD", - "vendorName": "AGT", - "dn": "cmjicai" -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post NE Info - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/neInfo - -> Body Parameters - -```json -{ - "neType": "UDM", - "neId": "SZ_02", - "neName": "UDM_SZ_01", - "ip": "192.168.1.187", - "port": "8080", - "pvFlag": "VNF", - "province": "GD", - "vendorName": "AGT", - "dn": "cmjicai" -} -``` - -### 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Put System Parameter to UDM - -PUT /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Post System Parameter to UDM - -POST /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete System Parameter to UDM - -DELETE /api/rest/systemManagement/v1/elementType/udm/objectType/config/system - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management - -## PUT Batch Modify PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/{number} - -> Body Parameters - -```json -{ - "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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | 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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST new subscriber data - -POST /ne/udm/sub/{neId} - -This API can add 4&5G subscriber at the same time - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### 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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | string | true | none | | none | -| » msg | string | true | none | | none | - -## PUT modify subscriber data - -PUT /ne/udm/sub/{neId} - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### 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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST batch add subscriber data - -POST /ne/udm/sub/{neId}/{num} - -> Body Parameters - -```json -{ - "msisdn": "string", - "imsi": "string", - "ambr": "string", - "nssai": "string", - "rat": "string", - "arfb": "string", - "sar": "string", - "cn": "string", - "smData": "string", - "smfSel": "string", - "epsDat": "string", - "epsFlag": "string", - "epsOdb": "string", - "hplmnOdb": "string", - "ard": "string", - "epstpl": "string", - "contextId": "string", - "apnContext": "string", - "staticIp": "string" -} -``` - -### 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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## 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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | string | true | none | | none | -| » msg | string | true | none | | none | - -## POST import subsriber data file - -POST /ne/udm/sub/export - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## PUT Reload data for Redis - -PUT /ne/udm/sub/resetData/{neId} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------- | ------------ | -------- | ------------ | --------------------- | ------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 - -```yaml -neId: "002" -file: 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 | -| » file | body | string(binary) | yes | | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| -------------- | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| -------------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## PUT Reload data for Redis - -PUT /ne/udm/auth/resetData/{neId} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 1, - "data": 37981, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | integer | true | none | | none | -| » msg | string | true | none | | none | - -## POST add authentication data - -POST /ne/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | string | true | none | | none | -| » msg | string | true | none | | none | - -## PUT modify authentication data - -PUT /ne/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST batch add authentication data - -POST /ne/udm/auth/{neId}/{num} - -> Body Parameters - -```json -{ - "algoIndex": "string", - "amf": "string", - "imsi": "string", - "ki": "string", - "opc": "string" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » data | string | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE batch delete authentication data - -DELETE /ne/udm/auth/{neId}/{imsi}/{num} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST export authentication data file - -POST /ne/udm/auth/export - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | integer | true | none | | none | - -## POST import authentication data file - -POST /ne/udm/auth/import - -> Body Parameters - -```yaml -neId: "002" -file: 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 | -| » file | body | string(binary) | yes | | none | - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# 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 | Title | 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 - -```json -{ - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] -} -``` - -```json -{ - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] -} -``` - -```json -{ - "data": [ - { - "hdrEnrich": "dnn", - "imsi": "460990100000006", - "msisdn": "86755900001", - "pccRules": "internet|ims_sig", - "qosAudio": "qos_audio", - "qosVideo": "qos_video", - "rfsp": 1, - "sar": "def_sar", - "sessRules": "internet|ims_sig", - "uePolicy": "uep_001" - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Add PCF UE Info - -POST /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -> Body Parameters - -```json -{ - "imsi": "460990100000002", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Modify PCF UE Info - -PUT /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -> Body Parameters - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete PCF UE Info - -DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "cause": "DATA_NOT_FOUND", - "status": 404 -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ----------------------------------------------------------- | ---------------- | ----------- | -| 404 | [Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | Record Not Found | Inline | - -### Responses Data Schema - -HTTP Status Code **404** - -| Name | Type | Required | Restrictions | 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 - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Batch Delete PCF UE Info - -DELETE /api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/number - -> Body Parameters - -```json -{ - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/N3IWF Online User - -## GET Query N3IWF UE Info - -GET /api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "data": [ - { - "activeTime": "2023-11-29 06:35:43", - "imsi": "460302072701181", - "nai": "0460302072701181@nai.epc.mnc030.mcc460.3gppnetwork.org", - "regState": 1 - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | 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 | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/IMS Online User - -## GET Get UE Info from IMS - -GET /api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/SMF Online User - -## GET Get UE Info from SMF - -GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Get UE Number from SMF - -GET /api/rest/ueManagement/v1/elementType/smf/objectType/ueNum - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# UE Management/General APIs - -## GET query NE's type and ID - -GET /ne/info - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST files to the NE - -POST /ne/action/pushFile - -> Body Parameters - -```json -{ - "uploadPath": "string", - "neType": "string", - "neId": "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 | -| » 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 - -```json -{ - "code": 1, - "data": "/home/agtuser/5G_cn.pdf", - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | 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 - -```json -{ - "mml": [ - "date", - "date" - ] -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -# Security/Departent info - -## GET Department list - -GET /system/dept/list - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ----------------- | ------------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ----------------- | ------------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------- | -------- | -------- | ------------ | --------------------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to add [xxx] to department, department name already exists" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Department modification - -PUT /system/dept - -> Body Parameters - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string", - "deptId": "string" -} -``` - -### 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access department data" -} -``` - -```json -{ - "code": 500, - "msg": "Department modification [xxx] failed, the superior department cannot be myself" -} -``` - -```json -{ - "code": 500, - "msg": "This department contains sub-departments that are not deactivated!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Department deletion - -DELETE /system/dept/{deptId} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access department data" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | ------------ | -------- | ------------ | ---------------------- | ------------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ---------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 - -```text -content-disposition: attachment;filename=post_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "postCode": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | ------------ | -------- | ------------ | ---------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to add [xxx] to the position, the position name already exists" -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Position modification - -PUT /system/post - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Position modification [xxx] failed, the position name already exists" -} -``` - -```json -{ - "code": 500, - "msg": "Position modification [xxx] failed, the position code already exists" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Position deletation - -DELETE /system/post/{postIds} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access job data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | 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 | - -> Response Examples - -> Success - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------ | -------- | -------- | ------------ | --------- | --------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## POST Modify avatar - -POST /system/user/profile/avatar - -> Body Parameters - -```yaml -file: 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 | -| » file | body | string(binary) | yes | | Please choose a proportional picture as the avatar, such as 200x200, 400x400 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success", - "data": "/upload/avatar/2023/04/11.png" -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ------------------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | string | true | none | The image's address | none | - -## PUT change Password - -PUT /system/user/profile/updatePwd - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "The new password cannot be the same as the old password" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to change password, old password is wrong" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# Security/Role info - -## GET Role information list - -GET /system/role/list - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------------- | -------- | -------- | ------------ | ----------- | ------------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------- | -------- | -------- | ------------ | --------------- | ------------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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" - } -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------------- | ------- | -------- | ------------ | ----------- | ------------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Modify Role [xxx] failed, the role name already exists" -} -``` - -```json -{ - "code": 500, - "msg": "Modify Role [xxxx] failed, the permission key value already exists" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access character data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## POST role information add - -POST /system/role - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Add Role[xxxx] failed, role name already exists" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE role information delete - -DELETE /system/role/{roleIds} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access character data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT role status changes - -PUT /system/role/changeStatus - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access character data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Role data permission modification - -PUT /system/role/dataScope - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access character data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 - -```text -content-disposition: attachment;filename=role_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "status": "string", - "beginTime": "string", - "endTime": "string" -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Role assignment selection authorization - -PUT /system/role/authUser/checked - -> Body Parameters - -```json -{ - "roleId": "string", - "userIds": "string", - "checked": true -} -``` - -### 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access character data!" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 - -```text -content-disposition: attachment;filename=user_import_template_1684230715497.xlsx -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -### 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 | - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## GET User information list - -GET /system/user/list - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------- | ------------ | -------- | ------------ | --------------- | ------------------------ | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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": "" - } - ] - } -} -``` - -```json -{ - "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": "" - } - ] - } -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access user data" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to add user [xxxx], the login account already exists" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to add user [xxxx], the mobile phone number already exists" -} -``` - -x - -```json -{ - "code": 500, - "msg": "Failed to add user [xxxx], the mailbox already exists" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Modify user information - -PUT /system/user - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to modify user [xxx], the mobile phone number already exists" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to modify user [xxx], the login account already exists" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to modify user [xxx], the mailbox already exists" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## POST Export user information list - -POST /system/user/export - -The file stream is Response ed normally, and the response header is as follows - -```text -content-disposition: attachment;filename=user_export_11_1684230271701.xlsx -content-length: 21499 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "userName": "string", - "phonenumber": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "deptId": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## POST User information list import file - -POST /system/user/importData - -> Body Parameters - -```yaml -file: [] -updateSupport: "{% mock 'pick' , ['false','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 | -| » file | body | string(binary) | no | | | -| » updateSupport | body | string | no | | | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "" -} -``` - -```json -{ - "code": 200, - "msg": "" -} -``` - -```json -{ - "code": 200, - "msg": "" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -```json -{ - "code": 500, - "msg": "" -} -``` - -```json -{ - "code": 500, - "msg": "" -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE User information deletion - -DELETE /system/user/{userIds} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access user data！" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT reset user password - -PUT /system/user/resetPwd - -> Body Parameters - -```json -{ - "password": "string", - "userId": "string" -} -``` - -### 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access user data！" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT User status modification - -PUT /system/user/changeStatus - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "No permission to access user data！" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | 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 | - -> Response Examples - -> Success - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------------------------------ | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | 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 | - -> Response Examples - -> Success - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ------ | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | -------- | -------- | ------------ | ------------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------- | ------- | -------- | ------------ | ------------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE delete list of key names under cache name - -DELETE /monitor/cache/clearCacheName/{cacheName} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Safely clear cached names - -DELETE /monitor/cache/clearCacheSafe - -### 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 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# 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 - -```text -content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx -content-length: 17079 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0, - "beginTime": "string", - "endTime": "string" -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------- | -------- | -------- | ------------ | ------ | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------- | ------------ | -------- | ------------ | ------ | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Clear scheduled task logs - -DELETE /monitor/jobLog/clean - -### 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 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# 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 - -```text -content-disposition: attachment;filename=job_export_6_1684058991890.xlsx -content-length: 19346 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------- | -------- | -------- | ------------ | ----------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------- | ------------ | -------- | ------------ | ----------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Scheduling task add[xxx] failed, the same task name exists in the same task group" -} -``` - -```json -{ - "code": 500, - "msg": "Scheduling task add[xxxx] failed, Cron expression is incorrect" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Scheduling task modification - -PUT /monitor/job - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "Scheduling task modification [xxxx] failed, the Cron expression is incorrect" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Schedule task delete - -DELETE /monitor/job/{jobIds} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Scheduling task modification status - -PUT /monitor/job/changeStatus - -> Body Parameters - -```json -{ - "jobId": "22", - "status": "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 | -| » jobId | body | string | yes | | none | -| » status | body | string | yes | | 0 Inactive 1 Active | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Schedule the task to be executed immediately - -PUT /monitor/job/run/{jobId} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Scheduling task reset refresh queue - -PUT /monitor/job/resetQueueJob - -### 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 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# System/Operation log information - -## GET Operation log lists - -GET /monitor/operlog/list - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------ | -------- | -------- | ------------ | ------------------ | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 - -```text -content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx -content-length: 36500 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "title": "string", - "operName": "string", - "businessType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 | 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 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Operation log deletion - -DELETE /monitor/operlog/{operIds} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# System/Logged in information - -## GET Login access list - -GET /monitor/logininfor/list - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------ | -------- | -------- | ------------ | ---------- | -------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 Login access list export - -POST /monitor/logininfor/export - -The file stream is Response ed normally, and the response header is as follows - -```text -content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx -content-length: 24305 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "ipaddr": "string", - "userName": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### 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 - -```json -{ - "code": 500, - "msg": "Export data record is empty" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Login access clear - -DELETE /monitor/logininfor/clean - -### 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 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## PUT Logged in account unlock - -PUT /monitor/logininfor/unlock/{userName} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## DELETE Logged in account delete - -DELETE /monitor/logininfor/{infoIds} - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# System/Online user information - -## GET Online user list - -GET /monitor/online/list - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------ | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » 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 | Title | 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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "fail" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# System/Server monitoring information - -## GET Server information - -GET /monitor/system-info - -### 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 | - -> Response Examples - -> Success - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------------------------- | -------- | -------- | ------------ | ------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------------------------- | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "code": 200, - "msg": "" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -## GET verification code - -GET /captchaImage - -Verification code is valid for 2 minutes - -### 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 | - -> Response Examples - -> Success - -```json -{ - "code": 200, - "msg": "Success", - "captchaEnabled": true, - "uuid": "os0t2l1532dhuvqv", - "img": "" -} -``` - -```json -{ - "code": 200, - "msg": "Success", - "text": "9", - "captchaEnabled": true, - "uuid": "s7hf2j3erfpritqy", - "img": "" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------- | ------- | -------- | ------------ | ----------------------- | ----------- | -| » code | 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 - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------- | ------------ | -------- | ------------ | --------------------- | ------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 - -```json -{ - "uploadPath": "string", - "language": "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 | -| » uploadPath | body | string | yes | | none | -| » language | body | string | yes | | none | - -> Response Examples - -> Success - -```json -{ - "code": 1, - "data": "/static/helpDoc/zh_doc.pdf", - "msg": "success" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# General APIs/File operations - -## POST upload files - -POST /file/upload - -> Body Parameters - -```yaml -file: string -subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common', - 'download', 'chunk'] %}" - -``` - -### 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 | -| » file | body | string(binary) | yes | | upload files | -| » subPath | body | string | yes | | subpath, optional range ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk'] | - -> Response Examples - -> Success - -```json -{ - "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" - } -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success", - "data": [] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | 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 - -```js -// 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 - -```yaml -file: string -index: "{% mock 'increment' %}" -identifier: "{% mock 'id' %}" - -``` - -### 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 | -| » 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 - -```json -{ - "code": 200, - "msg": "Success", - "data": "/upload/chunk/2023/06/identifier/index" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | --------------------------------------------------------------- | ----------- | ----------- | -| 206 | [Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1) | 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 - -```json -{ - "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 - -```json -{ - "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" - } -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | -------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 | Title | 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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | file data | Inline | -| 206 | [Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1) | Resume data block transfer from breakpoint | Inline | - -### Responses Data Schema - -# General APIs/General request - -## POST Hash encryption - -POST /common/hash - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | string | true | none | | none | - -## GET multilingual processing - -GET /common/i18n - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | string | true | none | | none | - -## POST Hash and salt encryption - -POST /common/hmac - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success", - "data": "6c44dbdf8d759c97dfd8c43a2974ba22" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | string | true | none | | none | - -# General APIs/User operation - -## GET user information - -GET /getInfo - -### 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 | - -> Response Examples - -> Success - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------------ | -------- | -------- | ------------ | ----------- | --------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | 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 | - -> Response Examples - -> Success - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ---------------- | ------------ | -------- | ------------ | --------------------- | ------------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | [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 - -POST /login - -> Body Parameters - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -```json -{ - "code": 500, - "msg": "Verification code has expired" -} -``` - -```json -{ - "code": 500, - "msg": "Verification code error" -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ----------------- | ------- | -------- | ------------ | ------------------- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | -| » data | 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 | Title | 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 - -```json -{ - "code": 200, - "msg": "Logout Success" -} -``` - -```json -{ - "code": 500, - "msg": "The access is too frequent, please try again later." -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 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 - -```json -{ - "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 - -```json -{ - "code": 200, - "msg": "Success" -} -``` - -```json -{ - "code": 500, - "msg": "The registration function is not currently enabled in the system!" -} -``` - -```json -{ - "code": 500, - "msg": "Failed to register user [xxxx], the registered account already exists" -} -``` - -```json -{ - "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." -} -``` - -```json -{ - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------- | ------- | -------- | ------------ | ----- | ----------- | -| » code | integer | true | none | | none | -| » msg | string | true | none | | none | - -# Data Management - -## GET Fuzzy query with '%' - -GET /api/rest/dataManagement/v1/omc_db/alarm - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Query by where condition - -GET /api/rest/dataManagement/v1/omc_db/ne_info - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## GET Multiple SQL query - -GET /api/rest/dataManagement/v1/omc_db/ne_state - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## POST Insert multiple record into table alarm_log - -POST /api/rest/dataManagement/v1/omc_db/alarm_log - -> Body Parameters - -```json -{ - "alarm_log": [ - { - "ne_type": "AMF", - "ne_id": "001", - "alarm_id": "2", - "alarm_code": "2", - "alarm_seq": "3", - "event_time": "2023-10-29 15:52:09" - }, - { - "ne_type": "SMF", - "ne_id": "001", - "alarm_id": "4", - "alarm_code": "2", - "alarm_seq": "3", - "event_time": "2023-10-29 16:52:09" - } - ] -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT Update single record - -PUT /api/rest/dataManagement/v1/omc_db/user - -> Body Parameters - -```json -{ - "user": { - "name": "test3" - } -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## PUT UPDATE MeasureTask - -PUT /api/rest/dataManagement/v1/omc_db/measure_task - -> Body Parameters - -```json -{ - "measure_task": { - "id": "28", - "ne_type": "SMF", - "ne_ids": "[\"SZ_01\"]", - "kpi_set": "[{\"Code\":\"SMFHA01\",\"KPIs\":[\"SMF.AttCreatePduSession\",\"SMF.AttCreatePduSession._Dnn\"]}]", - "schedule": "[{\"Type\":\"\",\"Days\":[]}]", - "start_time": "", - "end_time": "", - "granul_option": "30M", - "status": "Inactive", - "create_time": "2023-5-25 21:59:9", - "periods": "[]" - } -} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema - -## DELETE Delete historical alarm exceeding 90 days - -DELETE /api/rest/dataManagement/v1/delete/omc_db/alarm - -> Body Parameters - -```json -{} -``` - -### Request Parameters - -| Name | Location | Type | Required | Title | 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 - -```json -{} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | Success | Inline | - -### Responses Data Schema diff --git a/docs/interfaces/08-OMC HTTP Restful API Interfaces.pdf b/docs/interfaces/08-OMC HTTP Restful API Interfaces.pdf deleted file mode 100644 index 21ff8bb..0000000 Binary files a/docs/interfaces/08-OMC HTTP Restful API Interfaces.pdf and /dev/null differ diff --git a/docs/interfaces/08-OMC Open API v2409.4.md b/docs/interfaces/08-OMC Open API v2409.4.md deleted file mode 100644 index b5ef3e3..0000000 --- a/docs/interfaces/08-OMC Open API v2409.4.md +++ /dev/null @@ -1,21463 +0,0 @@ ---- -title: OMC -language_tabs: - - shell: Shell - - http: HTTP - - javascript: JavaScript - - ruby: Ruby - - python: Python - - php: PHP - - java: Java - - go: Go -toc_footers: [] -includes: [] -search: true -code_clipboard: true -highlight_theme: darkula -headingLevel: 2 -generator: "@tarslib/widdershins v4.0.23" - ---- - -# OMC - -OMC HTTP Restful API Interfaces - -Base URLs: - -# 中文目录接口/通用模块 - -## GET 默认主页 - -GET / - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Referer|header|string| yes |User Referer| -|User-Agent|header|string| yes |User Agent| -|Accept-Language|header|string| yes |en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Welcome to the CN EMS Core Network Management Platform, current version: 2.2401.1, please access via the frontend address." -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 获取验证码 - -GET /captchaImage - -验证码有效期2分钟 - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |User Referer| -|User-Agent|header|string| yes |User Agent| -|Accept-Language|header|string| yes |en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "captchaEnabled": true, - "uuid": "os0t2l1532dhuvqv", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%2364e6e6' d='M62.19 26.62L62.24 26.67L62.16 26.59Q65.43 27.87 69.20 27.87L69.20 27.88L69.26 27.94Q70.89 27.97 72.45 27.75L72.42 27.71L72.32 27.61Q71.98 28.18 71.33 29.36L71.26 29.29L71.29 29.32Q71.92 29.46 72.60 29.23L72.65 29.27L72.49 29.11Q72.23 30.03 72.23 30.83L72.28 30.89L72.19 30.79Q72.19 31.52 72.46 32.24L72.54 32.32L72.51 32.29Q70.98 31.95 69.20 31.99L69.29 32.08L69.23 32.02Q67.58 32.12 66.17 32.39L66.17 32.39L66.03 32.25Q66.46 31.46 66.35 30.47L66.36 30.48L66.36 30.49Q66.19 30.62 65.97 30.58L65.86 30.48L65.87 30.49Q65.69 30.47 65.39 30.47L65.37 30.44L65.49 30.57Q65.20 28.71 62.15 26.58ZM65.45 29.99L65.54 30.08L65.51 30.05Q67.04 30.25 68.18 30.21L68.22 30.25L68.13 30.16Q70.97 30.30 70.97 30.30L70.96 30.28L70.83 30.16Q71.02 29.20 71.74 28.18L71.68 28.11L71.59 28.03Q70.56 28.29 69.38 28.29L69.45 28.36L69.38 28.29Q66.36 28.35 63.47 27.40L63.43 27.36L63.37 27.30Q65.24 28.64 65.62 30.17ZM65.12 30.77L65.19 30.84L65.23 30.87Q65.53 30.79 66.21 30.83L66.19 30.81L66.15 30.77Q66.09 31.89 65.56 32.65L65.56 32.66L65.59 32.69Q67.19 32.57 67.03 32.57L67.07 32.60L67.07 32.60Q66.49 33.54 65.73 34.31L65.65 34.22L65.68 34.26Q67.75 33.97 69.69 33.97L69.55 33.83L69.64 33.91Q74.20 33.87 78.31 35.58L78.40 35.67L75.97 34.31L75.83 34.16Q73.52 32.73 73.52 30.52L73.38 30.39L73.46 30.46Q73.14 30.45 72.88 30.45L72.98 30.55L72.52 30.63L72.40 30.51Q72.58 29.78 73.15 28.83L73.13 28.81L73.05 28.72Q72.58 28.75 71.63 28.94L71.80 29.11L71.65 28.96Q72.26 28.05 73.25 27.29L73.21 27.25L73.11 27.15Q71.26 27.58 69.24 27.58L69.32 27.66L69.18 27.52Q64.54 27.64 60.77 25.77L60.70 25.70L60.78 25.78Q65.14 28.39 65.25 30.90ZM66.06 29.73L66.15 29.82L65.84 29.78L65.93 29.86Q65.64 29.61 65.53 29.61L65.71 29.79L65.72 29.80Q65.53 29.23 65.15 28.82L64.97 28.64L64.22 27.77L64.27 27.82Q66.75 28.66 69.49 28.66L69.36 28.54L69.46 28.64Q70.16 28.50 71.03 28.42L71.14 28.52L70.96 28.84L70.75 29.05L70.74 29.04Q69.46 29.09 68.17 29.06L68.18 29.06L68.33 29.22Q66.91 29.10 65.62 28.83L65.53 28.74L65.68 28.88Q66.05 29.26 66.20 29.87Z'/%3e%3cpath fill='%2371ade8' d='M44.80 18.31L44.89 18.39L44.82 18.33Q41.80 18.50 39.97 17.43L39.85 17.31L39.91 17.37Q42.41 15.99 47.28 11.77L47.20 11.68L47.21 11.69Q47.93 11.50 49.23 10.89L49.37 11.03L49.19 10.85Q47.99 16.93 47.88 23.28L47.82 23.23L47.74 23.15Q47.66 29.54 48.72 35.63L48.88 35.78L48.77 35.68Q47.12 34.97 44.98 34.86L45.00 34.87L44.91 34.78Q44.95 30.79 44.95 26.71L44.85 26.62L44.84 26.60Q44.89 22.55 44.93 18.43ZM44.49 20.62L44.51 35.22L44.60 35.31Q45.66 35.15 46.61 35.34L46.63 35.36L46.75 35.48Q46.71 36.05 46.90 37.42L46.91 37.43L46.92 37.44Q49.78 37.98 52.21 40.22L52.28 40.29L52.29 40.30Q49.82 33.19 49.79 25.73L49.66 25.60L49.66 25.60Q49.66 18.22 51.49 10.98L51.52 11.02L51.56 11.05Q50.92 11.37 49.32 12.47L49.37 12.52L49.39 12.53Q49.53 11.73 49.84 10.21L49.89 10.26L49.86 10.23Q48.47 10.94 47.02 11.32L47.11 11.40L47.16 11.45Q43.30 14.94 39.00 17.22L39.01 17.23L38.93 17.16Q40.33 18.25 42.69 18.59L42.75 18.65L42.72 18.62Q42.05 19.13 40.76 20.20L40.80 20.24L40.77 20.21Q42.38 20.71 44.58 20.71L44.48 20.61Z'/%3e%3cpath fill='%23328ce5' d='M21.38 18.49L21.29 18.40L21.25 18.35Q18.06 18.36 16.23 17.29L16.30 17.36L16.32 17.39Q18.86 16.04 23.73 11.82L23.69 11.77L23.72 11.80Q24.32 11.48 25.61 10.87L25.68 10.95L25.67 10.93Q24.27 16.80 24.15 23.16L24.27 23.28L24.25 23.25Q24.08 29.55 25.14 35.65L25.24 35.75L25.26 35.76Q23.44 34.90 21.31 34.78L21.45 34.93L21.33 34.80Q21.30 30.73 21.30 26.66L21.32 26.68L21.30 26.66Q21.18 22.44 21.22 18.33ZM21.01 20.74L20.85 35.16L20.88 35.19Q22.20 35.29 23.15 35.48L23.18 35.51L23.02 35.35Q23.15 36.09 23.34 37.46L23.40 37.53L23.34 37.46Q26.25 38.05 28.68 40.29L28.73 40.34L28.57 40.18Q26.18 33.15 26.15 25.69L26.07 25.61L26.20 25.74Q26.00 18.15 27.82 10.92L27.83 10.92L27.98 11.08Q27.25 11.30 25.65 12.40L25.78 12.53L25.79 12.54Q25.94 11.73 26.24 10.21L26.19 10.16L26.21 10.19Q24.96 11.03 23.51 11.41L23.43 11.32L23.48 11.37Q19.71 14.95 15.41 17.23L15.40 17.22L15.37 17.19Q16.80 18.32 19.16 18.66L19.09 18.60L19.19 18.70Q18.48 19.16 17.18 20.22L17.13 20.18L17.27 20.32Q18.61 20.55 20.82 20.55L20.86 20.59Z'/%3e%3cpath fill='%23ea5b7f' d='M99.33 32.82L99.48 32.98L99.49 32.99Q99.70 33.88 100.23 35.90L100.26 35.93L100.19 35.86Q95.96 34.53 91.36 34.79L91.43 34.87L91.36 34.79Q86.86 35.13 82.86 37.11L82.93 37.18L82.77 37.02Q83.04 36.37 83.08 36.45L83.03 36.40L83.12 36.49Q86.76 32.44 90.68 28.03L90.81 28.15L90.75 28.10Q95.13 23.07 96.31 18.39L96.27 18.35L96.37 18.45Q96.79 16.66 95.52 15.48L95.57 15.53L95.51 15.48Q94.32 14.38 92.53 14.53L92.55 14.55L92.54 14.55Q92.19 14.49 91.85 14.49L91.78 14.43L91.82 14.47Q90.33 14.50 89.08 15.42L88.92 15.26L89.03 15.38Q87.75 16.75 87.97 19.42L87.92 19.37L88.00 19.44Q86.06 18.95 84.84 18.50L84.84 18.49L84.86 18.51Q84.76 17.19 84.68 15.75L84.69 15.75L84.77 15.83Q84.61 14.11 85.22 12.97L85.20 12.95L85.12 12.87Q87.02 11.61 90.37 11.61L90.36 11.60L92.10 11.59L92.14 11.63Q94.30 11.54 95.25 11.66L95.24 11.65L95.25 11.65Q99.69 12.18 99.96 14.61L99.85 14.51L99.95 14.61Q100.04 15.19 99.96 15.99L99.88 15.90L100.03 16.05Q99.98 16.69 99.83 17.37L99.82 17.37L99.67 17.22Q98.08 25.38 90.51 32.23L90.53 32.26L90.51 32.23Q91.96 32.12 93.33 32.12L93.30 32.09L93.29 32.08Q96.57 32.13 99.43 32.93ZM98.92 12.16L98.80 12.04L98.93 12.17Q97.17 11.37 95.46 11.29L95.53 11.37L92.18 11.25L92.06 11.13Q87.59 10.85 85.38 11.96L85.41 11.98L85.34 11.91Q84.31 13.32 84.31 15.38L84.34 15.40L84.44 15.51Q84.32 16.07 84.63 18.89L84.76 19.02L84.72 18.98Q85.24 19.19 86.42 19.50L86.39 19.47L86.47 20.58L86.37 20.48Q86.42 21.03 86.50 21.56L86.48 21.54L86.42 21.48Q87.75 21.67 90.23 21.90L90.24 21.92L90.11 21.79Q90.23 21.56 90.23 21.22L90.21 21.20L90.17 21.16Q90.16 19.32 91.37 17.96L91.45 18.04L91.47 18.06Q92.64 16.66 94.43 16.78L94.36 16.71L94.33 16.67Q95.20 16.82 95.96 16.97L95.93 16.94L95.93 16.94Q95.99 17.27 96.06 17.69L96.08 17.71L96.00 17.62Q96.11 18.11 96.03 18.46L95.97 18.39L96.15 18.57Q94.71 23.15 90.30 27.99L90.36 28.05L90.40 28.09Q88.21 30.27 82.76 36.33L82.77 36.33L82.78 36.35Q82.53 37.12 82.18 37.69L82.19 37.70L82.23 37.73Q83.92 36.95 85.45 36.42L85.31 36.28L85.46 36.43Q84.62 36.88 83.67 38.37L83.80 38.50L83.77 38.47Q83.69 38.85 83.57 39.19L83.52 39.14L83.49 39.10Q88.27 36.96 93.76 37.15L93.88 37.28L93.90 37.29Q99.62 37.50 104.19 39.86L104.12 39.79L103.17 37.70L103.03 37.56Q102.53 36.37 102.26 35.57L102.12 35.43L102.24 35.55Q101.46 35.08 100.24 34.66L100.30 34.71L100.21 34.63Q100.03 33.87 99.65 32.50L99.78 32.63L99.64 32.49Q97.40 31.89 95.12 31.70L95.17 31.75L95.13 31.71Q99.98 27.32 101.51 19.05L101.48 19.03L101.62 16.09L101.67 16.13Q101.59 14.34 100.37 13.66L100.31 13.59L100.27 13.59L100.27 13.59Q100.18 13.47 100.11 13.47L100.09 13.45L100.11 13.47Q100.01 12.76 98.91 12.15Z'/%3e%3cpath d='M14 30 C59 18%2c65 9%2c110 17' stroke='%2363dddd' fill='none'/%3e%3cpath d='M13 24 C48 26%2c39 6%2c107 9' stroke='%23de77c4' fill='none'/%3e%3cpath d='M12 11 C50 25%2c80 39%2c113 8' stroke='%23e593bc' fill='none'/%3e%3cpath d='M19 17 C43 30%2c51 8%2c109 8' stroke='%23ddc16d' fill='none'/%3e%3c/svg%3e" -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "text": "9", - "captchaEnabled": true, - "uuid": "s7hf2j3erfpritqy", - "img": "data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='120' height='40' viewBox='0%2c0%2c120%2c40'%3e%3crect width='100%25' height='100%25' fill='%23fafafa'/%3e%3cpath fill='%23ec73ce' d='M85.44 24.04L85.53 24.13L85.51 24.11Q83.59 23.90 82.35 25.33L82.43 25.40L82.43 25.41Q81.15 26.79 80.96 28.70L81.02 28.76L81.00 28.73Q80.82 30.84 81.91 31.81L81.97 31.87L81.87 31.78Q83.04 32.83 85.13 32.72L84.98 32.56L85.02 32.61Q87.16 32.50 88.26 31.81L88.29 31.84L88.27 31.82Q89.38 30.68 89.38 29.12L89.37 29.11L89.44 29.19Q89.37 28.73 89.30 28.35L89.35 28.41L89.39 28.44Q89.39 26.69 88.28 25.34L88.23 25.29L88.35 25.40Q87.20 24.01 85.52 24.12ZM85.09 35.22L85.17 35.31L85.10 35.24Q80.72 35.24 79.32 34.48L79.34 34.50L79.28 34.44Q78.32 33.75 78.13 32.04L78.05 31.96L78.03 31.93Q78.01 31.27 78.05 30.55L78.11 30.61L78.16 30.65Q78.27 29.66 78.27 29.21L78.24 29.17L78.13 29.06Q78.70 26.32 78.85 25.64L78.79 25.57L78.85 25.64Q79.36 23.75 80.20 22.34L80.18 22.33L80.01 22.15Q82.70 17.80 88.64 11.44L88.62 11.42L88.67 11.48Q91.34 11.17 93.55 10.37L93.58 10.41L93.62 10.44Q86.67 17.81 83.47 22.04L83.47 22.03L83.48 22.04Q84.46 21.53 85.75 21.53L85.86 21.64L85.82 21.60Q89.14 21.61 90.67 23.56L90.71 23.60L90.75 23.64Q91.92 25.12 92.26 28.66L92.27 28.66L92.29 28.68Q92.39 29.43 92.39 30.04L92.36 30.01L92.47 30.12Q92.44 33.21 90.23 34.28L90.23 34.28L90.26 34.30Q88.98 34.86 85.10 35.24ZM87.47 37.72L87.43 37.68L87.35 37.60Q88.60 37.52 90.58 37.60L90.71 37.72L90.71 37.73Q92.28 37.73 93.84 37.01L93.93 37.09L93.82 36.99Q94.99 36.26 94.99 34.47L94.96 34.43L95.01 34.49Q95.03 34.01 94.86 33.02L94.88 33.04L94.82 32.98Q94.56 31.91 94.56 31.45L94.60 31.49L94.54 31.43Q93.75 26.79 92.15 24.88L92.04 24.78L92.07 24.81Q92.00 24.70 91.85 24.47L91.90 24.52L91.66 24.36L91.50 24.24L91.51 24.25Q91.11 23.69 90.50 22.74L90.55 22.79L90.49 22.74Q89.69 21.89 87.71 21.44L87.64 21.36L87.62 21.35Q88.95 19.86 91.92 16.17L91.82 16.07L96.16 10.89L96.12 10.85Q94.61 11.77 92.21 12.53L92.15 12.47L92.19 12.52Q93.08 11.51 94.87 9.53L94.82 9.48L94.81 9.46Q92.46 10.58 88.58 11.15L88.59 11.17L88.58 11.16Q82.94 17.12 79.97 22.07L79.85 21.95L79.89 21.99Q78.41 24.55 77.84 30.79L77.84 30.79L77.72 30.67Q77.67 31.27 77.74 32.22L77.69 32.17L77.72 32.20Q77.90 34.05 79.00 34.96L78.95 34.91L78.92 34.88Q79.37 35.10 79.33 35.14L79.29 35.10L79.36 35.17Q79.71 36.05 80.51 36.47L80.42 36.38L80.50 36.46Q81.90 37.10 83.84 37.29L83.84 37.29L83.85 37.30Q83.79 37.24 87.30 37.54ZM87.11 26.36L87.10 26.35L87.17 26.41Q87.77 26.33 88.72 26.83L88.63 26.74L88.77 26.87Q88.99 27.71 88.99 28.36L88.94 28.30L89.00 28.37Q89.12 30.16 88.17 31.15L88.28 31.26L88.28 31.26Q87.16 31.92 85.06 32.23L85.15 32.32L85.11 32.28Q83.59 32.20 83.05 31.93L83.20 32.08L83.03 31.91Q82.84 31.45 82.84 31.15L82.85 31.16L83.00 31.31Q82.76 28.03 85.69 26.73L85.62 26.66L85.62 26.65Q86.45 26.39 87.22 26.46Z'/%3e%3cpath d='M10 16 C70 25%2c49 8%2c114 10' stroke='%2378c4dd' fill='none'/%3e%3cpath fill='%23d24065' d='M23.39 35.44L23.31 35.35L23.31 35.35Q21.80 35.33 20.24 34.91L20.24 34.91L20.26 34.93Q19.14 34.12 18.99 32.48L18.89 32.38L18.88 32.38Q18.97 32.31 19.16 29.68L19.17 29.69L19.07 29.59Q20.06 29.37 22.08 28.99L22.06 28.97L21.89 29.75L22.00 29.86Q21.69 31.57 23.10 32.14L23.15 32.19L23.18 32.22Q23.98 32.57 26.08 32.57L26.01 32.50L25.93 32.42Q27.52 32.26 27.71 32.18L27.87 32.35L27.76 32.23Q28.67 32.08 29.39 31.58L29.52 31.71L29.51 31.70Q30.85 30.68 30.66 28.59L30.61 28.54L30.60 28.52Q30.46 26.14 28.73 24.58L28.78 24.63L28.81 24.66Q27.08 23.10 24.61 23.10L24.60 23.09L24.53 22.79L24.55 22.81Q24.82 22.67 25.69 22.59L25.87 22.76L25.67 22.57Q27.66 22.53 29.03 21.30L29.07 21.34L28.97 21.24Q30.46 20.12 30.61 18.26L30.65 18.29L30.63 18.27Q30.61 17.84 30.61 17.50L30.70 17.58L30.61 17.49Q30.67 16.03 29.29 15.11L29.30 15.12L29.23 15.05Q28.02 14.25 26.42 14.37L26.39 14.34L26.38 14.33Q25.06 14.15 23.84 14.57L23.94 14.67L23.85 14.58Q22.55 15.25 22.24 16.40L22.11 16.26L22.21 16.37Q21.98 17.09 22.06 17.85L22.16 17.96L22.17 17.96Q21.02 17.62 18.97 16.89L18.89 16.82L18.91 16.83Q18.81 15.28 18.85 14.45L18.82 14.42L18.84 14.44Q18.83 12.80 19.90 12.11L20.08 12.29L19.99 12.20Q21.48 11.67 23.08 11.67L22.93 11.53L22.93 11.53Q26.17 11.57 29.33 11.84L29.29 11.79L29.34 11.85Q34.43 12.29 34.12 16.06L34.06 16.00L34.04 15.97Q34.00 17.50 33.51 19.06L33.59 19.14L33.55 19.10Q32.65 22.20 30.29 23.12L30.22 23.04L30.14 22.97Q32.90 23.63 33.51 26.98L33.50 26.97L33.50 26.97Q33.63 28.02 33.71 30.03L33.80 30.12L33.74 30.06Q33.91 34.53 29.30 34.99L29.30 34.99L29.40 35.09Q28.57 35.06 23.28 35.33ZM28.53 37.60L28.57 37.65L28.41 37.49Q29.16 37.66 32.01 37.74L31.88 37.61L32.06 37.79Q33.81 37.86 35.45 37.22L35.45 37.22L35.35 37.11Q36.46 36.10 36.27 34.35L36.41 34.49L36.29 34.36Q36.31 33.16 36.00 31.41L35.88 31.29L35.94 31.36Q35.18 26.82 33.24 25.19L33.21 25.16L33.10 24.86L33.06 24.78L32.98 24.69Q34.87 23.39 35.63 19.01L35.50 18.88L35.45 18.84Q35.57 18.46 35.69 17.51L35.78 17.61L35.65 17.47Q35.78 16.76 35.70 16.08L35.80 16.17L35.71 16.08Q35.63 14.48 34.33 13.79L34.34 13.80L34.17 13.71L34.22 13.76Q33.85 12.70 32.71 12.17L32.80 12.26L32.68 12.14Q31.11 11.41 25.97 11.11L26.08 11.21L25.99 11.12Q24.41 11.14 22.81 11.14L22.83 11.16L22.87 11.20Q21.14 11.07 19.62 11.72L19.76 11.86L19.73 11.83Q18.52 12.60 18.52 14.35L18.51 14.34L18.41 14.24Q18.40 13.81 18.67 17.16L18.78 17.28L18.69 17.19Q18.99 17.26 20.63 17.87L20.60 17.84L20.62 17.86Q20.76 18.53 20.72 19.02L20.54 18.84L20.73 19.03Q20.54 19.34 20.58 19.87L20.63 19.93L20.66 19.95Q22.51 20.39 24.53 20.51L24.57 20.55L24.39 20.37Q24.38 18.42 25.48 17.58L25.50 17.59L25.44 17.54Q26.27 16.89 28.29 16.66L28.41 16.78L28.39 16.76Q29.52 16.75 30.09 16.94L30.06 16.90L30.08 16.92Q30.15 17.07 30.19 17.19L30.05 17.05L30.20 17.39L30.27 17.92L30.23 17.88Q30.30 18.13 30.26 18.28L30.18 18.21L30.31 18.34Q30.19 20.01 28.67 21.19L28.59 21.10L28.57 21.09Q27.71 22.06 25.69 22.25L25.72 22.28L25.69 22.24Q25.04 22.47 24.17 22.47L24.11 22.42L24.00 22.30Q24.03 22.64 24.19 23.33L24.35 23.49L24.35 23.50Q26.11 23.50 27.56 24.23L27.50 24.16L27.36 24.14L25.79 24.32L25.76 24.29Q25.76 24.59 25.87 25.20L26.02 25.36L25.90 25.23Q28.07 25.19 29.78 26.53L29.72 26.46L29.85 26.59Q30.02 26.92 30.33 28.55L30.36 28.59L30.35 28.58Q30.47 31.44 27.54 31.85L27.69 32.01L27.61 31.92Q25.48 32.16 24.91 32.12L24.88 32.09L24.98 32.19Q24.46 32.02 23.93 31.94L23.99 32.00L23.91 31.47L24.12 31.10L24.16 30.73L24.16 30.38L24.18 30.40Q23.17 30.42 22.37 30.61L22.44 30.68L22.41 30.65Q22.35 30.40 22.35 30.21L22.43 30.29L22.42 30.28Q22.46 30.09 22.46 29.86L22.33 29.73L22.34 29.74Q22.44 29.39 22.59 28.67L22.57 28.64L22.66 28.73Q20.80 28.96 18.93 29.30L18.88 29.26L18.80 29.18Q18.85 29.72 18.74 30.84L18.80 30.91L18.66 30.76Q18.64 31.99 18.64 32.59L18.55 32.50L18.55 32.50Q18.70 34.63 20.07 35.39L20.08 35.40L20.01 35.33Q21.56 37.68 26.28 37.49L26.31 37.52L26.24 37.45Q27.06 37.51 28.59 37.66Z'/%3e%3cpath d='M13 4 C51 9%2c65 6%2c110 4' stroke='%237590df' fill='none'/%3e%3cpath fill='%23d24b4b' d='M57.55 34.48L57.61 34.54L57.53 34.46Q56.76 34.34 56.08 34.38L56.14 34.44L56.20 34.50Q55.53 34.63 54.85 34.63L54.68 34.47L54.66 34.45Q55.13 31.03 55.13 27.61L55.18 27.66L55.14 27.61Q53.29 27.63 52.37 27.63L52.57 27.82L52.48 27.73Q51.54 27.64 49.72 27.56L49.69 27.54L49.80 27.64Q49.90 27.44 49.71 24.97L49.65 24.91L49.57 24.82Q52.15 25.39 55.12 25.39L55.18 25.45L55.19 25.46Q54.81 20.93 54.39 18.34L54.48 18.43L54.56 18.51Q55.36 18.62 56.16 18.62L56.03 18.49L57.67 18.50L57.78 18.61Q57.44 22.76 57.44 25.35L57.58 25.49L57.45 25.36Q59.72 25.46 62.92 25.12L62.84 25.04L62.84 25.03Q62.75 26.40 62.75 27.61L62.81 27.68L62.69 27.56Q62.58 27.71 61.78 27.75L61.75 27.72L61.70 27.66Q60.68 27.63 60.07 27.67L60.01 27.62L60.07 27.68Q60.10 27.71 57.44 27.71L57.51 27.78L57.34 31.04L57.51 31.21Q57.46 32.79 57.57 34.50ZM63.36 24.64L63.33 24.62L63.27 24.55Q61.46 24.95 59.59 25.03L59.54 24.98L59.53 24.97Q59.78 21.82 60.19 19.96L60.18 19.94L60.22 19.98Q59.51 20.03 58.10 20.18L58.10 20.18L58.31 18.15L58.19 18.03Q55.69 18.15 54.01 18.04L54.01 18.04L54.02 18.05Q54.54 21.12 54.73 25.00L54.70 24.97L54.67 24.94Q52.99 24.97 49.30 24.36L49.20 24.27L49.30 24.37Q49.53 25.51 49.53 28.14L49.55 28.16L51.02 28.11L50.96 28.05Q51.07 28.88 50.92 30.29L50.86 30.23L54.76 29.90L54.85 29.99Q54.64 33.17 54.34 35.00L54.38 35.04L54.33 34.99Q55.05 34.95 56.45 34.83L56.56 34.93L56.49 34.86Q56.55 35.62 56.52 36.95L56.41 36.85L56.39 36.83Q56.88 36.78 60.50 36.93L60.59 37.02L60.50 36.94Q59.71 33.98 59.48 30.02L59.38 29.92L59.45 29.99Q62.82 30.12 64.91 30.50L64.93 30.52L64.79 30.38Q64.61 29.43 64.61 28.48L64.58 28.46L64.74 26.71L64.69 26.66Q64.46 26.66 63.93 26.70L63.98 26.75L63.08 26.65L63.05 26.62Q63.09 25.86 63.20 24.49Z'/%3e%3cpath d='M6 19 C52 21%2c78 16%2c107 21' stroke='%2383ebb7' fill='none'/%3e%3cpath d='M8 38 C57 34%2c69 37%2c109 30' stroke='%237baddf' fill='none'/%3e%3c/svg%3e" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|验证码值|仅开发模式返回显示| -|» captchaEnabled|boolean|true|none|是否启用|none| -|» uuid|string|true|none|uuid|none| -|» img|string|true|none|base64图片|none| - -## GET 系统暴露的配置信息 - -GET /sys-conf - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Referer|header|string| yes |User Referer| -|User-Agent|header|string| yes |User Agent| -|Accept-Language|header|string| yes |en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "buildTime": "-", - "copyright": "Copyright ©2023 AGrandTech", - "filePathBrand": "/static/logo/{language}_brand.png", - "filePathIcon": "/static/logo/{language}_icon.png", - "goVer": "-", - "helpDoc": "/static/helpDoc/{language}_doc.pdf", - "i18nDefault": "en_US", - "i18nOpen": "true", - "loginBackground": "#", - "logoType": "icon", - "officialUrl": "#", - "registerUser": "false", - "serialNum": "-", - "sysGuide": "true", - "title": "AGrandEMS", - "version": "-" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» bootloader|string|true|none||none| -|»» buildTime|string|true|none||none| -|»» copyright|string|true|none||none| -|»» filePathBrand|string|true|none||none| -|»» filePathIcon|string|true|none||none| -|»» goVer|string|true|none||none| -|»» helpDoc|string|true|none||none| -|»» i18nDefault|string|true|none||none| -|»» i18nOpen|string|true|none||none| -|»» loginBackground|string|true|none||none| -|»» logoType|string|true|none||none| -|»» officialUrl|string|true|none||none| -|»» registerUser|string|true|none||none| -|»» serialNum|string|true|none||none| -|»» title|string|true|none||none| -|»» version|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/通用模块/文件操作 - -## POST 上传文件 - -POST /file/upload - -> Body Parameters - -```yaml -file: string -subPath: "{% mock 'pick' , ['default', 'avatar', 'import', 'export', 'common', - 'download', 'chunk'] %}" - -``` - -### Params - -|Name|Location|Type|Required|Description| -|---|---|---|---|---| -|Authorization|header|string| yes |Authoirzation token| -|Referer|header|string| yes |User Referer| -|User-Agent|header|string| yes |User Agent| -|Accept-Language|header|string| yes |en_US;q=0.9| -|body|body|object| no |none| -|» file|body|string(binary)| yes |上传文件对象| -|» subPath|body|string| yes |子路径，可选范围 ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "url": "http://127.0.0.1:6275/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "fileName": "/upload/common/2023/05/o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "newFileName": "o_1d2bofn8f19dh5s11okpje61mipg_画板1_iq526uqv.png", - "originalFileName": "o_1d2bofn8f19dh5s11okpje61mipg_画板1.png" - } -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，支持以下类型：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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» url|string|true|none||none| -|»» fileName|string|true|none||none| -|»» newFileName|string|true|none||none| -|»» originalFileName|string|true|none||none| - -## POST 切片文件检查 - -POST /file/chunkCheck - -> Body Parameters - -```json -{ - "identifier": "string", - "fileName": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» identifier|body|string| yes | 切片文件目录标识符|MD5(文件名+文件大小)| -|» fileName|body|string| yes | 原始文件名称|检查格式是否允许上传| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|已上传切片数据块的编号|none| - -## POST 切片文件上传 - -POST /file/chunkUpload - -```js -// 上传数据块 -const formData = new FormData(); -formData.append('file', chunk, 'xxx.pdf'); -formData.append('index', chunksIndex); -formData.append('identifier', fileIdentifier); -``` - -chunk是切片块的数据需要给上传文件的名称带后缀 - -> Body Parameters - -```yaml -file: "" -index: "{% mock 'increment' %}" -identifier: "{% mock 'id' %}" - -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» file|body|string(binary)| yes ||数据块Blob对象，需要给文件名称带后缀| -|» index|body|string| yes ||数据块的编号| -|» identifier|body|string| yes ||切片文件目录标识符| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": "/upload/chunk/2023/06/identifier/index" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|206|[Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)|none|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|上传资源地址|none| - -## POST 转存上传文件到静态资源 - -POST /file/transferStaticFile - -> Body Parameters - -```json -{ - "uploadPath": "string", - "staticPath": "string", - "language": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» uploadPath|body|string| yes ||none| -|» staticPath|body|string| yes ||none| -|» language|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "data": "/static/helpDoc/zh_doc.pdf", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 切片文件合并 - -POST /file/chunkMerge - -> Body Parameters - -```json -{ - "identifier": "string", - "fileName": "string", - "subPath": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» identifier|body|string| yes | 切片文件目录标识符|MD5(文件名+文件大小)| -|» fileName|body|string| yes | 原始文件名称|检查格式是否允许上传| -|» subPath|body|string| yes | 子路径|可选范围 ['default', 'avatar', 'import', 'export', 'common', 'download', 'chunk']| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "url": "http://127.0.0.1:6275/upload/avatar/2023/06/gmircbr_48xqb8.png", - "fileName": "/upload/avatar/2023/06/gmircbr_48xqb8.png", - "newFileName": "gmircbr_48xqb8.png", - "originalFileName": "gmircbr.png" - } -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，支持以下类型：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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|已上传切片数据块的编号|none| - -## GET 下载文件 - -GET /file/download/{filePath} - -filePath参数需要进行base64编码，base64("文件存放资源路径，URL相对地址") - -断点续传可以在请求头中加入下载数据块的区间，示例如单块5M大小 `Range: bytes=0-5242879` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|filePath|path|string| yes ||base64("文件存放资源路径，URL相对地址")| -|Range|header|string| no ||进行断点续传数据块下载| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 206 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| -|206|[Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/通用模块/通用请求 - -## POST 哈希加密 - -POST /common/hash - -> Body Parameters - -```json -{ - "type": "string", - "str": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» type|body|string| yes | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| yes | 加密字符串|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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||none| - -## GET 多语言处理 - -GET /common/i18n - -### Params - -|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": "9e9a253840ebd80b2160be621d2efc7c" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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||none| - -## POST 哈希加盐加密 - -POST /common/hmac - -> Body Parameters - -```json -{ - "type": "string", - "str": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» type|body|string| yes | 加密类型|'sha1' | 'sha256' | 'sha512' | 'md5'| -|» str|body|string| yes | 加密字符串|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": "6c44dbdf8d759c97dfd8c43a2974ba22" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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||none| - -# 中文src目录接口/通用模块/账号身份操作 - -## GET 登录用户信息 - -GET /getInfo - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "permissions": [ - "*:*:*" - ], - "roles": [ - "admin" - ], - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "maskAdmin", - "nickName": "管理员", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "管理员", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "status": "1" - } - } - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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]|false|none|权限|字符数组| -|»» roles|[string]|false|none|角色|字符数组| -|»» user|object|false|none|用户信息|none| -|»»» roles|[object]|false|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|integer|false|none||none| -|»»» createBy|string|false|none||none| -|»»» createTime|integer|false|none||none| -|»»» remark|string|true|none||none| -|»»» dept|object|false|none||none| -|»»»» deptId|string|true|none||none| -|»»»» parentId|string|false|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 登录路由信息 - -GET /getRouters - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "name": "System", - "path": "/system", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/user", - "children": [ - { - "name": "User", - "path": "user", - "component": "system/user/index", - "meta": { - "icon": "icon-pcduan", - "title": "用户管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Role", - "path": "role", - "component": "system/role/index", - "meta": { - "icon": "icon-pcduan", - "title": "角色管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "RoleinlineauthuserroleId", - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "meta": { - "icon": "icon-pcduan", - "title": "角色分配用户", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Menu", - "path": "menu", - "component": "system/menu/index", - "meta": { - "icon": "icon-pcduan", - "title": "菜单管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dept", - "path": "dept", - "component": "system/dept/index", - "meta": { - "icon": "icon-pcduan", - "title": "部门管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Post", - "path": "post", - "component": "system/post/index", - "meta": { - "icon": "icon-pcduan", - "title": "岗位管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Dict", - "path": "dict", - "component": "system/dict/index", - "meta": { - "icon": "icon-pcduan", - "title": "字典管理", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "DictinlinedatadictId", - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "meta": { - "icon": "icon-pcduan", - "title": "字典数据", - "hide": true, - "cache": false, - "target": null - } - }, - { - "name": "Config", - "path": "config", - "component": "system/config/index", - "meta": { - "icon": "icon-pcduan", - "title": "参数设置", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Notice", - "path": "notice", - "component": "system/notice/index", - "meta": { - "icon": "icon-pcduan", - "title": "通知公告", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Log", - "path": "log", - "component": "BlankLayout", - "meta": { - "icon": "icon-pcduan", - "title": "日志管理", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/system/log/operlog", - "children": [ - { - "name": "Operlog", - "path": "operlog", - "component": "monitor/operlog/index", - "meta": { - "icon": "icon-pcduan", - "title": "操作日志", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Logininfor", - "path": "logininfor", - "component": "monitor/logininfor/index", - "meta": { - "icon": "icon-pcduan", - "title": "登录日志", - "hide": false, - "cache": true, - "target": null - } - } - ] - } - ] - }, - { - "name": "Monitor", - "path": "/monitor", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统监控", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/monitor/server", - "children": [ - { - "name": "Server", - "path": "server", - "component": "monitor/server/index", - "meta": { - "icon": "icon-pcduan", - "title": "服务监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Cache", - "path": "cache", - "component": "monitor/cache/index", - "meta": { - "icon": "icon-pcduan", - "title": "缓存监控", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "CacheList", - "path": "cacheList", - "component": "monitor/cache/list", - "meta": { - "icon": "icon-pcduan", - "title": "缓存列表", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Online", - "path": "online", - "component": "monitor/online/index", - "meta": { - "icon": "icon-pcduan", - "title": "在线用户", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "Job", - "path": "job", - "component": "monitor/job/index", - "meta": { - "icon": "icon-pcduan", - "title": "调度任务", - "hide": false, - "cache": true, - "target": null - } - }, - { - "name": "JobinlinelogjobId", - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "meta": { - "icon": "icon-pcduan", - "title": "调度日志", - "hide": true, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "Tool", - "path": "/tool", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "系统工具", - "hide": false, - "cache": true, - "target": null - }, - "redirect": "/tool/swagger", - "children": [ - { - "name": "Swagger", - "path": "swagger", - "component": "tool/swagger/index", - "meta": { - "icon": "icon-pcduan", - "title": "系统接口", - "hide": false, - "cache": true, - "target": null - } - } - ] - }, - { - "name": "HttpsLink4", - "path": "https://gitee.com/TsMask/mask_api_midwayjs", - "component": "BasicLayout", - "meta": { - "icon": "icon-pcduan", - "title": "Gitee仓库", - "hide": false, - "cache": false, - "target": "_blank" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|false|none|元数据|none| -|»»» icon|string|false|none|菜单图标|none| -|»»» title|string|false|none|菜单标题|none| -|»»» hide|boolean|false|none|是否隐藏|默认 false| -|»»» cache|boolean|false|none|是否缓存|默认 false| -|»»» target|string|false|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|false|none||none| -|»»» meta|object|false|none|元数据|none| -|»»»» icon|string|false|none||none| -|»»»» title|string|false|none|标题|none| -|»»»» hide|boolean|false|none||none| -|»»»» cache|boolean|false|none||none| -|»»»» target|string|false|none||none| - -## POST 系统登录 - -POST /login - -> Body Parameters - -```json -{ - "username": "admin", - "password": "rootaa", - "code": "{{code-text}}", - "uuid": "{{code-uuid}}" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» username|body|string| yes | 登录名|none| -|» password|body|string| yes | 密码|none| -|» code|body|string| yes | 验证码值|none| -|» uuid|body|string| yes | 验证码唯一标识|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -```json -{ - "code": 500, - "msg": "验证码已失效" -} -``` - -```json -{ - "code": 500, - "msg": "验证码错误" -} -``` - -```json -{ - "code": 2, - "data": "tUwUZC14lA8LuOdA3sjmeQuKWsepythNj8Kf4x88kM5ApuYH0NMG/a+Q2WMSCJbTRT00UpThkWHbKWGSWU63rsJAW4E9aoosRLlVyzhyGlbnsiHgE5Cp2LNevlbmsPCbSADcWC9a5P58BuVYLy6O13bhuBSogrk7l1ogPuT2L9sQC/G30lLLDLKIn4nfrx90p4opCsZ58uvP97gXaLxeKUsWwjsqY0UxqCjllgLEYAilm2lCmPjZp0axmap2qCaLUQbuzmAqHPa0j6z7sLemRLZdEYLjz3+06P08sepPy9ls4T1f70yMcwsJ/jiKi9sLJKcD2Gt61FSqK88MLhMViVbAAdr4CtcM766yBzhQ/XKeBVcHNbNp4rdWkCEzSe3wqyACPFV0qlCWl2W+mxvcqw==", - "msg": "encrypt" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|false|none||none| - -## POST 系统登出 - -POST /logout - -对IP进行限流 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| no ||授权令牌，可有可无| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "退出成功" -} -``` - -```json -{ - "code": 500, - "msg": "访问过于频繁，请稍候再试" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none|固定值|none| -|» msg|string|true|none|固定值|none| - -# 中文src目录接口/通用模块/账号注册操作 - -## POST 系统注册 - -POST /register - -> Body Parameters - -```json -{ - "username": "string", - "password": "string", - "confirmPassword": "string", - "code": "string", - "uuid": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» username|body|string| yes | 用户名|none| -|» password|body|string| yes | 密码|none| -|» confirmPassword|body|string| yes | 确认密码|none| -|» code|body|string| yes | 验证码值|none| -|» uuid|body|string| yes | 验证码唯一标识|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "当前系统没有开启注册功能！" -} -``` - -```json -{ - "code": 500, - "msg": "注册用户【xxxx】失败，注册账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "账号不能以数字开头，可包含大写小写字母，数字，且不少于5位" -} -``` - -```json -{ - "code": 500, - "msg": "密码至少包含大小写字母、数字、特殊符号，且不少于6位" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/通用模块/启动引导初始化 - -## POST 首次引导开始 - -POST /bootloader - -确认完成后，该接口将不可重复调用 -用户ID: 1 的用户数据，超级管理 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dpbl9rZXkiOiIwamJmM3J1anRyamdibHNtOW44Mnk4Z2gxcTZmN2s1OCIsInVzZXJfaWQiOiIxIiwiaWF0IjoxNjgzOTY1ODEwLCJleHAiOjE2ODQwMDQyMTB9.rOChRhSPUi7ps6F3QLGMBB8IIOgrfYv2S5ApgxHjtXo" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|授权令牌|none| - -## PUT 首次引导完成 - -PUT /bootloader - -确认完成后，该接口将不可重复调用 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /bootloader - -确认完成后，该接口将不可重复调用 -系统数据将会重新加载 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 管理员账号变更 - -PUT /bootloader/account - -确认完成后，该接口将不可重复调用 -指定修改用户ID: 2 的用户数据 - -> Body Parameters - -```json -{ - "username": "admin", - "password": "Abcd1234.." -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» username|body|string| yes ||账号| -|» password|body|string| yes ||密码| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/监控模块/缓存信息 - -## GET 缓存监控信息 - -GET /monitor/cache - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "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" - }, - "memory": { - "used_memory": "1664304", - "used_memory_human": "1.59M", - "used_memory_rss": "9228288", - "used_memory_rss_human": "8.80M", - "used_memory_peak": "1917352", - "used_memory_peak_human": "1.83M", - "used_memory_peak_perc": "86.80%", - "used_memory_overhead": "978099", - "used_memory_startup": "863272", - "used_memory_dataset": "686205", - "used_memory_dataset_perc": "85.67%", - "allocator_allocated": "1851152", - "allocator_active": "2396160", - "allocator_resident": "4734976", - "total_system_memory": "2079748096", - "total_system_memory_human": "1.94G", - "used_memory_lua": "59392", - "used_memory_vm_eval": "59392", - "used_memory_lua_human": "58.00K", - "used_memory_scripts_eval": "5608", - "number_of_cached_scripts": "3", - "number_of_functions": "0", - "number_of_libraries": "0", - "used_memory_vm_functions": "32768", - "used_memory_vm_total": "92160", - "used_memory_vm_total_human": "90.00K", - "used_memory_functions": "184", - "used_memory_scripts": "5792", - "used_memory_scripts_human": "5.66K", - "maxmemory": "0", - "maxmemory_human": "0B", - "maxmemory_policy": "noeviction", - "allocator_frag_ratio": "1.29", - "allocator_frag_bytes": "545008", - "allocator_rss_ratio": "1.98", - "allocator_rss_bytes": "2338816", - "rss_overhead_ratio": "1.95", - "rss_overhead_bytes": "4493312", - "mem_fragmentation_ratio": "5.55", - "mem_fragmentation_bytes": "7565808", - "mem_not_counted_for_evict": "3584", - "mem_replication_backlog": "0", - "mem_total_replication_buffers": "0", - "mem_clients_slaves": "0", - "mem_clients_normal": "102107", - "mem_cluster_links": "0", - "mem_aof_buffer": "3584", - "mem_allocator": "jemalloc-5.2.1", - "active_defrag_running": "0", - "lazyfree_pending_objects": "0", - "lazyfreed_objects": "0" - }, - "persistence": { - "loading": "0", - "async_loading": "0", - "current_cow_peak": "0", - "current_cow_size": "0", - "current_cow_size_age": "0", - "current_fork_perc": "0.00", - "current_save_keys_processed": "0", - "current_save_keys_total": "0", - "rdb_changes_since_last_save": "28", - "rdb_bgsave_in_progress": "0", - "rdb_last_save_time": "1683985267", - "rdb_last_bgsave_status": "ok", - "rdb_last_bgsave_time_sec": "0", - "rdb_current_bgsave_time_sec": "-1", - "rdb_saves": "18", - "rdb_last_cow_size": "901120", - "rdb_last_load_keys_expired": "0", - "rdb_last_load_keys_loaded": "0", - "aof_enabled": "1", - "aof_rewrite_in_progress": "0", - "aof_rewrite_scheduled": "0", - "aof_last_rewrite_time_sec": "-1", - "aof_current_rewrite_time_sec": "-1", - "aof_last_bgrewrite_status": "ok", - "aof_rewrites": "0", - "aof_rewrites_consecutive_failures": "0", - "aof_last_write_status": "ok", - "aof_last_cow_size": "0", - "module_fork_in_progress": "0", - "module_fork_last_cow_size": "0", - "aof_current_size": "52707266", - "aof_base_size": "88", - "aof_pending_rewrite": "0", - "aof_buffer_length": "0", - "aof_pending_bio_fsync": "0", - "aof_delayed_fsync": "0" - }, - "stats": { - "total_connections_received": "139", - "total_commands_processed": "215944", - "instantaneous_ops_per_sec": "5", - "total_net_input_bytes": "6096966", - "total_net_output_bytes": "546971", - "total_net_repl_input_bytes": "0", - "total_net_repl_output_bytes": "0", - "instantaneous_input_kbps": "0.60", - "instantaneous_output_kbps": "0.01", - "instantaneous_input_repl_kbps": "0.00", - "instantaneous_output_repl_kbps": "0.00", - "rejected_connections": "0", - "sync_full": "0", - "sync_partial_ok": "0", - "sync_partial_err": "0", - "expired_keys": "1270", - "expired_stale_perc": "0.00", - "expired_time_cap_reached_count": "0", - "expire_cycle_cpu_milliseconds": "712", - "evicted_keys": "0", - "evicted_clients": "0", - "total_eviction_exceeded_time": "0", - "current_eviction_exceeded_time": "0", - "keyspace_hits": "1580", - "keyspace_misses": "27951", - "pubsub_channels": "3", - "pubsub_patterns": "0", - "pubsubshard_channels": "0", - "latest_fork_usec": "275", - "total_forks": "18", - "migrate_cached_sockets": "0", - "slave_expires_tracked_keys": "0", - "active_defrag_hits": "0", - "active_defrag_misses": "0", - "active_defrag_key_hits": "0", - "active_defrag_key_misses": "0", - "total_active_defrag_time": "0", - "current_active_defrag_time": "0", - "tracking_total_keys": "0", - "tracking_total_items": "0", - "tracking_total_prefixes": "0", - "unexpected_error_replies": "0", - "total_error_replies": "0", - "dump_payload_sanitizations": "0", - "total_reads_processed": "29542", - "total_writes_processed": "29425", - "io_threaded_reads_processed": "0", - "io_threaded_writes_processed": "0", - "reply_buffer_shrinks": "135", - "reply_buffer_expands": "9" - }, - "replication": { - "role": "master", - "connected_slaves": "0", - "master_failover_state": "no-failover", - "master_replid": "08e7cd72f9ecda6c4fd3e1e8504571203bb61290", - "master_replid2": "0000000000000000000000000000000000000000", - "master_repl_offset": "0", - "second_repl_offset": "-1", - "repl_backlog_active": "0", - "repl_backlog_size": "1048576", - "repl_backlog_first_byte_offset": "0", - "repl_backlog_histlen": "0" - }, - "cpu": { - "used_cpu_sys": "21.297760", - "used_cpu_user": "30.032301", - "used_cpu_sys_children": "0.033118", - "used_cpu_user_children": "0.030797", - "used_cpu_sys_main_thread": "20.252124", - "used_cpu_user_main_thread": "30.825211" - }, - "modules": {}, - "errorstats": {}, - "cluster": { - "cluster_enabled": "0" - }, - "keyspace": { - "db0": "keys=19,expires=0,avg_ttl=0", - "db1": "keys=22,expires=3,avg_ttl=21492323" - } - }, - "dbSize": 22, - "commandStats": [ - { - "name": "brpoplpush", - "value": "12044" - }, - { - "name": "get", - "value": "545" - }, - { - "name": "incr", - "value": "144" - }, - { - "name": "smembers", - "value": "1207" - }, - { - "name": "scan", - "value": "13" - }, - { - "name": "subscribe", - "value": "36" - }, - { - "name": "del", - "value": "147" - }, - { - "name": "auth", - "value": "139" - }, - { - "name": "exists", - "value": "2145" - }, - { - "name": "lrange", - "value": "1207" - }, - { - "name": "type", - "value": "28" - }, - { - "name": "ttl", - "value": "189" - }, - { - "name": "quit", - "value": "51" - }, - { - "name": "keys", - "value": "22" - }, - { - "name": "evalsha", - "value": "14200" - }, - { - "name": "select", - "value": "139" - }, - { - "name": "expire", - "value": "44" - }, - { - "name": "info", - "value": "61" - }, - { - "name": "zrevrange", - "value": "36" - }, - { - "name": "config|get", - "value": "9" - }, - { - "name": "zrangebyscore", - "value": "12087" - }, - { - "name": "client|setname", - "value": "37" - }, - { - "name": "ping", - "value": "1765" - }, - { - "name": "zrange", - "value": "12087" - }, - { - "name": "set", - "value": "1420" - }, - { - "name": "dbsize", - "value": "2" - }, - { - "name": "eval", - "value": "83" - } - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|Redis版本|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|RDB是否成功|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|AOF是否开启|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|Key数量|none| -|»» commandStats|[object]|true|none|命令统计|none| -|»»» name|string|true|none||none| -|»»» value|string|true|none||none| - -## GET 缓存名称列表 - -GET /monitor/cache/getNames - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "cacheName": "login_tokens", - "cacheKey": "", - "cacheValue": "", - "remark": "用户信息" - }, - { - "cacheName": "sys_config", - "cacheKey": "", - "cacheValue": "", - "remark": "配置信息" - }, - { - "cacheName": "sys_dict", - "cacheKey": "", - "cacheValue": "", - "remark": "数据字典" - }, - { - "cacheName": "captcha_codes", - "cacheKey": "", - "cacheValue": "", - "remark": "验证码" - }, - { - "cacheName": "repeat_submit", - "cacheKey": "", - "cacheValue": "", - "remark": "防重提交" - }, - { - "cacheName": "rate_limit", - "cacheKey": "", - "cacheValue": "", - "remark": "限流处理" - }, - { - "cacheName": "pwd_err_cnt", - "cacheKey": "", - "cacheValue": "", - "remark": "密码错误次数" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|备注|none| - -## GET 缓存名称下键名列表 - -GET /monitor/cache/getKeys/{cacheName} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cacheName|path|string| yes ||缓存名称列表中得到的缓存名称| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|缓存名称|缓存名称列表中得到的缓存名称| -|»» cacheKey|string|true|none|缓存键名|none| -|»» cacheValue|string|true|none|缓存内容|空字符串| -|»» remark|string|true|none|备注|空字符串| - -## GET 缓存内容 - -GET /monitor/cache/getValue/{cacheName}/{cacheKey} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cacheName|path|string| yes ||键名列表中得到的缓存名称| -|cacheKey|path|string| yes ||键名列表中得到的缓存键名| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "cacheName": "sys_config", - "cacheKey": "sys.account.captchaType", - "cacheValue": "math", - "remark": "" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|缓存名称|键名列表中得到的缓存名称| -|»» cacheKey|string|true|none|缓存名称|键名列表中得到的缓存键名| -|»» cacheValue|string|true|none|缓存内容|none| -|»» remark|string|true|none|备注|空字符串| - -## DELETE 删除缓存键名 - -DELETE /monitor/cache/clearCacheKey/{cacheName}/{cacheKey} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cacheName|path|string| yes ||键名列表中得到的缓存名称| -|cacheKey|path|string| yes ||键名列表中得到的缓存键名| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /monitor/cache/clearCacheName/{cacheName} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cacheName|path|string| yes ||缓存名称列表中得到的缓存名称| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /monitor/cache/clearCacheSafe - -指定可清理的缓存键名 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/监控模块/调度任务日志信息 - -## POST 调度任务日志列表导出 - -POST /monitor/jobLog/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=jobLog_export_1_1684058366284.xlsx -content-length: 17079 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0, - "beginTime": "string", - "endTime": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» jobName|body|string| no | 任务名称|none| -|» jobGroup|body|string| no | 任务组名|none| -|» status|body|string| no | 执行状态|none| -|» pageNum|body|number| no | 页数，默认1|none| -|» pageSize|body|number| no | 单页记录数，默认10|none| -|» beginTime|body|string| no | 操作开始时间|none| -|» endTime|body|string| no | 操作结束时间|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 调度任务日志列表 - -GET /monitor/jobLog/list - -### Params - -|Name|Location|Type|Required|Title|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "jobLogId": "4", - "jobName": "2-20个字符", - "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个字符", - "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个字符", - "jobGroup": "DEFAULT", - "invokeTarget": "test", - "targetParams": "{\"a\":1,\"b\":1}", - "jobMsg": "{\"jobId\":\"103\",\"params\":\"{\\\"a\\\":1,\\\"b\\\":1}\"}", - "status": "1", - "createTime": "1684056090490" - }, - { - "jobLogId": "1", - "jobName": "异常执行", - "jobGroup": "SYSTEM", - "invokeTarget": "bar", - "targetParams": "字符串参数", - "jobMsg": "{\"name\":\"Error\",\"message\":\"程序中途执行错误\"}", - "status": "0", - "createTime": "1683901320750" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|日志ID|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|none| -|»» invokeTarget|string|true|none|任务目标|none| -|»» targetParams|string|true|none|任务参数|none| -|»» jobMsg|string|true|none|日志记录|none| -|»» status|string|true|none|状态|none| -|»» createTime|string|true|none|记录时间|none| - -## GET 调度任务日志信息 - -GET /monitor/jobLog/{jobLogId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobLogId|path|string| yes ||日志ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "jobLogId": "3", - "jobName": "2-20个字符", - "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](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|日志ID|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|none| -|»» invokeTarget|string|true|none|任务目标|none| -|»» targetParams|string|true|none|任务参数|none| -|»» jobMsg|string|true|none|日志记录|none| -|»» status|string|true|none|状态|none| -|»» createTime|string|true|none|记录时间|none| - -## DELETE 调度任务日志删除 - -DELETE /monitor/jobLog/{jobLogIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobLogIds|path|string| yes ||日志ID，多个可用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /monitor/jobLog/clean - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/监控模块/调度任务信息 - -## POST 调度任务列表导出 - -POST /monitor/job/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=job_export_6_1684058991890.xlsx -content-length: 19346 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "jobName": "string", - "jobGroup": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» jobName|body|string| no | 任务名称|none| -|» jobGroup|body|string| no | 任务组名|none| -|» status|body|string| no | 执行状态|none| -|» pageNum|body|number| no | 页数，默认1|none| -|» pageSize|body|number| no | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 调度任务列表 - -GET /monitor/job/list - -### Params - -|Name|Location|Type|Required|Title|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 3, - "rows": [ - { - "jobId": "1", - "jobName": "触发执行", - "jobGroup": "SYSTEM", - "invokeTarget": "test", - "targetParams": "字符串参数", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527348", - "remark": "" - }, - { - "jobId": "2", - "jobName": "缓慢执行", - "jobGroup": "SYSTEM", - "invokeTarget": "foo", - "targetParams": "字符串参数", - "cronExpression": "0/15 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527355", - "remark": "" - }, - { - "jobId": "3", - "jobName": "异常执行", - "jobGroup": "SYSTEM", - "invokeTarget": "bar", - "targetParams": "字符串参数", - "cronExpression": "0/20 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527364", - "remark": "" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|任务id|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|同组内不可同任务名| -|»» invokeTarget|string|true|none|调用目标|需要代码中通过 @Processor('xxx') 注册任务目标| -|»» targetParams|string|true|none|传入参数|标准json格式字符串| -|»» cronExpression|string|true|none|cron表达式|6位，最后?号不使用| -|»» misfirePolicy|string|true|none|执行策略|计划执行错误策略（1立即执行 2执行一次 3放弃执行）| -|»» concurrent|string|true|none|是否并发|是否并发执行（0禁止 1允许）| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string|true|none|备注|none| - -## GET 调度任务信息 - -GET /monitor/job/{jobId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobId|path|string| yes ||任务ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "jobId": "1", - "jobName": "触发执行", - "jobGroup": "SYSTEM", - "invokeTarget": "test", - "targetParams": "字符串参数", - "cronExpression": "0/10 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "status": "0", - "createBy": "maskAdmin", - "createTime": "1682264527348", - "remark": "" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|任务id|none| -|»» jobName|string|true|none|任务名|none| -|»» jobGroup|string|true|none|任务组|同组内不可同任务名| -|»» invokeTarget|string|true|none|调用目标|需要代码中通过 @Processor('xxx') 注册任务目标| -|»» targetParams|string|true|none|传入参数|标准json格式字符串| -|»» cronExpression|string|true|none|cron表达式|6位，最后?号不使用| -|»» misfirePolicy|string|true|none|执行策略|计划执行错误策略（1立即执行 2执行一次 3放弃执行）| -|»» concurrent|string|true|none|是否并发|是否并发执行（0禁止 1允许）| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string|true|none|备注|none| - -## POST 调度任务新增 - -POST /monitor/job - -> Body Parameters - -```json -{ - "jobName": "2-20个字符", - "invokeTarget": "test1", - "cronExpression": "0/22 * * * * ?", - "misfirePolicy": "3", - "concurrent": "0", - "jobGroup": "DEFAULT", - "status": "ullamco minim Ut", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "asdf" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» jobName|body|string| yes | 任务名称|none| -|» jobGroup|body|string| yes | 任务组名|none| -|» invokeTarget|body|string| yes | 调用目标字符串|需要代码中通过 @Processor('xxx') 注册任务目标| -|» targetParams|body|string| yes | 调用目标传入参数|标准json格式字符串| -|» cronExpression|body|string| yes | cron执行表达式|6位，最后?号不使用| -|» misfirePolicy|body|string| yes | 计划执行错误策略|1立即执行 2执行一次 3放弃执行| -|» concurrent|body|string| yes | 是否并发执行|0禁止 1允许| -|» status|body|string| yes | 任务状态|0正常 1暂停| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务新增【xxx】失败，同任务组内有相同任务名称" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务新增【xxxx】失败，Cron表达式不正确" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 调度任务修改 - -PUT /monitor/job - -> Body Parameters - -```json -{ - "jobName": "大但任", - "invokeTarget": "test", - "cronExpression": "0/40 * * * * ?", - "misfirePolicy": "3", - "concurrent": "1", - "jobGroup": "SYSTEM", - "status": "0", - "targetParams": "{\"a\":1,\"b\":1}", - "remark": "据连思过维存斗维动南子听。", - "jobId": "2" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» jobId|body|string| yes | 任务ID|none| -|» jobName|body|string| yes | 任务名称|none| -|» jobGroup|body|string| yes | 任务组名|none| -|» invokeTarget|body|string| yes | 调用目标字符串|需要代码中通过 @Processor('xxx') 注册任务目标| -|» targetParams|body|string| yes | 调用目标传入参数|标准json格式字符串| -|» cronExpression|body|string| yes | cron执行表达式|6位，最后?号不使用| -|» misfirePolicy|body|string| yes | 计划执行错误策略|1立即执行 2执行一次 3放弃执行| -|» concurrent|body|string| yes | 是否并发执行|0禁止 1允许| -|» status|body|string| yes | 任务状态|0正常 1暂停| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "调度任务修改【xxxx】失败，Cron表达式不正确" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /monitor/job/{jobIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobIds|path|string| yes ||任务ID，多个可用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 调度任务修改状态 - -PUT /monitor/job/changeStatus - -> Body Parameters - -```json -{ - "jobId": "22", - "status": "0" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» jobId|body|string| yes | 任务ID|none| -|» status|body|string| yes | 变更的状态|0正常 1暂停| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 调度任务立即执行一次 - -PUT /monitor/job/run/{jobId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|jobId|path|string| yes ||任务ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 调度任务重置刷新队列 - -PUT /monitor/job/resetQueueJob - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/监控模块/在线用户信息 - -## GET 在线用户列表 - -GET /monitor/online/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|query|string| no ||用户名称（登录账号）| -|ipaddr|query|string| no ||登录主机| -|Authorization|header|string| yes ||授权令牌| -|Referer|header|string| yes ||使用指定声明的Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "rows": [ - { - "tokenId": "vikufxmx625271bnddbe9t79p4pik5kv", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "未知 未知", - "os": "未知 未知", - "loginTime": 1684046645462, - "deptName": "研发部门" - }, - { - "tokenId": "lpatqefeohnxsnjpp28radugp0bovwt1", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "loginTime": 1684046560517, - "deptName": "研发部门" - } - ], - "total": 2 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 强退用户 - -DELETE /monitor/online/{tokenId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|tokenId|path|string| yes ||授权标识| -|Authorization|header|string| yes ||授权令牌| -|Referer|header|string| no ||使用指定声明的Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/监控模块/服务器监控信息 - -## GET 服务器服务信息 - -GET /monitor/system-info - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "以太网 2": "IPv4 1.251.212.178", - "以太网": "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\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»»» 以太网 2|string|false|none||none| -|»»» 以太网|string|false|none||none| -|»»» VirtualBox Host-Only Network|string|false|none||none| -|»»» Loopback Pseudo-Interface 1|string|false|none||none| -|»» time|object|true|none|时间|none| -|»»» current|string|true|none||none| -|»»» uptime|string|true|none||none| -|»»» timezone|string|true|none||none| -|»»» timezoneName|string|true|none||none| -|»» system|object|true|none|系统|none| -|»»» platform|string|true|none||none| -|»»» node|string|true|none||none| -|»»» v8|string|true|none||none| -|»»» processId|integer|true|none||none| -|»»» arch|string|true|none||none| -|»»» uname|string|true|none||none| -|»»» release|string|true|none||none| -|»»» hostname|string|true|none||none| -|»»» homeDir|string|true|none||none| -|»»» cmd|string|true|none||none| -|»»» execCommand|string|true|none||none| -|»» disk|[object]|true|none|磁盘|none| -|»»» size|string|true|none||none| -|»»» used|string|true|none||none| -|»»» avail|string|true|none||none| -|»»» pcent|string|true|none||none| -|»»» target|string|true|none||none| - -## GET 资源监控信息加载 - -GET /monitor/load - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|type|query|string| yes ||数据类型all/cpu/memory/io/network| -|startTime|query|number| yes ||开始时间-时间戳毫秒| -|endTime|query|number| yes ||结束时间-时间戳毫秒| -|neType|query|string| no ||网元类型| -|neId|query|string| no ||网元ID| -|name|query|string| no ||名称，networ和iok时有效| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "project": { - "appDir": "E:\\Self\\Projects\\mask_api_midwayjs", - "env": "local", - "name": "mask_api_midwayjs", - "version": "0.0.5", - "dependencies": { - "@dropb/diskinfo": "^3.0.0", - "@midwayjs/bootstrap": "^3.0.0", - "@midwayjs/bull": "^3.0.0", - "@midwayjs/core": "^3.0.0", - "@midwayjs/decorator": "^3.0.0", - "@midwayjs/jwt": "^3.0.0", - "@midwayjs/koa": "^3.0.0", - "@midwayjs/cross-domain": "^3.0.0", - "@midwayjs/logger": "^2.0.0", - "@midwayjs/redis": "^3.0.0", - "@midwayjs/static-file": "^3.0.0", - "@midwayjs/typeorm": "^3.0.0", - "@midwayjs/upload": "^3.0.0", - "cron-parser": "^4.0.0", - "bcrypt": "^5.0.0", - "dayjs": "^1.0.0", - "mini-svg-data-uri": "^1.4.0", - "mysql2": "^2.0.0", - "nanoid": "^3.0.0", - "svg-captcha": "^1.4.0", - "typeorm": "^0.3.0", - "ua-parser-js": "^1.0.0", - "xlsx": "^0.18.0" - } - }, - "cpu": { - "model": "Intel(R) Core(TM) i5-9400 CPU @ 2.90GHz", - "speed": "2904MHz", - "core": 6, - "coreUsed": [ - "12.94", - "16.88", - "14.15", - "14.48", - "13.20", - "15.08" - ] - }, - "memory": { - "usage": "71.57", - "freemem": "4.51GB", - "totalmem": "15.88GB", - "rss": "309.80MB", - "heapTotal": "252.49MB", - "heapUsed": "246.27MB", - "external": "6.54MB" - }, - "network": { - "以太网 2": "IPv4 1.251.212.178", - "以太网": "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\\mask_api_midwayjs", - "execCommand": "D:\\Program Files\\nodejs\\node.exe E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\@midwayjs\\cli-plugin-dev\\dist\\child.js {\"baseDir\":\"E:\\\\Self\\\\Projects\\\\mask_api_midwayjs\\\\src\",\"_\":[\"dev\"],\"ts\":true,\"npm\":\"npm --registry=https://registry.npmmirror.com\",\"layers\":[],\"port\":\"6275\"} -r E:\\Self\\Projects\\mask_api_midwayjs\\node_modules\\ts-node\\register" - }, - "disk": [ - { - "size": "100.00GB", - "used": "91.22GB", - "avail": "8.78GB", - "pcent": "92%", - "target": "C:" - }, - { - "size": "174.00GB", - "used": "114.02GB", - "avail": "59.98GB", - "pcent": "66%", - "target": "D:" - }, - { - "size": "173.12GB", - "used": "138.62GB", - "avail": "34.50GB", - "pcent": "81%", - "target": "E:" - } - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»»» 以太网 2|string|false|none||none| -|»»» 以太网|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| - -# 中文src目录接口/网元功能模块/网元操作处理 - -## POST 发送文件从本地到网元 - -POST /ne/action/pushFile - -发送的文件存放 /tmp/omc/push 目录下 - - -> Body Parameters - -```json -{ - "uploadPath": "/upload/default/2024/07/5G核心网网管操作手册(2)_xeuo4s.pdf", - "neType": "UPF", - "neId": "001", - "delTemp": true -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» uploadPath|body|string| yes ||通过通用接口上传文件得到地址| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||none| -|» delTemp|body|boolean| yes ||删除本地临时文件| - -> Response Examples - -```json -{ - "code": 1, - "data": "/tmp/omc/push/5G核心网网管操作手册(2)_xeuo4s.pdf", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 网元服务操作 - -PUT /ne/action/service - -系统：reboot poweroff -网元：start restart stop - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string", - "action": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||none| -|» action|body|string| yes ||start restart stop reboot poweroff| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "data": "string", - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元端文件列表 - -GET /ne/action/files - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|path|query|string| yes ||文件目录路径| -|search|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "path": "/var/log", - "rows": [ - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "363M", - "modifiedTime": 1702461459, - "fileName": "upfd1_1_2023_12_02_21_24_06.log" - }, - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "153M", - "modifiedTime": 1702461457, - "fileName": "upf.log" - }, - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "847K", - "modifiedTime": 1702440282, - "fileName": "upfd1_temp.log" - }, - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "451M", - "modifiedTime": 1701552246, - "fileName": "upfd1_2_2023_12_01_05_47_45.log" - }, - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "451M", - "modifiedTime": 1701409665, - "fileName": "upfd1_3_2023_11_17_10_13_16.log" - }, - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "451M", - "modifiedTime": 1700215987, - "fileName": "upfd1_4_2023_10_22_11_08_10.log" - }, - { - "fileType": "file", - "fileMode": "-rw-r--r--", - "linkCount": 1, - "owner": "root", - "group": "root", - "size": "451M", - "modifiedTime": 1697972880, - "fileName": "upfd1_5_2023_10_20_06_28_24.log" - } - ], - "total": 7, - "totalSize": "" -} -``` - -```json -{ - "code": 1, - "msg": "success", - "path": "/var/log/ims", - "rows": [ - { - "fileType": "dir", - "fileMode": "drwxr-xr-x", - "linkCount": 2, - "owner": "syslog", - "group": "syslog", - "size": "4.0K", - "modifiedTime": 1702021652, - "fileName": "mmtel" - }, - { - "fileType": "dir", - "fileMode": "drwxr-xr-x", - "linkCount": 2, - "owner": "syslog", - "group": "syslog", - "size": "4.0K", - "modifiedTime": 1701749249, - "fileName": "scscf" - }, - { - "fileType": "dir", - "fileMode": "drwxr-xr-x", - "linkCount": 2, - "owner": "syslog", - "group": "syslog", - "size": "4.0K", - "modifiedTime": 1701749102, - "fileName": "icscf" - } - ], - "total": 3, - "totalSize": "12K" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» path|string|true|none||none| -|» rows|[object]|true|none||none| -|»» fileMode|string|true|none||none| -|»» linkCount|integer|true|none||none| -|»» owner|string|true|none||none| -|»» group|string|true|none||none| -|»» size|string|true|none||none| -|»» modifiedTime|integer|true|none||none| -|»» fileName|string|true|none||none| -|»» fileType|string|true|none||none| -|» total|integer|true|none||none| -|» totalSize|string|true|none||none| - -## GET 获取文件从网元到本地 - -GET /ne/action/pullFile - -获取的文件临时放在 /tmp/omc/pull 目录下 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|path|query|string| yes ||文件目录路径| -|fileName|query|string| yes ||文件名| -|delTemp|query|boolean| no ||删除本地临时文件| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» rows|[object]|true|none||none| -|»»» fileMode|string|true|none||none| -|»»» linkCount|integer|true|none||none| -|»»» owner|string|true|none||none| -|»»» group|string|true|none||none| -|»»» size|string|true|none||none| -|»»» modifiedTime|integer|true|none||none| -|»»» fileName|string|true|none||none| -|»» total|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元功能模块/网元信息 - -## GET 网元neType和neID查询 - -GET /ne/info/byTypeAndID - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||none| -|neId|query|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## GET 网元端Para5G配置文件读取 - -GET /ne/info/para5GFile - -配置文件路径: /usr/local/etc/omc/para5G.yaml - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|fileType|query|string| no ||'' txt json yaml yml 根据指定文件类型进行解析序列出map->json| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "basic": { - "dnn_data": "internet", - "dnn_ims": "ims", - "oamEnable": true, - "plmnId": { - "mcc": 1, - "mnc": 1 - }, - "snmpEnable": false, - "snssai": { - "sd": 1, - "sst": 1 - }, - "tac": 4388 - }, - "external": { - "amfn2_ip": "192.168.8.120", - "ue_pool": "10.2.1.0/24", - "upfn3_gw": "192.168.1.1", - "upfn3_ip": "192.168.8.190/24", - "upfn6_gw": "192.168.1.1", - "upfn6_ip": "192.168.8.191/24" - } - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## PUT 网元端Para5G配置文件写入 - -PUT /ne/info/para5GFile - -网元固定路径：/usr/local/etc/conf/para5G.yaml - -> Body Parameters - -```json -{ - "fileType": "yaml", - "content": { - "SIPIP": "192.168.5.90", - "N2IP": "192.168.5.90", - "S1_MMEIP": "192.168.5.90", - "OMCIP": "172.60.5.100", - "AMFIP": "172.60.5.120", - "AUSFIP": "172.60.5.130", - "UDMIP": "172.60.5.140", - "SMFIP": "172.60.5.150", - "PCFIP": "172.60.5.160", - "UPFIP": "172.60.5.190", - "ADBIP": "172.60.5.140", - "IMSIP": "172.60.5.110", - "S11_MMEIP": "172.60.5.220", - "S10_MMEIP": "172.60.5.221", - "LTETAC": "88", - "MCC": "460", - "MNC": "00", - "SST": "1", - "SD": "010204", - "DNN": "cmnet", - "NRTAC": "88", - "UEIP": "10.10.40.0", - "UEIPMask": "255.255.255.0", - "N3IP": "192.168.5.191", - "N3Mask": "255.255.240.0", - "N3GW": "192.168.1.1", - "N3PCI": "0000:13:00.0", - "N3MAC": "00:0c:29:10:ac:d7", - "N6IP": "192.168.5.191", - "N6Mask": "255.255.240.0", - "N6GW": "192.168.1.1", - "N6MAC": "00:0c:29:10:ac:e1", - "N6PCI": "0000:1b:00.0" - }, - "syncNe": [] -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» fileType|body|string| yes ||'' txt json yaml yml 解析内容数据到对应文件类型| -|» content|body|string| yes ||none| -|» syncNe|body|[string]| no | 同步到网元|同步到网元端 NeType@NeId| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## GET 网元端OAM配置文件读取 - -GET /ne/info/oamFile - -配置文件路径: /usr/local/etc/omc/ne_config/{neType}/{neId}/oam_manager.yaml - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## PUT 网元端OAM配置文件写入 - -PUT /ne/info/oamFile - -网元固定路径：/usr/local/etc/{neType}/oam_manager.yaml - -> Body Parameters - -```json -{ - "neType": "UDM", - "neId": "001", - "content": { - "oamEnable": true, - "oamPort": 33030, - "snmpEnable": true, - "snmpPort": 4957, - "kpiEnable": false, - "kpiTimer": 20 - }, - "sync": false -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes | 内容|网元ID| -|» content|body|object| no | 内容|用json对象| -|» sync|body|boolean| no | 同步到网元|同步到网元端| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## GET 网元信息 - -GET /ne/info/{infoId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|infoId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "1", - "neType": "OMC", - "neId": "001", - "rmUid": "4400HX101", - "neName": "OMC_001", - "ip": "172.16.5.100", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "-", - "status": "1", - "updateTime": "2024-03-06 11:09:22 +0800 CST", - "hostIds": "1,2", - "hosts": [ - { - "hostId": "1", - "hostType": "ssh", - "groupId": "0", - "title": "OMC_001_22", - "addr": "172.16.5.100", - "port": 22, - "user": "agtuser", - "authMode": "0", - "password": "admin123", - "privateKey": "", - "passPhrase": "", - "remark": "", - "createBy": "admin", - "createTime": 1708333292882, - "updateBy": "", - "updateTime": 0 - }, - { - "hostId": "2", - "hostType": "telnet", - "groupId": "0", - "title": "OMC_001_4100", - "addr": "172.16.5.100", - "port": 4100, - "user": "admin", - "authMode": "0", - "password": "admin", - "privateKey": "", - "passPhrase": "", - "remark": "", - "createBy": "admin", - "createTime": 1708333292882, - "updateBy": "", - "updateTime": 0 - } - ] - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neId|string|true|none||none| -|»» rmUid|string|true|none||none| -|»» neName|string|true|none||none| -|»» ip|string|true|none||none| -|»» port|integer|true|none||none| -|»» pvFlag|string|true|none||none| -|»» province|string|true|none||none| -|»» vendorName|string|true|none||none| -|»» dn|string|true|none||none| -|»» neAddress|string|true|none||none| -|»» status|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» hostIds|string|true|none||none| -|»» hosts|[object]|true|none||none| -|»»» hostId|string|true|none||none| -|»»» hostType|string|true|none||none| -|»»» groupId|string|true|none||none| -|»»» title|string|true|none||none| -|»»» addr|string|true|none||none| -|»»» port|integer|true|none||none| -|»»» user|string|true|none||none| -|»»» authMode|string|true|none||none| -|»»» password|string|true|none||none| -|»»» privateKey|string|true|none||none| -|»»» passPhrase|string|true|none||none| -|»»» remark|string|true|none||none| -|»»» createBy|string|true|none||none| -|»»» createTime|integer|true|none||none| -|»»» updateBy|string|true|none||none| -|»»» updateTime|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 网元状态 - -GET /ne/info/state - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||none| -|neId|query|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 129, - "sysCpuUsage": 3669 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 20736, - "sysMemUsage": 6988, - "totalMem": 4000916 - }, - "sn": "13770707", - "version": "2.2311.9" - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 21, - "sysCpuUsage": 9610 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 52364, - "sysMemUsage": 7037, - "totalMem": 4005920 - }, - "neId": "001", - "neName": "SMF_001", - "neType": "SMF", - "refreshTime": 1704424061043, - "sn": "13770712", - "version": "2.2312.10" - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 156, - "sysCpuUsage": 9993 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 52364, - "sysMemUsage": 7013, - "totalMem": 4005920 - }, - "neId": "001", - "neName": "SMF_001", - "neType": "SMF", - "online": true, - "refreshTime": 1704424268764, - "sn": "13770712", - "version": "2.2312.10" - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": { - "neId": "001", - "neName": "OMC_001", - "neType": "OMC", - "online": false - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» capability|integer|true|none||none| -|»» cpu|object|true|none||none| -|»»» nfCpuUsage|integer|true|none||none| -|»»» sysCpuUsage|integer|true|none||none| -|»» expire|string|true|none||none| -|»» mem|object|true|none||none| -|»»» nfUsedMem|integer|true|none||none| -|»»» sysMemUsage|integer|true|none||none| -|»»» totalMem|integer|true|none||none| -|»» sn|string|true|none||none| -|»» version|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元列表 - -GET /ne/info/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||none| -|neId|query|string| no ||none| -|bandStatus|query|boolean| no ||可转布尔类型的值，默认false| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "2", - "neType": "IMS", - "neId": "001", - "rmUid": "4400HXIMS001", - "neName": "IMS_001", - "ip": "192.168.8.58", - "port": 29501, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "-", - "hostIds": "3,4", - "status": "1", - "remark": "", - "createBy": "", - "createTime": 0, - "updateBy": "supervisor", - "updateTime": 1722829289961 - }, - { - "id": "3", - "neType": "AMF", - "neId": "001", - "rmUid": "4400HXAMF001", - "neName": "AMF_001", - "ip": "192.168.8.58", - "port": 29502, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "", - "hostIds": "5,6", - "status": "1", - "remark": "", - "createBy": "", - "createTime": 0, - "updateBy": "supervisor", - "updateTime": 1723631621152 - }, - { - "id": "4", - "neType": "AUSF", - "neId": "001", - "rmUid": "4400HXAUSF001", - "neName": "AUSF_001", - "ip": "192.168.8.58", - "port": 29503, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "", - "hostIds": "7,8", - "status": "1", - "remark": "", - "createBy": "", - "createTime": 0, - "updateBy": "supervisor", - "updateTime": 1722845304851 - } - ], - "total": 13 -} -``` - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "2", - "neType": "IMS", - "neId": "001", - "rmUid": "4400HXIMS001", - "neName": "IMS_001", - "ip": "192.168.8.58", - "port": 29501, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "-", - "hostIds": "3,4", - "status": "1", - "remark": "", - "createBy": "", - "createTime": 0, - "updateBy": "supervisor", - "updateTime": 1722829289961, - "serverState": { - "capability": 100000, - "cpu": { - "nfCpuUsage": 15, - "sysCpuUsage": 806 - }, - "disk": { - "partitionInfo": [ - { - "total": 7928, - "used": 0 - }, - { - "total": 1598, - "used": 1 - }, - { - "total": 40010, - "used": 11625 - }, - { - "total": 7992, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 1598, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expire": "2026-06-30", - "mem": { - "nfUsedMem": 26880, - "sysMemUsage": 2828, - "totalMem": 16368300 - }, - "neIP": "192.168.8.58", - "neId": "001", - "neName": "IMS_001", - "neType": "IMS", - "online": true, - "refreshTime": 1723706285118, - "sn": "13750620", - "version": "2.2407.5" - } - }, - { - "id": "3", - "neType": "AMF", - "neId": "001", - "rmUid": "4400HXAMF001", - "neName": "AMF_001", - "ip": "192.168.8.58", - "port": 29502, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "", - "hostIds": "5,6", - "status": "1", - "remark": "", - "createBy": "", - "createTime": 0, - "updateBy": "supervisor", - "updateTime": 1723631621152, - "serverState": { - "capability": 100000, - "cpu": { - "nfCpuUsage": 4, - "sysCpuUsage": 163 - }, - "disk": { - "partitionInfo": [ - { - "total": 7928, - "used": 0 - }, - { - "total": 1598, - "used": 1 - }, - { - "total": 40010, - "used": 11625 - }, - { - "total": 7992, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 1598, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expire": "2026-06-30", - "mem": { - "nfUsedMem": 24640, - "sysMemUsage": 2828, - "totalMem": 16368300 - }, - "neIP": "192.168.8.58", - "neId": "001", - "neName": "AMF_001", - "neType": "AMF", - "online": true, - "refreshTime": 1723706285119, - "sn": "13750620", - "version": "2.2407.19" - } - }, - { - "id": "4", - "neType": "AUSF", - "neId": "001", - "rmUid": "4400HXAUSF001", - "neName": "AUSF_001", - "ip": "192.168.8.58", - "port": 29503, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "", - "hostIds": "7,8", - "status": "1", - "remark": "", - "createBy": "", - "createTime": 0, - "updateBy": "supervisor", - "updateTime": 1722845304851, - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 1, - "sysCpuUsage": 163 - }, - "disk": { - "partitionInfo": [ - { - "total": 7928, - "used": 0 - }, - { - "total": 1598, - "used": 1 - }, - { - "total": 40010, - "used": 11625 - }, - { - "total": 7992, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 1598, - "used": 0 - } - ], - "partitionNum": 6 - }, - "expire": "2026-06-30", - "mem": { - "nfUsedMem": 27624, - "sysMemUsage": 2828, - "totalMem": 16368300 - }, - "neIP": "192.168.8.58", - "neId": "001", - "neName": "AUSF_001", - "neType": "AUSF", - "online": true, - "refreshTime": 1723706285121, - "sn": "13750620", - "version": "2.2405.16" - } - } - ], - "total": 13 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|false|none||none| -|»» neType|string|false|none||none| -|»» neId|string|false|none||none| -|»» rmUid|string|false|none||none| -|»» neName|string|false|none||none| -|»» ip|string|false|none||none| -|»» port|integer|false|none||none| -|»» pvFlag|string|false|none||none| -|»» province|string|false|none||none| -|»» vendorName|string|false|none||none| -|»» dn|string|false|none||none| -|»» neAddress|string|false|none||none| -|»» hostIds|string|false|none||none| -|»» status|string|false|none||none| -|»» remark|string|false|none||none| -|»» createBy|string|false|none||none| -|»» createTime|integer|false|none||none| -|»» updateBy|string|false|none||none| -|»» updateTime|integer|false|none||none| -|» total|integer|true|none||none| - -## GET 网元列表全部无分页 - -GET /ne/info/listAll - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||网元类型| -|neId|query|string| no ||网元ID| -|bandStatus|query|boolean| no ||带状态信息| -|bandHost|query|boolean| no ||带主机信息| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": [ - { - "id": 1, - "neType": "OMC", - "neId": "001", - "rmUid": "4400HX101", - "neName": "OMC_001", - "ip": "172.16.16.50", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:47:43 +0800 CST" - }, - { - "id": 13, - "neType": "MME", - "neId": "001", - "rmUid": "4400HX1MME001", - "neName": "MME_001", - "ip": "172.16.5.220", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - }, - { - "id": 3, - "neType": "AMF", - "neId": "001", - "rmUid": "4400HX1AMF001", - "neName": "AMF_001", - "ip": "172.16.16.52", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST", - "serverState": { - "capability": 100000, - "cpu": { - "nfCpuUsage": 6, - "sysCpuUsage": 624 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 11508, - "sysMemUsage": 6675, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2312.8" - } - }, - { - "id": 4, - "neType": "AUSF", - "neId": "001", - "rmUid": "4400HX1AUF001", - "neName": "AUSF_001", - "ip": "172.16.16.53", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 5, - "sysCpuUsage": 624 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 17116, - "sysMemUsage": 6675, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2311.7" - } - }, - { - "id": 5, - "neType": "UDM", - "neId": "001", - "rmUid": "4400HX1UDM001", - "neName": "UDM_001", - "ip": "172.16.16.54", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 80, - "sysCpuUsage": 671 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 13456, - "sysMemUsage": 6675, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2312.8" - } - }, - { - "id": 6, - "neType": "SMF", - "neId": "001", - "rmUid": "4400HX1SMF001", - "neName": "SMF_001", - "ip": "172.16.16.55", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "GD", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-15 10:53:41 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 20, - "sysCpuUsage": 624 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 30592, - "sysMemUsage": 6675, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2311.9" - } - }, - { - "id": 201, - "neType": "SMF", - "neId": "002", - "rmUid": "SMF002", - "neName": "SMF002", - "ip": "172.16.16.55", - "port": 3030, - "pvFlag": "PNF", - "province": "", - "vendorName": "", - "dn": "", - "neAddress": "", - "status": "0", - "updateTime": "2023-12-15 10:53:30 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 49587, - "sysCpuUsage": 0 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 30848, - "sysMemUsage": 6675, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2311.9" - } - }, - { - "id": 7, - "neType": "PCF", - "neId": "001", - "rmUid": "4400HX1PCF001", - "neName": "PCF_001", - "ip": "172.16.16.56", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-18 15:06:28 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 220, - "sysCpuUsage": 624 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 14684, - "sysMemUsage": 6675, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2312.8" - } - }, - { - "id": 10, - "neType": "UPF", - "neId": "001", - "rmUid": "4400HX1UPF001", - "neName": "UPF_001", - "ip": "172.16.16.59", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - }, - { - "id": 9, - "neType": "NRF", - "neId": "001", - "rmUid": "4400HX1NRF001", - "neName": "NRF_001", - "ip": "172.16.16.58", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - }, - { - "id": 8, - "neType": "NSSF", - "neId": "001", - "rmUid": "4400HX1NSF001", - "neName": "NSSF_001", - "ip": "172.16.16.57", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - }, - { - "id": 2, - "neType": "IMS", - "neId": "001", - "rmUid": "4400HX1IMS001", - "neName": "IMS_001", - "ip": "172.16.16.51", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST", - "serverState": { - "capability": 100000, - "cpu": { - "nfCpuUsage": 2, - "sysCpuUsage": 626 - }, - "expire": "2024-03-31", - "mem": { - "nfUsedMem": 9600, - "sysMemUsage": 6659, - "totalMem": 4000912 - }, - "sn": "13770707", - "version": "2.2312.8" - } - }, - { - "id": 14, - "neType": "N3IWF", - "neId": "001", - "rmUid": "4400HX1IWF001", - "neName": "N3IWF_001", - "ip": "172.16.5.230", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - }, - { - "id": 12, - "neType": "NEF", - "neId": "001", - "rmUid": "4400HX1NEF001", - "neName": "NEF_001", - "ip": "172.16.5.210", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - }, - { - "id": 11, - "neType": "LMF", - "neId": "001", - "rmUid": "4400HX1LMF001", - "neName": "LMF_001", - "ip": "172.16.5.200", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-14 20:12:45 +0800 CST" - } - ], - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": [ - { - "id": 1, - "neType": "OMC", - "neId": "001", - "rmUid": "4400HX101", - "neName": "OMC_001", - "ip": "192.168.2.166", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2024-02-18 09:54:11 +0800 CST", - "serverState": { - "capability": 9999999, - "cpu": { - "nfCpuUsage": 12908, - "sysCpuUsage": 3330 - }, - "disk": { - "partitionInfo": [ - { - "total": 3911, - "used": 0 - }, - { - "total": 793, - "used": 3 - }, - { - "total": 23486, - "used": 17117 - }, - { - "total": 3968, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 30064, - "used": 16741 - }, - { - "total": 1945, - "used": 252 - }, - { - "total": 19985, - "used": 12031 - }, - { - "total": 1072, - "used": 6 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 70, - "used": 70 - }, - { - "total": 30064, - "used": 9793 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 74, - "used": 74 - }, - { - "total": 60, - "used": 60 - }, - { - "total": 74, - "used": 74 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 70, - "used": 70 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 793, - "used": 3 - }, - { - "total": 62, - "used": 62 - }, - { - "total": 19985, - "used": 12031 - }, - { - "total": 19985, - "used": 12031 - }, - { - "total": 19985, - "used": 12031 - }, - { - "total": 19985, - "used": 12031 - }, - { - "total": 793, - "used": 0 - } - ], - "partitionNum": 28 - }, - "expire": "-", - "mem": { - "nfUsedMem": 107860, - "sysMemUsage": 1420, - "totalMem": 8127428 - }, - "neIP": "192.168.2.166", - "neId": "001", - "neName": "OMC_001", - "neType": "OMC", - "online": true, - "refreshTime": 1709179386245, - "sn": "-", - "version": "2.2402.6" - } - }, - { - "id": 15, - "neType": "OMC", - "neId": "002", - "rmUid": "4400HX102", - "neName": "OMC_002", - "ip": "192.168.5.58", - "port": 3040, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "capability": 9999999, - "cpu": { - "nfCpuUsage": 0, - "sysCpuUsage": 307 - }, - "disk": { - "partitionInfo": [ - { - "total": 485436, - "used": 424807 - } - ], - "partitionNum": 1 - }, - "expire": "-", - "mem": { - "nfUsedMem": 111908, - "sysMemUsage": 6200, - "totalMem": 33231568 - }, - "neIP": "192.168.5.58", - "neId": "002", - "neName": "OMC_002", - "neType": "OMC", - "online": true, - "refreshTime": 1709179386419, - "sn": "-", - "version": "-" - } - }, - { - "id": 13, - "neType": "MME", - "neId": "001", - "rmUid": "4400HX1MME001", - "neName": "MME_001", - "ip": "192.168.13.220", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 3, - "neType": "AMF", - "neId": "001", - "rmUid": "4400HX1AMF001", - "neName": "AMF_001", - "ip": "192.168.13.120", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2024-02-05 11:26:36 +0800 CST", - "serverState": { - "capability": 100000, - "cpu": { - "nfCpuUsage": 0, - "sysCpuUsage": 5450 - }, - "disk": { - "partitionInfo": [ - { - "total": 1898, - "used": 0 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 29053, - "used": 16975 - }, - { - "total": 1956, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 1945, - "used": 254 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 391, - "used": 0 - } - ], - "partitionNum": 14 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 16908, - "sysMemUsage": 6976, - "totalMem": 4005920 - }, - "neIP": "192.168.13.120", - "neId": "001", - "neName": "AMF_001", - "neType": "AMF", - "online": true, - "refreshTime": 1709179386621, - "sn": "13770712", - "version": "2.2401.12" - } - }, - { - "id": 4, - "neType": "AUSF", - "neId": "001", - "rmUid": "4400HX1AUF001", - "neName": "AUSF_001", - "ip": "192.168.13.130", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 0, - "sysCpuUsage": 5450 - }, - "disk": { - "partitionInfo": [ - { - "total": 1898, - "used": 0 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 29053, - "used": 16975 - }, - { - "total": 1956, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 1945, - "used": 254 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 391, - "used": 0 - } - ], - "partitionNum": 14 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 18376, - "sysMemUsage": 6976, - "totalMem": 4005920 - }, - "neIP": "192.168.13.130", - "neId": "001", - "neName": "AUSF_001", - "neType": "AUSF", - "online": true, - "refreshTime": 1709179386624, - "sn": "13770712", - "version": "2.2312.8" - } - }, - { - "id": 5, - "neType": "UDM", - "neId": "001", - "rmUid": "4400HX1UDM001", - "neName": "UDM_001", - "ip": "192.168.13.140", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 54, - "sysCpuUsage": 5445 - }, - "disk": { - "partitionInfo": [ - { - "total": 1898, - "used": 0 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 29053, - "used": 16975 - }, - { - "total": 1956, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 1945, - "used": 254 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 391, - "used": 0 - } - ], - "partitionNum": 14 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 18440, - "sysMemUsage": 6976, - "totalMem": 4005920 - }, - "neIP": "192.168.13.140", - "neId": "001", - "neName": "UDM_001", - "neType": "UDM", - "online": true, - "refreshTime": 1709179386625, - "sn": "13770712", - "version": "2.2401.13" - } - }, - { - "id": 6, - "neType": "SMF", - "neId": "001", - "rmUid": "4400HX1SMF001", - "neName": "SMF_001", - "ip": "192.168.13.150", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "capability": 50000, - "cpu": { - "nfCpuUsage": 0, - "sysCpuUsage": 5452 - }, - "disk": { - "partitionInfo": [ - { - "total": 1898, - "used": 0 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 29053, - "used": 16975 - }, - { - "total": 1956, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 1945, - "used": 254 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 391, - "used": 0 - } - ], - "partitionNum": 14 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 44972, - "sysMemUsage": 6976, - "totalMem": 4005920 - }, - "neIP": "192.168.13.150", - "neId": "001", - "neName": "SMF_001", - "neType": "SMF", - "online": true, - "refreshTime": 1709179386627, - "sn": "13770712", - "version": "2.2401.13" - } - }, - { - "id": 7, - "neType": "PCF", - "neId": "001", - "rmUid": "4400HX1PCF001", - "neName": "PCF_001", - "ip": "192.168.13.160", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 10, - "neType": "UPF", - "neId": "001", - "rmUid": "4400HX1UPF001", - "neName": "UPF_001", - "ip": "192.168.13.190", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 9, - "neType": "NRF", - "neId": "001", - "rmUid": "4400HX1NRF001", - "neName": "NRF_001", - "ip": "192.168.13.180", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 8, - "neType": "NSSF", - "neId": "001", - "rmUid": "4400HX1NSF001", - "neName": "NSSF_001", - "ip": "192.168.13.170", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 2, - "neType": "IMS", - "neId": "001", - "rmUid": "4400HX1IMS001", - "neName": "IMS_001", - "ip": "192.168.13.110", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "capability": 100000, - "cpu": { - "nfCpuUsage": 22, - "sysCpuUsage": 5484 - }, - "disk": { - "partitionInfo": [ - { - "total": 1898, - "used": 0 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 29053, - "used": 16975 - }, - { - "total": 1956, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 40, - "used": 40 - }, - { - "total": 1945, - "used": 254 - }, - { - "total": 391, - "used": 1 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 87, - "used": 87 - }, - { - "total": 64, - "used": 64 - }, - { - "total": 391, - "used": 0 - } - ], - "partitionNum": 14 - }, - "expire": "2024-05-31", - "mem": { - "nfUsedMem": 16536, - "sysMemUsage": 6976, - "totalMem": 4005920 - }, - "neIP": "192.168.13.110", - "neId": "001", - "neName": "IMS_001", - "neType": "IMS", - "online": true, - "refreshTime": 1709179387431, - "sn": "13770712", - "version": "2.2402.4" - } - }, - { - "id": 14, - "neType": "N3IWF", - "neId": "001", - "rmUid": "4400HX1IWF001", - "neName": "N3IWF_001", - "ip": "192.168.13.230", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 12, - "neType": "NEF", - "neId": "001", - "rmUid": "4400HX1NEF001", - "neName": "NEF_001", - "ip": "192.168.13.210", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - }, - { - "id": 11, - "neType": "LMF", - "neId": "001", - "rmUid": "4400HX1LMF001", - "neName": "LMF_001", - "ip": "192.168.13.200", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "AGrandTech", - "dn": "-", - "neAddress": "-", - "status": "0", - "updateTime": "2023-12-29 21:04:24 +0800 CST", - "serverState": { - "online": false - } - } - ], - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» id|integer|true|none||none| -|»» neType|string|true|none|网元类型|none| -|»» neId|string|true|none||none| -|»» rmUid|string|true|none||none| -|»» neName|string|true|none||none| -|»» ip|string|true|none|网元IP|none| -|»» port|integer|true|none||none| -|»» pvFlag|string|true|none||none| -|»» province|string|true|none||none| -|»» vendorName|string|true|none||none| -|»» dn|string|true|none||none| -|»» neAddress|string|true|none||none| -|»» status|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» serverState|object|true|none|服务状态|none| -|»»» capability|integer|true|none||none| -|»»» cpu|object|true|none||none| -|»»»» nfCpuUsage|integer|true|none||none| -|»»»» sysCpuUsage|integer|true|none||none| -|»»» expire|string|true|none||none| -|»»» mem|object|true|none||none| -|»»»» nfUsedMem|integer|true|none||none| -|»»»» sysMemUsage|integer|true|none||none| -|»»»» totalMem|integer|true|none||none| -|»»» sn|string|true|none||none| -|»»» version|string|true|none||none| -|» msg|string|true|none||none| - -## POST 网元信息新增 - -POST /ne/info - -> Body Parameters - -```json -{ - "neType": "OMC", - "neId": "001", - "rmUid": "4400HX101", - "neName": "OMC_001", - "ip": "172.16.5.100", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "-", - "status": "1", - "hosts": [ - { - "hostType": "ssh", - "groupId": "1", - "title": "OMC_001_22", - "addr": "172.16.5.100", - "port": 22, - "user": "agtuser", - "authMode": "0", - "password": "admin123", - "privateKey": "", - "passPhrase": "", - "remark": "" - }, - { - "hostType": "telnet", - "groupId": "1", - "title": "OMC_001_4100", - "addr": "172.16.5.100", - "port": 4100, - "user": "admin", - "authMode": "0", - "password": "admin", - "privateKey": "", - "passPhrase": "", - "remark": "" - } - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||none| -|» neId|body|string| yes ||none| -|» rmUid|body|string| yes ||none| -|» neName|body|string| yes ||none| -|» ip|body|string| yes ||none| -|» port|body|integer| yes ||none| -|» pvFlag|body|string| yes ||none| -|» province|body|string| yes ||none| -|» vendorName|body|string| yes ||none| -|» dn|body|string| yes ||none| -|» neAddress|body|string| yes ||none| -|» status|body|string| yes ||none| -|» hosts|body|[object]| yes ||none| -|»» hostType|body|string| yes ||none| -|»» groupId|body|string| yes ||none| -|»» title|body|string| yes ||none| -|»» addr|body|string| yes ||none| -|»» port|body|integer| yes ||none| -|»» user|body|string| yes ||none| -|»» authMode|body|string| yes ||none| -|»» password|body|string| yes ||none| -|»» privateKey|body|string| yes ||none| -|»» passPhrase|body|string| yes ||none| -|»» remark|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» id|integer|true|none||none| -|»» neType|string|true|none|网元类型|none| -|»» neId|string|true|none||none| -|»» rmUid|string|true|none||none| -|»» neName|string|true|none||none| -|»» ip|string|true|none|网元IP|none| -|»» port|integer|true|none||none| -|»» pvFlag|string|true|none||none| -|»» province|string|true|none||none| -|»» vendorName|string|true|none||none| -|»» dn|string|true|none||none| -|»» neAddress|string|true|none||none| -|»» status|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» serverState|object|true|none|服务状态|none| -|»»» capability|integer|true|none||none| -|»»» cpu|object|true|none||none| -|»»»» nfCpuUsage|integer|true|none||none| -|»»»» sysCpuUsage|integer|true|none||none| -|»»» expire|string|true|none||none| -|»»» mem|object|true|none||none| -|»»»» nfUsedMem|integer|true|none||none| -|»»»» sysMemUsage|integer|true|none||none| -|»»»» totalMem|integer|true|none||none| -|»»» sn|string|true|none||none| -|»»» version|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 网元信息修改 - -PUT /ne/info - -> Body Parameters - -```json -{ - "id": "1", - "neType": "OMC", - "neId": "001", - "rmUid": "4400HX101", - "neName": "OMC_001", - "ip": "172.16.5.100", - "port": 3030, - "pvFlag": "PNF", - "province": "-", - "vendorName": "-", - "dn": "-", - "neAddress": "-", - "status": "1", - "hosts": [ - { - "hostId": "1", - "hostType": "ssh", - "groupId": "1", - "title": "OMC_001_22", - "addr": "172.16.5.100", - "port": 22, - "user": "agtuser", - "authMode": "0", - "password": "admin123", - "privateKey": "", - "passPhrase": "", - "remark": "" - }, - { - "hostId": "2", - "hostType": "telnet", - "groupId": "1", - "title": "OMC_001_4100", - "addr": "172.16.5.100", - "port": 4100, - "user": "admin", - "authMode": "0", - "password": "admin", - "privateKey": "", - "passPhrase": "", - "remark": "" - } - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» id|body|string| yes ||none| -|» neType|body|string| yes ||none| -|» neId|body|string| yes ||none| -|» rmUid|body|string| yes ||none| -|» neName|body|string| yes ||none| -|» ip|body|string| yes ||none| -|» port|body|integer| yes ||none| -|» pvFlag|body|string| yes ||none| -|» province|body|string| yes ||none| -|» vendorName|body|string| yes ||none| -|» dn|body|string| yes ||none| -|» neAddress|body|string| yes ||none| -|» status|body|string| yes ||none| -|» hosts|body|[object]| yes ||none| -|»» hostId|body|string| yes ||none| -|»» hostType|body|string| yes ||none| -|»» groupId|body|string| yes ||none| -|»» title|body|string| yes ||none| -|»» addr|body|string| yes ||none| -|»» port|body|integer| yes ||none| -|»» user|body|string| yes ||none| -|»» authMode|body|string| yes ||none| -|»» password|body|string| yes ||none| -|»» privateKey|body|string| yes ||none| -|»» passPhrase|body|string| yes ||none| -|»» remark|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» id|integer|true|none||none| -|»» neType|string|true|none|网元类型|none| -|»» neId|string|true|none||none| -|»» rmUid|string|true|none||none| -|»» neName|string|true|none||none| -|»» ip|string|true|none|网元IP|none| -|»» port|integer|true|none||none| -|»» pvFlag|string|true|none||none| -|»» province|string|true|none||none| -|»» vendorName|string|true|none||none| -|»» dn|string|true|none||none| -|»» neAddress|string|true|none||none| -|»» status|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» serverState|object|true|none|服务状态|none| -|»»» capability|integer|true|none||none| -|»»» cpu|object|true|none||none| -|»»»» nfCpuUsage|integer|true|none||none| -|»»»» sysCpuUsage|integer|true|none||none| -|»»» expire|string|true|none||none| -|»»» mem|object|true|none||none| -|»»»» nfUsedMem|integer|true|none||none| -|»»»» sysMemUsage|integer|true|none||none| -|»»»» totalMem|integer|true|none||none| -|»»» sn|string|true|none||none| -|»»» version|string|true|none||none| -|» msg|string|true|none||none| - -## DELETE 网元信息删除 - -DELETE /ne/info/{infoIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|infoIds|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元功能模块/网元主机 - -## POST 网元主机新增 - -POST /ne/host - -> Body Parameters - -```json -{ - "hostType": "ssh", - "groupId": "0", - "title": "测试机166", - "addr": "192.168.2.166", - "port": 22, - "user": "agtuser", - "authMode": "0", - "password": "admin123", - "privateKey": "", - "passPhrase": "", - "remark": "测试机166" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» hostType|body|string| yes | ssh telnet|none| -|» groupId|body|string| yes ||none| -|» title|body|string| yes ||none| -|» addr|body|string| yes | 主机地址|none| -|» port|body|integer| yes | SSH端口|none| -|» user|body|string| yes | 主机地址|none| -|» authMode|body|string| yes | 认证模式（0密码 1主机私钥）|none| -|» password|body|string| yes | 认证密码|none| -|» privateKey|body|string| yes | 认证私钥|none| -|» passPhrase|body|string| yes | 认证私钥密码|none| -|» remark|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||信息ID| -|» msg|string|true|none||none| - -## PUT 网元主机修改 - -PUT /ne/host - -> Body Parameters - -```json -{ - "hostId": "3", - "hostType": "telnet", - "groupId": "0", - "title": "测试机166", - "addr": "192.168.2.166", - "port": 22, - "user": "agtuser", - "authMode": "0", - "password": "admin123", - "privateKey": "", - "passPhrase": "", - "remark": "测试机166" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» hostId|body|string| yes ||none| -|» hostType|body|string| yes | ssh telnet|none| -|» groupId|body|string| yes ||none| -|» title|body|string| yes ||none| -|» addr|body|string| yes | 主机地址|none| -|» port|body|integer| yes | SSH端口|none| -|» user|body|string| yes | 主机地址|none| -|» authMode|body|string| yes | 认证模式（0密码 1主机私钥）|none| -|» password|body|string| yes | 认证密码|none| -|» privateKey|body|string| yes | 认证私钥|none| -|» passPhrase|body|string| yes | 认证私钥密码|none| -|» remark|body|string| yes ||none| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 网元主机测试连接 - -POST /ne/host/test - -> Body Parameters - -```json -{ - "addr": "string", - "port": 0, - "user": "string", - "authMode": "string", - "password": "string", - "privateKey": "string", - "passPhrase": "string", - "hostType": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» addr|body|string| yes | 主机地址|none| -|» port|body|integer| yes | SSH端口|none| -|» user|body|string| yes | 主机地址|none| -|» authMode|body|string| yes | 认证模式（0密码 1主机私钥）|none| -|» password|body|string| yes | 认证密码|none| -|» privateKey|body|string| yes | 认证私钥|none| -|» passPhrase|body|string| yes | 认证私钥密码|none| -|» hostType|body|string| yes | 主机类型 ssh telnet|none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## POST 网元主机SSH方式检查服务器环境 - -POST /ne/host/checkBySSH - -> Body Parameters - -```json -{ - "addr": "string", - "port": 0, - "user": "string", - "authMode": "string", - "password": "string", - "privateKey": "string", - "passPhrase": "string", - "hostType": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» addr|body|string| yes | 主机地址|none| -|» port|body|integer| yes | SSH端口|none| -|» user|body|string| yes | 主机地址|none| -|» authMode|body|string| yes | 认证模式（0密码 1主机私钥）|none| -|» password|body|string| yes | 认证密码|none| -|» privateKey|body|string| yes | 认证私钥|none| -|» passPhrase|body|string| yes | 认证私钥密码|none| -|» hostType|body|string| yes | 主机类型 ssh telnet|none| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "addr": "192.168.2.211", - "kernelName": "Linux", - "kernelRelease": "4.15.0-213-generic", - "machine": "x86_64", - "nodename": "omc-u18.04-dev", - "prettyName": "Ubuntu 18.04.6 LTS", - "sshLink": false, - "sudo": true - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» addr|string|true|none||none| -|»» kernelName|string|true|none||none| -|»» kernelRelease|string|true|none||none| -|»» machine|string|true|none||none| -|»» nodename|string|true|none||none| -|»» prettyName|string|true|none||none| -|»» sshLink|boolean|true|none||none| -|»» sudo|boolean|true|none||none| -|» msg|string|true|none||none| - -## POST 网元主机SSH方式授权免密发送 - -POST /ne/host/authorizedBySSH - -认证模式使用0 1 -不能用2已授权的进行请求 - -> Body Parameters - -```json -{ - "addr": "string", - "port": 0, - "user": "string", - "authMode": "string", - "password": "string", - "privateKey": "string", - "passPhrase": "string", - "hostType": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» addr|body|string| yes | 主机地址|none| -|» port|body|integer| yes | SSH端口|none| -|» user|body|string| yes | 主机地址|none| -|» authMode|body|string| yes | 认证模式（0密码 1主机私钥）|none| -|» password|body|string| yes | 认证密码|none| -|» privateKey|body|string| yes | 认证私钥|none| -|» passPhrase|body|string| yes | 认证私钥密码|none| -|» hostType|body|string| yes | 主机类型 ssh telnet|none| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "addr": "192.168.2.211", - "kernelName": "Linux", - "kernelRelease": "4.15.0-213-generic", - "machine": "x86_64", - "nodename": "omc-u18.04-dev", - "prettyName": "Ubuntu 18.04.6 LTS", - "sshLink": false, - "sudo": true - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "msg": "neHost.okBySSHLink" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 网元主机发送命令 - -POST /ne/host/cmd - -> Body Parameters - -```json -{ - "hostId": "string", - "cmd": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» hostId|body|string| yes | 主机ID|none| -|» cmd|body|string| yes | 执行命令|none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元主机列表 - -GET /ne/host/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|hostType|query|string| no ||主机类型| -|groupId|query|string| no ||组名| -|title|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "hostId": "2", - "groupType": "0", - "title": "", - "username": "agtuser", - "addr": "192.168.2.166", - "port": 22, - "authMode": "0", - "password": "-", - "privateKey": "-", - "privatePassword": "-", - "remark": "测试机166", - "createBy": "admin", - "createTime": 1708314549756, - "updateBy": "", - "updateTime": 0 - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» hostId|string|true|none||none| -|»» groupType|string|true|none||none| -|»» title|string|true|none||none| -|»» username|string|true|none||none| -|»» addr|string|true|none||none| -|»» port|integer|true|none||none| -|»» authMode|string|true|none||none| -|»» password|string|true|none||none| -|»» privateKey|string|true|none||none| -|»» privatePassword|string|true|none||none| -|»» remark|string|true|none||none| -|»» createBy|string|true|none||none| -|»» createTime|integer|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|integer|true|none||none| -|» total|integer|true|none||none| - -## DELETE 网元主机删除 - -DELETE /ne/host/{hostIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|hostIds|path|string| yes ||主机ID,多个用逗号分割| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元功能模块/网元主机命令 - -## GET 信息 - -GET /ne/host/{hostId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|hostId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "hostId": "7", - "hostType": "ssh", - "groupId": "0", - "title": "测试机166", - "addr": "192.168.2.166", - "port": 22, - "user": "agtuser", - "authMode": "0", - "password": "admin123", - "privateKey": "", - "passPhrase": "", - "remark": "测试机166", - "createBy": "admin", - "createTime": 1708333292882, - "updateBy": "", - "updateTime": 0 - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» hostId|string|true|none||none| -|»» hostType|string|true|none||none| -|»» groupId|string|true|none||none| -|»» title|string|true|none||none| -|»» addr|string|true|none||none| -|»» port|integer|true|none||none| -|»» user|string|true|none||none| -|»» authMode|string|true|none||none| -|»» password|string|true|none||none| -|»» privateKey|string|true|none||none| -|»» passPhrase|string|true|none||none| -|»» remark|string|true|none||none| -|»» createBy|string|true|none||none| -|»» createTime|integer|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|integer|true|none||none| -|» msg|string|true|none||none| - -## POST 新增 - -POST /ne/hostCmd - -> Body Parameters - -```json -{ - "cmdType": "udm_cmd", - "groupId": "0", - "title": "UDM通用", - "command": "ls -lsh", - "remark": "备注是通用" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» cmdType|body|string| yes | 命令类型|none| -|» groupId|body|string| yes ||none| -|» title|body|string| yes ||none| -|» command|body|string| yes | 命令|none| -|» remark|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 修改 - -PUT /ne/hostCmd - -> Body Parameters - -```json -{ - "cmdId": "1", - "cmdType": "udm_cmd", - "groupId": "0", - "title": "UDM通用", - "command": "ls -lsh", - "remark": "备注是通用" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» cmdId|body|string| yes | 命令ID|none| -|» cmdType|body|string| yes | 命令类型|none| -|» groupId|body|string| yes ||none| -|» title|body|string| yes ||none| -|» command|body|string| yes | 命令|none| -|» remark|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 列表 - -GET /ne/hostCmd/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|groupType|query|string| no ||组名| -|title|query|string| no ||主机标题名称| -|cmdType|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "cmdId": "1", - "cmdType": "udm_cmd", - "groupId": "0", - "title": "UDM通用", - "command": "ls -lsh", - "remark": "备注是通用", - "createBy": "admin", - "createTime": 1708933210277, - "updateBy": "", - "updateTime": 0 - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» hostId|string|true|none||none| -|»» groupType|string|true|none||none| -|»» title|string|true|none||none| -|»» username|string|true|none||none| -|»» addr|string|true|none||none| -|»» port|integer|true|none||none| -|»» authMode|string|true|none||none| -|»» password|string|true|none||none| -|»» privateKey|string|true|none||none| -|»» privatePassword|string|true|none||none| -|»» remark|string|true|none||none| -|»» createBy|string|true|none||none| -|»» createTime|integer|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|integer|true|none||none| -|» total|integer|true|none||none| - -## DELETE 删除 - -DELETE /ne/hostCmd/{cmdIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cmdIds|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元功能模块/网元版本信息 - -## GET 网元版本列表 - -GET /ne/version/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||网元类型| -|neId|query|string| no ||网元ID| -|version|query|string| no ||当前版本| -|path|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "37", - "neType": "NSSF", - "neId": "001", - "version": "2.2403.10", - "path": "/usr/local/omc/software/nssf/nssf-r2.2403.10-ub22.deb", - "preVersion": "2.2403.10", - "prePath": "/usr/local/omc/software/nssf/nssf-r2.2403.10-ub22.deb", - "newVersion": "", - "newPath": "", - "status": "Inactive", - "createBy": "admin", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|false|none||none| -|»» neType|string|false|none||none| -|»» neId|string|false|none||none| -|»» version|string|false|none||none| -|»» path|string|false|none||none| -|»» preVersion|string|false|none||none| -|»» prePath|string|false|none||none| -|»» newVersion|string|false|none||none| -|»» newPath|string|false|none||none| -|»» status|string|false|none||none| -|»» createBy|string|false|none||none| -|»» createTime|integer|false|none||none| -|»» updateBy|string|false|none||none| -|»» updateTime|integer|false|none||none| -|» total|integer|true|none||none| - -## POST 网元版本操作 - -POST /ne/version/operate - -进行版本的安装/升级/回退操作功能 - -> Body Parameters - -```json -{ - "software": { - "neType": "SMF", - "name": "smf-r2.2403.16-ub22.deb", - "path": "/upload/software/2024/04/smf-r2.2403.17-ub22_4n6d98.deb", - "version": "2.2403.16", - "description": "=====", - "neId": "0012" - }, - "preinput": { - "pisCSCF": "y", - "pubIP": "192.168.5.57", - "mcc": "001", - "mnc": "01", - "priIP": "172.16.16.51" - } -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||网元ID| -|» action|body|string| yes ||操作行为 install upgrade rollback| -|» preinput|body|object| no | 预先输入参数|预先输入| -|»» pisCSCF|body|string| no | modipplmn|IMS P/I/S-CSCF Config 配置覆盖| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元版本信息 - -GET /ne/version/{versionId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|versionId|path|string| yes ||版本ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "32", - "neType": "PCF", - "neId": "001", - "version": "2.2402.14", - "filePath": "/usr/local/omc/software/pcf/pcf-r2.2402.14-ub22.deb", - "preVersion": "", - "preFile": "", - "newVersion": "", - "newFile": "", - "status": "Active", - "updateTime": "2024-03-04T06:11:47+08:00" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neId|string|true|none||none| -|»» version|string|true|none||none| -|»» filePath|string|true|none||none| -|»» preVersion|string|true|none||none| -|»» preFile|string|true|none||none| -|»» newVersion|string|true|none||none| -|»» newFile|string|true|none||none| -|»» status|string|true|none||none| -|»» updateTime|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元功能模块/网元授权激活信息 - -## POST 网元授权激活授权文件替换 - -POST /ne/license/change - -状态会被置为无效，通过手动刷新检查更新状态 - -> Body Parameters - -```json -{ - "neType": "SMF", - "neId": "0012", - "licensePath": "/upload/license/2024/03/SMF_13.150_system_7jn9lh.ini", - "remark": "", - "reload": true -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||网元ID| -|» licensePath|body|string| yes ||授权文件| -|» reload|body|boolean| no ||刷新刷新服务| -|» remark|body|string| no ||备注| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元授权激活状态 - -GET /ne/license/state - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "expire": "2024-05-31", - "sn": "13770712" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» expire|string|true|none||none| -|»» sn|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元授权激活列表 - -GET /ne/license/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||网元类型| -|neId|query|string| no ||网元ID| -|expiryDate|query|string| no ||过期时间| -|createBy|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "1", - "neType": "AUSF", - "neId": "001", - "activationRequestCode": "73A80974096B54B0096E28D15CB2B63AC188137BE14AC778C188137BE14AC778C8AB80E9DBA1D55598815DA798397C96", - "licensePath": "/usr/local/etc/smf/license/system.imi", - "serialNum": "13750541", - "expiryDate": "2024-05-31", - "status": "1", - "remark": "通用激活", - "createBy": "", - "createTime": 0, - "updateBy": "admin", - "updateTime": 1711705049275 - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|false|none||none| -|»» neType|string|false|none||none| -|»» neId|string|false|none||none| -|»» activationRequestCode|string|false|none||none| -|»» licensePath|string|false|none||none| -|»» serialNum|string|false|none||none| -|»» expiryDate|string|false|none||none| -|»» status|string|false|none||none| -|»» remark|string|false|none||none| -|»» createBy|string|false|none||none| -|»» createTime|integer|false|none||none| -|»» updateBy|string|false|none||none| -|»» updateTime|integer|false|none||none| -|» total|integer|true|none||none| - -## GET 网元授权激活信息 - -GET /ne/license/{licenseId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|licenseId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "3", - "neType": "SMF", - "neId": "001", - "activationRequestCode": "73A80974096B54B0096E28D15CB2B63AC188137BE14AC778C188137BE14AC778C8AB80E9DBA1D55598815DA798397C96", - "licensePath": "/usr/local/etc/smf/license/system.imi", - "serialNum": "13750541", - "expiryDate": "2024-05-31", - "status": "1", - "remark": "通用激活", - "createBy": "admin", - "createTime": 1711704945463, - "updateBy": "", - "updateTime": 0 - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neId|string|true|none||none| -|»» activationRequestCode|string|true|none||none| -|»» licensePath|string|true|none||none| -|»» serialNum|string|true|none||none| -|»» expiryDate|string|true|none||none| -|»» status|string|true|none||none| -|»» remark|string|true|none||none| -|»» createBy|string|true|none||none| -|»» createTime|integer|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|integer|true|none||none| -|» msg|string|true|none||none| - -## GET 网元授权激活授权申请码 - -GET /ne/license/code - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元id| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": "2B12515AECDC46779ED26BB237AB2547C6A59D31FE3B60C34570DA4B53B0BF54C4988FCC17ED9D54803563DA3DC0C055", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元neType和neID查询 - -GET /ne/license/byTypeAndID - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元id| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "6", - "neType": "SMF", - "neId": "001", - "activationRequestCode": "BF9668CD434898D68FCCA373AC4922E0C864B485D17EEC407F53CDC6F966D95C090C89D79F2DC9BC531D600637CE3F37", - "licensePath": "/upload/license/2024/04/5GC_00000005_2024-04-19_system_rjldl7.ini", - "serialNum": "00000005", - "expiryDate": "2025-04-19", - "status": "0", - "remark": "", - "createBy": "supervisor", - "createTime": 1713928436971, - "updateBy": "supervisor", - "updateTime": 1714372400293 - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元功能模块/网元软件包 - -## POST 网元软件包新增 - -POST /ne/software - -校验唯一：类型-名称-版本 -当前接口会找到已存在的删除后重新添加 - -> Body Parameters - -```json -{ - "neType": null, - "name": null, - "version": null, - "path": "string", - "description": null -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no | ne_software|none| -|» neType|body|string| yes ||网元类型| -|» name|body|string| yes ||包名称| -|» version|body|string| yes ||包版本| -|» path|body|string| no ||包路径| -|» description|body|string| no ||包说明| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 网元软件包修改 - -PUT /ne/software - -> Body Parameters - -```json -{ - "id": "string", - "neType": null, - "name": null, - "version": null, - "path": "string", - "description": null -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no | ne_software|none| -|» id|body|string| yes ||none| -|» neType|body|string| yes ||网元类型| -|» name|body|string| yes ||包名称| -|» version|body|string| yes ||包版本| -|» path|body|string| yes ||包路径| -|» description|body|string| no ||包说明| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 网元软件包设为网元新版本 - -POST /ne/software/newNeVersion - -将已有的软件包信息作为网元新版本 -选择软件包作为安装升级时使用 - -> Body Parameters - -```json -{ - "version": "2.2404.18", - "neType": "SMF", - "name": "smf-r2.2404.18-ub22.deb" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» version|body|string| yes ||包版本| -|» name|body|string| yes ||包名称| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## GET 网元软件包列表 - -GET /ne/software/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||网元类型| -|name|query|string| no ||文件名| -|version|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "127", - "neType": "AUSF", - "name": "ausf-r2.2403.13-ub22.deb", - "path": "/upload/software/2024/03/ausf-r2.2403.13-ub22_4858az.deb", - "version": "2.2403.13", - "description": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - } - ], - "total": 2 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» name|string|true|none||none| -|»» path|string|true|none||none| -|»» version|string|true|none||none| -|»» description|string|true|none||none| -|»» createBy|string|true|none||none| -|»» createTime|integer|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|integer|true|none||none| -|» total|integer|true|none||none| - -## GET 网元软件包信息 - -GET /ne/software/{softwareId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|softwareId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "127", - "neType": "AUSF", - "name": "ausf-r2.2403.13-ub22.deb", - "path": "/upload/software/2024/03/ausf-r2.2403.13-ub22_4858az.deb", - "version": "2.2403.13", - "description": "", - "createBy": "", - "createTime": 0, - "updateBy": "", - "updateTime": 0 - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» name|string|true|none||none| -|»» path|string|true|none||none| -|»» version|string|true|none||none| -|»» description|string|true|none||none| -|»» createBy|string|true|none||none| -|»» createTime|integer|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|integer|true|none||none| -|» msg|string|true|none||none| - -## DELETE 网元软件包删除 - -DELETE /ne/software/{softwareIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|softwareIds|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元功能模块/网元参数配置/网元参数配置可用属性值 - -## POST 网元参数配置可用属性值新增 - -POST /ne/config - -> Body Parameters - -```json -{ - "neType": "AMF", - "paramName": "system", - "paramDisplay": "System Config", - "paramType": "list", - "paramSort": 23, - "paramPerms": "post,put,delete", - "paramData": [ - { - "access": "read-write", - "comment": "", - "display": "AMF Name", - "filter": "0~64", - "name": "amfName", - "type": "string", - "value": "AMF" - }, - { - "access": "read-write", - "comment": "0~255", - "display": "Relative Capacity", - "filter": "0~255", - "name": "relativeCapacity", - "type": "int", - "value": "255" - }, - { - "access": "read-write", - "comment": "", - "display": "SBI Scheme", - "filter": "{\"0\":\"http\",\"1\":\"https\"}", - "name": "sbiScheme", - "type": "enum", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "SBI Server IP", - "filter": "0~64", - "name": "sbiServerIp", - "type": "string", - "value": "192.168.1.183" - }, - { - "access": "read-write", - "comment": "0~65535", - "display": "SBI Server Port", - "filter": "0~65535", - "name": "sbiServerPort", - "type": "int", - "value": "8080" - }, - { - "access": "read-write", - "comment": "", - "display": "NRF Enabled", - "filter": "{\"0\":\"false\",\"1\":\"true\"}", - "name": "nrfEnabled", - "type": "bool", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "NRF URI", - "filter": "0~64", - "name": "nrfUri", - "type": "string", - "value": "http://172.16.5.180:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "AUSF URI", - "filter": "0~64", - "name": "ausfUri", - "type": "string", - "value": "http://172.16.5.130:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "UDM URI", - "filter": "0~64", - "name": "udmUri", - "type": "string", - "value": "http://172.16.5.140:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "SMF URI", - "filter": "0~64", - "name": "smfUri", - "type": "string", - "value": "http://172.16.5.150:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "PCF URI", - "filter": "0~64", - "name": "pcfUri", - "type": "string", - "value": "http://172.16.5.160:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "LMF URI", - "filter": "0~64", - "name": "lmfUri", - "type": "string", - "value": "http://172.16.5.200:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "NEF URI", - "filter": "0~64", - "name": "nefUri", - "type": "string", - "value": "http://172.16.5.210:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "DNN Correction Enabled", - "filter": "{\"0\":\"false\",\"1\":\"true\"}", - "name": "dnnCorrectionEnabled", - "type": "bool", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "Default DNN", - "filter": "0~64", - "name": "defaultDnn", - "type": "string", - "value": "internet" - }, - { - "access": "read-write", - "comment": "", - "display": "Integrity Algorithm", - "filter": "{\"0\":\"NIA0\",\"1\":\"NIA1\",\"2\":\"NIA2\",\"3\":\"NIA3\"}", - "name": "integrityAlgorithm", - "type": "enum", - "value": "2" - }, - { - "access": "read-write", - "comment": "", - "display": "Ciphering Algorithm", - "filter": "{\"0\":\"NEA0\",\"1\":\"NEA1\",\"2\":\"NEA2\",\"3\":\"NEA3\"}", - "name": "cipheringAlgorithm", - "type": "enum", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "T3502", - "filter": "1~65535", - "name": "t3502", - "type": "int", - "value": "720" - }, - { - "access": "read-write", - "comment": "", - "display": "T3512", - "filter": "1~65535", - "name": "t3512", - "type": "int", - "value": "3600" - }, - { - "access": "read-write", - "comment": "", - "display": "T3513", - "filter": "1~65535", - "name": "t3513", - "type": "int", - "value": "2" - }, - { - "access": "read-write", - "comment": "", - "display": "T3522", - "filter": "1~65535", - "name": "t3522", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3550", - "filter": "1~65535", - "name": "t3550", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3555", - "filter": "1~65535", - "name": "t3555", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3560", - "filter": "1~65535", - "name": "t3560", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3565", - "filter": "1~65535", - "name": "t3565", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3570", - "filter": "1~65535", - "name": "t3570", - "type": "int", - "value": "6" - } - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||none| -|» paramData|body|[object]| yes ||none| -|»» access|body|string| yes ||none| -|»» comment|body|string| yes ||none| -|»» display|body|string| yes ||none| -|»» filter|body|string| yes ||none| -|»» name|body|string| yes ||none| -|»» type|body|string| yes ||none| -|»» value|body|string| yes ||none| -|» paramName|body|string| yes ||none| -|» paramDisplay|body|string| yes ||none| -|» paramType|body|string| yes ||none| -|» paramSort|body|integer| yes ||none| -|» paramPerms|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT 网元参数配置可用属性值修改 - -PUT /ne/config - -> Body Parameters - -```json -{ - "id": "1874", - "neType": "AMF", - "paramName": "system", - "paramDisplay": "System Config", - "paramType": "list", - "paramSort": 23, - "paramPerms": "post,put,delete", - "paramData": [ - { - "access": "read-write", - "comment": "", - "display": "AMF Name", - "filter": "0~64", - "name": "amfName", - "type": "string", - "value": "AMF" - }, - { - "access": "read-write", - "comment": "0~255", - "display": "Relative Capacity", - "filter": "0~255", - "name": "relativeCapacity", - "type": "int", - "value": "255" - }, - { - "access": "read-write", - "comment": "", - "display": "SBI Scheme", - "filter": "{\"0\":\"http\",\"1\":\"https\"}", - "name": "sbiScheme", - "type": "enum", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "SBI Server IP", - "filter": "0~64", - "name": "sbiServerIp", - "type": "string", - "value": "192.168.1.183" - }, - { - "access": "read-write", - "comment": "0~65535", - "display": "SBI Server Port", - "filter": "0~65535", - "name": "sbiServerPort", - "type": "int", - "value": "8080" - }, - { - "access": "read-write", - "comment": "", - "display": "NRF Enabled", - "filter": "{\"0\":\"false\",\"1\":\"true\"}", - "name": "nrfEnabled", - "type": "bool", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "NRF URI", - "filter": "0~64", - "name": "nrfUri", - "type": "string", - "value": "http://172.16.5.180:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "AUSF URI", - "filter": "0~64", - "name": "ausfUri", - "type": "string", - "value": "http://172.16.5.130:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "UDM URI", - "filter": "0~64", - "name": "udmUri", - "type": "string", - "value": "http://172.16.5.140:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "SMF URI", - "filter": "0~64", - "name": "smfUri", - "type": "string", - "value": "http://172.16.5.150:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "PCF URI", - "filter": "0~64", - "name": "pcfUri", - "type": "string", - "value": "http://172.16.5.160:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "LMF URI", - "filter": "0~64", - "name": "lmfUri", - "type": "string", - "value": "http://172.16.5.200:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "NEF URI", - "filter": "0~64", - "name": "nefUri", - "type": "string", - "value": "http://172.16.5.210:8080" - }, - { - "access": "read-write", - "comment": "", - "display": "DNN Correction Enabled", - "filter": "{\"0\":\"false\",\"1\":\"true\"}", - "name": "dnnCorrectionEnabled", - "type": "bool", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "Default DNN", - "filter": "0~64", - "name": "defaultDnn", - "type": "string", - "value": "internet" - }, - { - "access": "read-write", - "comment": "", - "display": "Integrity Algorithm", - "filter": "{\"0\":\"NIA0\",\"1\":\"NIA1\",\"2\":\"NIA2\",\"3\":\"NIA3\"}", - "name": "integrityAlgorithm", - "type": "enum", - "value": "2" - }, - { - "access": "read-write", - "comment": "", - "display": "Ciphering Algorithm", - "filter": "{\"0\":\"NEA0\",\"1\":\"NEA1\",\"2\":\"NEA2\",\"3\":\"NEA3\"}", - "name": "cipheringAlgorithm", - "type": "enum", - "value": "0" - }, - { - "access": "read-write", - "comment": "", - "display": "T3502", - "filter": "1~65535", - "name": "t3502", - "type": "int", - "value": "720" - }, - { - "access": "read-write", - "comment": "", - "display": "T3512", - "filter": "1~65535", - "name": "t3512", - "type": "int", - "value": "3600" - }, - { - "access": "read-write", - "comment": "", - "display": "T3513", - "filter": "1~65535", - "name": "t3513", - "type": "int", - "value": "2" - }, - { - "access": "read-write", - "comment": "", - "display": "T3522", - "filter": "1~65535", - "name": "t3522", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3550", - "filter": "1~65535", - "name": "t3550", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3555", - "filter": "1~65535", - "name": "t3555", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3560", - "filter": "1~65535", - "name": "t3560", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3565", - "filter": "1~65535", - "name": "t3565", - "type": "int", - "value": "6" - }, - { - "access": "read-write", - "comment": "", - "display": "T3570", - "filter": "1~65535", - "name": "t3570", - "type": "int", - "value": "6" - } - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» id|body|string| yes ||none| -|» neType|body|string| yes ||none| -|» paramData|body|[object]| yes ||none| -|»» access|body|string| yes ||none| -|»» comment|body|string| yes ||none| -|»» display|body|string| yes ||none| -|»» filter|body|string| yes ||none| -|»» name|body|string| yes ||none| -|»» type|body|string| yes ||none| -|»» value|body|string| yes ||none| -|» paramName|body|string| yes ||none| -|» paramDisplay|body|string| yes ||none| -|» paramType|body|string| yes ||none| -|» paramSort|body|integer| yes ||none| -|» paramPerms|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /ne/config - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|id|query|string| no ||参数ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 网元参数配置可用属性值列表 - -GET /ne/config/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||网元类型| -|paramName|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "1824", - "neType": "MME", - "paramName": "system", - "paramDisplay": "System Config", - "paramType": "list", - "paramSort": "0", - "paramPerms": "", - "updateTime": 1719817365679 - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|false|none||none| -|»» neType|string|false|none||none| -|»» topTag|string|false|none||none| -|»» topDisplay|string|false|none||none| -|»» method|string|false|none||none| -|» total|integer|true|none||none| - -## GET 网元参数配置可用属性值列表指定网元类型全部无分页 - -GET /ne/config/list/{neType} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|path|string| yes ||网元类型| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "1637", - "neType": "UDM", - "topTag": "applicationServer", - "topDisplay": "Application Server", - "method": "" - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|false|none||none| -|»» neType|string|false|none||none| -|»» topTag|string|false|none||none| -|»» topDisplay|string|false|none||none| -|»» method|string|false|none||none| -|» total|integer|true|none||none| - -## GET 网元参数配置可用属性值信息 - -GET /ne/config/info/{id} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|id|path|string| yes ||列表数据ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "1824", - "neType": "MME", - "paramName": "system", - "paramDisplay": "System Config", - "paramType": "list", - "paramSort": "0", - "paramPerms": "", - "updateTime": 1719817365679, - "paramData": [ - { - "access": "read-write", - "comment": "true|false", - "display": "CSFB Enabled", - "filter": "{\"0\":\"false\",\"1\":\"true\"}", - "name": "csfbEnabled", - "type": "bool", - "value": "false" - }, - { - "access": "read-write", - "comment": "true|false", - "display": "VoLTE Enabled", - "filter": "{\"0\":\"false\",\"1\":\"true\"}", - "name": "volteEnabled", - "type": "bool", - "value": "false" - }, - { - "access": "read-write", - "comment": "0~64", - "display": "S1 MME IP", - "filter": "0~64", - "name": "s1MmeIp", - "type": "string", - "value": "192.168.1.179" - }, - { - "access": "read-only", - "comment": "0~65535", - "display": "S1 MME Port", - "filter": "0~65535", - "name": "s1MmePort", - "type": "int", - "value": "36412" - }, - { - "access": "read-write", - "comment": "0~64", - "display": "S11 MME IP", - "filter": "0~64", - "name": "s11MmeIp", - "type": "string", - "value": "192.168.1.179" - }, - { - "access": "read-write", - "comment": "0~65535", - "display": "S11 MME Port", - "filter": "0~65535", - "name": "s11MmePort", - "type": "int", - "value": "2123" - }, - { - "access": "read-write", - "comment": "0~64", - "display": "S10 MME IP", - "filter": "0~64", - "name": "s10MmeIp", - "type": "string", - "value": "192.168.1.178" - }, - { - "access": "read-write", - "comment": "0~65535", - "display": "S10 MME Port", - "filter": "0~65535", - "name": "s10MmePort", - "type": "int", - "value": "2123" - }, - { - "access": "read-write", - "comment": "0~64", - "display": "SGs MME IP", - "filter": "0~64", - "name": "sgsMmeIp", - "type": "string", - "value": "192.168.1.179" - }, - { - "access": "read-only", - "comment": "0~65535", - "display": "SGs MME Port", - "filter": "0~65535", - "name": "sgsMmePort", - "type": "int", - "value": "29118" - }, - { - "access": "read-write", - "comment": "0~100", - "display": "S6A MME Identity", - "filter": "0~100", - "name": "s6aIdentity", - "type": "string", - "value": "mme.epc.mnc001.mcc001.3gppnetwork.org" - }, - { - "access": "read-write", - "comment": "0~20", - "display": "S6A MME IP", - "filter": "0~20", - "name": "localIp", - "type": "string", - "value": "172.16.5.220" - } - ] - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» paramName|string|true|none||none| -|»» paramDisplay|string|true|none||none| -|»» paramType|string|true|none||none| -|»» paramSort|string|true|none||none| -|»» paramPerms|string|true|none||none| -|»» updateTime|integer|true|none||none| -|»» paramData|[object]|true|none||none| -|»»» access|string|true|none||none| -|»»» comment|string|true|none||none| -|»»» display|string|true|none||none| -|»»» filter|string|true|none||none| -|»»» name|string|true|none||none| -|»»» type|string|true|none||none| -|»»» value|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元功能模块/网元参数配置/网元参数配置数据 - -## GET 网元参数配置数据信息 - -GET /ne/config/data - -直连到网元端获取 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|paramName|query|string| yes ||可用属性值| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": [ - { - "amfName": "AMF", - "ausfUri": "http://192.168.13.130:8080", - "cipheringAlgorithm": 0, - "defaultDnn": "cmnet", - "dnnCorrectionEnabled": false, - "integrityAlgorithm": 2, - "lmfUri": "http://192.168.13.200:8080", - "nefUri": "http://192.168.13.210:23", - "nrfEnabled": false, - "nrfUri": "http://192.168.13.180:8080", - "pcfUri": "http://192.168.13.160:8080", - "relativeCapacity": 255, - "sbiScheme": 0, - "sbiServerIp": "192.168.13.120", - "sbiServerPort": 8080, - "smfUri": "http://192.168.13.150:8080", - "t3502": 720, - "t3512": 3600, - "t3513": 2, - "t3522": 2, - "t3550": 2, - "t3555": 2, - "t3560": 2, - "t3565": 2, - "t3570": 2, - "udmUri": "http://192.168.13.140:8080" - } - ], - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[string]|true|none||数组内容根据网元返回| -|» msg|string|true|none||none| - -## PUT 网元参数配置数据更新 - -PUT /ne/config/data - -成功204 无内容 -仅array使用与数据对象内index一致,有多层时划分嵌套层(index/subParamName/index) - -> Body Parameters - -```json -{ - "neType": "MME", - "neId": "001", - "paramName": "pgw", - "paramData": { - "index": 1, - "apn": "internet", - "pgwIp": "234.248.140.49", - "plmnId": "31233" - }, - "loc": "1" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||网元ID| -|» paramName|body|string| yes ||根据配置可选值| -|» paramData|body|object| yes ||数据对象| -|»» index|body|integer| no ||array更新项| -|»» apn|body|string| no ||none| -|»» pgwIp|body|string| no ||none| -|»» plmnId|body|string| no ||none| -|» loc|body|string| no ||仅array使用与数据对象内index一致,有多层时划分嵌套层(index/subParamName/index)| - -> Response Examples - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|none|Inline| - -### Responses Data Schema - -## POST 网元参数配置数据新增（array） - -POST /ne/config/data - -响应200成功，请求体发送什么返回什么 -loc与数据对象内index一致,有多层时划分嵌套层(index/subParamName/index) - -> Body Parameters - -```json -{ - "neType": "SMF", - "neId": "002", - "paramName": "upfConfig", - "paramData": { - "index": 1, - "dnn": "3333", - "ipPoolType": "IPv4v6", - "ipv4Pools": "192.168.1.0/24", - "ipv6Pools": "fe80::20c:29ff:fee4:dab7/50", - "staticIpv4Enable": false, - "staticIpv4Start": "", - "staticIpv4End": "", - "staticIpv6Enable": false, - "staticIpv6Start": "", - "staticIpv6End": "" - }, - "loc": "2/ueDnnIpPool/1" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||网元ID| -|» paramName|body|string| yes ||根据配置可选值| -|» loc|body|string| yes ||与数据对象内index一致,有多层时划分嵌套层(index/subParamName/index)| -|» paramData|body|object| yes ||数据对象| -|»» index|body|integer| no ||跟随loc层，不小于已存在的index| -|»» apn|body|string| no ||none| -|»» pgwIp|body|string| no ||none| -|»» plmnId|body|string| no ||none| - -> Response Examples - -```json -null -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## DELETE 网元参数配置数据删除（array） - -DELETE /ne/config/data - -成功返回204 无内容 -loc与数据对象内index一致,有多层时划分嵌套层(index/subParamName/index) - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|paramName|query|string| yes ||根据配置可选值| -|loc|query|string| yes ||与数据对象内index一致,有多层时划分嵌套层(index/subParamName/index)| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 204 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **204** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» dnn|string|true|none||none| -|» tai|string|true|none||none| -|» upfId|string|true|none||none| - -# 中文src目录接口/网元功能模块/网元配置文件备份记录 - -## GET 网元配置文件备份记录列表 - -GET /ne/config/backup/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| no ||网元类型| -|neId|query|string| no ||网元ID| -|name|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## GET 网元配置文件备份记录下载 - -GET /ne/config/backup/download - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|id|query|string| no ||信息ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## PUT 网元配置文件备份记录修改 - -PUT /ne/config/backup - -> Body Parameters - -```json -{ - "id": "string", - "name": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» id|body|string| yes ||记录ID| -|» name|body|string| yes ||名称| -|» remark|body|string| no ||备注| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## DELETE 网元配置文件备份记录删除 - -DELETE /ne/config/backup - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|id|query|string| no ||信息Id，可多个删除,号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST 网元配置文件备份导入 - -POST /ne/config/backup/import - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string", - "type": "string", - "path": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||网元ID| -|» type|body|string| yes ||导入方式 backup upload| -|» path|body|string| yes ||文件路径| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST 网元配置文件备份导出 - -POST /ne/config/backup/export - -> Body Parameters - -```json -{ - "neType": "string", - "neId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型| -|» neId|body|string| yes ||网元ID| - -> Response Examples - -> 200 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元数据模块/性能统计 - -## GET 统计标题 - -GET /neData/kpi/title - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": [ - { - "id": "28", - "neType": "UDM", - "kpiId": "UDM.01", - "titleJson": "{\"cn\": \"5G注册用户数\", \"en\": \"UDR.5gActSub\"}", - "cnTitle": "5G注册用户数", - "enTitle": "UDR.5gActSub" - }, - { - "id": "29", - "neType": "UDM", - "kpiId": "UDM.02", - "titleJson": "{\"cn\": \"AMF发起的UECM注册请求次数\", \"en\": \"UDM.AmfUecmRegReq\"}", - "cnTitle": "AMF发起的UECM注册请求次数", - "enTitle": "UDM.AmfUecmRegReq" - }, - { - "id": "30", - "neType": "UDM", - "kpiId": "UDM.03", - "titleJson": "{\"cn\": \"AMF发起的UECM注册成功次数\", \"en\": \"UDM.AmfUecmRegSucc\"}", - "cnTitle": "AMF发起的UECM注册成功次数", - "enTitle": "UDM.AmfUecmRegSucc" - }, - { - "id": "31", - "neType": "UDM", - "kpiId": "UDM.04", - "titleJson": "{\"cn\": \"SMF发起的UECM注册成功次数\", \"en\": \"UDM.SmfUecmRegSucc\"}", - "cnTitle": "SMF发起的UECM注册成功次数", - "enTitle": "UDM.SmfUecmRegSucc" - }, - { - "id": "32", - "neType": "UDM", - "kpiId": "UDM.05", - "titleJson": "{\"cn\": \"SMF发起的UECM注册请求次数\", \"en\": \"UDM.SmfUecmRegReq\"}", - "cnTitle": "SMF发起的UECM注册请求次数", - "enTitle": "UDM.SmfUecmRegReq" - }, - { - "id": "33", - "neType": "UDM", - "kpiId": "UDM.06", - "titleJson": "{\"cn\": \"4G注册用户数\", \"en\": \"SUB.EpsActSubsInHss\"}", - "cnTitle": "4G注册用户数", - "enTitle": "SUB.EpsActSubsInHss" - }, - { - "id": "34", - "neType": "UDM", - "kpiId": "UDM.07", - "titleJson": "{\"cn\": \"4G鉴权信息查询成功次数\", \"en\": \"DIAM.AucInfoAnsSucc\"}", - "cnTitle": "4G鉴权信息查询成功次数", - "enTitle": "DIAM.AucInfoAnsSucc" - }, - { - "id": "35", - "neType": "UDM", - "kpiId": "UDM.08", - "titleJson": "{\"cn\": \"4G鉴权信息查询请求次数\", \"en\": \"DIAM.AucInfoReq\"}", - "cnTitle": "4G鉴权信息查询请求次数", - "enTitle": "DIAM.AucInfoReq" - }, - { - "id": "36", - "neType": "UDM", - "kpiId": "UDM.09", - "titleJson": "{\"cn\": \"4G更新位置成功次数\", \"en\": \"DIAM.UpdateLocationAnsSucc\"}", - "cnTitle": "4G更新位置成功次数", - "enTitle": "DIAM.UpdateLocationAnsSucc" - }, - { - "id": "37", - "neType": "UDM", - "kpiId": "UDM.10", - "titleJson": "{\"cn\": \"4G更新位置请求次数\", \"en\": \"DIAM.UpdateLocationReq\"}", - "cnTitle": "4G更新位置请求次数", - "enTitle": "DIAM.UpdateLocationReq" - }, - { - "id": "38", - "neType": "UDM", - "kpiId": "UDM.11", - "titleJson": "{\"cn\": \"SAR成功响应总次数\", \"en\": \"UR.SuccSAA\"}", - "cnTitle": "SAR成功响应总次数", - "enTitle": "UR.SuccSAA" - }, - { - "id": "39", - "neType": "UDM", - "kpiId": "UDM.12", - "titleJson": "{\"cn\": \"SAR请求总次数\", \"en\": \"UR.AttSAR\"}", - "cnTitle": "SAR请求总次数", - "enTitle": "UR.AttSAR" - }, - { - "id": "40", - "neType": "UDM", - "kpiId": "UDM.13", - "titleJson": "{\"cn\": \"LIR成功响应总次数\", \"en\": \"LIQ.SuccLIA\"}", - "cnTitle": "LIR成功响应总次数", - "enTitle": "LIQ.SuccLIA" - }, - { - "id": "41", - "neType": "UDM", - "kpiId": "UDM.14", - "titleJson": "{\"cn\": \"LIR请求总次数\", \"en\": \"LIQ.AttLIR\"}", - "cnTitle": "LIR请求总次数", - "enTitle": "LIQ.AttLIR" - } - ], - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» cn_title|string|true|none||none| -|»» en_title|string|true|none||none| -|»» id|integer|true|none||none| -|»» kpi_id|string|true|none||none| -|»» ne_type|string|true|none||none| -|»» title_json|string|true|none||none| -|» msg|string|true|none||none| - -## GET 统计数据 - -GET /neData/kpi/data - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型| -|neId|query|string| yes ||网元ID| -|startTime|query|string| yes ||开始时间| -|endTime|query|string| yes ||结束时间| -|interval|query|number| yes ||颗粒度/平均采样值，单位秒 5 60 300 900 1800 3600| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": [ - { - "SMF.01": "1594", - "SMF.02": "1594", - "SMF.03": "1594", - "SMF.04": "1594", - "SMF.05": "1594", - "SMF.06": "1594", - "SMF.07": "1594", - "SMF.08": "1594", - "SMF.09": "1594", - "SMF.10": "1594", - "SMF.11": "1594", - "SMF.12": "1594", - "SMF.13": "1594", - "SMF.14": "797", - "neName": "0", - "startIndex": 0, - "timeGroup": "2023-09-25 00:00" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 15, - "timeGroup": "2023-09-25 00:15" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 30, - "timeGroup": "2023-09-25 00:30" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 45, - "timeGroup": "2023-09-25 00:45" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 93, - "timeGroup": "2023-09-25 01:30" - }, - { - "SMF.01": "0", - "SMF.02": "0", - "SMF.03": "0", - "SMF.04": "0", - "SMF.05": "0", - "SMF.06": "0", - "SMF.07": "0", - "SMF.08": "0", - "SMF.09": "0", - "SMF.10": "0", - "SMF.11": "0", - "SMF.12": "0", - "SMF.13": "0", - "SMF.14": "0", - "neName": "0", - "startIndex": 105, - "timeGroup": "2023-09-25 01:45" - } - ], - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|[object]|true|none||none| -|»» SMF.01|string|true|none||none| -|»» SMF.02|string|true|none||none| -|»» SMF.03|string|true|none||none| -|»» SMF.04|string|true|none||none| -|»» SMF.05|string|true|none||none| -|»» SMF.06|string|true|none||none| -|»» SMF.07|string|true|none||none| -|»» SMF.08|string|true|none||none| -|»» SMF.09|string|true|none||none| -|»» SMF.10|string|true|none||none| -|»» SMF.11|string|true|none||none| -|»» SMF.12|string|true|none||none| -|»» SMF.13|string|true|none||none| -|»» SMF.14|string|true|none||none| -|»» neName|string|true|none||none| -|»» startIndex|integer|true|none||none| -|»» timeGroup|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元数据模块/告警数据 - -## GET 告警列表 - -GET /neData/alarm/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型, 暂时支持AMF| -|neId|query|string| yes ||网元ID| -|startTime|query|string| no ||开始时间| -|endTime|query|string| no ||结束时间| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|objectType|query|string| no ||告警类型 1: Critical, 2: Major, 3: Minor, 4: Warning, 5: Event(Only VNF)| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "5", - "alarmSeq": "1", - "alarmId": "HXEMSSM10000", - "alarmTitle": "The system state is abnormal", - "neType": "AMF", - "neId": "4400HX1AMF001", - "alarmCode": 10000, - "eventTime": "2024-02-05T11:05:20Z", - "alarmType": "EquipmentAlarm", - "origSeverity": "Major", - "perceivedSeverity": "Major", - "pvFlag": "PNF", - "neName": "AMF_001", - "objectUid": "4400HX1AMF001", - "objectName": "EMS;SystemManagement;Heartbeat", - "objectType": "VNFM", - "locationInfo": "SystemManagement.State: NE heartbeat timestamp=2024-02-05 11:04:40，threshold=30", - "province": "-", - "alarmStatus": 0, - "specificProblem": "Alarm cause: the system state of target NE has not been received for 30 seconds", - "specificProblemId": "AC10000", - "addInfo": "subNeInfo:AMF", - "counter": 0, - "latestEventTime": "0001-01-01T00:00:00Z", - "ackState": 1, - "ackTime": "2024-02-05T11:05:25Z", - "ackUser": "admin", - "clearType": 1, - "clearTime": "2024-02-05T11:05:25Z", - "clearUser": "", - "timestamp": "2024-02-05T11:05:25Z" - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|false|none||none| -|»» alarmSeq|string|false|none||none| -|»» alarmId|string|false|none||none| -|»» alarmTitle|string|false|none||none| -|»» neType|string|false|none||none| -|»» neId|string|false|none||none| -|»» alarmCode|integer|false|none||none| -|»» eventTime|string|false|none||none| -|»» alarmType|string|false|none||none| -|»» origSeverity|string|false|none||none| -|»» perceivedSeverity|string|false|none||none| -|»» pvFlag|string|false|none||none| -|»» neName|string|false|none||none| -|»» objectUid|string|false|none||none| -|»» objectName|string|false|none||none| -|»» objectType|string|false|none||none| -|»» locationInfo|string|false|none||none| -|»» province|string|false|none||none| -|»» alarmStatus|integer|false|none||none| -|»» specificProblem|string|false|none||none| -|»» specificProblemId|string|false|none||none| -|»» addInfo|string|false|none||none| -|»» counter|integer|false|none||none| -|»» latestEventTime|string|false|none||none| -|»» ackState|integer|false|none||none| -|»» ackTime|string|false|none||none| -|»» ackUser|string|false|none||none| -|»» clearType|integer|false|none||none| -|»» clearTime|string|false|none||none| -|»» clearUser|string|false|none||none| -|»» timestamp|string|false|none||none| -|» total|integer|true|none||none| - -## DELETE 告警删除 - -DELETE /neData/alarm/{alarmIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|alarmIds|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元数据模块/IMS - -## GET IMS-CDR会话事件列表 - -GET /neData/ims/cdr/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型, 暂时支持IMS| -|neId|query|string| yes ||网元ID| -|recordType|query|string| no ||记录行为 MOC MTC MOSM MTSM| -|startTime|query|string| no ||开始时间 毫秒| -|endTime|query|string| no ||结束时间 毫秒| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "763", - "neType": "IMS", - "neName": "IMS_001", - "rmUID": "4400HX1IMS001", - "timestamp": 1706863363, - "cdrJSON": "{\"answerTime\":1706863363,\"callDuration\":391,\"callReference\":\"18656735160@10.25.0.210\",\"callType\":\"video\",\"calledParty\":\"18178166630\",\"callerParty\":\"13162346412\",\"cause\":200,\"fwdParty\":\"7999\",\"fwdType\":\"CFB\",\"recordType\":\"MTC\",\"releaseTime\":1706863363,\"seizureTime\":1706863363,\"seqNumber\":81,\"serviceResult\":\"ok\"}", - "createdAt": "2024-02-02T16:42:43+08:00" - }, - { - "id": "764", - "neType": "IMS", - "neName": "IMS_001", - "rmUID": "4400HX1IMS001", - "timestamp": 1706863363, - "cdrJSON": "{\"answerTime\":1706863363,\"callDuration\":707,\"callReference\":\"18112767515@10.25.0.210\",\"callType\":\"audio\",\"calledParty\":\"18175529792\",\"callerParty\":\"13953612934\",\"cause\":200,\"fwdParty\":\"7999\",\"fwdType\":\"CFB\",\"recordType\":\"MTC\",\"releaseTime\":1706863363,\"seizureTime\":1706863363,\"seqNumber\":81,\"serviceResult\":\"ok\"}", - "createdAt": "2024-02-02T16:42:43+08:00" - } - ], - "total": 8428 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neName|string|true|none||none| -|»» rmUID|string|true|none||none| -|»» timestamp|integer|true|none||none| -|»» cdrJSON|string|true|none||none| -|»» createdAt|string|true|none||none| -|» total|integer|true|none||none| - -## DELETE IMS-CDR会话删除 - -DELETE /neData/ims/cdr/{cdrIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cdrIds|path|string| yes ||多个逗号分割| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST IMS-CDR会话列表导出 - -POST /neData/ims/cdr/export - -> Body Parameters - -```json -{ - "neType": "IMS", - "neId": "001", - "recordType": "MTC,MTSM", - "callerParty": "", - "calledParty": "", - "startTime": "", - "endTime": "", - "sortField": "timestamp", - "sortOrder": "desc", - "pageNum": 1, - "pageSize": 100 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型, 暂时支持IMS| -|» neId|body|string| yes ||none| -|» recordType|body|string| no ||记录行为 MOC MTC MOSM MTSM| -|» callerParty|body|string| no ||主叫号码| -|» calledParty|body|string| yes ||被叫号码| -|» startTime|body|string| no ||none| -|» endTime|body|string| no ||none| -|» sortField|body|string| yes ||排序字段 timestamp| -|» sortOrder|body|string| yes ||排序升降序，asc desc| -|» pageNum|body|integer| yes ||none| -|» pageSize|body|integer| yes ||最大10000| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元数据模块/SMSC - -## GET SMSC-CDR会话事件列表 - -GET /neData/smsc/cdr/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型, 暂时支持SMSC| -|neId|query|string| yes ||网元ID| -|recordType|query|string| no ||记录行为 MOSM MTSM| -|startTime|query|string| no ||开始时间 毫秒| -|endTime|query|string| no ||结束时间 毫秒| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string", - "rows": [ - { - "id": "string", - "neType": "string", - "neName": "string", - "rmUID": "string", - "timestamp": 0, - "cdrJSON": "string", - "createdAt": "string" - } - ], - "total": 0 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neName|string|true|none||none| -|»» rmUID|string|true|none||none| -|»» timestamp|integer|true|none||none| -|»» cdrJSON|string|true|none||none| -|»» createdAt|string|true|none||none| -|» total|integer|true|none||none| - -## DELETE SMSC-CDR会话删除 - -DELETE /neData/smsc/cdr/{cdrIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cdrIds|path|string| yes ||多个逗号分割| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST SMSC-CDR会话列表导出 - -POST /neData/smsc/cdr/export - -> Body Parameters - -```json -{ - "neType": "SMSC", - "neId": "001", - "recordType": "MOSM,MTSM", - "callerParty": "", - "calledParty": "", - "startTime": "", - "endTime": "", - "sortField": "timestamp", - "sortOrder": "desc", - "pageNum": 1, - "pageSize": 100 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型, 暂时支持SMSC| -|» neId|body|string| yes ||none| -|» recordType|body|string| no ||记录行为 MOSM MTSM| -|» callerParty|body|string| no ||主叫号码| -|» calledParty|body|string| yes ||被叫号码| -|» startTime|body|string| no ||none| -|» endTime|body|string| no ||none| -|» sortField|body|string| yes ||排序字段 timestamp| -|» sortOrder|body|string| yes ||排序升降序，asc desc| -|» pageNum|body|integer| yes ||none| -|» pageSize|body|integer| yes ||最大10000| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元数据模块/SMF - -## GET SMF-CDR会话事件列表 - -GET /neData/smf/cdr/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型, 暂时支持SMF| -|neId|query|string| yes ||网元ID| -|subscriberID|query|string| no ||用户 IMSI| -|startTime|query|string| no ||开始时间| -|endTime|query|string| no ||结束时间| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "763", - "neType": "IMS", - "neName": "IMS_001", - "rmUID": "4400HX1IMS001", - "timestamp": 1706863363, - "cdrJSON": "{\"answerTime\":1706863363,\"callDuration\":391,\"callReference\":\"18656735160@10.25.0.210\",\"callType\":\"video\",\"calledParty\":\"18178166630\",\"callerParty\":\"13162346412\",\"cause\":200,\"fwdParty\":\"7999\",\"fwdType\":\"CFB\",\"recordType\":\"MTC\",\"releaseTime\":1706863363,\"seizureTime\":1706863363,\"seqNumber\":81,\"serviceResult\":\"ok\"}", - "createdAt": "2024-02-02T16:42:43+08:00" - }, - { - "id": "764", - "neType": "IMS", - "neName": "IMS_001", - "rmUID": "4400HX1IMS001", - "timestamp": 1706863363, - "cdrJSON": "{\"answerTime\":1706863363,\"callDuration\":707,\"callReference\":\"18112767515@10.25.0.210\",\"callType\":\"audio\",\"calledParty\":\"18175529792\",\"callerParty\":\"13953612934\",\"cause\":200,\"fwdParty\":\"7999\",\"fwdType\":\"CFB\",\"recordType\":\"MTC\",\"releaseTime\":1706863363,\"seizureTime\":1706863363,\"seqNumber\":81,\"serviceResult\":\"ok\"}", - "createdAt": "2024-02-02T16:42:43+08:00" - } - ], - "total": 8428 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neName|string|true|none||none| -|»» rmUID|string|true|none||none| -|»» timestamp|integer|true|none||none| -|»» cdrJSON|string|true|none||none| -|»» createdAt|string|true|none||none| -|» total|integer|true|none||none| - -## GET SMF-在线订阅用户列表信息 - -GET /neData/smf/subscribers - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|query|string| yes ||网元ID| -|imsi|query|string| no ||用户 IMSI| -|msisdn|query|string| no ||MSISDN| -|upstate|query|string| no ||状态 Inactive Active| -|pageNum|query|integer| no ||页数| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string", - "rows": [ - { - "imsi": "string", - "msisdn": "string", - "pduSessionInfo": [ - { - "activeTime": "string", - "dnn": "string", - "ipv4": "string", - "ipv6": "string", - "pduSessionID": 0, - "ranN3IP": "string", - "sstSD": "string", - "tai": "string", - "upState": "string", - "upfN3IP": "string" - } - ], - "ratType": "string" - } - ], - "total": 0 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» imsi|string|true|none||none| -|»» msisdn|string|true|none||none| -|»» pduSessionInfo|[object]|true|none||none| -|»»» activeTime|string|true|none||none| -|»»» dnn|string|true|none||none| -|»»» ipv4|string|true|none||none| -|»»» ipv6|string|true|none||none| -|»»» pduSessionID|integer|true|none||none| -|»»» ranN3IP|string|true|none||none| -|»»» sstSD|string|true|none||none| -|»»» tai|string|true|none||none| -|»»» upState|string|true|none||none| -|»»» upfN3IP|string|true|none||none| -|»» ratType|string|true|none||none| -|» total|integer|true|none||none| - -## DELETE SMF-CDR会话删除 - -DELETE /neData/smf/cdr/{cdrIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|cdrIds|path|string| yes ||多个逗号分割| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST SMF-CDR会话列表导出 - -POST /neData/smf/cdr/export - -> Body Parameters - -```json -{ - "neType": "SMF", - "neId": "001", - "subscriberID": "", - "startTime": "", - "endTime": "", - "sortField": "timestamp", - "sortOrder": "desc", - "pageNum": 1, - "pageSize": 100 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型, 暂时支持SMF| -|» neId|body|string| yes ||网元ID| -|» subscriberID|body|string| no ||用户 IMSI| -|» startTime|body|string| no ||开始时间 ms| -|» endTime|body|string| no ||结束时间 ms| -|» sortField|body|string| yes ||排序字段 timestamp| -|» sortOrder|body|string| yes ||排序升降序，asc desc| -|» pageNum|body|integer| yes ||none| -|» pageSize|body|integer| yes ||最大10000| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元数据模块/AMF - -## GET AMF-UE会话事件列表 - -GET /neData/amf/ue/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型, 暂时支持AMF| -|neId|query|string| yes ||网元ID| -|startTime|query|string| no ||开始时间 毫秒| -|endTime|query|string| no ||结束时间 毫秒| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|eventType|query|string| no ||事件类型 auth-result detach cm-state| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string", - "rows": [ - { - "id": "string", - "neType": "string", - "neName": "string", - "rmUID": "string", - "timestamp": 0, - "eventType": "string", - "eventJSON": "string", - "createdAt": "string" - } - ], - "total": 0 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neName|string|true|none||none| -|»» rmUID|string|true|none||none| -|»» timestamp|integer|true|none||none| -|»» eventType|string|true|none||none| -|»» eventJSON|string|true|none||none| -|»» createdAt|string|true|none||none| -|» total|integer|true|none||none| - -## DELETE AMF-UE会话删除 - -DELETE /neData/amf/ue/{ueIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|ueIds|path|string| yes ||多个逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST AMF-UE会话列表导出 - -POST /neData/amf/ue/export - -> Body Parameters - -```json -{ - "neType": "AMF", - "neId": "001", - "eventType": "auth-result", - "imsi": "", - "startTime": "", - "endTime": "", - "sortField": "timestamp", - "sortOrder": "desc", - "pageNum": 1, - "pageSize": 100 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型, 暂时支持AMF| -|» neId|body|string| yes ||none| -|» eventType|body|string| no ||事件类型 auth-result detach cm-state| -|» imsi|body|string| no ||none| -|» startTime|body|string| no ||none| -|» endTime|body|string| no ||none| -|» sortField|body|string| yes ||排序字段 timestamp| -|» sortOrder|body|string| yes ||排序升降序，asc desc| -|» pageNum|body|integer| yes ||none| -|» pageSize|body|integer| yes ||最大10000| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/网元数据模块/UPF - -## GET UPF-总流量数 N3上行 N6下行 - -GET /neData/upf/totalFlow - -单位 比特(bit) - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|query|string| yes ||网元ID| -|day|query|integer| yes ||当前时间往前的天数| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "down": null, - "up": null - }, - "msg": "success" -} -``` - -```json -{ - "code": 1, - "data": { - "down": "163341243876", - "up": "223155839712" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|object|true|none||none| -|»» down|string|true|none||none| -|»» up|string|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元数据模块/UDM鉴权用户 - -## GET UDM鉴权用户列表 - -GET /neData/udm/auth/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|query|string| no ||none| -|imsi|query|string| no ||none| -|sortField|query|string| no ||排序字段| -|sortOrder|query|string| no ||排序方式 desc asc| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "1", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "2", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "3", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "4", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "5", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "6", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "7", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "8", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "9", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - { - "id": "10", - "imsi": "", - "amf": "8000", - "status": "1", - "ki": "339c8cfe19cae8dfe094dd159fe56192b95374ba8ddff8c2", - "algoIndex": "0", - "opc": "-", - "neId": "" - } - ], - "total": 16046 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 UDM鉴权用户信息 - -GET /neData/udm/auth/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|imsi|path|string| yes ||IMSI| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|AccessToken|header|string| no ||Access token| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "3", - "imsi": "460000100014002", - "amf": "8000", - "status": "1", - "ki": "805dadc6e8a54a0d59d622c7a04d08e0", - "algoIndex": "0", - "opc": "-", - "neId": "" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 UDM鉴权用户删除 - -DELETE /neData/udm/auth/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|imsi|path|string| yes ||多个用英文逗号分割 1,2| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "460000100000030": "command ok", - "460000100000031": "command ok" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## PUT UDM鉴权用户重载数据 - -PUT /neData/udm/auth/resetData/{neId} - -清空数据库后重新从Redis加载到数据库，批量3000条同时操作。 -请检查配置的udmuser链接是否正确同步 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": 16046, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|integer|true|none||none| -|» msg|string|true|none||none| - -## POST UDM鉴权用户新增 - -POST /neData/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "0", - "amf": "8000", - "imsi": "160000100000032", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "opc": "CF7FD414E05754CFE08B4FE7F2EF2A36" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|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 - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "add fail: already exist" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT UDM鉴权用户修改 - -PUT /neData/udm/auth/{neId} - -> Body Parameters - -```json -{ - "algoIndex": "0", - "amf": "9090", - "imsi": "460000100000030", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "opc": "CF7FD414E05754CFE08B4FE7F2EF2A36" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|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 - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST UDM鉴权用户批量新增 - -POST /neData/udm/auth/{neId}/{num} - -> Body Parameters - -```json -{ - "algoIndex": "0", - "amf": "8000", - "imsi": "460000100000030", - "ki": "805DADC6E8A54A0D59D622C7A04D08E0", - "opc": "CF7FD414E05754CFE08B4FE7F2EF2A36" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|num|path|string| yes ||放号数，数量减去当前imsi| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» 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 - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## DELETE UDM鉴权用户批量删除 - -DELETE /neData/udm/auth/{neId}/{imsi}/{num} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|imsi|path|string| yes ||none| -|num|path|string| yes ||放号数，数量包含当前imsi| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": 2021, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST UDM鉴权用户导出 - -POST /neData/udm/auth/export - -> Body Parameters - -```json -{ - "neId": "001", - "type": "csv" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neId|body|string| yes ||none| -|» type|body|string| yes | csv txt|支持txt和csv文件| - -> Response Examples - -> 200 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|integer|true|none||none| - -## POST UDM鉴权用户导入 - -POST /neData/udm/auth/import - -> Body Parameters - -```json -{ - "neId": "001", - "uploadPath": "/upload/import/2024/06/omc_auth_user_export__1718260762715_634hcv.txt" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neId|body|string| yes ||网元ID| -|» uploadPath|body|string| yes ||通过上传接口得到文件路径| - -> Response Examples - -```json -{ - "code": 1, - "msg": "import ok, succ num: 36891, fail num: 1092." -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/网元数据模块/UDM签约用户 - -## GET UDM签约用户信息 - -GET /neData/udm/sub/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|imsi|path|string| yes ||IMSI| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "id": "3", - "msisdn": "8612307550990", - "imsi": "460000100000030", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "1,64,24,65,def_eps,1,2,010200000000,-", - "neId": "", - "epsFlag": "1", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "010200000000", - "staticIp": "-" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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 UDM签约用户删除 - -DELETE /neData/udm/sub/{neId}/{imsi} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|imsi|path|string| yes ||多个用英文逗号分割 1,2| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": { - "460000100000030": "command ok", - "460000100000031": "command ok" - }, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST UDM签约用户新增 - -POST /neData/udm/sub/{neId} - -此命令可同时添加45G签约用户 - -> Body Parameters - -```json -{ - "msisdn": "8612307550990", - "imsi": "460000100000030", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "64", - "epsFlag": "1", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "010200000000", - "staticIp": "201.32.49.134" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|AccessToken|header|string| no ||Access token| -|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指给4G UE分配的静态IP，没有可不带此字段名| - -> Response Examples - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## PUT UDM签约用户修改 - -PUT /neData/udm/sub/{neId} - -> Body Parameters - -```json -{ - "msisdn": "8612307550990", - "imsi": "460000100000030", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "64", - "epsFlag": "1", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "010200000000", - "staticIp": "185.62.45.170" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||none| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|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指给4G UE分配的静态IP，没有可不带此字段名| - -> Response Examples - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## POST UDM签约用户批量新增 - -POST /neData/udm/sub/{neId}/{num} - -> Body Parameters - -```json -{ - "msisdn": "8612307550990", - "imsi": "460000100000030", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "64", - "epsFlag": "1", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "010200000000", - "staticIp": "" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||none| -|num|path|string| yes ||放号数，包含当前imsi| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» 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| no ||static_ip指给4G UE分配的静态IP，没有可不带此字段名| - -> Response Examples - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## DELETE UDM签约用户批量删除 - -DELETE /neData/udm/sub/{neId}/{imsi}/{num} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||none| -|imsi|path|string| yes ||imsi| -|num|path|string| yes ||数量包含当前imsi| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": "command ok", - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» data|string|true|none||none| -|» msg|string|true|none||none| - -## POST UDM签约用户导出 - -POST /neData/udm/sub/export - -> Body Parameters - -```json -{ - "neId": "001", - "type": "txt" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neId|body|string| yes ||none| -|» type|body|string| yes | csv txt|支持txt和csv文件| - -> Response Examples - -> 200 Response - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## PUT UDM签约用户重载数据 - -PUT /neData/udm/sub/resetData/{neId} - -清空数据库后重新从Redis加载到数据库，批量2000条同时操作。 -请检查配置的udmuser链接是否正确同步 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neId|path|string| yes ||网元ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "data": 6, - "msg": "success" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» name|string|true|none|路由名称|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件|- BasicLayout-基础布局组件标识 菜单类型-菜单D
- BlankLayout-空白布局组件标识 菜单类型-菜单M
- LinkLayout-内链接布局组件标识 菜单类型-菜单M
- 按钮菜单类型-菜单B 不会读取到路由中| -|»» meta|object|true|none|元数据|none| -|»»» icon|string|true|none|菜单图标|none| -|»»» title|string|true|none|菜单标题|none| -|»»» hide|boolean|true|none|是否隐藏|默认 false| -|»»» cache|boolean|true|none|是否缓存|默认 false| -|»»» target|string¦null|true|none|链接行为|- 非链接 null
- 内部跳转 _self
- 外部跳转 _blank| -|»» redirect|string|false|none|目录重定向|none| -|»» children|[object]|false|none|子菜单|none| -|»»» name|string|true|none||none| -|»»» path|string|true|none||none| -|»»» component|string|true|none||none| -|»»» meta|object|true|none|元数据|none| -|»»»» icon|string|true|none||none| -|»»»» title|string|true|none|标题|none| -|»»»» hide|boolean|true|none||none| -|»»»» cache|boolean|true|none||none| -|»»»» target|string¦null|true|none||none| - -## POST UDM签约用户导入 - -POST /neData/udm/sub/import - -> Body Parameters - -```json -{ - "neId": "001", - "uploadPath": "/upload/import/2024/06/udm_sub_user_export__1718268308315_g4owx5.txt" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neId|body|string| yes ||网元ID| -|» uploadPath|body|string| yes ||通过上传接口得到文件路径| - -> Response Examples - -```json -{ - "code": 1, - "msg": "import ok, succ num: 3, fail num: 0." -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» data|integer|true|none||none| - -## GET UDM签约用户列表 - -GET /neData/udm/sub/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|msisdn|query|string| no ||none| -|imsi|query|string| no ||none| -|neId|query|string| no ||none| -|sortField|query|string| no ||排序字段| -|sortOrder|query|string| no ||排序方式 desc asc| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "success", - "rows": [ - { - "id": "3", - "msisdn": "8612307550990", - "imsi": "460000100000030", - "ambr": "def_ambr", - "nssai": "def_nssai", - "rat": "0", - "arfb": "def_arfb", - "sar": "def_sar", - "cn": "3", - "smData": "1-000001&cmnet&ims", - "smfSel": "def_snssai", - "epsDat": "1,64,24,65,def_eps,1,2,010200000000,-", - "neId": "", - "epsFlag": "1", - "epsOdb": "64", - "hplmnOdb": "24", - "ard": "65", - "epstpl": "def_eps", - "contextId": "1", - "apnContext": "010200000000", - "staticIp": "-" - } - ], - "total": 1 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|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| - -# 中文src目录接口/网元数据模块/MME - -## GET MME-UE会话事件列表 - -GET /neData/mme/ue/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|neType|query|string| yes ||网元类型, 暂时支持MME| -|neId|query|string| yes ||网元ID| -|startTime|query|string| no ||开始时间 毫秒| -|endTime|query|string| no ||结束时间 毫秒| -|sortField|query|string| no ||排序字段，填写结果字段| -|sortOrder|query|string| no ||排序升降序，asc desc| -|eventType|query|string| no ||事件类型 ECM STATUS, EMM STATUS| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string", - "rows": [ - { - "id": "string", - "neType": "string", - "neName": "string", - "rmUID": "string", - "timestamp": 0, - "eventType": "string", - "eventJSON": "string", - "createdAt": "string" - } - ], - "total": 0 -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| -|» rows|[object]|true|none||none| -|»» id|string|true|none||none| -|»» neType|string|true|none||none| -|»» neName|string|true|none||none| -|»» rmUID|string|true|none||none| -|»» timestamp|integer|true|none||none| -|»» eventType|string|true|none||none| -|»» eventJSON|string|true|none||none| -|»» createdAt|string|true|none||none| -|» total|integer|true|none||none| - -## DELETE MME-UE会话删除 - -DELETE /neData/mme/ue/{ueIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|ueIds|path|string| yes ||多个逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 1, - "msg": "Deleted successfully: 1" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST MME-UE会话列表导出 - -POST /neData/mme/ue/export - -> Body Parameters - -```json -{ - "neType": "MME", - "neId": "001", - "eventType": "", - "imsi": "", - "startTime": "", - "endTime": "", - "sortField": "timestamp", - "sortOrder": "desc", - "pageNum": 1, - "pageSize": 100 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» neType|body|string| yes ||网元类型, 暂时支持MME| -|» neId|body|string| yes ||none| -|» eventType|body|string| no ||事件类型 ECM STATUS, EMM STATUS| -|» imsi|body|string| no ||none| -|» startTime|body|string| no ||none| -|» endTime|body|string| no ||none| -|» sortField|body|string| yes ||排序字段 timestamp| -|» sortOrder|body|string| yes ||排序升降序，asc desc| -|» pageNum|body|integer| yes ||none| -|» pageSize|body|integer| yes ||最大10000| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# 中文src目录接口/系统模块/参数配置信息 - -## GET 参数配置列表 - -GET /system/config/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configName|query|string| no ||参数名称| -|configKey|query|string| no ||参数键名| -|configType|query|string| no ||系统内置-是Y 否N| -|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "configId": 1, - "configName": "用户管理-账号初始密码", - "configKey": "sys.user.initPassword", - "configValue": "123456", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527266", - "updateBy": "", - "updateTime": "0", - "remark": "导入用户初始化密码 123456" - }, - { - "configId": 2, - "configName": "账号自助-验证码开关", - "configKey": "sys.account.captchaEnabled", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527271", - "updateBy": "", - "updateTime": "0", - "remark": "是否开启验证码功能（true开启，false关闭）" - }, - { - "configId": 3, - "configName": "账号自助-验证码类型", - "configKey": "sys.account.captchaType", - "configValue": "math", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527277", - "updateBy": "", - "updateTime": "0", - "remark": "使用验证码类型（math数值计算，char字符验证）" - }, - { - "configId": 4, - "configName": "账号自助-是否开启用户注册功能", - "configKey": "sys.account.registerUser", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527280", - "updateBy": "maskAdmin", - "updateTime": "1683291796123", - "remark": "是否开启注册用户功能（true开启，false关闭）" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» configId|integer|true|none|配置ID|none| -|»» configName|string|true|none|配置名称|none| -|»» configKey|string|true|none|参数键名|none| -|»» configValue|string|true|none|配置值|none| -|»» configType|string|true|none|系统内置|Y是 N否| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 参数配置列表导出 - -POST /system/config/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=config_export_10_1684131509100.xlsx -content-length: 18337 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» configName|body|string| no | 参数名称|none| -|» configKey|body|string| no | 参数键名|none| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 根据参数键名取值 - -GET /system/config/configKey/{configKey} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configKey|path|string| yes ||参数键名| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": "true" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|配置值|none| - -## GET 参数配置信息 - -GET /system/config/{configId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configId|path|string| yes ||配置ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "configId": 4, - "configName": "账号自助-是否开启用户注册功能", - "configKey": "sys.account.registerUser", - "configValue": "true", - "configType": "Y", - "createBy": "maskAdmin", - "createTime": "1682264527280", - "updateBy": "maskAdmin", - "updateTime": "1683291796123", - "remark": "是否开启注册用户功能（true开启，false关闭）" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» configId|integer|true|none|配置ID|none| -|»» configName|string|true|none|配置名称|none| -|»» configKey|string|true|none|参数键名|none| -|»» configValue|string|true|none|配置值|none| -|»» configType|string|true|none|系统内置|Y是 N否| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» updateBy|string|true|none||none| -|»» updateTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 参数配置新增 - -POST /system/config - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» configName|body|string| yes | 配置名称|none| -|» configKey|body|string| yes | 参数键名|none| -|» configValue|body|string| yes | 配置值|none| -|» configType|body|string| yes | 系统内置|Y是 N否| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "参数配置新增【xxxx】失败，参数键名已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 参数配置修改 - -PUT /system/config - -> Body Parameters - -```json -{ - "configName": "string", - "configKey": "string", - "configValue": "string", - "configType": "string", - "remark": "string", - "configId": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» configName|body|string| yes | 配置名称|none| -|» configKey|body|string| yes | 参数键名|none| -|» configValue|body|string| yes | 配置值|none| -|» configType|body|string| yes | 系统内置|Y是 N否| -|» remark|body|string| yes | 备注|none| -|» configId|body|integer| yes | 配置ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问参数配置数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 根据参数键名改值 - -PUT /system/config/changeValue - -> Body Parameters - -```json -{ - "key": "sys.logo.filePathIcon", - "value": "核心网" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» key|body|string| yes ||none| -|» value|body|string| yes ||none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "参数配置新增【xxxx】失败，参数键名已存在" -} -``` - -```json -{ - "code": 1, - "msg": "success" -} -``` - -```json -{ - "code": 0, - "msg": "变更状态与旧值相等！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/config/{configIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|configIds|path|string| yes ||配置ID，多个用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "内置参数 xxx 不能删除" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 参数缓存刷新 - -PUT /system/config/refreshCache - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/部门信息 - -## GET 部门列表 - -GET /system/dept/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|status|query|string| no ||状态（0正常 1停用）| -|deptName|query|string| no ||部门名称| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "MASK科技", - "orderNum": 0, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526241" - }, - { - "deptId": "101", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广西总公司", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526245" - }, - { - "deptId": "102", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广东分公司", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526248" - }, - { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526251" - }, - { - "deptId": "104", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "市场部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526254" - }, - { - "deptId": "105", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "测试部门", - "orderNum": 3, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526257" - }, - { - "deptId": "106", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "财务部门", - "orderNum": 4, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526261" - }, - { - "deptId": "107", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "运维部门", - "orderNum": 5, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526264" - }, - { - "deptId": "108", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "市场部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526268" - }, - { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526271" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| - -## GET 部门列表（排除节点） - -GET /system/dept/list/exclude/{deptId} - -进行更新操作时，可选的上级应排除当前部门下的所有节点 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|deptId|path|string| yes ||部门编号| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "deptId": "100", - "parentId": "0", - "ancestors": "0", - "deptName": "MASK科技", - "orderNum": 0, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526241" - }, - { - "deptId": "102", - "parentId": "100", - "ancestors": "0,100", - "deptName": "广东分公司", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526248" - }, - { - "deptId": "108", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "市场部门", - "orderNum": 1, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526268" - }, - { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "delFlag": "0", - "createBy": "maskAdmin", - "createTime": "1682264526271" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| - -## GET 部门树结构列表 - -GET /system/dept/treeSelect - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|status|query|string| no ||状态（0正常 1停用）| -|deptName|query|string| no ||部门名称| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "id": "100", - "label": "MASK科技", - "children": [ - { - "id": "101", - "label": "广西总公司", - "children": [ - { - "id": "103", - "label": "研发部门", - "children": [] - }, - { - "id": "104", - "label": "市场部门", - "children": [] - }, - { - "id": "105", - "label": "测试部门", - "children": [] - }, - { - "id": "106", - "label": "财务部门", - "children": [] - }, - { - "id": "107", - "label": "运维部门", - "children": [] - } - ] - }, - { - "id": "102", - "label": "广东分公司", - "children": [ - { - "id": "108", - "label": "市场部门", - "children": [] - }, - { - "id": "109", - "label": "财务部门", - "children": [] - } - ] - } - ] - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» 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 部门树结构列表（指定角色） - -GET /system/dept/roleDeptTreeSelect/{roleId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleId|path|string| yes ||角色ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "depts": [ - { - "id": "100", - "label": "MASK科技", - "children": [ - { - "id": "101", - "label": "广西总公司", - "children": [ - { - "id": "103", - "label": "研发部门", - "children": [] - }, - { - "id": "104", - "label": "市场部门", - "children": [] - }, - { - "id": "105", - "label": "测试部门", - "children": [] - }, - { - "id": "106", - "label": "财务部门", - "children": [] - }, - { - "id": "107", - "label": "运维部门", - "children": [] - } - ] - }, - { - "id": "102", - "label": "广东分公司", - "children": [ - { - "id": "108", - "label": "市场部门", - "children": [] - }, - { - "id": "109", - "label": "财务部门", - "children": [] - } - ] - } - ] - } - ], - "checkedKeys": [] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|部门节点|none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -## POST 部门新增 - -POST /system/dept - -> Body Parameters - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» orderNum|body|integer| yes | 显示顺序|none| -|» deptName|body|string| yes | 部门名称|none| -|» leader|body|string| yes | 负责人|none| -|» phone|body|string| yes | 联系电话|none| -|» email|body|string| yes | 邮箱|none| -|» status|body|string| yes | 部门状态|0正常 1停用| -|» parentId|body|string| yes | 父部门ID|0为根节点| -|» parentName|body|string| no | 父部门名称|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "部门新增【xxx】失败，部门名称已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 部门修改 - -PUT /system/dept - -> Body Parameters - -```json -{ - "orderNum": 0, - "deptName": "string", - "leader": "string", - "phone": "string", - "email": "string", - "status": "string", - "parentId": "string", - "parentName": "string", - "deptId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» orderNum|body|integer| yes | 显示顺序|none| -|» deptName|body|string| yes | 部门名称|none| -|» leader|body|string| yes | 负责人|none| -|» phone|body|string| yes | 联系电话|none| -|» email|body|string| yes | 邮箱|none| -|» status|body|string| yes | 部门状态|0正常 1停用| -|» parentId|body|string| yes | 父部门ID|none| -|» parentName|body|string| no | 父部门名称|none| -|» deptId|body|string| yes | 部门ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问部门数据" -} -``` - -```json -{ - "code": 500, - "msg": "部门修改【拉高济查】失败，上级部门不能是自己" -} -``` - -```json -{ - "code": 500, - "msg": "该部门包含未停用的子部门！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/dept/{deptId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|deptId|path|string| yes ||部门ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问部门数据" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 部门信息 - -GET /system/dept/{deptId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|deptId|path|string| yes ||部门编号| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "deptId": "109", - "parentId": "102", - "ancestors": "0,100,102", - "deptName": "财务部门", - "orderNum": 2, - "leader": "MASK", - "phone": "15888888888", - "email": "mask@qq.com", - "status": "1", - "parentName": "广东分公司" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|部门ID|none| -|»» parentId|string|true|none|父部门ID|none| -|»» ancestors|string|true|none|祖级列表|none| -|»» deptName|string|true|none|部门名称|none| -|»» orderNum|integer|true|none|显示顺序|none| -|»» leader|string|true|none|负责人|none| -|»» phone|string|true|none|联系电话|none| -|»» email|string|true|none|邮箱|none| -|»» status|string|true|none|部门状态|0正常 1停用| -|»» parentName|string|true|none|父部门名称|none| - -# 中文src目录接口/系统模块/字典数据信息 - -## POST 字典数据列表导出 - -POST /system/dict/data/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=dict_data_export_10_1684245668586.xlsx -content-length: 18236 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "dictLabel": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dictLabel|body|string| no | 数据标签|none| -|» dictType|body|string| no | 字典类型|none| -|» status|body|string| no | 状态|0正常 1停用| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 字典数据列表 - -GET /system/dict/data/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictType|query|string| no ||字典类型| -|dictLabel|query|string| no ||数据标签| -|status|query|string| no ||状态（0正常 1停用）| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 3, - "rows": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "未知", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527109", - "remark": "性别男" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "男", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527118", - "remark": "性别女" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "女", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527126", - "remark": "性别未知" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» dictCode|string|true|none|编码ID|none| -|»» dictSort|integer|true|none|排序|none| -|»» dictLabel|string|true|none|标签名称|none| -|»» dictValue|string|true|none|标签值|none| -|»» dictType|string|true|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|true|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|true|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典数据详情 - -GET /system/dict/data/{dictCode} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictCode|path|string| yes ||编码ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "dictCode": "15", - "dictSort": 2, - "dictLabel": "公告", - "dictValue": "2", - "dictType": "sys_notice_type", - "tagClass": "", - "tagType": "processing", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527183", - "remark": "公告" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» dictCode|string|true|none|编码ID|none| -|»» dictSort|integer|true|none|排序|none| -|»» dictLabel|string|true|none|标签名称|none| -|»» dictValue|string|true|none|标签值|none| -|»» dictType|string|true|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|true|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|true|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典数据列表（指定字典类型） - -GET /system/dict/data/type/{dictType} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictType|path|string| yes ||字典类型，从字典类型列表中获取| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "dictCode": "1", - "dictSort": 1, - "dictLabel": "未知", - "dictValue": "0", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527109", - "remark": "性别男" - }, - { - "dictCode": "2", - "dictSort": 2, - "dictLabel": "男", - "dictValue": "1", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527118", - "remark": "性别女" - }, - { - "dictCode": "3", - "dictSort": 3, - "dictLabel": "女", - "dictValue": "2", - "dictType": "sys_user_sex", - "tagClass": "", - "tagType": "", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527126", - "remark": "性别未知" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» dictCode|string|false|none|编码ID|none| -|»» dictSort|integer|false|none|排序|none| -|»» dictLabel|string|false|none|标签名称|none| -|»» dictValue|string|false|none|标签值|none| -|»» dictType|string|false|none|字典类型|从字典类型列表中获取| -|»» tagClass|string|false|none|样式属性（样式扩展）|预设的class样式| -|»» tagType|string|false|none|标签类型（预设颜色）|预设数据固定项| -|»» status|string|false|none|状态|0停用 1正常| -|»» createBy|string|false|none||none| -|»» createTime|string|false|none||none| -|»» remark|string|false|none|备注|none| - -## POST 字典数据新增 - -POST /system/dict/data - -> Body Parameters - -```json -{ - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dictType|body|string| yes | 字典类型|从字典类型列表中获取| -|» dictLabel|body|string| yes | 标签名称|none| -|» dictValue|body|string| yes | 标签值|none| -|» dictSort|body|integer| yes | 排序|none| -|» tagClass|body|string| yes | 样式属性（样式扩展）|预设的class样式| -|» tagType|body|string| yes | 标签类型（预设颜色）|预设数据固定项| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "数据新增【xxxx】失败，该字典类型下标签名已存在" -} -``` - -```json -{ - "code": 500, - "msg": "数据新增【x】失败，该字典类型下标签值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 字典数据修改 - -PUT /system/dict/data - -> Body Parameters - -```json -{ - "dictCode": "string", - "dictType": "string", - "dictLabel": "string", - "dictValue": "string", - "dictSort": 0, - "tagClass": "string", - "tagType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dictCode|body|string| yes | 编码ID|none| -|» dictType|body|string| yes | 字典类型|从字典类型列表中获取| -|» dictLabel|body|string| yes | 标签名称|none| -|» dictValue|body|string| yes | 标签值|none| -|» dictSort|body|integer| yes | 排序|none| -|» tagClass|body|string| yes | 样式属性（样式扩展）|预设的class样式| -|» tagType|body|string| yes | 标签类型（预设颜色）|预设数据固定项| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典编码数据！" -} -``` - -```json -{ - "code": 500, - "msg": "数据修改【x】失败，该字典类型下标签值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "数据修改【xxxx】失败，该字典类型下标签名已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/dict/data/{dictCodes} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictCodes|path|string| yes ||字典编码ID，多个用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典编码数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/字典类型信息 - -## GET 字典类型列表 - -GET /system/dict/type/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictName|query|string| no ||名称| -|dictType|query|string| no ||类型| -|status|query|string| no ||状态（0正常 1停用）| -|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 10, - "rows": [ - { - "dictId": "1", - "dictName": "用户性别", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526985", - "remark": "用户性别列表" - }, - { - "dictId": "2", - "dictName": "菜单状态", - "dictType": "sys_show_hide", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526992", - "remark": "菜单状态列表" - }, - { - "dictId": "3", - "dictName": "系统开关", - "dictType": "sys_normal_disable", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526999", - "remark": "系统开关列表" - }, - { - "dictId": "4", - "dictName": "任务状态", - "dictType": "sys_job_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527005", - "remark": "任务状态列表" - }, - { - "dictId": "5", - "dictName": "任务分组", - "dictType": "sys_job_group", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527010", - "remark": "任务分组列表" - }, - { - "dictId": "6", - "dictName": "系统是否", - "dictType": "sys_yes_no", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527016", - "remark": "系统是否列表" - }, - { - "dictId": "7", - "dictName": "通知类型", - "dictType": "sys_notice_type", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527023", - "remark": "通知类型列表" - }, - { - "dictId": "8", - "dictName": "通知状态", - "dictType": "sys_notice_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527029", - "remark": "通知状态列表" - }, - { - "dictId": "9", - "dictName": "操作类型", - "dictType": "sys_oper_type", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527035", - "remark": "操作类型列表" - }, - { - "dictId": "10", - "dictName": "系统状态", - "dictType": "sys_common_status", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264527042", - "remark": "登录状态列表" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» dictId|string|true|none|字典ID|none| -|»» dictName|string|true|none|名称|none| -|»» dictType|string|true|none|类型|none| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 字典类型详细 - -GET /system/dict/type/{dictId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictId|path|string| yes ||字典ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "dictId": "1", - "dictName": "用户性别", - "dictType": "sys_user_sex", - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526985", - "remark": "用户性别列表" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» dictId|string|true|none|字典ID|none| -|»» dictName|string|true|none|名称|none| -|»» dictType|string|true|none|类型|none| -|»» status|string|true|none|状态|0停用 1正常| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 字典类型列表导出 - -POST /system/dict/type/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=dict_type_export_12_1684240671183.xlsx -content-length: 18246 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dictName|body|string| no | 名称|none| -|» dictType|body|string| no | 类型|none| -|» status|body|string| no | 状态|0正常 1停用| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 字典类型新增 - -POST /system/dict/type - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "status": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dictName|body|string| yes | 名称|none| -|» dictType|body|string| yes | 类型|none| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "字典新增【xxx】失败，字典名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "字典新增【xxxx】失败，字典类型已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 字典类型修改 - -PUT /system/dict/type - -> Body Parameters - -```json -{ - "dictName": "string", - "dictType": "string", - "remark": "string", - "status": "string", - "dictId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dictName|body|string| yes | 名称|none| -|» dictType|body|string| yes | 类型|none| -|» remark|body|string| yes | 备注|none| -|» status|body|string| yes | 状态|0停用 1正常| -|» dictId|body|string| no | 字典ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "字典修改【xxxx】失败，字典名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "字典修改【xxxx】失败，字典类型已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/dict/type/{dictIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|dictIds|path|string| yes ||字典ID，多个用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问字典类型数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 字典类型选择框列表 - -GET /system/dict/type/getDictOptionselect - -在字典数据中进行下拉项选择 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "label": "用户性别", - "value": "sys_user_sex" - }, - { - "label": "菜单状态", - "value": "sys_show_hide" - }, - { - "label": "系统开关", - "value": "sys_normal_disable" - }, - { - "label": "任务状态", - "value": "sys_job_status" - }, - { - "label": "任务分组", - "value": "sys_job_group" - }, - { - "label": "系统是否", - "value": "sys_yes_no" - }, - { - "label": "通知类型", - "value": "sys_notice_type" - }, - { - "label": "通知状态", - "value": "sys_notice_status" - }, - { - "label": "操作类型", - "value": "sys_oper_type" - }, - { - "label": "系统状态", - "value": "sys_common_status" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» label|string|true|none|标签名称|none| -|»» value|string|true|none|标签值|none| - -## PUT 字典类型刷新缓存 - -PUT /system/dict/type/refreshCache - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/菜单信息 - -## GET 菜单列表 - -GET /system/menu/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuName|query|string| no ||菜单名称| -|status|query|string| no ||菜单状态 0正常 1停用| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "menuId": "1", - "menuName": "系统管理", - "parentId": "0", - "menuSort": 1, - "path": "system", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526443", - "remark": "系统管理目录" - }, - { - "menuId": "2", - "menuName": "系统监控", - "parentId": "0", - "menuSort": 2, - "path": "monitor", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526448", - "remark": "系统监控目录" - }, - { - "menuId": "3", - "menuName": "系统工具", - "parentId": "0", - "menuSort": 3, - "path": "tool", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526452", - "remark": "系统工具目录" - }, - { - "menuId": "4", - "menuName": "开源仓库", - "parentId": "0", - "menuSort": 4, - "path": "https://gitee.com/TsMask", - "component": "", - "isFrame": "0", - "isCache": "0", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526456", - "remark": "开源仓库跳转外部链接打开新窗口" - }, - { - "menuId": "100", - "menuName": "用户管理", - "parentId": "1", - "menuSort": 1, - "path": "user", - "component": "system/user/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:user:list", - "icon": "#", - "createTime": "1682264526459", - "remark": "用户管理菜单" - }, - { - "menuId": "101", - "menuName": "角色管理", - "parentId": "1", - "menuSort": 2, - "path": "role", - "component": "system/role/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:role:list", - "icon": "#", - "createTime": "1682264526463", - "remark": "角色管理菜单" - }, - { - "menuId": "102", - "menuName": "分配角色", - "parentId": "1", - "menuSort": 3, - "path": "role/inline/auth-user/:roleId", - "component": "system/role/auth-user", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "system:role:auth", - "icon": "#", - "createTime": "1682264526467", - "remark": "分配角色内嵌隐藏菜单" - }, - { - "menuId": "103", - "menuName": "菜单管理", - "parentId": "1", - "menuSort": 4, - "path": "menu", - "component": "system/menu/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:menu:list", - "icon": "#", - "createTime": "1682264526471", - "remark": "菜单管理菜单" - }, - { - "menuId": "104", - "menuName": "部门管理", - "parentId": "1", - "menuSort": 5, - "path": "dept", - "component": "system/dept/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:dept:list", - "icon": "#", - "createTime": "1682264526475", - "remark": "部门管理菜单" - }, - { - "menuId": "105", - "menuName": "岗位管理", - "parentId": "1", - "menuSort": 6, - "path": "post", - "component": "system/post/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:post:list", - "icon": "#", - "createTime": "1682264526479", - "remark": "岗位管理菜单" - }, - { - "menuId": "106", - "menuName": "字典管理", - "parentId": "1", - "menuSort": 7, - "path": "dict", - "component": "system/dict/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:dict:list", - "icon": "#", - "createTime": "1682264526484", - "remark": "字典管理菜单" - }, - { - "menuId": "107", - "menuName": "字典数据", - "parentId": "1", - "menuSort": 8, - "path": "dict/inline/data/:dictId", - "component": "system/dict/data", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "system:dict:data", - "icon": "#", - "createTime": "1682264526488", - "remark": "字典数据内嵌隐藏菜单" - }, - { - "menuId": "108", - "menuName": "参数设置", - "parentId": "1", - "menuSort": 9, - "path": "config", - "component": "system/config/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:config:list", - "icon": "#", - "createTime": "1682264526491", - "remark": "参数设置菜单" - }, - { - "menuId": "109", - "menuName": "通知公告", - "parentId": "1", - "menuSort": 10, - "path": "notice", - "component": "system/notice/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:notice:list", - "icon": "#", - "createTime": "1682264526495", - "remark": "通知公告菜单" - }, - { - "menuId": "111", - "menuName": "日志管理", - "parentId": "1", - "menuSort": 11, - "path": "log", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "D", - "visible": "1", - "status": "1", - "perms": "", - "icon": "#", - "createTime": "1682264526498", - "remark": "日志管理菜单" - }, - { - "menuId": "112", - "menuName": "服务监控", - "parentId": "2", - "menuSort": 1, - "path": "server-info", - "component": "monitor/server/info", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:server:info", - "icon": "#", - "createTime": "1682264526502", - "remark": "服务监控菜单" - }, - { - "menuId": "113", - "menuName": "缓存监控", - "parentId": "2", - "menuSort": 2, - "path": "cache-info", - "component": "monitor/cache/info", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:cache:info", - "icon": "#", - "createTime": "1682264526505", - "remark": "缓存监控菜单" - }, - { - "menuId": "114", - "menuName": "缓存列表", - "parentId": "2", - "menuSort": 3, - "path": "cache", - "component": "monitor/cache/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:cache:list", - "icon": "#", - "createTime": "1682264526509", - "remark": "缓存列表菜单" - }, - { - "menuId": "115", - "menuName": "在线用户", - "parentId": "2", - "menuSort": 4, - "path": "online", - "component": "monitor/online/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:online:list", - "icon": "#", - "createTime": "1682264526513", - "remark": "在线用户菜单" - }, - { - "menuId": "116", - "menuName": "调度任务", - "parentId": "2", - "menuSort": 5, - "path": "job", - "component": "monitor/job/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:job:list", - "icon": "#", - "createTime": "1682264526517", - "remark": "调度任务菜单" - }, - { - "menuId": "117", - "menuName": "调度日志", - "parentId": "2", - "menuSort": 6, - "path": "job/inline/log/:jobId", - "component": "monitor/job/log", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "0", - "status": "1", - "perms": "monitor:job:log", - "icon": "#", - "createTime": "1682264526520", - "remark": "调度日志内嵌隐藏菜单" - }, - { - "menuId": "118", - "menuName": "系统接口", - "parentId": "3", - "menuSort": 1, - "path": "swagger", - "component": "tool/swagger/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:swagger:list", - "icon": "#", - "createTime": "1682264526524", - "remark": "系统接口菜单" - }, - { - "menuId": "1000", - "menuName": "用户查询", - "parentId": "100", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:query", - "icon": "#", - "createTime": "1682264526537", - "remark": "" - }, - { - "menuId": "1001", - "menuName": "用户新增", - "parentId": "100", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:add", - "icon": "#", - "createTime": "1682264526540", - "remark": "" - }, - { - "menuId": "1002", - "menuName": "用户修改", - "parentId": "100", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:edit", - "icon": "#", - "createTime": "1682264526545", - "remark": "" - }, - { - "menuId": "1003", - "menuName": "用户删除", - "parentId": "100", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:remove", - "icon": "#", - "createTime": "1682264526549", - "remark": "" - }, - { - "menuId": "1004", - "menuName": "用户导出", - "parentId": "100", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:export", - "icon": "#", - "createTime": "1682264526552", - "remark": "" - }, - { - "menuId": "1005", - "menuName": "用户导入", - "parentId": "100", - "menuSort": 6, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:import", - "icon": "#", - "createTime": "1682264526556", - "remark": "" - }, - { - "menuId": "1006", - "menuName": "重置密码", - "parentId": "100", - "menuSort": 7, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:user:resetPwd", - "icon": "#", - "createTime": "1682264526561", - "remark": "" - }, - { - "menuId": "1007", - "menuName": "角色查询", - "parentId": "101", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:query", - "icon": "#", - "createTime": "1682264526564", - "remark": "" - }, - { - "menuId": "1008", - "menuName": "角色新增", - "parentId": "101", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:add", - "icon": "#", - "createTime": "1682264526567", - "remark": "" - }, - { - "menuId": "1009", - "menuName": "角色修改", - "parentId": "101", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:edit", - "icon": "#", - "createTime": "1682264526571", - "remark": "" - }, - { - "menuId": "1010", - "menuName": "角色删除", - "parentId": "101", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:remove", - "icon": "#", - "createTime": "1682264526575", - "remark": "" - }, - { - "menuId": "1011", - "menuName": "角色导出", - "parentId": "101", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:role:export", - "icon": "#", - "createTime": "1682264526579", - "remark": "" - }, - { - "menuId": "1012", - "menuName": "菜单查询", - "parentId": "103", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:query", - "icon": "#", - "createTime": "1682264526583", - "remark": "" - }, - { - "menuId": "1013", - "menuName": "菜单新增", - "parentId": "103", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:add", - "icon": "#", - "createTime": "1682264526586", - "remark": "" - }, - { - "menuId": "1014", - "menuName": "菜单修改", - "parentId": "103", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:edit", - "icon": "#", - "createTime": "1682264526589", - "remark": "" - }, - { - "menuId": "1015", - "menuName": "菜单删除", - "parentId": "103", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:menu:remove", - "icon": "#", - "createTime": "1682264526592", - "remark": "" - }, - { - "menuId": "1016", - "menuName": "部门查询", - "parentId": "104", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:query", - "icon": "#", - "createTime": "1682264526595", - "remark": "" - }, - { - "menuId": "1017", - "menuName": "部门新增", - "parentId": "104", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:add", - "icon": "#", - "createTime": "1682264526598", - "remark": "" - }, - { - "menuId": "1018", - "menuName": "部门修改", - "parentId": "104", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:edit", - "icon": "#", - "createTime": "1682264526600", - "remark": "" - }, - { - "menuId": "1019", - "menuName": "部门删除", - "parentId": "104", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dept:remove", - "icon": "#", - "createTime": "1682264526603", - "remark": "" - }, - { - "menuId": "1020", - "menuName": "岗位查询", - "parentId": "105", - "menuSort": 1, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:query", - "icon": "#", - "createTime": "1682264526606", - "remark": "" - }, - { - "menuId": "1021", - "menuName": "岗位新增", - "parentId": "105", - "menuSort": 2, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:add", - "icon": "#", - "createTime": "1682264526609", - "remark": "" - }, - { - "menuId": "1022", - "menuName": "岗位修改", - "parentId": "105", - "menuSort": 3, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:edit", - "icon": "#", - "createTime": "1682264526612", - "remark": "" - }, - { - "menuId": "1023", - "menuName": "岗位删除", - "parentId": "105", - "menuSort": 4, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:remove", - "icon": "#", - "createTime": "1682264526616", - "remark": "" - }, - { - "menuId": "1024", - "menuName": "岗位导出", - "parentId": "105", - "menuSort": 5, - "path": "", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:post:export", - "icon": "#", - "createTime": "1682264526618", - "remark": "" - }, - { - "menuId": "1025", - "menuName": "字典查询", - "parentId": "106", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:query", - "icon": "#", - "createTime": "1682264526621", - "remark": "" - }, - { - "menuId": "1026", - "menuName": "字典新增", - "parentId": "106", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:add", - "icon": "#", - "createTime": "1682264526623", - "remark": "" - }, - { - "menuId": "1027", - "menuName": "字典修改", - "parentId": "106", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:edit", - "icon": "#", - "createTime": "1682264526627", - "remark": "" - }, - { - "menuId": "1028", - "menuName": "字典删除", - "parentId": "106", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:remove", - "icon": "#", - "createTime": "1682264526630", - "remark": "" - }, - { - "menuId": "1029", - "menuName": "字典导出", - "parentId": "106", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:dict:export", - "icon": "#", - "createTime": "1682264526632", - "remark": "" - }, - { - "menuId": "1030", - "menuName": "参数查询", - "parentId": "108", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:query", - "icon": "#", - "createTime": "1682264526635", - "remark": "" - }, - { - "menuId": "1031", - "menuName": "参数新增", - "parentId": "108", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:add", - "icon": "#", - "createTime": "1682264526638", - "remark": "" - }, - { - "menuId": "1032", - "menuName": "参数修改", - "parentId": "108", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:edit", - "icon": "#", - "createTime": "1682264526640", - "remark": "" - }, - { - "menuId": "1033", - "menuName": "参数删除", - "parentId": "108", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:remove", - "icon": "#", - "createTime": "1682264526643", - "remark": "" - }, - { - "menuId": "1034", - "menuName": "参数导出", - "parentId": "108", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:config:export", - "icon": "#", - "createTime": "1682264526646", - "remark": "" - }, - { - "menuId": "1035", - "menuName": "公告查询", - "parentId": "109", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:query", - "icon": "#", - "createTime": "1682264526650", - "remark": "" - }, - { - "menuId": "1036", - "menuName": "公告新增", - "parentId": "109", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:add", - "icon": "#", - "createTime": "1682264526654", - "remark": "" - }, - { - "menuId": "1037", - "menuName": "公告修改", - "parentId": "109", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:edit", - "icon": "#", - "createTime": "1682264526658", - "remark": "" - }, - { - "menuId": "1038", - "menuName": "公告删除", - "parentId": "109", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "system:notice:remove", - "icon": "#", - "createTime": "1682264526662", - "remark": "" - }, - { - "menuId": "500", - "menuName": "操作日志", - "parentId": "111", - "menuSort": 1, - "path": "operlog", - "component": "monitor/operlog/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:list", - "icon": "#", - "createTime": "1682264526528", - "remark": "操作日志菜单" - }, - { - "menuId": "501", - "menuName": "登录日志", - "parentId": "111", - "menuSort": 2, - "path": "logininfor", - "component": "monitor/logininfor/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:list", - "icon": "#", - "createTime": "1682264526532", - "remark": "登录日志菜单" - }, - { - "menuId": "1046", - "menuName": "缓存查询", - "parentId": "114", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:cache:query", - "icon": "#", - "createTime": "1682264526692", - "remark": "" - }, - { - "menuId": "1047", - "menuName": "缓存删除", - "parentId": "114", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:cache:remove", - "icon": "#", - "createTime": "1682264526696", - "remark": "" - }, - { - "menuId": "1048", - "menuName": "在线查询", - "parentId": "115", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:query", - "icon": "#", - "createTime": "1682264526700", - "remark": "" - }, - { - "menuId": "1049", - "menuName": "批量强退", - "parentId": "115", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:batchLogout", - "icon": "#", - "createTime": "1682264526704", - "remark": "" - }, - { - "menuId": "1050", - "menuName": "单条强退", - "parentId": "115", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:online:forceLogout", - "icon": "#", - "createTime": "1682264526707", - "remark": "" - }, - { - "menuId": "1051", - "menuName": "任务查询", - "parentId": "116", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:query", - "icon": "#", - "createTime": "1682264526713", - "remark": "" - }, - { - "menuId": "1052", - "menuName": "任务新增", - "parentId": "116", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:add", - "icon": "#", - "createTime": "1682264526717", - "remark": "" - }, - { - "menuId": "1053", - "menuName": "任务修改", - "parentId": "116", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:edit", - "icon": "#", - "createTime": "1682264526721", - "remark": "" - }, - { - "menuId": "1054", - "menuName": "任务删除", - "parentId": "116", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:remove", - "icon": "#", - "createTime": "1682264526725", - "remark": "" - }, - { - "menuId": "1055", - "menuName": "状态修改", - "parentId": "116", - "menuSort": 5, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:changeStatus", - "icon": "#", - "createTime": "1682264526730", - "remark": "" - }, - { - "menuId": "1056", - "menuName": "任务导出", - "parentId": "116", - "menuSort": 6, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:job:export", - "icon": "#", - "createTime": "1682264526735", - "remark": "" - }, - { - "menuId": "1039", - "menuName": "操作查询", - "parentId": "500", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:query", - "icon": "#", - "createTime": "1682264526665", - "remark": "" - }, - { - "menuId": "1040", - "menuName": "操作删除", - "parentId": "500", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:remove", - "icon": "#", - "createTime": "1682264526670", - "remark": "" - }, - { - "menuId": "1041", - "menuName": "日志导出", - "parentId": "500", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:operlog:export", - "icon": "#", - "createTime": "1682264526673", - "remark": "" - }, - { - "menuId": "1042", - "menuName": "登录查询", - "parentId": "501", - "menuSort": 1, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:query", - "icon": "#", - "createTime": "1682264526677", - "remark": "" - }, - { - "menuId": "1043", - "menuName": "登录删除", - "parentId": "501", - "menuSort": 2, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:remove", - "icon": "#", - "createTime": "1682264526681", - "remark": "" - }, - { - "menuId": "1044", - "menuName": "日志导出", - "parentId": "501", - "menuSort": 3, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:export", - "icon": "#", - "createTime": "1682264526684", - "remark": "" - }, - { - "menuId": "1045", - "menuName": "账户解锁", - "parentId": "501", - "menuSort": 4, - "path": "#", - "component": "", - "isFrame": "1", - "isCache": "1", - "menuType": "B", - "visible": "1", - "status": "1", - "perms": "monitor:logininfor:unlock", - "icon": "#", - "createTime": "1682264526688", - "remark": "" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» menuId|string|true|none|菜单ID|none| -|»» menuName|string|true|none|菜单名称|none| -|»» parentId|string|true|none|父菜单ID|none| -|»» menuSort|integer|true|none|显示顺序|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件路径|none| -|»» isFrame|string|true|none|是否内部跳转|0否 1是| -|»» isCache|string|true|none|是否缓存|0不缓存 1缓存| -|»» menuType|string|true|none|菜单类型|D目录 M菜单 B按钮| -|»» visible|string|true|none|是否显示|0隐藏 1显示| -|»» status|string|true|none|状态|0停用 1正常| -|»» perms|string|true|none|权限标识|none| -|»» icon|string|true|none|图标|无图标要#号或空字符串| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 菜单信息 - -GET /system/menu/{menuId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuId|path|string| yes ||菜单ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "menuId": "100", - "menuName": "用户管理", - "parentId": "1", - "menuSort": 1, - "path": "user", - "component": "system/user/index", - "isFrame": "1", - "isCache": "1", - "menuType": "M", - "visible": "1", - "status": "1", - "perms": "system:user:list", - "icon": "#", - "createTime": "1682264526459", - "remark": "用户管理菜单" - } -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "data": null -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» menuId|string|true|none|菜单ID|none| -|»» menuName|string|true|none|菜单名称|none| -|»» parentId|string|true|none|父菜单ID|none| -|»» menuSort|integer|true|none|显示顺序|none| -|»» path|string|true|none|路由地址|none| -|»» component|string|true|none|组件路径|none| -|»» isFrame|string|true|none|是否内部跳转|0否 1是| -|»» isCache|string|true|none|是否缓存|0不缓存 1缓存| -|»» menuType|string|true|none|菜单类型|D目录 M菜单 B按钮| -|»» visible|string|true|none|是否显示|0隐藏 1显示| -|»» status|string|true|none|状态|0停用 1正常| -|»» perms|string|true|none|权限标识|none| -|»» icon|string|true|none|图标|无图标要#号或空字符串| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## DELETE 菜单删除 - -DELETE /system/menu/{menuId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuId|path|string| yes ||菜单ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问菜单数据" -} -``` - -```json -{ - "code": 500, - "msg": "存在子菜单,不允许删除" -} -``` - -```json -{ - "code": 500, - "msg": "菜单已分配给角色,不允许删除" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 菜单修改 - -PUT /system/menu - -> Body Parameters - -```json -{ - "menuId": "string", - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» menuId|body|string| yes | 菜单ID|none| -|» parentId|body|string| yes | 父菜单ID|none| -|» menuName|body|string| yes | 菜单名称|none| -|» menuType|body|string| yes | 菜单类型|D目录 M菜单 B按钮| -|» menuSort|body|integer| yes | 显示顺序|默认0| -|» isFrame|body|string| no | 是否内部跳转|目录和菜单必传，0否 1是| -|» isCache|body|string| no | 是否缓存|目录和菜单必传，0不缓存 1缓存| -|» visible|body|string| no | 是否显示|目录和菜单必传，0隐藏 1显示| -|» status|body|string| no | 状态|目录和菜单必传，0停用 1正常| -|» icon|body|string| no | 图标|目录和菜单必传，#无图标| -|» path|body|string| no | 路由地址|目录和菜单必传| -|» component|body|string| no | 组件路径|菜单必传| -|» perms|body|string| no | 权限标识|菜单和按钮必传| -|» remark|body|string| no | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问菜单数据" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxxx】失败，非内部地址必须以http(s)://开头" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxxx】失败，菜单路由地址已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单修改【xxx】失败，菜单名称已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST 菜单新增 - -POST /system/menu - -> Body Parameters - -```json -{ - "parentId": "string", - "menuName": "string", - "menuType": "string", - "menuSort": 0, - "isFrame": "string", - "isCache": "string", - "visible": "string", - "status": "string", - "icon": "string", - "path": "string", - "component": "string", - "perms": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» parentId|body|string| yes | 父菜单ID|根据菜单ID| -|» menuName|body|string| yes | 菜单名称|none| -|» menuType|body|string| yes | 菜单类型|D目录 M菜单 B按钮| -|» menuSort|body|integer| yes | 显示顺序|默认0| -|» isFrame|body|string| no | 是否内部跳转|目录和菜单必传，0否 1是| -|» isCache|body|string| no | 是否缓存|目录和菜单必传，0不缓存 1缓存| -|» visible|body|string| no | 是否显示|目录和菜单必传，0隐藏 1显示| -|» status|body|string| no | 状态|目录和菜单必传，0停用 1正常| -|» icon|body|string| no | 图标|目录和菜单必传，#无图标| -|» path|body|string| no | 路由地址|目录和菜单必传| -|» component|body|string| no | 组件路径|菜单必传| -|» perms|body|string| no | 权限标识|菜单和按钮必传| -|» remark|body|string| no | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxx】失败，菜单路由地址已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxxx】失败，菜单名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "菜单新增【xxxx】失败，非内部地址必须以http(s)://开头" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 菜单树结构列表（指定角色） - -GET /system/menu/roleMenuTreeSelect/{roleId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleId|path|string| yes ||角色ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "menus": [ - { - "id": "1", - "label": "系统管理", - "children": [ - { - "id": "100", - "label": "用户管理", - "children": [ - { - "id": "1000", - "label": "用户查询", - "children": [] - }, - { - "id": "1001", - "label": "用户新增", - "children": [] - }, - { - "id": "1002", - "label": "用户修改", - "children": [] - }, - { - "id": "1003", - "label": "用户删除", - "children": [] - }, - { - "id": "1004", - "label": "用户导出", - "children": [] - }, - { - "id": "1005", - "label": "用户导入", - "children": [] - }, - { - "id": "1006", - "label": "重置密码", - "children": [] - } - ] - }, - { - "id": "101", - "label": "角色管理", - "children": [ - { - "id": "1007", - "label": "角色查询", - "children": [] - }, - { - "id": "1008", - "label": "角色新增", - "children": [] - }, - { - "id": "1009", - "label": "角色修改", - "children": [] - }, - { - "id": "1010", - "label": "角色删除", - "children": [] - }, - { - "id": "1011", - "label": "角色导出", - "children": [] - } - ] - }, - { - "id": "102", - "label": "分配角色", - "children": [] - }, - { - "id": "103", - "label": "菜单管理", - "children": [ - { - "id": "1012", - "label": "菜单查询", - "children": [] - }, - { - "id": "1013", - "label": "菜单新增", - "children": [] - }, - { - "id": "1014", - "label": "菜单修改", - "children": [] - }, - { - "id": "1015", - "label": "菜单删除", - "children": [] - } - ] - }, - { - "id": "104", - "label": "部门管理", - "children": [ - { - "id": "1016", - "label": "部门查询", - "children": [] - }, - { - "id": "1017", - "label": "部门新增", - "children": [] - }, - { - "id": "1018", - "label": "部门修改", - "children": [] - }, - { - "id": "1019", - "label": "部门删除", - "children": [] - } - ] - }, - { - "id": "105", - "label": "岗位管理", - "children": [ - { - "id": "1020", - "label": "岗位查询", - "children": [] - }, - { - "id": "1021", - "label": "岗位新增", - "children": [] - }, - { - "id": "1022", - "label": "岗位修改", - "children": [] - }, - { - "id": "1023", - "label": "岗位删除", - "children": [] - }, - { - "id": "1024", - "label": "岗位导出", - "children": [] - } - ] - }, - { - "id": "106", - "label": "字典管理", - "children": [ - { - "id": "1025", - "label": "字典查询", - "children": [] - }, - { - "id": "1026", - "label": "字典新增", - "children": [] - }, - { - "id": "1027", - "label": "字典修改", - "children": [] - }, - { - "id": "1028", - "label": "字典删除", - "children": [] - }, - { - "id": "1029", - "label": "字典导出", - "children": [] - } - ] - }, - { - "id": "107", - "label": "字典数据", - "children": [] - }, - { - "id": "108", - "label": "参数设置", - "children": [ - { - "id": "1030", - "label": "参数查询", - "children": [] - }, - { - "id": "1031", - "label": "参数新增", - "children": [] - }, - { - "id": "1032", - "label": "参数修改", - "children": [] - }, - { - "id": "1033", - "label": "参数删除", - "children": [] - }, - { - "id": "1034", - "label": "参数导出", - "children": [] - } - ] - }, - { - "id": "109", - "label": "通知公告", - "children": [ - { - "id": "1035", - "label": "公告查询", - "children": [] - }, - { - "id": "1036", - "label": "公告新增", - "children": [] - }, - { - "id": "1037", - "label": "公告修改", - "children": [] - }, - { - "id": "1038", - "label": "公告删除", - "children": [] - } - ] - }, - { - "id": "111", - "label": "日志管理", - "children": [ - { - "id": "500", - "label": "操作日志", - "children": [ - { - "id": "1039", - "label": "操作查询", - "children": "[Object]" - }, - { - "id": "1040", - "label": "操作删除", - "children": "[Object]" - }, - { - "id": "1041", - "label": "日志导出", - "children": "[Object]" - } - ] - }, - { - "id": "501", - "label": "登录日志", - "children": [ - { - "id": "1042", - "label": "登录查询", - "children": "[Object]" - }, - { - "id": "1043", - "label": "登录删除", - "children": "[Object]" - }, - { - "id": "1044", - "label": "日志导出", - "children": "[Object]" - }, - { - "id": "1045", - "label": "账户解锁", - "children": "[Object]" - } - ] - } - ] - } - ] - }, - { - "id": "2", - "label": "系统监控", - "children": [ - { - "id": "112", - "label": "服务监控", - "children": [] - }, - { - "id": "113", - "label": "缓存监控", - "children": [] - }, - { - "id": "114", - "label": "缓存列表", - "children": [ - { - "id": "1046", - "label": "缓存查询", - "children": [] - }, - { - "id": "1047", - "label": "缓存删除", - "children": [] - } - ] - }, - { - "id": "115", - "label": "在线用户", - "children": [ - { - "id": "1048", - "label": "在线查询", - "children": [] - }, - { - "id": "1049", - "label": "批量强退", - "children": [] - }, - { - "id": "1050", - "label": "单条强退", - "children": [] - } - ] - }, - { - "id": "116", - "label": "调度任务", - "children": [ - { - "id": "1051", - "label": "任务查询", - "children": [] - }, - { - "id": "1052", - "label": "任务新增", - "children": [] - }, - { - "id": "1053", - "label": "任务修改", - "children": [] - }, - { - "id": "1054", - "label": "任务删除", - "children": [] - }, - { - "id": "1055", - "label": "状态修改", - "children": [] - }, - { - "id": "1056", - "label": "任务导出", - "children": [] - } - ] - }, - { - "id": "117", - "label": "调度日志", - "children": [] - } - ] - }, - { - "id": "3", - "label": "系统工具", - "children": [ - { - "id": "118", - "label": "系统接口", - "children": [] - } - ] - }, - { - "id": "4", - "label": "开源仓库", - "children": [] - }, - { - "id": "2002", - "label": "备千验白儿这", - "children": [] - }, - { - "id": "2001", - "label": "要形存做情式2史", - "children": [] - } - ], - "checkedKeys": [] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» menus|[object]|true|none|菜单节点|none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -## GET 菜单树结构列表 - -GET /system/menu/treeSelect - -角色新增修改中菜单权限列表使用 - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|menuName|query|string| no ||菜单名称| -|status|query|string| no ||菜单状态 0正常 1停用| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": [ - { - "id": "1", - "label": "系统管理", - "children": [ - { - "id": "100", - "label": "用户管理", - "children": [ - { - "id": "1000", - "label": "用户查询", - "children": [] - }, - { - "id": "1001", - "label": "用户新增", - "children": [] - }, - { - "id": "1002", - "label": "用户修改", - "children": [] - }, - { - "id": "1003", - "label": "用户删除", - "children": [] - }, - { - "id": "1004", - "label": "用户导出", - "children": [] - }, - { - "id": "1005", - "label": "用户导入", - "children": [] - }, - { - "id": "1006", - "label": "重置密码", - "children": [] - } - ] - }, - { - "id": "101", - "label": "角色管理", - "children": [ - { - "id": "1007", - "label": "角色查询", - "children": [] - }, - { - "id": "1008", - "label": "角色新增", - "children": [] - }, - { - "id": "1009", - "label": "角色修改", - "children": [] - }, - { - "id": "1010", - "label": "角色删除", - "children": [] - }, - { - "id": "1011", - "label": "角色导出", - "children": [] - } - ] - }, - { - "id": "102", - "label": "分配角色", - "children": [] - }, - { - "id": "103", - "label": "菜单管理", - "children": [ - { - "id": "1012", - "label": "菜单查询", - "children": [] - }, - { - "id": "1013", - "label": "菜单新增", - "children": [] - }, - { - "id": "1014", - "label": "菜单修改", - "children": [] - }, - { - "id": "1015", - "label": "菜单删除", - "children": [] - } - ] - }, - { - "id": "104", - "label": "部门管理", - "children": [ - { - "id": "1016", - "label": "部门查询", - "children": [] - }, - { - "id": "1017", - "label": "部门新增", - "children": [] - }, - { - "id": "1018", - "label": "部门修改", - "children": [] - }, - { - "id": "1019", - "label": "部门删除", - "children": [] - } - ] - }, - { - "id": "105", - "label": "岗位管理", - "children": [ - { - "id": "1020", - "label": "岗位查询", - "children": [] - }, - { - "id": "1021", - "label": "岗位新增", - "children": [] - }, - { - "id": "1022", - "label": "岗位修改", - "children": [] - }, - { - "id": "1023", - "label": "岗位删除", - "children": [] - }, - { - "id": "1024", - "label": "岗位导出", - "children": [] - } - ] - }, - { - "id": "106", - "label": "字典管理", - "children": [ - { - "id": "1025", - "label": "字典查询", - "children": [] - }, - { - "id": "1026", - "label": "字典新增", - "children": [] - }, - { - "id": "1027", - "label": "字典修改", - "children": [] - }, - { - "id": "1028", - "label": "字典删除", - "children": [] - }, - { - "id": "1029", - "label": "字典导出", - "children": [] - } - ] - }, - { - "id": "107", - "label": "字典数据", - "children": [] - }, - { - "id": "108", - "label": "参数设置", - "children": [ - { - "id": "1030", - "label": "参数查询", - "children": [] - }, - { - "id": "1031", - "label": "参数新增", - "children": [] - }, - { - "id": "1032", - "label": "参数修改", - "children": [] - }, - { - "id": "1033", - "label": "参数删除", - "children": [] - }, - { - "id": "1034", - "label": "参数导出", - "children": [] - } - ] - }, - { - "id": "109", - "label": "通知公告", - "children": [ - { - "id": "1035", - "label": "公告查询", - "children": [] - }, - { - "id": "1036", - "label": "公告新增", - "children": [] - }, - { - "id": "1037", - "label": "公告修改", - "children": [] - }, - { - "id": "1038", - "label": "公告删除", - "children": [] - } - ] - }, - { - "id": "111", - "label": "日志管理", - "children": [ - { - "id": "500", - "label": "操作日志", - "children": [ - { - "id": "1039", - "label": "操作查询", - "children": [] - }, - { - "id": "1040", - "label": "操作删除", - "children": [] - }, - { - "id": "1041", - "label": "日志导出", - "children": [] - } - ] - }, - { - "id": "501", - "label": "登录日志", - "children": [ - { - "id": "1042", - "label": "登录查询", - "children": [] - }, - { - "id": "1043", - "label": "登录删除", - "children": [] - }, - { - "id": "1044", - "label": "日志导出", - "children": [] - }, - { - "id": "1045", - "label": "账户解锁", - "children": [] - } - ] - } - ] - } - ] - }, - { - "id": "2", - "label": "系统监控", - "children": [ - { - "id": "112", - "label": "服务监控", - "children": [] - }, - { - "id": "113", - "label": "缓存监控", - "children": [] - }, - { - "id": "114", - "label": "缓存列表", - "children": [ - { - "id": "1046", - "label": "缓存查询", - "children": [] - }, - { - "id": "1047", - "label": "缓存删除", - "children": [] - } - ] - }, - { - "id": "115", - "label": "在线用户", - "children": [ - { - "id": "1048", - "label": "在线查询", - "children": [] - }, - { - "id": "1049", - "label": "批量强退", - "children": [] - }, - { - "id": "1050", - "label": "单条强退", - "children": [] - } - ] - }, - { - "id": "116", - "label": "调度任务", - "children": [ - { - "id": "1051", - "label": "任务查询", - "children": [] - }, - { - "id": "1052", - "label": "任务新增", - "children": [] - }, - { - "id": "1053", - "label": "任务修改", - "children": [] - }, - { - "id": "1054", - "label": "任务删除", - "children": [] - }, - { - "id": "1055", - "label": "状态修改", - "children": [] - }, - { - "id": "1056", - "label": "任务导出", - "children": [] - } - ] - }, - { - "id": "117", - "label": "调度日志", - "children": [] - } - ] - }, - { - "id": "3", - "label": "系统工具", - "children": [ - { - "id": "118", - "label": "系统接口", - "children": [] - } - ] - }, - { - "id": "4", - "label": "开源仓库", - "children": [] - }, - { - "id": "2002", - "label": "备千验白儿这", - "children": [] - }, - { - "id": "2001", - "label": "要形存做情式2史", - "children": [] - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» menus|[object]|true|none||none| -|»»» id|string|true|none|ID|none| -|»»» label|string|true|none|名称|none| -|»»» children|[object]|true|none|子节点|none| -|»»»» id|string|false|none|ID|none| -|»»»» label|string|false|none|名称|none| -|»»»» children|[object]|false|none|子节点|none| -|»» checkedKeys|[object]|true|none|已选ID数组|none| - -# 中文src目录接口/系统模块/岗位信息 - -## GET 岗位列表 - -GET /system/post/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|postCode|query|string| no ||岗位编码| -|postName|query|string| no ||岗位名称| -|status|query|string| no ||状态（0正常 1停用）| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 4, - "rows": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|岗位ID|none| -|»» postCode|string|true|none|编码|none| -|»» postName|string|true|none|名称|none| -|»» postSort|integer|true|none|排序|none| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 岗位列表导出 - -POST /system/post/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=post_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "configName": "string", - "postCode": "string", - "status": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» configName|body|string| no | 岗位名称|none| -|» postCode|body|string| no | 岗位编码|none| -|» status|body|string| no | 状态|0正常 1停用| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 岗位详细 - -GET /system/post/{postId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|postId|path|string| yes ||岗位ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|岗位ID|none| -|»» postCode|string|true|none|编码|none| -|»» postName|string|true|none|名称|none| -|»» postSort|integer|true|none|排序|none| -|»» status|string|true|none|状态|none| -|»» createBy|string|true|none||none| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## POST 岗位新增 - -POST /system/post - -> Body Parameters - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": "string", - "phone": "string", - "remark": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» postCode|body|string| yes | 岗位编码|none| -|» postName|body|string| yes | 岗位名称|none| -|» postSort|body|string| yes | 排序|none| -|» phone|body|string| yes | 状态|0正常 1停用| -|» remark|body|string| yes | 备注|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "岗位新增【xxx】失败，岗位名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "岗位新增【xxx】失败，岗位编码已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 岗位修改 - -PUT /system/post - -> Body Parameters - -```json -{ - "postCode": "string", - "postName": "string", - "postSort": "string", - "phone": "string", - "remark": "string", - "postId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» postCode|body|string| yes | 岗位编码|none| -|» postName|body|string| yes | 岗位名称|none| -|» postSort|body|string| yes | 排序|none| -|» phone|body|string| yes | 状态|0正常 1停用| -|» remark|body|string| yes | 备注|none| -|» postId|body|string| yes | 岗位ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "岗位修改【xxx】失败，岗位名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "岗位修改【xxx】失败，岗位编码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/post/{postIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|postIds|path|string| yes ||岗位ID，多个用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问岗位数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/个人信息 - -## GET 基础信息获取 - -GET /system/user/profile - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": { - "roles": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "status": "1" - } - ], - "userId": "1", - "deptId": "103", - "userName": "maskAdmin", - "nickName": "管理员", - "userType": "sys", - "email": "", - "avatar": "", - "phonenumber": "", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "127.0.0.1", - "loginDate": "1683968355811", - "createBy": "maskAdmin", - "createTime": "1682264526306", - "remark": "管理员", - "dept": { - "deptId": "103", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "研发部门", - "orderNum": 1, - "leader": "MASK", - "status": "1" - } - }, - "roleGroup": [ - "管理员" - ], - "postGroup": [ - "董事长" - ] - } -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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| -|»» user|object|true|none|用户信息|none| -|»»» roles|[object]|true|none|角色信息|none| -|»»»» roleId|string|false|none||none| -|»»»» roleName|string|false|none||none| -|»»»» roleKey|string|false|none||none| -|»»»» roleSort|integer|false|none||none| -|»»»» dataScope|string|false|none||none| -|»»»» status|string|false|none||none| -|»»» userId|string|true|none||none| -|»»» deptId|string|true|none||none| -|»»» userName|string|true|none||none| -|»»» nickName|string|true|none||none| -|»»» userType|string|true|none||none| -|»»» email|string|true|none||none| -|»»» avatar|string|true|none||none| -|»»» phonenumber|string|true|none||none| -|»»» sex|string|true|none||none| -|»»» status|string|true|none||none| -|»»» delFlag|string|true|none||none| -|»»» loginIp|string|true|none||none| -|»»» loginDate|string|true|none||none| -|»»» createBy|string|true|none||none| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none||none| -|»»» dept|object|false|none|岗位|none| -|»»»» deptId|string|true|none||none| -|»»»» parentId|string|true|none||none| -|»»»» ancestors|string|true|none||none| -|»»»» deptName|string|true|none||none| -|»»»» orderNum|integer|true|none||none| -|»»»» leader|string|true|none||none| -|»»»» status|string|true|none||none| -|»» roleGroup|[string]|true|none|角色|字符数组| -|»» postGroup|[string]|true|none|岗位|字符数组| - -## PUT 基础信息修改 - -PUT /system/user/profile - -> Body Parameters - -```json -{ - "nickName": "阎秀兰", - "sex": "1", - "phonenumber": "18169338391", - "email": "t.eknevzfl@htejfppo.so" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» nickName|body|string| yes | 昵称|none| -|» email|body|string| no | 邮箱|none| -|» phonenumber|body|string| no | 手机|none| -|» sex|body|string| yes | 性别|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxxx】失败，手机号码格式错误" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 修改头像 - -POST /system/user/profile/avatar - -> Body Parameters - -```yaml -file: "" - -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» file|body|string(binary)| yes ||请选择等比大小图片作为头像，如200x200、400x400| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": "/upload/avatar/2023/04/o_1d2bofn8f19dh5s11okpje61mipg_画板1_bf3wq4h6.png" -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，仅支持以下类型：jpg,jpeg,png" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|图片地址|none| - -## PUT 修改密码 - -PUT /system/user/profile/updatePwd - -> Body Parameters - -```json -{ - "oldPassword": "admin@1234", - "newPassword": "Admin@1234" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» oldPassword|body|string| yes | 旧密码|none| -|» newPassword|body|string| yes | 新密码|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "新密码不能与旧密码相同" -} -``` - -```json -{ - "code": 500, - "msg": "修改密码失败，旧密码错误" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/角色信息 - -## GET 角色信息列表 - -GET /system/role/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleName|query|string| no ||角色名称| -|roleKey|query|string| no ||权限字符| -|status|query|string| no ||状态 0正常 1停用| -|beginTime|query|string| no ||创建时间-开始| -|endTime|query|string| no ||创建时间-结束| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 2, - "rows": [ - { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526399", - "remark": "管理员" - }, - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|角色ID|none| -|»» roleName|string|true|none|名称|none| -|»» roleKey|string|true|none|键值|none| -|»» roleSort|integer|true|none|排序|none| -|»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» status|string|true|none|角色状态|0停用 1正常| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## GET 角色分配用户列表 - -GET /system/role/authUser/allocatedList - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|query|string| no ||用户名称| -|phonenumber|query|string| no ||用户手机号| -|status|query|string| no ||用户状态| -|roleId|query|string| yes ||角色ID| -|allocated|query|string| yes ||已分配角色用户 true是 false否| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "userName": "maskUser", - "nickName": "普通用户", - "email": "maskUser@qq.com", - "phonenumber": "13412341234", - "status": "1", - "createTime": "1682264526309", - "dept": { - "deptId": "105", - "deptName": "测试部门" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|角色状态|0停用 1正常| -|»» createTime|string|false|none|创建时间|none| -|»» roles|[string]|false|none|角色ID数组|none| -|»» userId|string|false|none|用户ID|none| -|»» deptId|string|false|none|部门ID|none| -|»» userName|string|false|none|用户名称|none| -|»» nickName|string|false|none|用户昵称|none| -|»» email|string|false|none|邮箱|none| -|»» phonenumber|string|false|none|手机号|none| -|»» dept|object|false|none|部门信息|none| -|»»» deptId|string|false|none|部门ID|none| -|»»» deptName|string|false|none|部门名称|none| - -## GET 角色信息详情 - -GET /system/role/{roleId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleId|path|string| yes ||角色ID| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "roleId": "1", - "roleName": "管理员", - "roleKey": "admin", - "roleSort": 1, - "dataScope": "1", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526399", - "remark": "管理员" - } -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|角色ID|none| -|»» roleName|string|true|none|名称|none| -|»» roleKey|string|true|none|键值|none| -|»» roleSort|integer|true|none|排序|none| -|»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»» status|string|true|none|角色状态|0停用 1正常| -|»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»» createTime|string|true|none||none| -|»» remark|string|true|none|备注|none| - -## PUT 角色信息修改 - -PUT /system/role - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» roleName|body|string| yes | 名称|none| -|» roleKey|body|string| yes | 键值|none| -|» roleSort|body|integer| yes | 排序|none| -|» status|body|string| yes | 角色状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» dataScope|body|string| yes | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» menuCheckStrictly|body|string| yes | 菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| yes | 菜单权限|菜单ID数组| -|» roleId|body|string| yes | 角色ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "角色修改【xxx】失败，角色名称已存在" -} -``` - -```json -{ - "code": 500, - "msg": "角色修改【xxxx】失败，权限键值已存在" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 角色信息新增 - -POST /system/role - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "roleSort": 0, - "status": "string", - "remark": "string", - "dataScope": "string", - "menuCheckStrictly": "string", - "menuIds": [ - "string" - ] -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» roleName|body|string| yes | 名称|none| -|» roleKey|body|string| yes | 键值|none| -|» roleSort|body|integer| yes | 排序|none| -|» status|body|string| yes | 角色状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» dataScope|body|string| yes | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» menuCheckStrictly|body|string| yes | 菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| yes | 菜单权限|菜单ID数组| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "角色新增【xxxx】失败，角色名称已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## DELETE 角色信息删除 - -DELETE /system/role/{roleIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|roleIds|path|string| yes ||角色ID，多个可用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## PUT 角色状态变更 - -PUT /system/role/changeStatus - -> Body Parameters - -```json -{ - "roleId": "string", - "status": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» roleId|body|string| yes | 角色ID|none| -|» status|body|string| no | 状态|0停用 1正常| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 角色数据权限修改 - -PUT /system/role/dataScope - -> Body Parameters - -```json -{ - "dataScope": "string", - "deptCheckStrictly": "string", - "menuIds": [ - "string" - ], - "roleId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» dataScope|body|string| yes | 数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|» deptCheckStrictly|body|string| yes | 部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|» menuIds|body|[string]| no | 部门权限|数据范围选择2时必传，部门ID数组| -|» roleId|body|string| yes | 角色ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 角色列表导出 - -POST /system/role/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=role_export_16_1684133344353.xlsx -content-length: 19438 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "roleName": "string", - "roleKey": "string", - "status": "string", - "beginTime": "string", - "endTime": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» roleName|body|string| no | 角色名称|none| -|» roleKey|body|string| no | 权限字符|none| -|» status|body|string| no | 状态|0正常 1停用| -|» beginTime|body|string| no | 创建时间-开始|none| -|» endTime|body|string| no | 创建时间-结束|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 角色分配选择授权 - -PUT /system/role/authUser/checked - -> Body Parameters - -```json -{ - "roleId": "string", - "userIds": "string", - "checked": true -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» roleId|body|string| yes | 角色ID|none| -|» userIds|body|string| yes | 用户ID|多个可用英文逗号分隔| -|» checked|body|boolean| yes | 选择操作|添加true 取消false| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问角色数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/用户信息 - -## POST 用户信息列表导入模板下载 - -POST /system/user/importTemplate - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=user_import_template_1684230715497.xlsx -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{ - "code": 0, - "msg": "string" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 用户信息列表 - -GET /system/user/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|query|string| no ||用户名称| -|phonenumber|query|string| no ||手机号码| -|status|query|string| no ||状态| -|beginTime|query|string| no ||创建时间-开始| -|endTime|query|string| no ||创建时间-结束| -|deptId|query|string| no ||部门ID| -|pageNum|query|number| no ||Page number，default 1| -|pageSize|query|number| no ||Size of one page，default 10| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 1, - "rows": [ - { - "roles": [], - "userId": "2", - "deptId": "105", - "nickName": "普通用户", - "userName": "maskUser", - "email": "maskUser@qq.com", - "avatar": "", - "phonenumber": "13412341234", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.56.1", - "loginDate": "1683364764238", - "createBy": "maskAdmin", - "createTime": "1682264526309", - "remark": "普通人员", - "dept": { - "deptId": "105", - "deptName": "测试部门", - "leader": "MASK" - } - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|角色ID数组|none| -|»» userId|string|true|none|用户ID|none| -|»» deptId|string¦null|true|none|部门ID|none| -|»» nickName|string|true|none|用户昵称|none| -|»» userName|string|true|none|用户名称|none| -|»» email|string|true|none|邮箱|none| -|»» avatar|string|true|none|头像|none| -|»» phonenumber|string|true|none|电话|none| -|»» sex|string|true|none|性别|0未知 1男 2女| -|»» status|string|true|none|状态|0停用 1正常| -|»» delFlag|string|true|none|是否删除|0代表存在 1代表删除| -|»» loginIp|string|true|none|登录IP|none| -|»» loginDate|string|true|none|登录时间|none| -|»» createBy|string|true|none|创建人|none| -|»» createTime|string|true|none|创建时间|none| -|»» remark|string¦null|true|none|备注|none| -|»» dept|object|true|none|部门信息|none| -|»»» deptId|string¦null|true|none|部门ID|none| -|»»» deptName|string¦null|true|none|部门名称|none| -|»»» leader|string¦null|true|none|负责人|none| - -## GET 用户信息详情 - -GET /system/user/{userId} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userId|path|string| yes ||用户ID，新增0| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": { - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "status": "1" - } - ], - "userId": "2", - "deptId": "105", - "userName": "maskUser", - "nickName": "普通用户", - "userType": "sys", - "email": "maskUser@qq.com", - "avatar": "", - "phonenumber": "13412341234", - "sex": "1", - "status": "1", - "delFlag": "0", - "loginIp": "192.168.56.1", - "loginDate": "1683364764238", - "createBy": "maskAdmin", - "createTime": "1682264526309", - "remark": "普通人员", - "dept": { - "deptId": "105", - "parentId": "101", - "ancestors": "0,100,101", - "deptName": "测试部门", - "orderNum": 3, - "leader": "MASK", - "status": "1" - } - }, - "roleIds": [ - "2" - ], - "postIds": [ - "2" - ], - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ], - "posts": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] - } -} -``` - -```json -{ - "code": 200, - "msg": "成功", - "data": { - "user": {}, - "roleIds": [], - "postIds": [], - "roles": [ - { - "roleId": "2", - "roleName": "普通角色", - "roleKey": "common", - "roleSort": 2, - "dataScope": "2", - "menuCheckStrictly": "1", - "deptCheckStrictly": "1", - "status": "1", - "delFlag": "0", - "createTime": "1682264526404", - "remark": "普通角色" - } - ], - "posts": [ - { - "postId": "1", - "postCode": "ceo", - "postName": "董事长", - "postSort": 1, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526344", - "remark": "" - }, - { - "postId": "2", - "postCode": "se", - "postName": "项目经理", - "postSort": 2, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526348", - "remark": "" - }, - { - "postId": "3", - "postCode": "hr", - "postName": "人力资源", - "postSort": 3, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526354", - "remark": "" - }, - { - "postId": "4", - "postCode": "user", - "postName": "普通员工", - "postSort": 4, - "status": "1", - "createBy": "maskAdmin", - "createTime": "1682264526358", - "remark": "" - } - ] - } -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|用户信息|none| -|»»» roles|[object]|true|none|角色信息|none| -|»»»» roleId|string|false|none|角色ID|none| -|»»»» roleName|string|false|none|名称|none| -|»»»» roleKey|string|false|none|键值|none| -|»»»» roleSort|integer|false|none|排序|none| -|»»»» dataScope|string|false|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»»»» status|string|false|none|角色状态|0停用 1正常| -|»»» userId|string|true|none|用户ID|none| -|»»» deptId|string¦null|true|none|部门ID|none| -|»»» userName|string|true|none|用户名称|none| -|»»» nickName|string|true|none|用户昵称|none| -|»»» email|string|true|none|邮箱|none| -|»»» avatar|string|true|none|头像|none| -|»»» phonenumber|string|true|none|电话|none| -|»»» sex|string|true|none|性别|0未知 1男 2女| -|»»» status|string|true|none|状态|0停用 1正常| -|»»» delFlag|string|true|none|是否删除|0代表存在 1代表删除| -|»»» loginIp|string|true|none|登录IP|none| -|»»» loginDate|string|true|none|登录时间|none| -|»»» createBy|string|true|none|创建人|none| -|»»» createTime|string|true|none|创建时间|none| -|»»» remark|string¦null|true|none|备注|none| -|»»» dept|object|true|none|部门信息|none| -|»»»» deptId|string|true|none|部门ID|none| -|»»»» parentId|string|true|none|父部门ID|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|部门状态|0正常 1停用| -|»»»» phone|string|false|none|联系电话|none| -|»»»» email|string|false|none|邮箱|none| -|»» roleIds|[string]|true|none|已选角色ID|none| -|»» postIds|[string]|true|none|已选岗位ID|none| -|»» roles|[object]|true|none|角色信息数组|none| -|»»» roleId|string|true|none|角色ID|none| -|»»» roleName|string|true|none|名称|none| -|»»» roleKey|string|true|none|键值|none| -|»»» roleSort|integer|true|none|排序|none| -|»»» dataScope|string|true|none|数据范围|1：全部数据权限 2：自定数据权限 3：本部门数据权限 4：本部门及以下数据权限 5：仅本人数据权限）| -|»»» menuCheckStrictly|string|true|none|菜单树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»»» deptCheckStrictly|string|true|none|部门树选择项是否关联显示|0：父子不互相关联显示 1：父子互相关联显示| -|»»» status|string|true|none|角色状态|0停用 1正常| -|»»» delFlag|string|true|none|删除标志|0代表存在 1代表删除| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none|备注|none| -|»» posts|[object]|true|none|岗位信息数组|none| -|»»» postId|string|true|none|岗位ID|none| -|»»» postCode|string|true|none|编码|none| -|»»» postName|string|true|none|名称|none| -|»»» postSort|integer|true|none|排序|none| -|»»» status|string|true|none|状态|none| -|»»» createBy|string|true|none||none| -|»»» createTime|string|true|none||none| -|»»» remark|string|true|none|备注|none| - -## POST 用户信息新增 - -POST /system/user - -> Body Parameters - -```json -{ - "remark": "去只传周物给", - "deptId": 102, - "nickName": "龙杰", - "email": "h.vrcjiz@qcfgqedxw.bz", - "phonenumber": "18641692257", - "sex": "0", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 1, - 2, - 3, - 4 - ], - "userName": "gijobqebs", - "password": "123456" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» userName|body|string| yes | 用户名称|none| -|» password|body|string| yes | 用户密码|none| -|» nickName|body|string| yes | 用户昵称|none| -|» email|body|string| yes | 邮箱|none| -|» phonenumber|body|string| yes | 电话|none| -|» sex|body|string| yes | 性别|0未知 1男 2女| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» deptId|body|string| yes | 部门ID|none| -|» roleIds|body|[string]| yes | 角色ID数组|none| -|» postIds|body|[string]| yes | 岗位ID数组|none| -|» userType|body|string| no | 用户类型|sys系统用户| -|» avatar|body|string| no | 头像|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【xxxx】失败，登录账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【xxxx】失败，手机号码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "新增用户【zwciugaw2】失败，邮箱已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## PUT 用户信息修改 - -PUT /system/user - -> Body Parameters - -```json -{ - "remark": "群劳设着给王", - "deptId": 80, - "nickName": "许芳", - "email": "x.swtaf@oypeubb.tg", - "phonenumber": "18106129309", - "sex": "1", - "status": "1", - "roleIds": [ - 2 - ], - "postIds": [ - 2 - ], - "userId": "101", - "userName": "x34bvpi" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» userId|body|string| yes | 用户ID|none| -|» userName|body|string| yes | 用户名称|none| -|» nickName|body|string| yes | 用户昵称|none| -|» email|body|string| yes | 邮箱|none| -|» phonenumber|body|string| yes | 电话|none| -|» sex|body|string| yes | 性别|0未知 1男 2女| -|» status|body|string| yes | 状态|0停用 1正常| -|» remark|body|string| yes | 备注|none| -|» deptId|body|string| yes | 部门ID|none| -|» roleIds|body|[string]| yes | 角色ID数组|none| -|» postIds|body|[string]| yes | 岗位ID数组|none| -|» userType|body|string| no | 用户类型|sys系统用户| -|» avatar|body|string| no | 头像|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxx】失败，手机号码已存在" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【liming】失败，登录账号已存在" -} -``` - -```json -{ - "code": 500, - "msg": "修改用户【xxx】失败，邮箱已存在" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 用户信息列表导出 - -POST /system/user/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=user_export_11_1684230271701.xlsx -content-length: 21499 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "userName": "string", - "phonenumber": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "deptId": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» userName|body|string| no | 用户名称|none| -|» phonenumber|body|string| no | 手机号码|none| -|» status|body|string| no | 状态|0停用 1正常| -|» beginTime|body|string| no | 创建开始时间|none| -|» endTime|body|string| no | 创建结束时间|none| -|» deptId|body|string| no | 部门ID|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 用户信息列表导入 - -POST /system/user/importData - -> Body Parameters - -```yaml -file: [] -updateSupport: "{% mock 'pick' , ['false','true'] %}" - -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» file|body|string(binary)| no ||导入xls、xlsx表格文件| -|» updateSupport|body|string| no ||是否更新已经存在的数据，默认false| - -> Response Examples - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 1 条，数据如下：
序号：1 登录名称 user001 导入成功" -} -``` - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 0 条，数据如下：" -} -``` - -```json -{ - "code": 200, - "msg": "恭喜您，数据已全部导入成功！共 1 条，数据如下：
序号：1 登录名称 user001 更新成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -```json -{ - "code": 500, - "msg": "很抱歉，导入失败！共 5 条数据格式不正确，错误如下：
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称
表格中必填列表项，登录名称、用户名称" -} -``` - -```json -{ - "code": 500, - "msg": "导入用户数据不能为空！" -} -``` - -```json -{ - "code": 500, - "msg": "上传文件类型不支持，仅支持以下类型：xls,xlsx" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/user/{userIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userIds|path|string| yes ||用户ID，多个用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 用户重置密码 - -PUT /system/user/resetPwd - -> Body Parameters - -```json -{ - "password": "string", - "userId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» password|body|string| yes | 密码|none| -|» userId|body|string| yes | 用户ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 用户状态修改 - -PUT /system/user/changeStatus - -> Body Parameters - -```json -{ - "status": "string", - "userId": "string" -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» status|body|string| yes | 状态|0停用 1正常| -|» userId|body|string| yes | 用户ID|none| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "没有权限访问用户数据！" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/系统日志/操作日志信息 - -## GET 操作日志列表 - -GET /system/log/operate/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|title|query|string| no ||操作模块名称| -|operName|query|string| no ||操作人员名称| -|businessType|query|string| no ||操作类型| -|status|query|string| no ||操作状态| -|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 125, - "rows": [ - { - "operId": "224", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/17", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071705357" - }, - { - "operId": "223", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071683254" - }, - { - "operId": "222", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071682157" - }, - { - "operId": "221", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/201", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":500,\"msg\":\"失败\"}", - "status": "0", - "operTime": "1684071669833" - }, - { - "operId": "220", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/11,12,13", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071570065" - }, - { - "operId": "219", - "title": "通知公告信息", - "businessType": "3", - "method": "SysNoticeController.remove()", - "requestMethod": "DELETE", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice/7,58,96,8,45", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{}", - "operMsg": "{\"code\":500,\"msg\":\"失败\"}", - "status": "0", - "operTime": "1684071537536" - }, - { - "operId": "218", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"常员报情\",\"noticeType\":\"1\",\"noticeContent\":\"记月为认交叫次去铁亲基天会产。气深情问值约于严火更思目部光交。在目部深效五己运设接本报资。论型治感标消当期再件始军品团命院写结。\",\"status\":\"1\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071459926" - }, - { - "operId": "217", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071429311" - }, - { - "operId": "216", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071426784" - }, - { - "operId": "215", - "title": "通知公告信息", - "businessType": "1", - "method": "SysNoticeController.add()", - "requestMethod": "POST", - "operatorType": "1", - "operName": "maskAdmin", - "deptName": "研发部门", - "operUrl": "/system/notice", - "operIp": "127.0.0.1", - "operLocation": "内网IP", - "operParam": "{\"noticeTitle\":\"结西基\",\"noticeType\":\"2\",\"noticeContent\":\"运素元低角工老风三易切员火组干。任下极你部万利求听在这年。见准需东经布资张口动太领员本。引果历常高划党却分造行火九影。干强百历但所可存各拉技白广强日如定提。整次段得受都着维东转律自化。\",\"status\":\"0\"}", - "operMsg": "{\"code\":200,\"msg\":\"成功\"}", - "status": "1", - "operTime": "1684071419755" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|IP地址|none| -|»» operLocation|string|true|none|IP地区|none| -|»» operParam|string|true|none|请求参数|none| -|»» operMsg|string|true|none|操作信息|none| -|»» status|string|true|none|状态|none| -|»» operTime|string|true|none|时间|none| -|»» costTime|string|true|none|消耗时间（毫秒）|none| - -## POST 操作日志列表导出 - -POST /system/log/operate/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=operlog_export_20_1684073261184.xlsx -content-length: 36500 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "title": "string", - "operName": "string", - "businessType": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|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 | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/log/operate/clean - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/log/operate/{operIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|operIds|path|string| yes ||操作日志ID，多个可用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/系统模块/系统日志/登录访问信息 - -## GET 登录访问列表 - -GET /system/log/login/list - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|ipaddr|query|string| no ||登录地址ip| -|userName|query|string| no ||用户名称| -|status|query|string| no ||登录状态 0失败 1成功| -|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 ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功", - "total": 130, - "rows": [ - { - "infoId": "119", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683370928996" - }, - { - "infoId": "118", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683370924042" - }, - { - "infoId": "117", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683370402328" - }, - { - "infoId": "116", - "userName": "liming", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "注册成功", - "loginTime": "1683370382877" - }, - { - "infoId": "115", - "userName": "maskAdmin", - "ipaddr": "127.0.0.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683370352406" - }, - { - "infoId": "114", - "userName": "maskAdmin", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683364801882" - }, - { - "infoId": "113", - "userName": "maskUser", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683364794403" - }, - { - "infoId": "112", - "userName": "maskUser", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "登录成功", - "loginTime": "1683364764244" - }, - { - "infoId": "111", - "userName": "wangdf", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "注册成功", - "loginTime": "1683364746502" - }, - { - "infoId": "110", - "userName": "maskAdmin", - "ipaddr": "192.168.56.1", - "loginLocation": "内网IP", - "browser": "Chrome 86.0.4240.198", - "os": "Windows 10", - "status": "1", - "msg": "退出成功", - "loginTime": "1683364727385" - } - ] -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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|登录记录ID|none| -|»» userName|string|true|none|登录用户名称|none| -|»» ipaddr|string|true|none|IP地址|none| -|»» loginLocation|string|true|none|IP地区|none| -|»» browser|string|true|none|浏览器|none| -|»» os|string|true|none|操作系统|none| -|»» status|string|true|none|状态|0失败 1成功| -|»» msg|string|true|none|操作行为|none| -|»» loginTime|string|true|none|登录时间|none| - -## POST 登录访问列表导出 - -POST /system/log/login/export - -正常返回文件流，响应头如下 - -```text -content-disposition: attachment;filename=logininfor_export_124_1684076929742.xlsx -content-length: 24305 -content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet -``` - -> Body Parameters - -```json -{ - "ipaddr": "string", - "userName": "string", - "status": "string", - "beginTime": "string", - "endTime": "string", - "pageNum": 0, - "pageSize": 0 -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» ipaddr|body|string| no | 登录地址ip|none| -|» userName|body|string| no | 用户名称|none| -|» status|body|string| no | 登录状态|0失败 1成功| -|» beginTime|body|string| no | 登录开始时间|none| -|» endTime|body|string| no | 登录结束时间|none| -|» pageNum|body|number| yes | 页数，默认1|none| -|» pageSize|body|number| yes | 单页记录数，默认10|none| - -> Response Examples - -```json -{ - "code": 500, - "msg": "导出数据记录为空" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/log/login/clean - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 登录访问账户解锁 - -PUT /system/log/login/{userName} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|userName|path|string| yes ||登录用户名| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 /system/log/login/{loginIds} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|loginIds|path|string| yes ||日志ID，多个可用英文逗号分隔| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 200, - "msg": "成功" -} -``` - -```json -{ - "code": 500, - "msg": "失败" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/图表模块/G6关系图 - -## GET 获取图数据 - -GET /chart/graph - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|group|query|string| yes ||关系图组名称| -|type|query|string| no ||组内类型 | -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## POST 保存图数据 - -POST /chart/graph - -> Body Parameters - -```json -{ - "group": "neGG", - "data": { - "nodes": [ - { - "id": "AMF", - "comboId": "", - "x": -194, - "y": -147, - "type": "rect", - "size": [ - 80, - 40 - ], - "anchorPoints": false, - "style": { - "active": { - "fill": "rgb(247, 250, 255)", - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10 - }, - "selected": { - "fill": "rgb(255, 255, 255)", - "stroke": "rgb(95, 149, 255)", - "lineWidth": 4, - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10, - "text-shape": { - "fontWeight": 500 - } - }, - "highlight": { - "fill": "rgb(223, 234, 255)", - "stroke": "#4572d9", - "lineWidth": 2, - "text-shape": { - "fontWeight": 500 - } - }, - "inactive": { - "fill": "rgb(247, 250, 255)", - "stroke": "rgb(191, 213, 255)", - "lineWidth": 1 - }, - "disable": { - "fill": "rgb(250, 250, 250)", - "stroke": "rgb(224, 224, 224)", - "lineWidth": 1 - }, - "radius": 4, - "stroke": "#f33535", - "lineWidth": 1, - "cursor": "pointer", - "fill": "#902323" - }, - "label": "AMF", - "labelCfg": { - "position": "right", - "offset": 0, - "style": { - "fill": "#fff0f0", - "fontSize": 12, - "fontWeight": 500 - } - }, - "icon": { - "show": false, - "img": "/svg/service.svg", - "width": 25, - "height": 25, - "offset": 20 - }, - "direction": "up" - }, - { - "id": "SMF", - "comboId": "", - "x": -290, - "y": 32, - "type": "triangle", - "size": 30, - "anchorPoints": false, - "style": { - "active": { - "fill": "rgb(247, 250, 255)", - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10 - }, - "selected": { - "fill": "rgb(255, 255, 255)", - "stroke": "rgb(95, 149, 255)", - "lineWidth": 4, - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10, - "text-shape": { - "fontWeight": 500 - } - }, - "highlight": { - "fill": "rgb(223, 234, 255)", - "stroke": "#4572d9", - "lineWidth": 2, - "text-shape": { - "fontWeight": 500 - } - }, - "inactive": { - "fill": "rgb(247, 250, 255)", - "stroke": "rgb(191, 213, 255)", - "lineWidth": 1 - }, - "disable": { - "fill": "rgb(250, 250, 250)", - "stroke": "rgb(224, 224, 224)", - "lineWidth": 1 - }, - "radius": 4, - "stroke": "#8b3232", - "lineWidth": 1, - "cursor": "pointer", - "fill": "#7e2020" - }, - "label": "SMF", - "labelCfg": { - "position": "bottom", - "offset": 0, - "style": { - "fill": "#cc7171", - "fontSize": 12, - "fontWeight": 500 - } - }, - "direction": "up", - "icon": { - "show": false, - "img": "/svg/service.svg", - "width": 25, - "height": 25, - "offset": 20 - } - }, - { - "id": "UDM", - "comboId": "k", - "x": 165, - "y": -5, - "type": "ellipse", - "size": [ - 40, - 30 - ], - "anchorPoints": false, - "style": { - "radius": 4, - "stroke": "#52e0c9", - "lineWidth": 2, - "cursor": "pointer", - "fill": "#ffcccc" - }, - "label": "UDM", - "labelCfg": { - "position": "center", - "offset": 0, - "style": { - "fill": "#318fbf", - "fontSize": 12, - "fontWeight": 500 - } - }, - "direction": "up", - "icon": { - "show": true, - "img": "/svg/service.svg", - "width": 25, - "height": 25, - "offset": 20 - }, - "depth": 12 - }, - { - "id": "UPF", - "comboId": "k", - "x": 2, - "y": 59, - "type": "image", - "size": [ - 30, - 30 - ], - "anchorPoints": false, - "label": "UPF", - "labelCfg": { - "position": "center", - "offset": 0, - "style": { - "fill": "#b92727", - "fontSize": 12, - "fontWeight": 500 - } - }, - "direction": "up", - "icon": { - "show": true, - "img": "/svg/service.svg", - "width": 25, - "height": 25, - "offset": 20 - }, - "img": "/svg/service.svg", - "clipCfg": { - "show": true, - "width": 0, - "height": 0, - "type": "circle" - }, - "style": { - "radius": 4, - "stroke": "#ffffff", - "lineWidth": 1, - "cursor": "pointer" - }, - "depth": 11 - } - ], - "edges": [ - { - "id": "AMF~1704176260916~SMF", - "source": "AMF", - "target": "SMF", - "type": "polyline", - "style": { - "offset": 20, - "radius": 2, - "stroke": "#ffd500", - "lineWidth": 4, - "cursor": "pointer", - "active": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 1 - }, - "selected": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10, - "text-shape": { - "fontWeight": 500 - } - }, - "highlight": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "text-shape": { - "fontWeight": 500 - } - }, - "inactive": { - "stroke": "rgb(234, 234, 234)", - "lineWidth": 1 - }, - "disable": { - "stroke": "rgb(245, 245, 245)", - "lineWidth": 1 - }, - "endArrow": true - }, - "label": "3分3发", - "labelCfg": { - "refX": 0, - "refY": 0, - "position": "middle", - "autoRotate": false, - "style": { - "fill": "#e73636", - "fontSize": 12, - "fontWeight": 500 - } - }, - "startPoint": { - "x": -234.5, - "y": -147, - "anchorIndex": 0, - "id": "-234.5|||-147" - }, - "endPoint": { - "x": -275.50545794061196, - "y": 4.90120389771695, - "id": "-275.50545794061196|||4.90120389771695" - } - }, - { - "id": "AMF~1704176447324~k", - "source": "AMF", - "target": "k", - "type": "polyline", - "style": { - "active": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 1 - }, - "selected": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10, - "text-shape": { - "fontWeight": 500 - } - }, - "highlight": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "text-shape": { - "fontWeight": 500 - } - }, - "inactive": { - "stroke": "rgb(234, 234, 234)", - "lineWidth": 1 - }, - "disable": { - "stroke": "rgb(245, 245, 245)", - "lineWidth": 1 - }, - "offset": 20, - "radius": 2, - "stroke": "#ff5900", - "lineWidth": 4, - "cursor": "pointer", - "endArrow": true - }, - "label": "签文本及其配", - "labelCfg": { - "refX": 0, - "refY": 0, - "position": "middle", - "autoRotate": false, - "style": { - "fill": "#bd1f1f", - "fontSize": 12, - "fontWeight": 500 - } - }, - "isComboEdge": true, - "startPoint": { - "x": -153.5, - "y": -147, - "anchorIndex": 1, - "id": "-153.5|||-147" - }, - "endPoint": { - "x": -43.5, - "y": 26.5, - "anchorIndex": 0, - "id": "-43.5|||26.5" - } - } - ], - "combos": [ - { - "id": "k", - "type": "rect", - "size": [ - 40, - 40 - ], - "padding": [ - 30, - 30, - 30, - 30 - ], - "style": { - "active": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 1, - "fill": "rgb(247, 250, 255)" - }, - "selected": { - "stroke": "rgb(95, 149, 255)", - "lineWidth": 2, - "fill": "rgb(253, 253, 253)", - "shadowColor": "rgb(95, 149, 255)", - "shadowBlur": 10, - "text-shape": { - "fontWeight": 500 - } - }, - "highlight": { - "stroke": "#4572d9", - "lineWidth": 2, - "fill": "rgb(253, 253, 253)", - "text-shape": { - "fontWeight": 500 - } - }, - "inactive": { - "stroke": "rgb(224, 224, 224)", - "fill": "rgb(253, 253, 253)", - "lineWidth": 1 - }, - "disable": { - "stroke": "rgb(234, 234, 234)", - "fill": "rgb(250, 250, 250)", - "lineWidth": 1 - }, - "radius": 2, - "fill": "#ffffff", - "stroke": "#ffffff", - "lineWidth": 1, - "cursor": "grab", - "fillOpacity": 0.5, - "r": 99.5, - "width": 199, - "height": 95 - }, - "label": "标签文本及其配置", - "labelCfg": { - "refX": 10, - "refY": 10, - "position": "top", - "style": { - "fill": "#b93131", - "fontSize": 12, - "fontWeight": 500 - } - }, - "children": [ - { - "id": "UDM", - "comboId": "k", - "itemType": "node", - "depth": 12 - }, - { - "id": "UPF", - "comboId": "k", - "itemType": "node", - "depth": 12 - } - ], - "depth": 10, - "x": 86.5, - "y": 26.5 - } - ] - } -} -``` - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| -|body|body|object| no ||none| -|» group|body|string| yes ||none| -|» data|body|object| yes ||none| -|»» nodes|body|[object]| yes ||none| -|»»» id|body|string| yes ||none| -|»»» comboId|body|string| yes ||none| -|»»» x|body|integer| yes ||none| -|»»» y|body|integer| yes ||none| -|»»» type|body|string| yes ||none| -|»»» size|body|[integer]| yes ||none| -|»»» anchorPoints|body|boolean| yes ||none| -|»»» style|body|object| yes ||none| -|»»»» active|body|object| no ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» shadowColor|body|string| yes ||none| -|»»»»» shadowBlur|body|integer| yes ||none| -|»»»» selected|body|object| no ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» shadowColor|body|string| yes ||none| -|»»»»» shadowBlur|body|integer| yes ||none| -|»»»»» text-shape|body|object| yes ||none| -|»»»»»» fontWeight|body|integer| yes ||none| -|»»»» highlight|body|object| no ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» text-shape|body|object| yes ||none| -|»»»»»» fontWeight|body|integer| yes ||none| -|»»»» inactive|body|object| no ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» disable|body|object| no ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» radius|body|integer| yes ||none| -|»»»» stroke|body|string| yes ||none| -|»»»» lineWidth|body|integer| yes ||none| -|»»»» cursor|body|string| yes ||none| -|»»»» fill|body|string| no ||none| -|»»» label|body|string| yes ||none| -|»»» labelCfg|body|object| yes ||none| -|»»»» position|body|string| yes ||none| -|»»»» offset|body|integer| yes ||none| -|»»»» style|body|object| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» fontSize|body|integer| yes ||none| -|»»»»» fontWeight|body|integer| yes ||none| -|»»» icon|body|object| yes ||none| -|»»»» show|body|boolean| yes ||none| -|»»»» img|body|string| yes ||none| -|»»»» width|body|integer| yes ||none| -|»»»» height|body|integer| yes ||none| -|»»»» offset|body|integer| yes ||none| -|»»» direction|body|string| yes ||none| -|»»» depth|body|integer| yes ||none| -|»»» img|body|string| no ||none| -|»»» clipCfg|body|object| no ||none| -|»»»» show|body|boolean| yes ||none| -|»»»» width|body|integer| yes ||none| -|»»»» height|body|integer| yes ||none| -|»»»» type|body|string| yes ||none| -|»» edges|body|[object]| yes ||none| -|»»» id|body|string| yes ||none| -|»»» source|body|string| yes ||none| -|»»» target|body|string| yes ||none| -|»»» type|body|string| yes ||none| -|»»» style|body|object| yes ||none| -|»»»» offset|body|integer| yes ||none| -|»»»» radius|body|integer| yes ||none| -|»»»» stroke|body|string| yes ||none| -|»»»» lineWidth|body|integer| yes ||none| -|»»»» cursor|body|string| yes ||none| -|»»»» active|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» selected|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» shadowColor|body|string| yes ||none| -|»»»»» shadowBlur|body|integer| yes ||none| -|»»»»» text-shape|body|object| yes ||none| -|»»»»»» fontWeight|body|integer| yes ||none| -|»»»» highlight|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» text-shape|body|object| yes ||none| -|»»»»»» fontWeight|body|integer| yes ||none| -|»»»» inactive|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» disable|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» endArrow|body|boolean| yes ||none| -|»»» label|body|string| yes ||none| -|»»» labelCfg|body|object| yes ||none| -|»»»» refX|body|integer| yes ||none| -|»»»» refY|body|integer| yes ||none| -|»»»» position|body|string| yes ||none| -|»»»» autoRotate|body|boolean| yes ||none| -|»»»» style|body|object| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» fontSize|body|integer| yes ||none| -|»»»»» fontWeight|body|integer| yes ||none| -|»»» startPoint|body|object| yes ||none| -|»»»» x|body|number| yes ||none| -|»»»» y|body|integer| yes ||none| -|»»»» anchorIndex|body|integer| yes ||none| -|»»»» id|body|string| yes ||none| -|»»» endPoint|body|object| yes ||none| -|»»»» x|body|number| yes ||none| -|»»»» y|body|number| yes ||none| -|»»»» id|body|string| yes ||none| -|»»»» anchorIndex|body|integer| yes ||none| -|»»» isComboEdge|body|boolean| no ||none| -|»» combos|body|[object]| yes ||none| -|»»» id|body|string| no ||none| -|»»» type|body|string| no ||none| -|»»» size|body|[integer]| no ||none| -|»»» padding|body|[integer]| no ||none| -|»»» style|body|object| no ||none| -|»»»» active|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»» selected|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» shadowColor|body|string| yes ||none| -|»»»»» shadowBlur|body|integer| yes ||none| -|»»»»» text-shape|body|object| yes ||none| -|»»»»»» fontWeight|body|integer| yes ||none| -|»»»» highlight|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» text-shape|body|object| yes ||none| -|»»»»»» fontWeight|body|integer| yes ||none| -|»»»» inactive|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» disable|body|object| yes ||none| -|»»»»» stroke|body|string| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» lineWidth|body|integer| yes ||none| -|»»»» radius|body|integer| yes ||none| -|»»»» fill|body|string| yes ||none| -|»»»» stroke|body|string| yes ||none| -|»»»» lineWidth|body|integer| yes ||none| -|»»»» cursor|body|string| yes ||none| -|»»»» fillOpacity|body|number| yes ||none| -|»»»» r|body|number| yes ||none| -|»»»» width|body|integer| yes ||none| -|»»»» height|body|integer| yes ||none| -|»»» label|body|string| no ||none| -|»»» labelCfg|body|object| no ||none| -|»»»» refX|body|integer| yes ||none| -|»»»» refY|body|integer| yes ||none| -|»»»» position|body|string| yes ||none| -|»»»» style|body|object| yes ||none| -|»»»»» fill|body|string| yes ||none| -|»»»»» fontSize|body|integer| yes ||none| -|»»»»» fontWeight|body|integer| yes ||none| -|»»» children|body|[object]| no ||none| -|»»»» id|body|string| yes ||none| -|»»»» comboId|body|string| yes ||none| -|»»»» itemType|body|string| yes ||none| -|»»»» depth|body|integer| yes ||none| -|»»» depth|body|integer| no ||none| -|»»» x|body|number| no ||none| -|»»» y|body|number| no ||none| - -> Response Examples - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|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 图组名称 - -GET /chart/graph/groups - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -## DELETE 删除图组数据 - -DELETE /chart/graph/{group} - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|group|path|string| yes ||图所组名称| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -```json -{ - "code": 0, - "msg": "error" -} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -HTTP Status Code **200** - -|Name|Type|Required|Restrictions|Title|description| -|---|---|---|---|---|---| -|» code|integer|true|none||none| -|» msg|string|true|none||none| - -# 中文src目录接口/WS 模块 - -## GET 测试发送 - -GET /ws/test - -### Params - -|Name|Location|Type|Required|Title|Description| -|---|---|---|---|---|---| -|clientId|query|string| no ||ws链接得到的客户端ID| -|groupID|query|string| no ||组ID 1010| -|Authorization|header|string| yes ||Authoirzation token| -|Referer|header|string| yes ||User Referer| -|User-Agent|header|string| yes ||User Agent| -|Accept-Language|header|string| yes ||en_US;q=0.9| - -> Response Examples - -> 200 Response - -```json -{} -``` - -### Responses - -|HTTP Status Code |Meaning|Description|Data schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline| - -### Responses Data Schema - -# Data Schema - diff --git a/docs/interfaces/11-CN-NF http restful openapi swagger v1.01.json b/docs/interfaces/11-CN-NF http restful openapi swagger v1.01.json deleted file mode 100644 index 66a77b2..0000000 --- a/docs/interfaces/11-CN-NF http restful openapi swagger v1.01.json +++ /dev/null @@ -1,4801 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "OMC", - "description": "OMC HTTP Restful API Interfaces", - "version": "1.0.0" - }, - "tags": [ - { - "name": "核心网 HTTP RESTful API 服务接口" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/NEs' State" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Alarm" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/KPI report" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task Data" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/Measure Report" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Configuration" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Configuration/NE Management" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/N3IWF Online User" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/NodeB Information" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/IMS Online User" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User" - } - ], - "paths": { - "/api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms": { - "get": { - "summary": "Sync Alarms from NE", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Alarm", - "x-apifox-status": "released", - "deprecated": false, - "description": "Sync alarms from NF", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Alarm" - ], - "parameters": [ - { - "name": "elementTypeValue", - "in": "path", - "description": "网元类型", - "required": true, - "example": "smf", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "33bf9e86-2a05-8377-4619-bb01b0a8e18e", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - }, - "x-200:NULL Alarm": { - "description": "NULL Alarm", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-ignore-properties": [], - "x-apifox-orders": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807945-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/systemState": { - "get": { - "summary": "Get NE System State", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/NEs' State", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取网元系统状态信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/NEs' State" - ], - "parameters": [ - { - "name": "elementTypeValue", - "in": "path", - "description": "", - "required": true, - "example": "amf", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": false, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "description": "主机名" - }, - "osInfo": { - "type": "string", - "description": "操作系统信息" - }, - "dbInfo": { - "type": "string", - "description": "数据库信息" - }, - "ipAddr": { - "type": "array", - "items": { - "type": "string" - }, - "description": "IP地址列表" - }, - "port": { - "type": "integer", - "description": "端口" - }, - "version": { - "type": "string", - "description": "版本" - }, - "capability": { - "type": "integer", - "description": "容量" - }, - "serialNum": { - "type": "string", - "description": "序列号" - }, - "expiryDate": { - "type": "string", - "description": "过期时间" - }, - "cpuUsage": { - "type": "object", - "properties": { - "nfCpuUsage": { - "type": "integer", - "description": "网元CPU占用率" - }, - "sysCpuUsage": { - "type": "integer", - "description": "系统CPU占用率" - } - }, - "required": [ - "nfCpuUsage", - "sysCpuUsage" - ], - "x-apifox-orders": [ - "nfCpuUsage", - "sysCpuUsage" - ], - "description": "CPU占用率", - "x-apifox-ignore-properties": [] - }, - "memUsage": { - "type": "object", - "properties": { - "totalMem": { - "type": "integer", - "description": "内存数" - }, - "nfUsedMem": { - "type": "integer", - "description": "网元内存使用量" - }, - "sysMemUsage": { - "type": "integer", - "description": "系统内存使用量" - } - }, - "required": [ - "totalMem", - "nfUsedMem", - "sysMemUsage" - ], - "x-apifox-orders": [ - "totalMem", - "nfUsedMem", - "sysMemUsage" - ], - "description": "内存占用率", - "x-apifox-ignore-properties": [] - }, - "diskSpace": { - "type": "object", - "properties": { - "partitionNum": { - "type": "integer", - "description": "分区数" - }, - "partitionInfo": { - "type": "array", - "items": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "total", - "used" - ], - "x-apifox-orders": [ - "total", - "used" - ], - "x-apifox-ignore-properties": [] - }, - "description": "分区信息" - } - }, - "required": [ - "partitionNum", - "partitionInfo" - ], - "x-apifox-orders": [ - "partitionNum", - "partitionInfo" - ], - "description": "硬盘空间信息", - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "hostName", - "osInfo", - "dbInfo", - "ipAddr", - "port", - "version", - "capability", - "serialNum", - "expiryDate", - "cpuUsage", - "memUsage", - "diskSpace" - ], - "x-apifox-orders": [ - "hostName", - "osInfo", - "dbInfo", - "ipAddr", - "port", - "version", - "capability", - "serialNum", - "expiryDate", - "cpuUsage", - "memUsage", - "diskSpace" - ], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "成功示例", - "value": { - "hostName": "5GC", - "osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux", - "dbInfo": "adb v1.0.1", - "ipAddr": [ - "192.168.1.172" - ], - "port": 3030, - "version": "2.2312.8", - "capability": 100000, - "serialNum": "13740272", - "expiryDate": "2023-12-31", - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 278 - }, - "memUsage": { - "totalMem": 8167368, - "nfUsedMem": 28452, - "sysMemUsage": 923 - }, - "diskSpace": { - "partitionNum": 7, - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 200559, - "used": 16766 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ] - } - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807947-run", - "security": [] - } - }, - "/api/rest/faultManagement/v1/elementType/smf/objectType/alarms": { - "post": { - "summary": "Report Alarm from SMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Alarm", - "x-apifox-status": "released", - "deprecated": false, - "description": "", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Alarm" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "objectId": { - "type": "string" - }, - "alarmTitle": { - "type": "string" - }, - "eventTime": { - "type": "string" - }, - "alarmCode": { - "type": "integer" - }, - "alarmType": { - "type": "string" - }, - "perceivedSeverity": { - "type": "integer" - }, - "alarmStatus": { - "type": "integer" - }, - "specificProblem": { - "type": "string" - }, - "additionalText": { - "type": "string" - }, - "alarmSource": { - "type": "string" - } - }, - "required": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-orders": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807950-run", - "security": [] - } - }, - "/api/rest/faultManagement/v1/elementType/amf/objectType/alarms": { - "post": { - "summary": "Report Alarm from AMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Alarm", - "x-apifox-status": "released", - "deprecated": false, - "description": "", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Alarm" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "objectId": { - "type": "string" - }, - "alarmTitle": { - "type": "string" - }, - "eventTime": { - "type": "string" - }, - "alarmCode": { - "type": "integer" - }, - "alarmType": { - "type": "string" - }, - "perceivedSeverity": { - "type": "integer" - }, - "alarmStatus": { - "type": "integer" - }, - "specificProblem": { - "type": "string" - }, - "additionalText": { - "type": "string" - }, - "alarmSource": { - "type": "string" - } - }, - "required": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-orders": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807953-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo": { - "get": { - "summary": "Query PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "查询PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "1. IMSI和MSISDN只填一个，则以该信息查询对应记录 2. IMSI和MSISDN都不填时，查询全部 3. IMSI和MSISDN都填时，以IMSI为条件", - "required": false, - "example": "212", - "schema": { - "type": "string" - } - }, - { - "name": "msisdn", - "in": "query", - "description": "", - "required": false, - "example": "2121", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "Success", - "value": { - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] - } - }, - "2": { - "summary": "Success", - "value": { - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] - } - }, - "3": { - "summary": "Success", - "value": { - "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" - } - ] - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808016-run", - "security": [] - }, - "post": { - "summary": "Add PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "增加PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808017-run", - "security": [] - }, - "put": { - "summary": "Modify PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "修改PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": false, - "example": "212", - "schema": { - "type": "string" - } - }, - { - "name": "msisdn", - "in": "query", - "description": "", - "required": false, - "example": "2121", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808043-run", - "security": [] - }, - "delete": { - "summary": "Delete PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "删除PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": true, - "example": "212", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "404": { - "description": "Record Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cause": { - "type": "string" - }, - "status": { - "type": "integer" - } - }, - "required": [ - "cause", - "status" - ], - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "cause", - "status" - ] - }, - "examples": { - "1": { - "summary": "Success", - "value": { - "cause": "DATA_NOT_FOUND", - "status": 404 - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808045-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}": { - "post": { - "summary": "Batch Add PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "批量增加PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "number", - "in": "path", - "description": "", - "required": true, - "example": "10", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "num": 11, - "imsi": "260990100000001", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video", - "neId": "001" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808024-run", - "security": [] - }, - "put": { - "summary": "Batch Modify PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "批量修改PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "number", - "in": "path", - "description": "", - "required": true, - "example": "10", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808027-run", - "security": [] - }, - "delete": { - "summary": "Batch Delete PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "批量删除PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "number", - "in": "path", - "description": "", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "imsi", - "in": "query", - "description": "", - "required": true, - "example": "460910100000001", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "Exception", - "value": { - "cause": "no imsi", - "status": 400 - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808040-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/export": { - "get": { - "summary": "Export PCF UE Info ", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "导出PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "fileType", - "in": "query", - "description": "", - "required": true, - "example": "txt", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808038-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/import": { - "put": { - "summary": "Import PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "导入PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "filePath", - "in": "query", - "description": "", - "required": true, - "example": "/", - "schema": { - "type": "string" - } - }, - { - "name": "fileType", - "in": "query", - "description": "", - "required": true, - "example": "type", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "neId": "001", - "type": "txt", - "filePath": "xxx.txt" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "neId": { - "type": "string" - }, - "fileType": { - "type": "string" - }, - "filePath": { - "type": "string" - } - }, - "required": [ - "neId", - "fileType", - "filePath" - ], - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "neId", - "fileType", - "filePath" - ] - }, - "examples": { - "1": { - "summary": "Exception", - "value": { - "detail": "[Request Body] unexpected end of JSON input", - "status": 400, - "title": "Malformed request syntax" - } - }, - "2": { - "summary": "Success", - "value": { - "neId": "001", - "fileType": "txt", - "filePath": "/home/agtuser/PCF_001_1701420431873_zsda89.txt" - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808039-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo": { - "get": { - "summary": "Query N3IWF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/N3IWF Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "查询N3IWF在线用户信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/N3IWF Online User" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": false, - "example": "460000100000093", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "activeTime": { - "type": "string" - }, - "imsi": { - "type": "string" - }, - "nai": { - "type": "string" - }, - "regState": { - "type": "integer" - } - }, - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "activeTime", - "imsi", - "nai", - "regState" - ] - } - } - }, - "required": [ - "data" - ], - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "data" - ] - }, - "examples": { - "1": { - "summary": "Success", - "value": { - "data": [ - { - "activeTime": "2023-11-29 06:35:43", - "imsi": "460302072701181", - "nai": "0460302072701181@nai.epc.mnc030.mcc460.3gppnetwork.org", - "regState": 1 - } - ] - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808046-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo": { - "get": { - "summary": "Get NB Info from AMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/NodeB Information", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取AMF基站信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/NodeB Information" - ], - "parameters": [ - { - "name": "nbId", - "in": "query", - "description": "", - "required": true, - "example": "7", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "002", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808052-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo": { - "get": { - "summary": "Get UE Info from IMS", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/IMS Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取IMS在线用户信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/IMS Online User" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": true, - "example": "460000100000093", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808053-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo": { - "get": { - "summary": "Get UE Info from SMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取SMF在线用户信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808054-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/smf/objectType/ueNum": { - "get": { - "summary": "Get UE Number from SMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取SMF在线用户数目", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808055-run", - "security": [] - } - }, - "/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask": { - "patch": { - "summary": "Patch Measure Task", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task", - "x-apifox-status": "released", - "deprecated": false, - "description": "挂起性能测量任务", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Task" - ], - "parameters": [ - { - "name": "id", - "in": "query", - "description": "", - "required": true, - "example": "86", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808056-run", - "security": [] - }, - "delete": { - "summary": "Delete Measure Task", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task", - "x-apifox-status": "released", - "deprecated": false, - "description": "删除性能测量任务, 未激活的测量任务才可以删除", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Task" - ], - "parameters": [ - { - "name": "taskId", - "in": "query", - "description": "", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808068-run", - "security": [] - } - }, - "/api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport": { - "post": { - "summary": "Post Measure Report", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task Data", - "x-apifox-status": "released", - "deprecated": false, - "description": "性能统计任务数据报告接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Task Data" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "title": "任务ID" - }, - "TimeStamp": { - "type": "string", - "title": "时间戳" - }, - "NeName": { - "type": "string", - "title": "网元名称" - }, - "rmUID": { - "type": "string", - "title": "网元资源标识" - }, - "NeType": { - "type": "string", - "title": "网元类型" - }, - "Report": { - "type": "object", - "properties": { - "Period": { - "type": "object", - "properties": { - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "EndTime": { - "type": "string", - "title": "结束时间" - } - }, - "required": [ - "StartTime", - "EndTime" - ], - "x-apifox-orders": [ - "StartTime", - "EndTime" - ], - "title": "时间片", - "x-apifox-ignore-properties": [] - }, - "Datas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Code": { - "type": "string", - "title": "统计项类目编号" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "KPIValues": { - "type": "null", - "title": "值" - } - }, - "required": [ - "KPIID", - "KPIValues" - ], - "x-apifox-orders": [ - "KPIID", - "KPIValues" - ], - "x-apifox-ignore-properties": [] - }, - "title": "指标集" - } - }, - "required": [ - "Code", - "KPIs" - ], - "x-apifox-orders": [ - "Code", - "KPIs" - ], - "x-apifox-ignore-properties": [] - }, - "title": "数据集" - } - }, - "required": [ - "Period", - "Datas" - ], - "x-apifox-orders": [ - "Period", - "Datas" - ], - "title": "测量报告", - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "Id", - "TimeStamp", - "NeName", - "rmUID", - "NeType", - "Report" - ], - "x-apifox-orders": [ - "Id", - "TimeStamp", - "NeName", - "rmUID", - "NeType", - "Report" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "Id": 86, - "TimeStamp": "1702970580", - "NeName": "UDM_001", - "rmUID": "4400HX1UDM001", - "NeType": "UDM", - "Report": { - "Period": { - "StartTime": "2023-12-19 15: 08: 00", - "EndTime": "2023-12-19 15: 23: 00" - }, - "Datas": [ - { - "Code": "UDMHA02", - "KPIs": [ - { - "KPIID": "UDM.AmfUecmRegSucc", - "KPIValues": null - } - ] - }, - { - "Code": "UDMHA03", - "KPIs": [ - { - "KPIID": "UDM.AmfUecmRegUpdateReq", - "KPIValues": null - } - ] - }, - { - "Code": "UDMHA01", - "KPIs": [ - { - "KPIID": "UDM.AmfUecmRegReq", - "KPIValues": null - } - ] - } - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808059-run", - "security": [] - } - }, - "/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement": { - "post": { - "summary": "Post Measurement", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Report", - "x-apifox-status": "released", - "deprecated": false, - "description": "性能统计15分钟数据定时上报接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Report" - ], - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "example": "application/json", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Index": { - "type": "integer", - "title": "Index", - "description": "性能统计数据索引，取值: 0~95" - }, - "NeName": { - "type": "string", - "title": "网元名称" - }, - "RmUID": { - "type": "string", - "title": "网元资源标识" - }, - "NeType": { - "type": "string", - "title": "网络类型" - }, - "PmVersion": { - "type": "string", - "title": "PM版本号" - }, - "Dn": { - "type": "string", - "title": "数据网络名" - }, - "Period": { - "type": "string", - "title": "粒度", - "description": "15M" - }, - "TimeZone": { - "type": "string", - "title": "时区" - }, - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "Datas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ObjectType": { - "type": "string", - "title": "空间粒度" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "KPIValues": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "title": "KPI Name" - }, - "Value": { - "type": "integer", - "title": "值" - } - }, - "required": [ - "Name", - "Value" - ], - "x-apifox-orders": [ - "Name", - "Value" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "KPIID", - "KPIValues" - ], - "x-apifox-orders": [ - "KPIID", - "KPIValues" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "ObjectType", - "KPIs" - ], - "x-apifox-orders": [ - "ObjectType", - "KPIs" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-orders": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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 - } - ] - } - ] - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808060-run", - "security": [] - }, - "get": { - "summary": "Get Measurement", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Report", - "x-apifox-status": "released", - "deprecated": false, - "description": "性能统计15分钟数据补采接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Report" - ], - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "example": "application/json", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Index": { - "type": "integer", - "title": "Index", - "description": "性能统计数据索引，取值: 0~95" - }, - "NeName": { - "type": "string", - "title": "网元名称" - }, - "RmUID": { - "type": "string", - "title": "网元资源标识" - }, - "NeType": { - "type": "string", - "title": "网络类型" - }, - "PmVersion": { - "type": "string", - "title": "PM版本号" - }, - "Dn": { - "type": "string", - "title": "数据网络名" - }, - "Period": { - "type": "string", - "title": "粒度", - "description": "15M" - }, - "TimeZone": { - "type": "string", - "title": "时区" - }, - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "Datas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ObjectType": { - "type": "string", - "title": "空间粒度" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "KPIValues": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "title": "KPI Name" - }, - "Value": { - "type": "integer", - "title": "值" - } - }, - "required": [ - "Name", - "Value" - ], - "x-apifox-orders": [ - "Name", - "Value" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "KPIID", - "KPIValues" - ], - "x-apifox-orders": [ - "KPIID", - "KPIValues" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "ObjectType", - "KPIs" - ], - "x-apifox-orders": [ - "ObjectType", - "KPIs" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-orders": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808063-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/udm/objectType/config/system": { - "get": { - "summary": "Get System Parameter from UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取UDM系统参数接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "", - "required": true, - "example": "serviceIP", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "serviceIP": { - "type": "string" - }, - "servicePort": { - "type": "integer" - }, - "scheme": { - "type": "integer" - }, - "enableNrf": { - "type": "boolean" - }, - "nrfUri": { - "type": "string" - }, - "ausfIP": { - "type": "string" - }, - "fqdn": { - "type": "string" - }, - "priority": { - "type": "integer" - }, - "capacity": { - "type": "integer" - }, - "groupId": { - "type": "string" - }, - "supiRanges": { - "type": "string" - }, - "gpsiRanges": { - "type": "string" - } - }, - "x-apifox-orders": [ - "serviceIP", - "servicePort", - "scheme", - "enableNrf", - "nrfUri", - "ausfIP", - "fqdn", - "priority", - "capacity", - "groupId", - "supiRanges", - "gpsiRanges" - ], - "x-apifox-ignore-properties": [] - }, - "title": "参数数据集", - "description": "map数组，名值对，根据不同的网元和参数集" - } - }, - "x-apifox-orders": [ - "data" - ], - "required": [ - "data" - ], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808112-run", - "security": [] - }, - "put": { - "summary": "Put System Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "修改UDM参数System", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "serviceIP": { - "type": "string" - } - }, - "required": [ - "serviceIP" - ], - "x-apifox-orders": [ - "serviceIP" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "capacity": 1000, - "priority": 2 - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808119-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr": { - "get": { - "summary": "Get subsUEAmbr Parameter from UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取UDM网元subsUEAmbr参数接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808113-run", - "security": [] - }, - "post": { - "summary": "Post subsUEAmbr Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "新增表subsUEAmbr的参数列", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "参数列的定位Index", - "required": false, - "example": "2", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "title": "Index", - "description": "参数列序号" - }, - "name": { - "type": "string" - }, - "uplink": { - "type": "string" - }, - "downlink": { - "type": "string" - } - }, - "required": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-orders": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "capacity": 1000, - "priority": 2 - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808120-run", - "security": [] - }, - "delete": { - "summary": "Delete subsUEAmbr Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "删除表subsUEAmbr的参数列", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "", - "required": true, - "example": "2", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808121-run", - "security": [] - }, - "put": { - "summary": "Put subsUEAmbr Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "修改表subsUEAmbr的参数", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "", - "required": true, - "example": "2", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "uplink": { - "type": "string" - }, - "downlink": { - "type": "string" - } - }, - "required": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-orders": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "capacity": 1000, - "priority": 2 - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-134660708-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection": { - "get": { - "summary": "Get UDM smfSelection", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取UDM网元参数表smfSelection数据接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808114-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/amf/objectType/config/guami": { - "get": { - "summary": "Get IMS system param", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取IMS网元参数接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808115-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/omcNeConfig": { - "put": { - "summary": "Set NE Config Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/NE Management", - "x-apifox-status": "released", - "deprecated": false, - "description": "网元配置公共参数修改接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/NE Management" - ], - "parameters": [ - { - "name": "elementTypeValue", - "in": "path", - "description": "网元类型", - "required": true, - "example": "smf", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "dn": { - "type": "string", - "title": "资源里边的ManagedBy，性能的Dn，网络唯一标识" - }, - "province": { - "type": "string", - "title": "网元所在省份" - }, - "neId": { - "type": "string", - "title": "网元标识(内部)" - }, - "neName": { - "type": "string", - "title": "网元名称(内部)/友好名称(北向资源/性能等使用)" - }, - "pvFlag": { - "type": "string", - "title": "网元虚实性标识 VNF/PNF: 虚拟/物理" - }, - "rmUID": { - "type": "string", - "title": "rmUID 网元唯一标识" - }, - "vendorName": { - "type": "string", - "title": "厂商名称" - } - }, - "required": [ - "neId", - "neName", - "province", - "pvFlag", - "rmUID", - "vendorName", - "dn" - ], - "x-apifox-orders": [ - "dn", - "province", - "neId", - "neName", - "pvFlag", - "rmUID", - "vendorName" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "neId": "001", - "neName": "SMF_001", - "port": 3030, - "province": "-", - "pvFlag": "PNF", - "rmUID": "4400HX1SMF001", - "vendorName": "AGrandTech", - "dn": "-" - } - } - } - }, - "responses": { - "204": { - "description": "删除成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-ignore-properties": [], - "x-apifox-orders": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-134080001-run", - "security": [] - } - }, - "/api/rest/performanceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/kpiReport/{index}": { - "post": { - "summary": "上报黄金指标统计数据集", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/KPI report", - "x-apifox-status": "released", - "deprecated": false, - "description": "", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/KPI report" - ], - "parameters": [ - { - "name": "apiVersion", - "in": "path", - "description": "", - "required": true, - "example": "v1", - "schema": { - "type": "string" - } - }, - { - "name": "elementTypeValue", - "in": "path", - "description": "", - "required": true, - "example": "smf", - "schema": { - "type": "string" - } - }, - { - "name": "index", - "in": "path", - "description": "黄金指标的上报粒度是1分钟，index是当前时间片在一天中的索引，取值：0~1439", - "required": true, - "example": "111", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "TimeStamp": { - "type": "string", - "title": "时间戳", - "description": "上报时的时间戳，格式：\"2023-12-19T01:52:01Z\"" - }, - "Task": { - "type": "object", - "properties": { - "Period": { - "type": "object", - "properties": { - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "EndTime": { - "type": "string", - "title": "结束时间" - } - }, - "required": [ - "StartTime", - "EndTime" - ], - "x-apifox-orders": [ - "StartTime", - "EndTime" - ], - "title": "时间片", - "x-apifox-ignore-properties": [] - }, - "NE": { - "type": "object", - "properties": { - "NEName": { - "type": "string" - }, - "rmUID": { - "type": "string", - "title": "网元资源唯一标识" - }, - "NeType": { - "type": "string", - "title": "网元类型" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "Value": { - "type": "integer", - "title": "统计值" - }, - "Err": { - "type": "string", - "title": "错误信息" - } - }, - "required": [ - "KPIID", - "Value", - "Err" - ], - "x-apifox-orders": [ - "KPIID", - "Value", - "Err" - ], - "x-apifox-ignore-properties": [] - }, - "title": "KPI数据集", - "nullable": true - } - }, - "required": [ - "NEName", - "rmUID", - "NeType", - "KPIs" - ], - "x-apifox-orders": [ - "NEName", - "rmUID", - "NeType", - "KPIs" - ], - "title": "网元名称", - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "Period", - "NE" - ], - "x-apifox-orders": [ - "Period", - "NE" - ], - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "TimeStamp", - "Task" - ], - "x-apifox-orders": [ - "TimeStamp", - "Task" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "id": 1, - "NeType": "SMF" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-134467270-run", - "security": [] - } - } - }, - "components": { - "schemas": {}, - "securitySchemes": {} - }, - "servers": [] -} \ No newline at end of file diff --git a/docs/interfaces/11-CN-NF http restful openapi swagger v1.10.json b/docs/interfaces/11-CN-NF http restful openapi swagger v1.10.json deleted file mode 100644 index 37b642a..0000000 --- a/docs/interfaces/11-CN-NF http restful openapi swagger v1.10.json +++ /dev/null @@ -1,5058 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "OMC", - "description": "OMC HTTP Restful API Interfaces", - "version": "1.0.0" - }, - "tags": [ - { - "name": "核心网 HTTP RESTful API 服务接口" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/NEs' State" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Alarm" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/KPI report" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task Data" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Performance/Measure Report" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Configuration" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Configuration/NE Management" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/N3IWF Online User" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/NodeB Information" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/IMS Online User" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User" - }, - { - "name": "核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription" - } - ], - "paths": { - "/api/rest/faultManagement/v1/elementType/{elementTypeValue}/objectType/alarms": { - "get": { - "summary": "Sync Alarms from NE", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Alarm", - "x-apifox-status": "released", - "deprecated": false, - "description": "Sync alarms from NF", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Alarm" - ], - "parameters": [ - { - "name": "elementTypeValue", - "in": "path", - "description": "网元类型", - "required": true, - "example": "smf", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "33bf9e86-2a05-8377-4619-bb01b0a8e18e", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - }, - "x-200:NULL Alarm": { - "description": "NULL Alarm", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-ignore-properties": [], - "x-apifox-orders": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807945-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/systemState": { - "get": { - "summary": "Get NE System State", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/NEs' State", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取网元系统状态信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/NEs' State" - ], - "parameters": [ - { - "name": "elementTypeValue", - "in": "path", - "description": "", - "required": true, - "example": "omc", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": false, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "description": "主机名" - }, - "osInfo": { - "type": "string", - "description": "操作系统信息" - }, - "dbInfo": { - "type": "string", - "description": "数据库信息" - }, - "ipAddr": { - "type": "array", - "items": { - "type": "string" - }, - "description": "IP地址列表" - }, - "port": { - "type": "integer", - "description": "端口" - }, - "version": { - "type": "string", - "description": "版本" - }, - "capability": { - "type": "integer", - "description": "容量" - }, - "serialNum": { - "type": "string", - "description": "序列号" - }, - "expiryDate": { - "type": "string", - "description": "过期时间" - }, - "cpuUsage": { - "type": "object", - "properties": { - "nfCpuUsage": { - "type": "integer", - "description": "网元CPU占用率" - }, - "sysCpuUsage": { - "type": "integer", - "description": "系统CPU占用率" - } - }, - "required": [ - "nfCpuUsage", - "sysCpuUsage" - ], - "x-apifox-orders": [ - "nfCpuUsage", - "sysCpuUsage" - ], - "description": "CPU占用率", - "x-apifox-ignore-properties": [] - }, - "memUsage": { - "type": "object", - "properties": { - "totalMem": { - "type": "integer", - "description": "内存数" - }, - "nfUsedMem": { - "type": "integer", - "description": "网元内存使用量" - }, - "sysMemUsage": { - "type": "integer", - "description": "系统内存使用量" - } - }, - "required": [ - "totalMem", - "nfUsedMem", - "sysMemUsage" - ], - "x-apifox-orders": [ - "totalMem", - "nfUsedMem", - "sysMemUsage" - ], - "description": "内存占用率", - "x-apifox-ignore-properties": [] - }, - "diskSpace": { - "type": "object", - "properties": { - "partitionNum": { - "type": "integer", - "description": "分区数" - }, - "partitionInfo": { - "type": "array", - "items": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "total", - "used" - ], - "x-apifox-orders": [ - "total", - "used" - ], - "x-apifox-ignore-properties": [] - }, - "description": "分区信息" - } - }, - "required": [ - "partitionNum", - "partitionInfo" - ], - "x-apifox-orders": [ - "partitionNum", - "partitionInfo" - ], - "description": "硬盘空间信息", - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "hostName", - "osInfo", - "dbInfo", - "ipAddr", - "port", - "version", - "capability", - "serialNum", - "expiryDate", - "cpuUsage", - "memUsage", - "diskSpace" - ], - "x-apifox-orders": [ - "hostName", - "osInfo", - "dbInfo", - "ipAddr", - "port", - "version", - "capability", - "serialNum", - "expiryDate", - "cpuUsage", - "memUsage", - "diskSpace" - ], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "成功示例", - "value": { - "hostName": "5GC", - "osInfo": "Linux 5GC 4.15.0-112-generic #113-Ubuntu SMP Thu Jul 9 23:41:39 UTC 2020 x86_64 GNU/Linux", - "dbInfo": "adb v1.0.1", - "ipAddr": [ - "192.168.1.172" - ], - "port": 3030, - "version": "2.2312.8", - "capability": 100000, - "serialNum": "13740272", - "expiryDate": "2023-12-31", - "cpuUsage": { - "nfCpuUsage": 0, - "sysCpuUsage": 278 - }, - "memUsage": { - "totalMem": 8167368, - "nfUsedMem": 28452, - "sysMemUsage": 923 - }, - "diskSpace": { - "partitionNum": 7, - "partitionInfo": [ - { - "total": 3966, - "used": 0 - }, - { - "total": 797, - "used": 0 - }, - { - "total": 200559, - "used": 16766 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 5, - "used": 0 - }, - { - "total": 3987, - "used": 0 - }, - { - "total": 797, - "used": 0 - } - ] - } - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807947-run", - "security": [] - } - }, - "/api/rest/faultManagement/v1/elementType/smf/objectType/alarms": { - "post": { - "summary": "Report Alarm from SMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Alarm", - "x-apifox-status": "released", - "deprecated": false, - "description": "", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Alarm" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "objectId": { - "type": "string" - }, - "alarmTitle": { - "type": "string" - }, - "eventTime": { - "type": "string" - }, - "alarmCode": { - "type": "integer" - }, - "alarmType": { - "type": "string" - }, - "perceivedSeverity": { - "type": "integer" - }, - "alarmStatus": { - "type": "integer" - }, - "specificProblem": { - "type": "string" - }, - "additionalText": { - "type": "string" - }, - "alarmSource": { - "type": "string" - } - }, - "required": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-orders": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-ignore-properties": [] - }, - "example": [ - { - "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", - "origSeverity": "Minor" - } - ] - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807950-run", - "security": [] - } - }, - "/api/rest/faultManagement/v1/elementType/amf/objectType/alarms": { - "post": { - "summary": "Report Alarm from AMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Alarm", - "x-apifox-status": "released", - "deprecated": false, - "description": "", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Alarm" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "objectId": { - "type": "string" - }, - "alarmTitle": { - "type": "string" - }, - "eventTime": { - "type": "string" - }, - "alarmCode": { - "type": "integer" - }, - "alarmType": { - "type": "string" - }, - "perceivedSeverity": { - "type": "integer" - }, - "alarmStatus": { - "type": "integer" - }, - "specificProblem": { - "type": "string" - }, - "additionalText": { - "type": "string" - }, - "alarmSource": { - "type": "string" - } - }, - "required": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-orders": [ - "objectId", - "alarmTitle", - "eventTime", - "alarmCode", - "alarmType", - "perceivedSeverity", - "alarmStatus", - "specificProblem", - "additionalText", - "alarmSource" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130807953-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo": { - "get": { - "summary": "Query PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "查询PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "1. IMSI和MSISDN只填一个，则以该信息查询对应记录 2. IMSI和MSISDN都不填时，查询全部 3. IMSI和MSISDN都填时，以IMSI为条件", - "required": false, - "example": "212", - "schema": { - "type": "string" - } - }, - { - "name": "msisdn", - "in": "query", - "description": "", - "required": false, - "example": "2121", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "Success", - "value": { - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] - } - }, - "2": { - "summary": "Success", - "value": { - "data": [ - { - "msisdn": "12307550237", - "pccRules": "internet", - "rfsp": 0, - "sessRules": "internet" - }, - { - "msisdn": "12307550238", - "pccRules": "internet|ims_sig", - "rfsp": 0, - "sessRules": "internet|ims_sig" - } - ] - } - }, - "3": { - "summary": "Success", - "value": { - "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" - } - ] - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808016-run", - "security": [] - }, - "post": { - "summary": "Add PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "增加PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808017-run", - "security": [] - }, - "put": { - "summary": "Modify PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "修改PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": false, - "example": "212", - "schema": { - "type": "string" - } - }, - { - "name": "msisdn", - "in": "query", - "description": "", - "required": false, - "example": "2121", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808043-run", - "security": [] - }, - "delete": { - "summary": "Delete PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "删除PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": true, - "example": "212", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "404": { - "description": "Record Not Found", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cause": { - "type": "string" - }, - "status": { - "type": "integer" - } - }, - "required": [ - "cause", - "status" - ], - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "cause", - "status" - ] - }, - "examples": { - "1": { - "summary": "Success", - "value": { - "cause": "DATA_NOT_FOUND", - "status": 404 - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808045-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/batch/{number}": { - "post": { - "summary": "Batch Add PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "批量增加PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "number", - "in": "path", - "description": "", - "required": true, - "example": "10", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "num": 11, - "imsi": "260990100000001", - "msisdn": "86755900001", - "qosAudio": "qos_audio", - "pccRules": "internet|ims_sig", - "rfsp": 1, - "uePolicy": "uep_001", - "sessRules": "internet|ims_sig", - "sar": "def_sar", - "hdrEnrich": "dnn", - "qosVideo": "qos_video", - "neId": "001" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808024-run", - "security": [] - }, - "put": { - "summary": "Batch Modify PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "批量修改PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "number", - "in": "path", - "description": "", - "required": true, - "example": "10", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "imsi": "000510200000001", - "msisdn": "1350000001", - "rfsp": "omitempty", - "sar": "", - "pccRules": "", - "sessRules": "", - "uePolicy": "", - "qosAudio": "", - "qosVideo": "", - "hdrEnrich": "" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808027-run", - "security": [] - }, - "delete": { - "summary": "Batch Delete PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "批量删除PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "number", - "in": "path", - "description": "", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "imsi", - "in": "query", - "description": "", - "required": true, - "example": "460910100000001", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "Exception", - "value": { - "cause": "no imsi", - "status": 400 - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808040-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/export": { - "get": { - "summary": "Export PCF UE Info ", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "导出PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "fileType", - "in": "query", - "description": "", - "required": true, - "example": "txt", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808038-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/pcf/objectType/ueInfo/file/import": { - "put": { - "summary": "Import PCF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules", - "x-apifox-status": "released", - "deprecated": false, - "description": "导入PCF用户策略控制信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/PCF User PCC Rules" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "filePath", - "in": "query", - "description": "", - "required": true, - "example": "/", - "schema": { - "type": "string" - } - }, - { - "name": "fileType", - "in": "query", - "description": "", - "required": true, - "example": "type", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "imsi": { - "type": "string" - }, - "msisdn": { - "type": "string" - }, - "rfsp": { - "type": "integer" - }, - "sar": { - "type": "string" - }, - "pccRules": { - "type": "string" - }, - "sessRules": { - "type": "string" - }, - "uePolicy": { - "type": "string" - }, - "qosAudio": { - "type": "string" - }, - "qosVideo": { - "type": "string" - }, - "hdrEnrich": { - "type": "string" - } - }, - "required": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-orders": [ - "imsi", - "msisdn", - "rfsp", - "sar", - "pccRules", - "sessRules", - "uePolicy", - "qosAudio", - "qosVideo", - "hdrEnrich" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "neId": "001", - "type": "txt", - "filePath": "xxx.txt" - } - } - } - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "neId": { - "type": "string" - }, - "fileType": { - "type": "string" - }, - "filePath": { - "type": "string" - } - }, - "required": [ - "neId", - "fileType", - "filePath" - ], - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "neId", - "fileType", - "filePath" - ] - }, - "examples": { - "1": { - "summary": "Exception", - "value": { - "detail": "[Request Body] unexpected end of JSON input", - "status": 400, - "title": "Malformed request syntax" - } - }, - "2": { - "summary": "Success", - "value": { - "neId": "001", - "fileType": "txt", - "filePath": "/home/agtuser/PCF_001_1701420431873_zsda89.txt" - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808039-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/n3iwf/objectType/ueInfo": { - "get": { - "summary": "Query N3IWF UE Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/N3IWF Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "查询N3IWF在线用户信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/N3IWF Online User" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": false, - "example": "460000100000093", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "activeTime": { - "type": "string" - }, - "imsi": { - "type": "string" - }, - "nai": { - "type": "string" - }, - "regState": { - "type": "integer" - } - }, - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "activeTime", - "imsi", - "nai", - "regState" - ] - } - } - }, - "required": [ - "data" - ], - "x-apifox-ignore-properties": [], - "x-apifox-orders": [ - "data" - ] - }, - "examples": { - "1": { - "summary": "Success", - "value": { - "data": [ - { - "activeTime": "2023-11-29 06:35:43", - "imsi": "460302072701181", - "nai": "0460302072701181@nai.epc.mnc030.mcc460.3gppnetwork.org", - "regState": 1 - } - ] - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808046-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo": { - "get": { - "summary": "Get NB Info from AMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/NodeB Information", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取AMF基站信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/NodeB Information" - ], - "parameters": [ - { - "name": "nbId", - "in": "query", - "description": "", - "required": true, - "example": "7", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808052-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo": { - "get": { - "summary": "Get UE Info from IMS", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/IMS Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取IMS在线用户信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/IMS Online User" - ], - "parameters": [ - { - "name": "imsi", - "in": "query", - "description": "", - "required": true, - "example": "460000100000093", - "schema": { - "type": "string" - } - }, - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808053-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo": { - "get": { - "summary": "Get UE Info from SMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取SMF在线用户信息", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808054-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/smf/objectType/ueNum": { - "get": { - "summary": "Get UE Number from SMF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取SMF在线用户数目", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/SMF Online User" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808055-run", - "security": [] - } - }, - "/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask": { - "patch": { - "summary": "Patch Measure Task", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task", - "x-apifox-status": "released", - "deprecated": false, - "description": "挂起性能测量任务", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Task" - ], - "parameters": [ - { - "name": "id", - "in": "query", - "description": "", - "required": true, - "example": "86", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808056-run", - "security": [] - }, - "delete": { - "summary": "Delete Measure Task", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task", - "x-apifox-status": "released", - "deprecated": false, - "description": "删除性能测量任务, 未激活的测量任务才可以删除", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Task" - ], - "parameters": [ - { - "name": "taskId", - "in": "query", - "description": "", - "required": true, - "example": "1", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808068-run", - "security": [] - } - }, - "/api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport": { - "post": { - "summary": "Post Measure Report", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Task Data", - "x-apifox-status": "released", - "deprecated": false, - "description": "性能统计任务数据报告接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Task Data" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Id": { - "type": "integer", - "title": "任务ID" - }, - "TimeStamp": { - "type": "string", - "title": "时间戳" - }, - "NeName": { - "type": "string", - "title": "网元名称" - }, - "rmUID": { - "type": "string", - "title": "网元资源标识" - }, - "NeType": { - "type": "string", - "title": "网元类型" - }, - "Report": { - "type": "object", - "properties": { - "Period": { - "type": "object", - "properties": { - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "EndTime": { - "type": "string", - "title": "结束时间" - } - }, - "required": [ - "StartTime", - "EndTime" - ], - "x-apifox-orders": [ - "StartTime", - "EndTime" - ], - "title": "时间片", - "x-apifox-ignore-properties": [] - }, - "Datas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Code": { - "type": "string", - "title": "统计项类目编号" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "KPIValues": { - "type": "null", - "title": "值" - } - }, - "required": [ - "KPIID", - "KPIValues" - ], - "x-apifox-orders": [ - "KPIID", - "KPIValues" - ], - "x-apifox-ignore-properties": [] - }, - "title": "指标集" - } - }, - "required": [ - "Code", - "KPIs" - ], - "x-apifox-orders": [ - "Code", - "KPIs" - ], - "x-apifox-ignore-properties": [] - }, - "title": "数据集" - } - }, - "required": [ - "Period", - "Datas" - ], - "x-apifox-orders": [ - "Period", - "Datas" - ], - "title": "测量报告", - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "Id", - "TimeStamp", - "NeName", - "rmUID", - "NeType", - "Report" - ], - "x-apifox-orders": [ - "Id", - "TimeStamp", - "NeName", - "rmUID", - "NeType", - "Report" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "Id": 86, - "TimeStamp": "1702970580", - "NeName": "UDM_001", - "rmUID": "4400HX1UDM001", - "NeType": "UDM", - "Report": { - "Period": { - "StartTime": "2023-12-19 15: 08: 00", - "EndTime": "2023-12-19 15: 23: 00" - }, - "Datas": [ - { - "Code": "UDMHA02", - "KPIs": [ - { - "KPIID": "UDM.AmfUecmRegSucc", - "KPIValues": null - } - ] - }, - { - "Code": "UDMHA03", - "KPIs": [ - { - "KPIID": "UDM.AmfUecmRegUpdateReq", - "KPIValues": null - } - ] - }, - { - "Code": "UDMHA01", - "KPIs": [ - { - "KPIID": "UDM.AmfUecmRegReq", - "KPIValues": null - } - ] - } - ] - } - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808059-run", - "security": [] - } - }, - "/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement": { - "post": { - "summary": "Post Measurement", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Report", - "x-apifox-status": "released", - "deprecated": false, - "description": "性能统计15分钟数据定时上报接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Report" - ], - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "example": "application/json", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Index": { - "type": "integer", - "title": "Index", - "description": "性能统计数据索引，取值: 0~95" - }, - "NeName": { - "type": "string", - "title": "网元名称" - }, - "RmUID": { - "type": "string", - "title": "网元资源标识" - }, - "NeType": { - "type": "string", - "title": "网络类型" - }, - "PmVersion": { - "type": "string", - "title": "PM版本号" - }, - "Dn": { - "type": "string", - "title": "数据网络名" - }, - "Period": { - "type": "string", - "title": "粒度", - "description": "15M" - }, - "TimeZone": { - "type": "string", - "title": "时区" - }, - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "Datas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ObjectType": { - "type": "string", - "title": "空间粒度" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "KPIValues": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "title": "KPI Name" - }, - "Value": { - "type": "integer", - "title": "值" - } - }, - "required": [ - "Name", - "Value" - ], - "x-apifox-orders": [ - "Name", - "Value" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "KPIID", - "KPIValues" - ], - "x-apifox-orders": [ - "KPIID", - "KPIValues" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "ObjectType", - "KPIs" - ], - "x-apifox-orders": [ - "ObjectType", - "KPIs" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-orders": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "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 - } - ] - } - ] - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808060-run", - "security": [] - }, - "get": { - "summary": "Get Measurement", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/Measure Report", - "x-apifox-status": "released", - "deprecated": false, - "description": "性能统计15分钟数据补采接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/Measure Report" - ], - "parameters": [ - { - "name": "Content-Type", - "in": "header", - "description": "", - "required": true, - "example": "application/json", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Index": { - "type": "integer", - "title": "Index", - "description": "性能统计数据索引，取值: 0~95" - }, - "NeName": { - "type": "string", - "title": "网元名称" - }, - "RmUID": { - "type": "string", - "title": "网元资源标识" - }, - "NeType": { - "type": "string", - "title": "网络类型" - }, - "PmVersion": { - "type": "string", - "title": "PM版本号" - }, - "Dn": { - "type": "string", - "title": "数据网络名" - }, - "Period": { - "type": "string", - "title": "粒度", - "description": "15M" - }, - "TimeZone": { - "type": "string", - "title": "时区" - }, - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "Datas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "ObjectType": { - "type": "string", - "title": "空间粒度" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "KPIValues": { - "type": "array", - "items": { - "type": "object", - "properties": { - "Name": { - "type": "string", - "title": "KPI Name" - }, - "Value": { - "type": "integer", - "title": "值" - } - }, - "required": [ - "Name", - "Value" - ], - "x-apifox-orders": [ - "Name", - "Value" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "KPIID", - "KPIValues" - ], - "x-apifox-orders": [ - "KPIID", - "KPIValues" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "ObjectType", - "KPIs" - ], - "x-apifox-orders": [ - "ObjectType", - "KPIs" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-orders": [ - "Index", - "NeName", - "RmUID", - "NeType", - "PmVersion", - "Dn", - "Period", - "TimeZone", - "StartTime", - "Datas" - ], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808063-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/udm/objectType/config/system": { - "get": { - "summary": "Get System Parameter from UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取UDM系统参数接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "", - "required": true, - "example": "serviceIP", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "serviceIP": { - "type": "string" - }, - "servicePort": { - "type": "integer" - }, - "scheme": { - "type": "integer" - }, - "enableNrf": { - "type": "boolean" - }, - "nrfUri": { - "type": "string" - }, - "ausfIP": { - "type": "string" - }, - "fqdn": { - "type": "string" - }, - "priority": { - "type": "integer" - }, - "capacity": { - "type": "integer" - }, - "groupId": { - "type": "string" - }, - "supiRanges": { - "type": "string" - }, - "gpsiRanges": { - "type": "string" - } - }, - "x-apifox-orders": [ - "serviceIP", - "servicePort", - "scheme", - "enableNrf", - "nrfUri", - "ausfIP", - "fqdn", - "priority", - "capacity", - "groupId", - "supiRanges", - "gpsiRanges" - ], - "x-apifox-ignore-properties": [] - }, - "title": "参数数据集", - "description": "map数组，名值对，根据不同的网元和参数集" - } - }, - "x-apifox-orders": [ - "data" - ], - "required": [ - "data" - ], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808112-run", - "security": [] - }, - "put": { - "summary": "Put System Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "修改UDM参数System", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "serviceIP": { - "type": "string" - } - }, - "required": [ - "serviceIP" - ], - "x-apifox-orders": [ - "serviceIP" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "capacity": 1000, - "priority": 2 - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808119-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr": { - "get": { - "summary": "Get subsUEAmbr Parameter from UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取UDM网元subsUEAmbr参数接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808113-run", - "security": [] - }, - "post": { - "summary": "Post subsUEAmbr Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "新增表subsUEAmbr的参数列", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "参数列的定位Index", - "required": false, - "example": "2", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "title": "Index", - "description": "参数列序号" - }, - "name": { - "type": "string" - }, - "uplink": { - "type": "string" - }, - "downlink": { - "type": "string" - } - }, - "required": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-orders": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "capacity": 1000, - "priority": 2 - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808120-run", - "security": [] - }, - "delete": { - "summary": "Delete subsUEAmbr Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "删除表subsUEAmbr的参数列", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "", - "required": true, - "example": "2", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808121-run", - "security": [] - }, - "put": { - "summary": "Put subsUEAmbr Parameter to UDM", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "修改表subsUEAmbr的参数", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "loc", - "in": "query", - "description": "", - "required": true, - "example": "2", - "schema": { - "type": "string" - } - }, - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "uplink": { - "type": "string" - }, - "downlink": { - "type": "string" - } - }, - "required": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-orders": [ - "index", - "name", - "uplink", - "downlink" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "capacity": 1000, - "priority": 2 - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-134660708-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection": { - "get": { - "summary": "Get UDM smfSelection", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取UDM网元参数表smfSelection数据接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808114-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/amf/objectType/config/guami": { - "get": { - "summary": "Get IMS system param", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取IMS网元参数接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/Parameter config" - ], - "parameters": [ - { - "name": "AccessToken", - "in": "header", - "description": "", - "required": true, - "example": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-130808115-run", - "security": [] - } - }, - "/api/rest/systemManagement/v1/elementType/{elementTypeValue}/objectType/config/omcNeConfig": { - "put": { - "summary": "Set NE Config Info", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Configuration/NE Management", - "x-apifox-status": "released", - "deprecated": false, - "description": "网元配置公共参数修改接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Configuration/NE Management" - ], - "parameters": [ - { - "name": "elementTypeValue", - "in": "path", - "description": "网元类型", - "required": true, - "example": "omc", - "schema": { - "type": "string" - } - }, - { - "name": "sync", - "in": "query", - "description": "", - "required": false, - "example": "true", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "dn": { - "type": "string", - "title": "资源里边的ManagedBy，性能的Dn，网络唯一标识" - }, - "province": { - "type": "string", - "title": "网元所在省份" - }, - "neId": { - "type": "string", - "title": "网元标识(内部)" - }, - "neName": { - "type": "string", - "title": "网元名称(内部)/友好名称(北向资源/性能等使用)" - }, - "pvFlag": { - "type": "string", - "title": "网元虚实性标识 VNF/PNF: 虚拟/物理" - }, - "rmUID": { - "type": "string", - "title": "rmUID 网元唯一标识" - }, - "vendorName": { - "type": "string", - "title": "厂商名称" - } - }, - "required": [ - "neId", - "neName", - "province", - "pvFlag", - "rmUID", - "vendorName", - "dn" - ], - "x-apifox-orders": [ - "dn", - "province", - "neId", - "neName", - "pvFlag", - "rmUID", - "vendorName" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "neId": "001", - "neName": "SMF_001", - "port": 3030, - "province": "-", - "pvFlag": "PNF", - "rmUID": "4400HX1SMF001", - "vendorName": "AGrandTech", - "dn": "-" - } - } - } - }, - "responses": { - "204": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-ignore-properties": [], - "x-apifox-orders": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-134080001-run", - "security": [] - } - }, - "/api/rest/performanceManagement/{apiVersion}/elementType/{elementTypeValue}/objectType/kpiReport/{index}": { - "post": { - "summary": "上报黄金指标统计数据集", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/Performance/KPI report", - "x-apifox-status": "released", - "deprecated": false, - "description": "", - "tags": [ - "核心网 HTTP RESTful API 服务接口/Performance/KPI report" - ], - "parameters": [ - { - "name": "apiVersion", - "in": "path", - "description": "", - "required": true, - "example": "v1", - "schema": { - "type": "string" - } - }, - { - "name": "elementTypeValue", - "in": "path", - "description": "", - "required": true, - "example": "smf", - "schema": { - "type": "string" - } - }, - { - "name": "index", - "in": "path", - "description": "黄金指标的上报粒度是1分钟，index是当前时间片在一天中的索引，取值：0~1439", - "required": true, - "example": "111", - "schema": { - "type": "string" - } - }, - { - "name": "Authorization", - "in": "header", - "description": "Authoirzation token", - "required": true, - "example": "{{token-prefix}}{{token-text}}", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "TimeStamp": { - "type": "string", - "title": "时间戳", - "description": "上报时的时间戳，格式：\"2023-12-19T01:52:01Z\"" - }, - "Task": { - "type": "object", - "properties": { - "Period": { - "type": "object", - "properties": { - "StartTime": { - "type": "string", - "title": "开始时间" - }, - "EndTime": { - "type": "string", - "title": "结束时间" - } - }, - "required": [ - "StartTime", - "EndTime" - ], - "x-apifox-orders": [ - "StartTime", - "EndTime" - ], - "title": "时间片", - "x-apifox-ignore-properties": [] - }, - "NE": { - "type": "object", - "properties": { - "NEName": { - "type": "string" - }, - "rmUID": { - "type": "string", - "title": "网元资源唯一标识" - }, - "NeType": { - "type": "string", - "title": "网元类型" - }, - "KPIs": { - "type": "array", - "items": { - "type": "object", - "properties": { - "KPIID": { - "type": "string", - "title": "KPI ID" - }, - "Value": { - "type": "integer", - "title": "统计值" - }, - "Err": { - "type": "string", - "title": "错误信息" - } - }, - "required": [ - "KPIID", - "Value", - "Err" - ], - "x-apifox-orders": [ - "KPIID", - "Value", - "Err" - ], - "x-apifox-ignore-properties": [] - }, - "title": "KPI数据集", - "nullable": true - } - }, - "required": [ - "NEName", - "rmUID", - "NeType", - "KPIs" - ], - "x-apifox-orders": [ - "NEName", - "rmUID", - "NeType", - "KPIs" - ], - "title": "网元名称", - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "Period", - "NE" - ], - "x-apifox-orders": [ - "Period", - "NE" - ], - "x-apifox-ignore-properties": [] - } - }, - "required": [ - "TimeStamp", - "Task" - ], - "x-apifox-orders": [ - "TimeStamp", - "Task" - ], - "x-apifox-ignore-properties": [] - }, - "example": { - "id": 1, - "NeType": "SMF" - } - } - } - }, - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "x-apifox-orders": [], - "x-apifox-ignore-properties": [] - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-134467270-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/nssf/objectType/availableAMFs": { - "get": { - "summary": "Available AMFs List from NSSF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取NSSF当前所有注册的可用AMF列表接口", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nfId": { - "type": "string", - "title": "NF ID", - "description": "网元ID" - }, - "amfSetId": { - "type": "string", - "title": "AMF Set ID", - "description": "注册的AMF" - } - }, - "required": [ - "nfId", - "amfSetId" - ], - "x-apifox-orders": [ - "nfId", - "amfSetId" - ], - "x-apifox-ignore-properties": [] - }, - "title": "返回的数据集", - "description": "数据数组" - } - }, - "required": [ - "data" - ], - "x-apifox-orders": [ - "data" - ], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "成功示例", - "value": { - "data": [ - { - "nfId": "001", - "amfSetId": "001" - }, - { - "nfId": "002", - "amfSetId": "[001,002]" - } - ] - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-135199288-run", - "security": [] - } - }, - "/api/rest/ueManagement/v1/elementType/nssf/objectType/subscriptions": { - "get": { - "summary": "Subscriptions from NSSF", - "x-apifox-folder": "核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription", - "x-apifox-status": "released", - "deprecated": false, - "description": "获取NSSF在线订阅数", - "tags": [ - "核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription" - ], - "parameters": [ - { - "name": "neId", - "in": "query", - "description": "网管发往网元的不用带NE ID", - "required": true, - "example": "001", - "schema": { - "type": "string" - } - }, - { - "name": "Referer", - "in": "header", - "description": "Use the specified declared Referer", - "required": true, - "example": "{{referer}}", - "schema": { - "type": "string" - } - }, - { - "name": "User-Agent", - "in": "header", - "description": "User agent", - "required": true, - "example": "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.198 Safari/537.36", - "schema": { - "type": "string" - } - }, - { - "name": "Accept-Language", - "in": "header", - "description": "zh_CN;q=0.9 en_US;q=0.9", - "required": true, - "example": "en_US;q=0.9", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "成功", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "subscriptionId": { - "type": "string", - "title": "Subscription ID", - "description": "订阅ID" - }, - "nfNssaiAvailabilityUri": { - "type": "string", - "title": "NF NSSAI Availability Uri" - }, - "event": { - "type": "string", - "title": "Event" - } - }, - "required": [ - "subscriptionId", - "nfNssaiAvailabilityUri", - "event" - ], - "x-apifox-orders": [ - "subscriptionId", - "nfNssaiAvailabilityUri", - "event" - ], - "x-apifox-ignore-properties": [] - } - } - }, - "required": [ - "data" - ], - "x-apifox-orders": [ - "data" - ], - "x-apifox-ignore-properties": [] - }, - "examples": { - "1": { - "summary": "成功示例", - "value": { - "data": [ - { - "subscriptionId": "1", - "nfNssaiAvailabilityUri": "http://192.168.2.166/test", - "event": "test event 1" - }, - { - "subscriptionId": "2", - "nfNssaiAvailabilityUri": "http://192.168.2.166/test", - "event": "test event 2" - } - ] - } - } - } - } - } - } - }, - "x-run-in-apifox": "https://apifox.com/web/project/3157310/apis/api-135199289-run", - "security": [] - } - } - }, - "components": { - "schemas": {}, - "securitySchemes": {} - }, - "servers": [] -} \ No newline at end of file diff --git a/docs/interfaces/12-OMC Alarm Definition.xlsx b/docs/interfaces/12-OMC Alarm Definition.xlsx deleted file mode 100644 index 91444ca..0000000 Binary files a/docs/interfaces/12-OMC Alarm Definition.xlsx and /dev/null differ diff --git a/docs/interfaces/13-5GC Key Performance Indicator v1.2.xlsx b/docs/interfaces/13-5GC Key Performance Indicator v1.2.xlsx deleted file mode 100644 index 1933f55..0000000 Binary files a/docs/interfaces/13-5GC Key Performance Indicator v1.2.xlsx and /dev/null differ diff --git a/docs/interfaces/OMC-NSSF restful api.md b/docs/interfaces/OMC-NSSF restful api.md deleted file mode 100644 index dac1236..0000000 --- a/docs/interfaces/OMC-NSSF restful api.md +++ /dev/null @@ -1,108 +0,0 @@ ---- - - ---- -# 核心网 HTTP RESTful API 服务接口/UE Management/NSSF Available AMF and Subscription - -## GET Available AMFs List from NSSF - -GET /api/rest/ueManagement/v1/elementType/nssf/objectType/availableAMFs - -获取NSSF当前所有可用的AMF列表接口 - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------------- | -| neId | query | string | yes | 网管发往网元的不用带NE ID | -| 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 - -> 成功 - -```json -{ - "data": [ - { - "nfId": "001", - "amfSetId": "001" - }, - { - "nfId": "002", - "amfSetId": "[001,002]" - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| ------------- | -------- | -------- | ------------ | ------------ | ----------- | -| » data | [object] | true | none | 返回的数据集 | 数据数组 | -| »» nfId | string | true | none | NF ID | 网元ID | -| »» amfSetId | string | true | none | AMF Set ID | none | - -## GET Subscriptions from NSSF - -GET /api/rest/ueManagement/v1/elementType/nssf/objectType/subscriptions - -获取NSSF在线订阅数 - -### Params - -| Name | Location | Type | Required | Description | -| --------------- | -------- | ------ | -------- | ---------------------------------- | -| neId | query | string | yes | 网管发往网元的不用带NE ID | -| 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 - -> 成功 - -```json -{ - "data": [ - { - "subscriptionId": "1", - "nfNssaiAvailabilityUri": "http://192.168.2.166/test", - "event": "test event 1" - }, - { - "subscriptionId": "2", - "nfNssaiAvailabilityUri": "http://192.168.2.166/test", - "event": "test event 2" - } - ] -} -``` - -### Responses - -| HTTP Status Code | Meaning | Description | Data schema | -| ---------------- | ---------------------------------------------------- | ----------- | ----------- | -| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | 成功 | Inline | - -### Responses Data Schema - -HTTP Status Code **200** - -| Name | Type | Required | Restrictions | Title | description | -| --------------------------- | -------- | -------- | ------------ | ------------------------- | ----------- | -| » data | [object] | true | none | | none | -| »» subscriptionId | string | true | none | Subscription ID | 订阅ID | -| »» nfNssaiAvailabilityUri | string | true | none | NF NSSAI Availability Uri | none | -| »» event | string | true | none | Event | none | diff --git a/docs/interfaces/OMC-NSSF restful api.pdf b/docs/interfaces/OMC-NSSF restful api.pdf deleted file mode 100644 index 0c6c00f..0000000 Binary files a/docs/interfaces/OMC-NSSF restful api.pdf and /dev/null differ diff --git a/docs/omc_db.jpg b/docs/omc_db.jpg deleted file mode 100644 index fedbe03..0000000 Binary files a/docs/omc_db.jpg and /dev/null differ diff --git a/docs/overview/04-5GC OMC Architecture v0.81.pdf b/docs/overview/04-5GC OMC Architecture v0.81.pdf deleted file mode 100644 index 6230120..0000000 Binary files a/docs/overview/04-5GC OMC Architecture v0.81.pdf and /dev/null differ diff --git a/docs/overview/04-5GC OMC Architecture v0.82.pdf b/docs/overview/04-5GC OMC Architecture v0.82.pdf deleted file mode 100644 index 814eb9d..0000000 Binary files a/docs/overview/04-5GC OMC Architecture v0.82.pdf and /dev/null differ diff --git a/docs/overview/04-5GC OMC Overview v1.02.pdf b/docs/overview/04-5GC OMC Overview v1.02.pdf deleted file mode 100644 index 3caf48c..0000000 Binary files a/docs/overview/04-5GC OMC Overview v1.02.pdf and /dev/null differ diff --git a/docs/overview/04-5GC OMC 介绍.pdf b/docs/overview/04-5GC OMC 介绍.pdf deleted file mode 100644 index ccffcf0..0000000 Binary files a/docs/overview/04-5GC OMC 介绍.pdf and /dev/null differ diff --git a/docs/overview/04-OMC Overview v1.02.pdf b/docs/overview/04-OMC Overview v1.02.pdf deleted file mode 100644 index 3e47be5..0000000 Binary files a/docs/overview/04-OMC Overview v1.02.pdf and /dev/null differ diff --git a/docs/overview/04-OMC Overview v1.1.pdf b/docs/overview/04-OMC Overview v1.1.pdf deleted file mode 100644 index 2300873..0000000 Binary files a/docs/overview/04-OMC Overview v1.1.pdf and /dev/null differ diff --git a/docs/overview/04-OMC Overview.docx b/docs/overview/04-OMC Overview.docx deleted file mode 100644 index 60b7c4d..0000000 Binary files a/docs/overview/04-OMC Overview.docx and /dev/null differ diff --git a/docs/overview/04-OMC Overview.md b/docs/overview/04-OMC Overview.md deleted file mode 100644 index 09f8087..0000000 --- a/docs/overview/04-OMC Overview.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -OMC Overview ---- -## Introduction to OMC - -The Core Network OMC (Operation and Maintenance Center) is a central facility used by operators to manage and maintain core network equipment. It typically includes modules for network monitoring, fault management, performance management, configuration management, security management, and other functions to ensure the smooth operation and efficient maintenance of core network equipment. By monitoring and managing core network equipment, the OMC can quickly identify and resolve network faults in real-time, improve network performance, ensure network security, and enhance operational efficiency. The OMC plays a crucial role in the network operations and maintenance of operators, serving as a key element in ensuring stable network operation. - -## System Architecture - -![EMS Architecture](image/ems-arch.png) - -## Platform - -1. Operating System: Linux -2. Hardware Platform: X86/ARM64 -3. Network Architecture: B/S mode -4. Front-end Languages: HTML+CSS+JS (Vue3) -5. Back-end Languages: Golang+MySQL/MariaDB+Redis, Nginx (optional) - -## Features - -1. Topology Management (Dashboard/State/Monitor): Dashboard, Network topology, System status, etc. -2. Fault Management (FM): active alarms, historical alarms, etc. -3. Configuration Management (CM): NE (Network Element) management, parameter configuration, etc. -4. Performance Management (PM): subscription tasks for performance-related metrics, data reports, performance thresholds, etc. -5. CDR/Event Managemet (CDR): IMS CDR, SMF CDR, AMF UE event. -6. UE Management (UE): UDM Auth Data, UDM Subscriber, IMS Online Users, SMF UE Online Information, Radio Information, PCC Information, etc. -7. Operation and Maintenance (MML): NE MML(Man Machine Language) operations, UDM (User Data Management) MML, OMC (Operation and Maintenance Center) MML, etc. -8. Log Management (Log): operation logs, security logs, alarm logs, etc. -9. Tracing Management (Trace): signaling tracking task creation, signaling analysis, signaling capture, etc. -10. Security Management (Security): user management, role management, current online users, permission management, etc. -11. System Management (System): menu management, dictionary management, system information, scheduling tasks, etc. -12. Northbound Interface (NBI): optional and customized interfaces, northbound interface services, resource configuration data, performance statistics data, performance golden indicators, alarm reporting, 4A, etc. - -## Supported NEs - -AMF, AUSF, UDM, SMF, UPF, PCF, NRF, NSSF, NEF, LMF, IMS, MME, N3IWF, SMSC, MOCNGW - -## Interfaces - -![omc-interface](image/omc-interface.jpg) diff --git a/docs/overview/04-OMC 系统简介 v1.1.pdf b/docs/overview/04-OMC 系统简介 v1.1.pdf deleted file mode 100644 index 4882966..0000000 Binary files a/docs/overview/04-OMC 系统简介 v1.1.pdf and /dev/null differ diff --git a/docs/overview/04-OMC 系统简介.md b/docs/overview/04-OMC 系统简介.md deleted file mode 100644 index f029a99..0000000 --- a/docs/overview/04-OMC 系统简介.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -OMC架构与功能 ---- -## OMC简介 - -核心网OMC（Operation and Maintenance Center）是运营商用于管理和维护核心网设备的中心。它通常包括网络监控、故障管理、性能管理、配置管理、安全管理等功能模块，用于确保核心网设备的正常运行和高效维护。OMC通过监控和管理核心网设备，可以实时发现和解决网络故障，提高网络性能，保障网络安全，提升运营效率。OMC在运营商的网络运维中扮演着重要的角色，是保障网络稳定运行的关键环节。 - -## 系统架构 - -![ems architecture](image/ems-arch.png) - -## 开发平台 - -1. 操作系统：linux -2. 硬件平台：X86/ARM64 -3. 网络架构: B/S模式 -4. 前端语言：HTML+CSS+JS(vue3) -5. 后端语言：Golang+MySQL+Redis, Nginx(optional) - -## 功能清单 - -1. 拓扑管理(Dashboard/State/Monitor)：仪表盘，网络拓扑，系统状态等 -2. 故障管理(FM)：活动告警/历史告警等 -3. 配置管理(CM)：网元管理，参数配置等 -4. 性能管理(PM)：性能统计相关指标项的订阅任务，数据报表，性能门限等 -5. CDR管理(CDR): IMS话单，SMF话单，AMF UE事件等 -6. 终端管理(UE): UDM鉴权数据，UDM签约用户，IMS在线用户，SMF UE在线信息，基站信息，用户策略控制信息等 -7. 操作维护(MML)：网元MML操作，UDM用户数据MML，OMC MML等 -8. 日志管理(Log)：操作日志，安全日志，告警日志等 -9. 跟踪管理(Trace)：信令跟踪任务创建，信令分析，信令抓包等 -10. 安全管理(Security)：用户管理，角色管理，当前在线用户，权限管理等 -11. 系统管理(System): 菜单管理，字典管理，系统信息，调度任务等 -12. 北向接口(NBI: Northbound Interface): 可选接口，定制化接口，北向接口服务，资源配置数据，性能统计数据, 性能黄金指标, 告警上报, 4A等 - -## 支持的NEs - -AMF, AUSF, UDM, SMF, UPF, PCF, NRF, NSSF, NEF, LMF, IMS, MME, N3IWF, SMSC, MOCNGW - -## 接口 - -![omc-interface](image/omc-interface.jpg) diff --git a/docs/overview/09-OMC Front-end Architecture Design v1.01.pdf b/docs/overview/09-OMC Front-end Architecture Design v1.01.pdf deleted file mode 100644 index a6f3721..0000000 Binary files a/docs/overview/09-OMC Front-end Architecture Design v1.01.pdf and /dev/null differ diff --git a/docs/overview/09-OMC Front-end Architecture Design.docx b/docs/overview/09-OMC Front-end Architecture Design.docx deleted file mode 100644 index d22d1b6..0000000 Binary files a/docs/overview/09-OMC Front-end Architecture Design.docx and /dev/null differ diff --git a/docs/overview/10-OMC Brief Introduction to Front-end Architecture.pdf b/docs/overview/10-OMC Brief Introduction to Front-end Architecture.pdf deleted file mode 100644 index 76d4b5b..0000000 Binary files a/docs/overview/10-OMC Brief Introduction to Front-end Architecture.pdf and /dev/null differ diff --git a/docs/overview/image/ems-arch.png b/docs/overview/image/ems-arch.png deleted file mode 100644 index 605ec79..0000000 Binary files a/docs/overview/image/ems-arch.png and /dev/null differ diff --git a/docs/overview/image/omc-interface.jpg b/docs/overview/image/omc-interface.jpg deleted file mode 100644 index 947f2e2..0000000 Binary files a/docs/overview/image/omc-interface.jpg and /dev/null differ diff --git a/docs/quickstart/01-5GC OMC 安装指南 v1.3.pdf b/docs/quickstart/01-5GC OMC 安装指南 v1.3.pdf deleted file mode 100644 index 67b9e04..0000000 Binary files a/docs/quickstart/01-5GC OMC 安装指南 v1.3.pdf and /dev/null differ diff --git a/docs/quickstart/01-5GC OMC 安装指南 v1.31.pdf b/docs/quickstart/01-5GC OMC 安装指南 v1.31.pdf deleted file mode 100644 index 172099a..0000000 Binary files a/docs/quickstart/01-5GC OMC 安装指南 v1.31.pdf and /dev/null differ diff --git a/docs/quickstart/01-5GC OMC 安装指南.md b/docs/quickstart/01-5GC OMC 安装指南.md deleted file mode 100644 index d19614c..0000000 --- a/docs/quickstart/01-5GC OMC 安装指南.md +++ /dev/null @@ -1,403 +0,0 @@ -# 5GC OMC安装指南 - -## 1 安装环境及依赖包 - -X86_64通用服务器： - -``` -计算机或者虚拟机环境(最低配置)：CPU: 2, Memory: 8.00 GB, Disk: 200 GB -操作系统环境：Ubuntu 18.04 -数据库环境：mariadb-10.3.38-GA -WEB服务: nginx 1.14.0 (ubuntu) -安装包名称格式：OMC 5GC16.1.1.amd64.deb （其中，'5GC16.1.1'为版本号， 'amd64'为硬件平台名称） -``` - -麒麟arm64服务器： - -``` -计算机或者虚拟机环境(最低配置)：CPU: 2, Memory: 8.00 GB, Disk: 200 GB -操作系统环境：银河麒麟 kylin server v10 -数据库环境：mariadb-10.3.35-1.p01.ky10.aarch64 -WEB服务: nginx 1.16.1-11.p01.ky10.aarch64 -安装包名称格式：OMC-5GC16.1.1.arm64.rpm （其中，'5GC16.1.1'为版本号, 'arm64'为硬件平台名称） -``` - -注意事项： - -```tips -* 以下操作以银河麒麟arm64硬件平台为例 -* 全新安装方式，数据库的数据会被全部清除 -``` - -### 1.1 安装数据库 - -注意：非第一次安装或者全新安装请跳过此步骤 - -mariadb版本：mariadb-server-3:10.3.35-1.p01.ky10.aarch64 - -软件安装 - -银河麒麟OS(CentOS) - -```bash -# yum clean all -# yum makecache -# yum -y update -# yum install -y mariadb -# yum install -y mariadb-server-3:10.3.35-1.p01.ky10.aarch64 -``` - -配置修改 - -修改/etc/my.cnf.d/mariadb-server.cnf -增加或者修改如下三行： - -``` -bind-address=0.0.0.0 -port=33066 -max_connections=1000 -``` - -验证测试 - -```bash -# systemctl enable mariadb -# systemctl restart mariadb -# systemctl status mariadb -``` - -正常显示结果如下： - -```bash -[root@ems omc]# systemctl status mariadb -● mariadb.service - MariaDB 10.3.35 database server - Loaded: loaded (/usr/lib/systemd/system/mariadb.service; disabled; vendor preset: disabled) - Active: active (running) since Sun 2023-04-30 11:09:56 CST; 7h ago - Docs: man:mysqld(8) - https://mariadb.com/kb/en/library/systemd/ - Main PID: 5127 (mysqld) - Status: "Taking your SQL requests now..." - Tasks: 37 - Memory: 101.0M - CGroup: /system.slice/mariadb.service - └─5127 /usr/libexec/mysqld -``` - -修改mysql数据库root密码: - -```tips -!!!注意!!!: 修改后的密码需要更新到/usr/local/omc/etc/restconf.yaml, crontask.yaml和nbi_alarm.json等配置文件中的数据库信息配置项 -``` - -```bash -[root@ems ~]# mysql -u root -MariaDB [none]> use mysql - -MariaDB [mysql]> update user set password=PASSWORD('******') where User='root'; - -MariaDB [mysql]> flush privileges; - -MariaDB [mysql]> GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY '******' - -MariaDB [mysql]> quit -``` - -通过以下登录命令确认修改成功 - -``` -[root@ems ~]# mysql -u root -h 192.168.0.229 -P 33066 -p -Enter password: -Welcome to the MariaDB monitor. Commands end with ; or \g. -Your MariaDB connection id is 95 -Server version: 10.3.35-MariaDB MariaDB Server - -Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others. - -Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. - -MariaDB [(none)]> - -``` - -### 1.2 安装WEB服务(可选) - -注意：非第一次安装或者全新安装请跳过此步骤 - -OMC Web服务可通过nginx代理进行访问，也可不需要代理进行访问 - -WEB服务: nginx-1.16.1-11.p01.ky10.aarch64 - -* 软件安装 - -```bash -# yum clean all -# yum makecache -# yum -y update -# yum install -y nginx -``` - -* 验证测试 - -```bash -# systemctl enable nginx -# systemctl daemon-reload -# systemctl start nginx -# systemctl status nginx -● nginx.service - The nginx HTTP and reverse proxy server - Loaded: loaded (/usr/lib/systemd/system/nginx.service; disabled; vendor preset: disabled) - Active: active (running) since Tue 2023-05-02 20:57:48 CST; 3h 12min ago - Main PID: 23163 (nginx) - Tasks: 5 - Memory: 19.3M - CGroup: /system.slice/nginx.service - ├─23163 nginx: master process /usr/sbin/nginx - ├─23164 nginx: worker process - ├─23165 nginx: worker process -``` - -## 2 安装配置OMC - -### 2.1 安装OMC软件包 - -安装OMC软件包 - -```bash -# rpm -ivh OMC\ 5GC16.1.1.arm64.rpm -``` - -安装后的软件包目录树（实际目录树会随版本不同有变化，以下仅供参考）： - -```bash -# cd /usr/local -# tree omc -L 2 -omc -├── backup -├── bin -│   ├── cpsshkey.sh -│   ├── crontask -│   ├── importdb.sh -│   ├── nehosts -│   ├── omcsvc.sh -│   ├── restagent -│   └── tables.txt -├── database -├── etc -│   ├── cm -│   ├── crontask.yaml -│   ├── db -│   ├── default -│   ├── restconf.yaml -│   ├── schema -│   └── tasks.yaml -├── htdocs -│   └── front -├── license -├── log -│   ├── crontask.log -> /usr/local/omc/log/crontask.log-20230629 -│   ├── crontask.log-20230628 -│   ├── crontask.log-20230629 -│   ├── nbi_alarm -│   ├── restagent.log -> /usr/local/omc/log/restagent.log-20230629 -│   ├── restagent.log-20230628 -│   └── restagent.log-20230629 -├── software -└── upload -# -``` - -### 2.2 修改nginx服务的OMC配置(可选) - -安装软件包成功后可以根据实际环境对nginx的OMC配置进行修改，前端Web的默认侦听端口是8888，除了侦听端口，其它不用修改 - -```bash -# cd /etc/nginx/conf.d -# cat omc.conf -server { - listen 8888 default_server; - root /usr/local/omc/htdocs/front/; - index index.html index.htm; - server_name localhost; - location / { - try_files $uri $uri/ =404; - } -} -``` - -### 2.3 修改OMC Web前端配置 - -根据实际环境修改如下文件的IP地址和端口，端口需要和OMC的配置文件一致, OMC后端ipv4服务侦听端口默认为3030, ipv6的默认侦听端口为6060: - -```bash -# sudo sed -i.bak 's/192.168.2.119:/192.168.0.229:/g' /usr/local/omc/htdocs/front/config.js -``` - -### 2.4 修改OMC后端配置 - -说明： - -```tips -* 目录/usr/local/omc/etc/default下的文件是OMC程序的初始配置文件，不要修改 -* 拷贝default目录下的文件至/usr/local/omc/etc目录，根据使用环境修改配置文件 -``` - -```bash -# cd /usr/local/omc/etc -# cp default/* ../ -``` - -根据实际的运行环境对配置文件restconf.yaml, crontask.yaml, nbi_alarm.json, nbi_agent.json, 4a_agent.yaml及tasks.yaml进行修改, 特别是侦听端口和数据库配置信息(包括端口/用户/密码) - -### 2.5 数据库配置 - -注意：第一次或全新安装执行该步骤, 该步骤会清除掉原有的omc数据库 - -```bash -# /usr/local/omc/bin/importdb.sh install -``` - -升级安装执行该步骤 - -```bash -# /usr/local/omc/bin/importdb.sh upgrade -``` - -### 2.6 防火墙配置 - -如果系统默认是打开防火墙，需要添加配置文件中配置的服务和端口(端口要和实际环境配置一致)，如下： - -```bash -# firewall-cmd --add-port=33066/tcp --permanent -# firewall-cmd --add-port=8443/tcp --permanent -# firewall-cmd --add-port=8080/tcp --permanent -# firewall-cmd --add-port=4443/tcp --permanent -# firewall-cmd --add-port=8888/tcp --permanent -# firewall-cmd --add-port=3030/tcp --permanent -# firewall-cmd --add-port=4040/tcp --permanent -# firewall-cmd --add-port=5050/tcp --permanent -# firewall-cmd --add-port=6060/tcp --permanent -# firewall-cmd --add-port=31232-31271/tcp --permanent -# firewall-cmd --add-port=2222/tcp --permanent -# firewall-cmd --add-port=6379/tcp --permanent -# firewall-cmd --add-port=2152/udp --permanent -# firewall-cmd --reload -``` - -### 2.7 配置被管网元的SSH信任关系 - -为了便于OMC管理被管网元(包括登录网元，安装软件，备份配置文件和执行命令等操作), 第一次安装时需要配置被管网元与OMC的SSH信任关系，便于无密码SSH登录： - -* 修改/usr/local/omc/bin目录下的nehosts文件(******替换为明文密码), 根据现网环境增加被管网元的ip, 用户和密码信息列表 -* 运行脚本cpsshkey.sh, 将公钥拷贝至被管网元 -* 运行ssh root@192.168.4.133验证是否可以无密码登录 -* 执行成功后, 为了防止密码泄露，清除掉nehosts文件的密码信息 - -```bash -[root@ems bin]# cat nehosts -# host user password -# Example: 192.168.4.133 root password -192.168.4.133 root ****** -192.168.4.134 root ****** -[root@ems bin]# ./cpsshkey.sh -[root@ems bin]# ssh root@192.168.4.133 -``` - -## 3 启动和停止OMC - -### 3.1 系统服务启动 - -```bash -# systemctl enable restagent.service -# systemctl enable crontask.service -# systemctl enable sshsvc.service -# systemctl enable captrace.service -# systemctl daemon-reload -``` - -执行上述命令后，它被设置为作为 systemd 服务运行。 - -### 3.2 手动启动/查询/停止OMC - -您可以按如下方式启动，查询状态，停止和重新启动OMC, 以下命令可通过/usr/local/omc/bin/omcsvc.sh脚本一次性执行： - -```bash -# cd /usr/local/omc/bin -# ./omcsvc.sh start/stop/restart/status -``` - -单个OMC进程的执行命令如下, 启动/状态/停止/重启： - -```bash -# systemctl start restagent.service -# systemctl start crontask.service -# systemctl start sshsvc.service -# systemctl start captrace.service -``` - -```bash -# systemctl status restagent.service -# systemctl status crontask.service -# systemctl status sshsvc.service -# systemctl status captrace.service -``` - -```bash -# systemctl stop restagent.service -# systemctl stop crontask.service -# systemctl stop sshsvc.service -# systemctl stop captrace.service -``` - -```bash -# systemctl restart restagent.service -# systemctl restart crontask.service -# systemctl restart sshsvc.service -# systemctl restart captrace.service -``` - -## 4 问题定位跟踪 - -OMC restagent程序的配置文件在restagent.yaml，trace级别的日志通常在调试系统时使用，正常运行级别为debug，如下配置项所示： - -```yaml -logger: - file: /usr/local/omc/log/restagent.log - level: debug - duration: 24 - count: 90 -``` - -OMC crontask程序的配置文件在crontask.yaml，trace级别的日志通常在调试系统时使用，正常运行级别为debug，如下配置项所示： - -```yaml -logger: - file: /usr/local/omc/log/crontask.log - level: trace - duration: 24 - count: 90 -``` - -OMC sshsvc程序的配置文件在sshsvc.yaml，日志配置项如下所示： - -```json -logger: - file: /usr/local/omc/log/sshsvc.log - level: debug - duration: 24 - count: 30 -``` - -OMC captrace程序的配置文件在capconf.yaml，日志配置项如下所示： - -```json -logger: - file: /usr/local/omc/log/captrace.log - level: trace - duration: 24 - count: 10 -``` - -## 5 管理核心网系统 - -通过浏览器输入：[http://192.168.0.229:8888](http://192.168.0.229:8888) （nginx代理模式） - -或：http://192.168.0.229:8080 (非nginx代理模式) diff --git a/docs/quickstart/mysql install guide.md b/docs/quickstart/mysql install guide.md deleted file mode 100644 index c9652b8..0000000 --- a/docs/quickstart/mysql install guide.md +++ /dev/null @@ -1,11 +0,0 @@ -# MySQL install guide - ---- - -## 环境准备 - -硬件平台：辉腾arm服务器 - -操作系统：麒麟 - -MySQL：8.0.32 diff --git a/docs/reference/4A管控平台与OMC的资源查询流程图.docx b/docs/reference/4A管控平台与OMC的资源查询流程图.docx deleted file mode 100644 index e48b26f..0000000 Binary files a/docs/reference/4A管控平台与OMC的资源查询流程图.docx and /dev/null differ diff --git a/docs/releasenote/release note -amd64.txt b/docs/releasenote/release note -amd64.txt deleted file mode 100644 index a527384..0000000 --- a/docs/releasenote/release note -amd64.txt +++ /dev/null @@ -1,28 +0,0 @@ -2023.09.04 - -1. 系统状态 -2. 故障管理 -3. 配置管理 -4. 性能管理 -5. 操作维护 -6. 跟踪管理 -7. 日志管理 -8. 安全管理 -9. 系统管理 - -2023.09.07 -1. mml权限问题 - -2023.09.21 -1. 网元软件上传拆分为软件文件和校验文件，校验文件可选，目前暂未开放软件完整性校验机制 -2. 支持网元软件管理上传/下发/激活/回退, 解决amd平台ubuntu的agtuser网元用户权限问题, 网元需要配置sudoers的agtuser用户sudo免密 -3. 跟踪管理实现UDM数据上报的, amd平台暂未实现解码 -4. 新增：安全管理>菜单管理，支持动态配置菜单权限 -5. 新增：安全管理>角色管理，为更好的支持多用户使用权限的配置操作 -6. 新增：用户信息，对包含UDM/IMS/UE/AMF网元上用户数据管理。 -7. 新增：跟踪管理>信令抓包，提供网元服务流量PCAP捕获 -8. 更新：配置管理，支持LOGO更换 -9. 更新：配置管理>参数配置代码的优化 - -2023.09.22 -1. 修复了ims激活不成功问题 \ No newline at end of file diff --git a/docs/releasenote/release note -arm64.txt b/docs/releasenote/release note -arm64.txt deleted file mode 100644 index 364863f..0000000 --- a/docs/releasenote/release note -arm64.txt +++ /dev/null @@ -1,29 +0,0 @@ -2023.09.04 - -1. 系统状态 -2. 故障管理 -3. 配置管理 -4. 性能管理 -5. 操作维护 -6. 跟踪管理 -7. 日志管理 -8. 安全管理 -9. 系统管理 - -2023.09.07 - -1. mml权限问题 - -2023.09.21 -1. 网元软件上传拆分为软件文件和校验文件，校验文件可选，目前暂未开放软件完整性校验机制 -2. 支持网元软件管理上传/下发/激活/回退 -3. 跟踪管理实现UDM数据上报的, arm平台可实现解码 -4. 新增：安全管理>菜单管理，支持动态配置菜单权限 -5. 新增：安全管理>角色管理，为更好的支持多用户使用权限的配置操作 -6. 新增：用户信息，对包含UDM/IMS/UE/AMF网元上用户数据管理。 -7. 新增：跟踪管理>信令抓包，提供网元服务流量PCAP捕获 -8. 更新：配置管理，支持LOGO更换 -9. 更新：配置管理>参数配置代码的优化 - -2023.09.22 -1. 修复了ims激活不成功问题 \ No newline at end of file diff --git a/docs/releasenote/release note.txt b/docs/releasenote/release note.txt deleted file mode 100644 index 9f3f3f9..0000000 --- a/docs/releasenote/release note.txt +++ /dev/null @@ -1,271 +0,0 @@ -2023.05.31 - -1. 中移动北向性能接口：性能数据xml文件 -2. 15分钟性能统计数据的获取/补采接口 -3. 数据库表measure_title的几个指标项带有'\n'问题 -4. OMC Web UI 问题修复: 活动告警/历史告警查询 -5. 性能管理测量任务的创建修改优化, 测量数据的多维度查询 -6. 修改UDM任务激活成功后状态显示未激活的问题 - -2023.06.14 - -1. 中移动北向性能接口：性能数据xml文件分小时目录存储 -2. 中移动北向资源接口：资源配置数据xml文件按天目录存储 -3. 安全管理下的用户管理可以增删改 -4. 告警级别颜色可自定义，告警声音可自定义 -5. 参数配置增加optional（选填或必填），默认为选填 -6. MML增加exec shell命令，可执行linux shell命令 -7. UDM的用户数据MML命令增加export udmuser/export authdat命令，返回“本地UDM数据禁止导出” -8. 导出网元可下载zip的文件 -9. 增加UPF的参数项 -10. 删除网元判断网元状态，如果正常网元删除不成功 - -2023.06.21 - -1. 性能门限产生越限告警 -2. 增加软件管理，支持软件包上传下载和删除 -3. 支持导入网元，网元需要进行ssh密钥的发放 -4. MML命令拆分为系统操作MML和用户数据MML -5. 数据访问控制---安全部分 -6. 完成搜索框的自动检索功能---对应测试用例:7.10 性能测量数据的查询 -7. 完成导出全部、打印全部数据功能 -8. 软件完整性校验 - -2023.06.28 - -1. 增加性能报表 -2. 北向增加告警上报接口，测试需要oss的socket客户端模拟器 -3. 增加性能订阅数据表的定期备份功能 -4. 修正页面的问题：参数配置网元标识未刷新加载 -5. 修正历史告警页面的多余按钮 - - -2023.07.06 - -1. 增加跟踪管理功能项，实现跟踪任务创建/详细信息，网元暂未实现跟踪任务创建/修改/删除 -2. 北向增加黄金指标上报的相关接口 -3. 4A管控实现从账号和角色的相关查询/创建/修改/删除 -4. EMS(OMC后台)可作为一个网元增加至网元管理界面，并实现系统状态监控 -5. 网元管理的网元信息增加了省份，厂商名称，网络标识的参数设置项，并实现把网元标识（rmUID/neUID),网元名称（友好名称，UserLabel),网元虚拟化标识，省份，厂商名称，网络标识下发到网元进行设置，网元暂未实现接收该消息 -6. 性能任务修改开始时间/结束时间的完整性（增加秒） -7. 软件管理页面完成，可实现上传/下载/删除，网元的软件下发/激活/回退，和网元版本信息查询 -8. 修正活动告警/历史告警/数据管理（性能管理）的查询结果的全部数据导出功能，修正活动告警的个性化设置（告警颜色/声音） -9. 修正了性能统计任务在网元不正常情况下无法删除的问题 -10. 修正了性能统计任务在网元不存在（创建性能统计任务后未激活情况，修改了网元的标识导致查找为空）激活提示成功的问题 - -2023.07.25 - -1. 前端告警声音可自定义上传声音文件 -2. 备份管理支持网元备份文件的查看和下载/删除功能 -3. -4. - - -2023.07.29 -1. 自定义性能指标创建，查询，修改和删除 -2. 用户在线状态，用户注销 -3. 告警手动同步bug：有网元状态无法下发后续网元Get请求 -4. 性能采集超时修复bug: 时间格式问题（目前仍遗留任务挂起后激活有告警产生，及恢复告警） -5. OMC ssh mml框架，可通过ssh admin@xx.xx.xx.xx -p 2222进行登录，目前只创建了一个mml命令dsp neInfo:neType=...的脚本 - -2023.07.30 -1. restconf.yaml增加配置项omc: testMode, 为true表示测试模式, 部分操作和检测将被略过, 网元软件的激活和回退操作在testMode=true时不进行实际操作 -2. 用户登录时, 当配置项auth：session=single时一个用户只允许在线一个session, 返回403-2。 -3. Web上设置的注销等待时长将被应用在用户登录会话超时时长 -4. 添加告警前转接口的设置 -5. 修正日志设置、性能报表设置的数据回填 -6. 增加更新超时会话为离线状态 -7. 增加判断是否web的定时刷新操作，定时刷新操作不更新握手时间戳 -8. 系统操作mml分离出ausf网元部分 - -2023.07.31 -1. 修复OMC显示系统状态信息问题 -2. 告警前转增加短信接口, 记录前转日志（web界面查看日志未完成） -3. 登录增加验证码 -4. 自定义性能指标与性能门限进行关联 -5. 上传软件包时版本说明（comment）, 填充网元类型和输入的版本号, 如：AMF16.1.1 - - -2023.08.03 -1. nbi_agent问题修改 -2. omc mml 4~10 -3. 前端告警前转, 软件管理 - -2023.08.05 -1. 增加dsp nelink命令，需在表ne_link中构造数据 -2. dsp licenseinfo增加使用和功能开启列表, 可在新增的配置文件testconfig.yaml进行设置输出的数据信息 -2. 增加system_log表，启动定时任务，扫描进程情况，写入system_log -3. omc mml 增加del/atc/dea (删除/激活/去激活），后面两个暂时不可用 -4. 修复跟踪任务下发无task id - -2023.08.06 -1. 修改add/mod measuretask无法成功的问题 -2. 增加日志备份的自动定时任务 -3. 前转和北向日志增加时间搜索条件 -4. 修复OMC MML的界面命令的拼接问题 - -2023.08.07 -1. 操作维护增加dsp nbicm/upg neversion命令（用例：11.1.4/11.1.11） -2. 增加记录mml历史记录文件的功能，只能在配置文件/usr/local/omc/etc/sshsvc.yaml进行配置 （用例：11.1.17） -3. Web界面的OMC MML部分可以运行, 输入排版暂没有对齐 - -2023.08.08 -1. 操作维护增加dsp neconfig命令（用例：11.1.17 配置数据） -2. 增加user,role,permission的映射关系（RBAC）, 数据库中增加test1,test2的用户， test1只能做查询操作，test2可做查询和增加/删除/修改类操作（mml命令）（用例：11.1.17 权限） -3. 注意：后续测试用test1，test2用户，用户权限的数据没有完全配置好，admin无权限执行mml命令！ - -2023.08.10 -1. 支持4A单点登录sso功能, 注意没有对用户进行认证, 需关闭toke的校验功能 -2. 用户管理，用户组管理 （未完整实现） - - -2023.09.07 - -1. mml权限问题 - -2023.09.21 -1. 网元软件上传拆分为软件文件和校验文件，校验文件可选，目前暂未开放软件完整性校验机制 -2. 支持网元软件管理上传/下发/激活/回退 -3. 跟踪管理实现UDM数据上报的, arm平台可实现解码 -4. 新增：安全管理>菜单管理，支持动态配置菜单权限 -5. 新增：安全管理>角色管理，为更好的支持多用户使用权限的配置操作 -6. 新增：用户信息，对包含UDM/IMS/UE/AMF网元上用户数据管理。 -7. 新增：跟踪管理>信令抓包，提供网元服务流量PCAP捕获 -8. 更新：配置管理，支持LOGO更换 -9. 更新：配置管理>参数配置代码的优化 - -2023.09.22 -1. 修复了ims激活不成功问题 - -2023.09.28 -1. 用户信息-I在线IMS用户相关信息可视化/可做ims msisdn过滤 -2. 网元管理重启 没有下发restart给网元， 且是高危操作，需要有提醒确认 -3. 网元管理关机 没有下发poweroff给网元(操作可保留)， 且是高危操作，需要有提醒确认 -4. 没有抓包功能 -5. 配置文件列表最小列宽设置太大了 -6. UE在线-查询：显示的表需要优化，搞成老网管那样的显示 -7. 用户签约数据表格内容显示不完整，部分参数信息在表格和修改里没有 -8. 操作维护-用户数据MML，MML操作区，需要添加的数据中必填项建议左边加个红色*号表示必填，其余为非必填选项 -9. 用户在线状态优化 - -2023.10.21 -1.前端框架切换vue3 -2.增加菜单管理功能 -3.增加字典管理 -4.增加调度任务界面 -5.终端菜单栏 -6.接入PCF,NRF,NSSF,IMS网元 -7.网管配置-UPF：需要固定InterfaceType这一栏 -8.用户鉴权数据和签约数据搜索过用户以后，点全部获取不生效 -9.网管上进行udm配置文件参数新增时，新增的模板需要有缺省值；其他网元配置文件参数新增时，若模板参数较多，也建议填上缺省值 -10.信令跟踪，跟踪任务说明只能填数字 - -2023.11.1 -1. 调整菜单显示 -2. 增加调度任务删除过期黄金指标，过期网元备份文件,过期历史告警记录,网元配置自动备任务 -3. 前端登录页可定制，logo可定制 -4. 配置-网元管理；终端：表头需要固定 -5. 配置-备份管理：这里点删除提示成功，但是图标是x；需要刷新后才能看到指定文件删除成功 -6. 参数配置-UPF,改N3 N6接口参数信息时，一定都要求要改这个Udp Src Port，默认都是0，这要改成多少？ -7. 配置-软件管理-下发：下发版本，建议把操作里面的下发激活回退单独弄一列 -8. 性能管理-任务管理，添加任务不了，提示选择性能测量数据集 -9. x86-22.04 抓包过程中如果跳到其它界面，回不去原来的抓包界面，显示等待在抓包 -10.x86-22.04 upf不可抓包 -11.故障-活动告警-手工同步：同步后无数据显示 -12.配置-备份管理：IMS导出的配置文件无实际意义，建议导出vars.cfg -13.配置-网元管理-操作：导入失败 -14.配置-网元管理-把删除隐藏，重启显示出来 -15.主界面字体图片不太协调，需优化。注意涉及logo和公司名称的地方都要可白牌化 -16.跟踪-信令抓包-抓包参数:除UPF以外，其他网元默认用-n -s 0 -v -w -17.终端-UDM鉴权用户—新增：OPC取消必填，AMF,ALGO_INDEX增加默认值 -18.终端-UDM鉴权用户—修改：KI,OPC改为不可修改 -19.批量添加用户数据，sm_data数据改成必填项 -20.终端-UDM签约/鉴权数据-导入：不应该限制文件大小，导致文件导入不成功 -21.安全-用户管理，可以批量添加普通用户，可以批量删除普通用户，用表导入用户的时候导入不了 -22.MML-网元操作：网管下发下去的格式不对，导致回的消息异常 -23.MML-网元操作：UDM显示了AUSF的参数 -24.日志-操作日志：用户在网管的操作记录不齐全。比如配置参数就没有操作记录 -25.安全-角色管理：版本需要有默认的权限等级分配 （已提供权限分配截图，请研发出版本的时候按照要求分配权限）；角色名称要统一中文，不要有的中文有的英文；角色有4种Administrator（管理人员）Operator（运维人员）Monitor(监控人员)Visitor (普通用户)和岗位管理匹配上. -26.安全-岗位管理-岗位编码：auditor改成monitor，user改成visitor；岗位名称审计员改成监控人员 -27.安全-用户管理-新建：用户角色分配为普通角色无法获取到首页的系统状态 -28.登录界面去掉登录两个字，核心网平台的字体可以再大点 -29.系统-系统设置：系统名称，版权声明修改后再升级又会还原成默认配置 -30.系统-系统设置：升级后无法提交保存全图 -31.安全-用户管理，个人设置-基础信息：用户性别-未知去掉 -32.终端-UDM鉴权用户的KI,OPC明文显示 - -2023.11.6 -1. 修改版本号：2.2311.7 -2. NSSF网管无法显示配置参数 -3. 配置-备份管理：操作里面增加一个编辑，可以对备份的版本进行一个备注说明 -4. 配置-参数配置：重新载入按钮删除。如果只是reload的功能那不需要，当初做这个功能是部分参数不能网管配置直接生效，通过改配置文件生效才做的。网管上面改的参数是直接生效的不需要reload -5. 配置-参数配置-SMF：跟IPV6相关的参数无法配置成功 -6. 终端-UDM签约用户—4G Static IP：按照提示设置为空时，将静态IP改成动态IP不成功。需要设置为-，才能修改成功 -7. 配置-备份管理，0：15跟0：30分各备份一份，文件一样，中间时长建议加大 -8. 登录界面背景图片最大为2M，是否设置太小？ -9. 配置-参数配置，SMF参数配置中UPF Config必须要填IPv6pools，建议修改，空值也可以； -10.UPF参数修改Network Control Dnn List项，存在必选项M2M Udp Portss -11.配置-NRF-Registered NFs：此界面不存在手动增加，修改，删除。只是做网元注册到NRF的显示作用。建议删除此界面的增加，操作，删除按钮 - -2023.11.7 -1.部分用户数据异常导致所有用户数据无法显示问题 -2.安全-用户管理-新建-登录密码设置异常提示无法进行下一步操作 -3.用户数据删除N个，实际删除N+1 -4.安全-用户管理：operator登录账号改成manager,密码manager.其他默认账号提供密码。 - -2023.11.9 -1.修复了终端的UDM签约数据导入导出问题 -2.修复MML命令add authdata的ki参数无法输入字母，将int类型改为string类型 -3.用户导入导出写反了 -4.OMC Web浏览端口增加80(不通过nginx), 原有8888仍可访问(通过nginx) -5.参数重载移到网元操作 - -2023.11.24 -1. 支持中英文切换 -2. 告警菜单移至监控(monitor) -3. 网元参数配置参数名整改：专用缩略语大小写问题 -4. 建议首页显示系统时间，统计时间是按系统时间来的（时间同步功能） -5. 用户数据MML中添加4G参数选项，另外如果在MML命令输入框中已经输入完整命令的话可以识别是否填了必选项，如果有填可以直接执行成功，同时不用在下面的必选框中再填入一遍必选项数据。 -6. 故障-故障通用设置-前转发不了 -7. 安全-用户管理-新建：用户角色选项要和角色管理的角色名称匹配上，应支持添加同等级用户：如管理员应该可以支持添加新的管理员。11月1日版本：操作员权限用户能添加admin的账户 -8. MML，用户数据添加界面没有4G参数部分可填写 -9. MML-UDM操作-签约数据-Batch Modify Subscriber Data应支持所有参数的修改（同单个用户数据修改一致）" -10. MML-UMD操作-Upload Subscriber Data这条命令进行隐藏或者删除 -11. 配置-UDM-Service Area Restriction,DNN Conf,EPS APN,Application Server 类别的参数需要默认显示参数值而不是数字 -12. 安全-用户管理：重新添加与已删除的用户名相同用户名无法添加成功 -13. UDM签约数据，添加UDM签约数据时，没有4G Contextlist，默认值为000000000，需要新增一个Contextlist，txt导入用户数据需要一个模版，参照模板添加数据进行导入 - -2.2312.9-20231222 - -Back-end: - -- 新增 性能 KPI 统计数据获取接口 -- 新增 网元日志列表获取接口 -- 新增 PCF 用户策略控制交互接口 -- 修复 UDM 用户数据导入 imsi 空值异常错误 -- 修复 列表数据分页最大页面数导致的读取数据不全问题 -- 修复 调度任务日志查询全部数据接口异常 -- 优化 UDM 用户数据同步信息及时更新 -- 优化 获取网元状态接口请求耗时过长 -- 优化 用户管理导入支持预先分别角色权限 -- 增加setomc.sh脚本，命令行格式：setomc.sh -m {install/upgrade/upgvue3} -c {BA/...}, -m参数调用了importdb.sh, -c参数加"BA"表示设置BA的定制化OMC配置, 默认不执行定制化过程 -- 暂时屏蔽IMS网元的MML命令 -- UDM签约用户数据增加/批量增加MML的字段4G static IP改为非必选 - -Front-end: - -- 新增 日志管理查看网元日志文件并下载功能页面 -- 新增 国际化切换权限控制，系统设置里控制切换默认语言 -- 新增 性能管理 KPI 指标集功能页面 -- 新增 UE 管理 PCF 用户策略控制功能页面 -- 修复 参数配置新增数据类型值不匹配导致的异常失败 -- 修复 多处英文显示词义不明确的信息提示 -- 修复 UE 管理 UDM 签约用户数据批量新增时EPSODB转换十六进制问题 -- 优化 网元管理重启接口超时导致网元信息不一致问题 -- 优化 参数配置新增编辑参数顺序，参数类型格式化 -- 优化 主页网元状态饼图颜色选择自定义 -- 优化 MML 操作 UDM 签约用户信息字段，必填项标红 -- 优化 软件管理回退功能操作页面 -- 优化 静态文件地址追加随机戳避免缓存 -- 优化 补充移动端样式适配调整 -- 主页修改增加OMC的序列号，点击网元信息不再覆盖右边信息框 \ No newline at end of file diff --git a/docs/tips.txt b/docs/tips.txt deleted file mode 100644 index 46af34c..0000000 --- a/docs/tips.txt +++ /dev/null @@ -1,83 +0,0 @@ -rsync -avz agtuser@192.168.6.188:/home/agtuser/goprojects /home/simon - - -ssh root@192.168.122.229 - -192.168.0.109 - - -防火墙配置 -firewall-cmd --add-service=https --permanent -firewall-cmd --add-service=samba --permanent - -firewall-cmd --add-port=8888/tcp --permanent - -firewall-cmd --add-port=445/tcp --permanent #samba -firewall-cmd --add-port=139/tcp --permanent #samba - -firewall-cmd --reload -firewall-cmd --list-all - -add measuretask:netype=AMF,neids=["SZ_T01"],granuloption=30M,kpiset=[{"Code":"AMFHA01","KPIs":["AMF.AuthReq"]}] - -lst measuredata:id=40,starttime="2023-07-10 09:50:13",endtime="2023-07-10 11:00:00" - - -lst measuredata:id=40,kpiid=UDM.SmfUecmRegReq,starttime="2023-07-10 13:36:01" - -/api/rest/dataManagement/v1/omc_db/param_config?SQL=select+ne_type,ne_id,top_tag,json_extract(param_json,'$.*[*].name')+AS+param_name,JSON_EXTRACT(param_json,'$.*[*].value')+as+param_value+from+param_config - -select+ne_type,ne_id,top_tag,json_extract(param_json,'$.*[*].name')+AS+param_name,JSON_EXTRACT(param_json,'$.*[*].value')+as+param_value+from+param_config - - -license: - -lst license -dep license:srcnetype=AMF,srcneid=SZ_01,dstnetype=SMF,dstneid=SZ_01,number=50 -rel license:number=1000 -ins license:netype=UDM,neid=SZ_01,number=10000 -adj license:netype=UDM,neid=SZ_01,number=-100 -exp license:netype=UDM,neid=SZ_01 -uni license:netype=AMF,neid=SZ_01 - - -java -Dfile.encoding=utf-8 -jar ost-20230807.jar - -#导出数据库所有的表结构和数据 -mysqldump -h 192.168.2.211 -P 33066 -u root -p1000omc@kp! omc_db > omc_db.sql - -#导出数据库user表结构和数据 -mysqldump -h 192.168.2.211 -P 33066 -u root -p1000omc@kp! omc_db user > omc_db.sql - ---with-t1lib ---with-openssl - -./configure --prefix=/usr/local/php --with-config-file-path=/usr/local/php/etc --with-pear --with-gd --with-jpeg-dir --with-png-dir --with-zlib --with-xpm-dir --with-freetype-dir --with-mcrypt --with-mhash --with-mysql --with-mysqli --enable-pdo --with-pdo-mysql --with-xmlrpc --with-xsl --with-gettext --with-fpm-user=www-data --with-fpm-group=www-data --enable-fpm --enable-exif --enable-wddx --enable-zip --enable-bcmath -with-bz2 --enable-calendar --enable-ftp --enable-mbstring --enable-soap --enable-sockets --enable-shmop --enable-dba --enable-sysvmsg --enable-sysvsem --enable-sysvshm --enable-debug --enable-maintainer-zts --enable-embed --with-curl --with-libdir=/lib --with-xpm-dir=/usr - -ln -s /usr/lib/x86_64-linux-gnu/libXpm.so /usr/lib/ -ln -s /usr/lib/x86_64-linux-gnu/libXpm.a /usr/lib/ - -ln -s usr/include/x86_64-linux-gnu/curl/easy.h /usr/include/curl - -cd php-7.3.5/ -sed -i "s/freetype-config/pkg-config/g" ./configure -sed -i "s/freetype-config/pkg-config/g" ./ext/gd/config.m4 -sed -i "s/FREETYPE2_CONFIG --cflags/FREETYPE2_CONFIG freetype2 --cflags/g" ./configure -sed -i "s/FREETYPE2_CONFIG --libs/FREETYPE2_CONFIG freetype2 --cflags/g" ./configure - - -# 导入参数配置文件 -D:\omc.git\ems.agt\tools\loadpconf> go run .\loadpconf.go .\load.go .\db.go -p ..\..\config\param\udm_param_config.yaml -# 导入mml配置文件 -# 需配置load -D:\omc.git\ems.agt\tools\loadmconf> go run .\loadmconf.go .\load.go .\db.go -m ..\..\config\mml\system\mme_sys_mml_config.yaml - -# ssh信任关系绑定出错时，执行 -ssh-keygen -f "/root/.ssh/known_hosts" -R "20.15.0.190" - -# mariadb 10.6 创建修改用户密码和权限 -grant all privileges on *.* to root@'%' IDENTIFIED BY "admin123@EMS" with grant option; -flush privileges; - -grant all privileges on *.* to root@'localhost' IDENTIFIED BY "admin123@EMS" with grant option; -flush privileges; \ No newline at end of file diff --git a/env/OMC HTTP RESTful test cases.postman_collection.json b/env/OMC HTTP RESTful test cases.postman_collection.json deleted file mode 100644 index 7540329..0000000 --- a/env/OMC HTTP RESTful test cases.postman_collection.json +++ /dev/null @@ -1,6930 +0,0 @@ -{ - "info": { - "_postman_id": "3c1b252d-5d9f-488f-b685-82ffcce540f5", - "name": "EMS restful test cases", - "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "24850046", - "_collection_link": "https://restless-shadow-352614.postman.co/workspace/Team-Workspace~d23af9a8-708c-4cc8-8f2c-d6c797709730/collection/24850046-3c1b252d-5d9f-488f-b685-82ffcce540f5?action=share&source=collection_link&creator=24850046" - }, - "item": [ - { - "name": "resourceManagement", - "item": [ - { - "name": "192.168.6.188:3030/api/rest/resourceManagement/v1/elementType/AMF/objectType/ManagedElement?rmUIDs=3101AGCNAAMF012345679", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "77724f05-167e-57aa-0429-308d327b01e5", - "type": "text" - } - ], - "url": { - "raw": "192.168.6.188:3030/api/rest/resourceManagement/v1/elementType/AMF/objectType/ManagedElement?rmUIDs=3000AGCNAMF12,3002AGCNAMF12&fields=111", - "host": [ - "192", - "168", - "6", - "188" - ], - "port": "3030", - "path": [ - "api", - "rest", - "resourceManagement", - "v1", - "elementType", - "AMF", - "objectType", - "ManagedElement" - ], - "query": [ - { - "key": "rmUIDs", - "value": "3000AGCNAMF12,3002AGCNAMF12" - }, - { - "key": "fields", - "value": "111" - } - ] - } - }, - "response": [] - }, - { - "name": "192.168.6.188:3030/api/rest/resourceManagement/v1/elementType/AMF/objectType/ManagedElement?rmUIDs=3333&fields=", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "b4d4a92c-8302-a257-5218-088cc7611243", - "type": "text" - } - ], - "url": { - "raw": "192.168.6.188:3030/api/rest/resourceManagement/v1/elementType/AMF/objectType/ManagedElement?rmUIDs=3333&fields=AdministrativeState,Id", - "host": [ - "192", - "168", - "6", - "188" - ], - "port": "3030", - "path": [ - "api", - "rest", - "resourceManagement", - "v1", - "elementType", - "AMF", - "objectType", - "ManagedElement" - ], - "query": [ - { - "key": "rmUIDs", - "value": "3333" - }, - { - "key": "fields", - "value": "AdministrativeState,Id" - } - ] - } - }, - "response": [] - }, - { - "name": "GET NRM SMF", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "2dee31c3-8e5c-3959-ad5d-437271ecceab", - "type": "text" - } - ], - "url": { - "raw": "192.168.4.134:8081/api/rest/resourceManagement/v1/elementType/SMF/objectType/AddrPool?rmUIDs=", - "host": [ - "192", - "168", - "4", - "134" - ], - "port": "8081", - "path": [ - "api", - "rest", - "resourceManagement", - "v1", - "elementType", - "SMF", - "objectType", - "AddrPool" - ], - "query": [ - { - "key": "rmUIDs", - "value": "" - } - ] - } - }, - "response": [] - }, - { - "name": "51 rmUIDs case", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "c8ddd571-b6a3-6111-fbef-44e96d2c1f9c", - "type": "text" - } - ], - "url": { - "raw": "192.168.6.188:3000/api/rest/resourceManagement/v1/elementType/AMF/objectType/ManagedElement?rmUIDs=1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51", - "host": [ - "192", - "168", - "6", - "188" - ], - "port": "3000", - "path": [ - "api", - "rest", - "resourceManagement", - "v1", - "elementType", - "AMF", - "objectType", - "ManagedElement" - ], - "query": [ - { - "key": "rmUIDs", - "value": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "OAuth", - "item": [ - { - "name": "LOGIN 192.168.2.219:3040", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"admin\",\r\n \"value\": \"rootaa\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "http://192.168.2.219:3040/api/rest/securityManagement/v1/oauth/token", - "protocol": "http", - "host": [ - "192", - "168", - "2", - "219" - ], - "port": "3040", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "LOGIN 192.168.2.119:3040 Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"admin\",\r\n \"value\": \"rootaa\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "2", - "119" - ], - "port": "3040", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "LOGOUT 192.168.2.119", - "request": { - "method": "DELETE", - "header": [ - { - "key": "accessToken", - "value": "fb69dc20-cc40-4109-2afb-067152506847", - "type": "text" - }, - { - "key": "Content-Type", - "value": "", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "192.168.2.119:3030/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "2", - "119" - ], - "port": "3030", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "handshake 192.168.2.119", - "request": { - "method": "POST", - "header": [], - "url": { - "raw": "192.168.2.119:3040/api/rest/securityManagement/v1/oauth/handshake", - "host": [ - "192", - "168", - "2", - "119" - ], - "port": "3040", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "handshake" - ] - } - }, - "response": [] - }, - { - "name": "Invalid content-type case", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"test\",\r\n \"value\": \"123456\"\r\n}", - "options": { - "raw": { - "language": "javascript" - } - } - }, - "url": { - "raw": "192.168.6.188:3000/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "6", - "188" - ], - "port": "3000", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "Invalid content-type case Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"test\",\r\n \"value\": \"123456\"\r\n}", - "options": { - "raw": { - "language": "javascript" - } - } - }, - "url": { - "raw": "192.168.6.188:3000/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "6", - "188" - ], - "port": "3000", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - } - ] - }, - { - "name": "CMCA", - "item": [ - { - "name": "CMCA", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"cmca\",\r\n \"userName\": \"omc\",\r\n \"value\": \"WDwcC3NQswL2Bw7C2fY+D02v5vohER9IN4Ab+FFM7eGSzq6Rx72By/SLct/Zpr6fn4GQbsHYag08Bix8rX3/sSe9e3j/9YY9olsSloqBJF5ZJFACskerY/cdXdKnoAgylDwFvOl8u5j5OFMFe2HE106E2WOAayB2UKrzPL1wL16cXqKBSocZDz8huLHILWZI/E0VEiGAcMffghYEHolF+IEykP7e0Lq+ywd+uUsBSm5POSu5CM20ITuupLxf+alpwgI13gOic1yy8gJQVhL68u5liCxh6KoSed/hOgaE2usLF4tbeC4zS3FpyF3Hw46KMSReRVRgw1lNblMUGBW61g==\",\r\n \"cert\": \"\\n-----BEGIN CERTIFICATE-----\\nMIIC4jCCAcqgAwIBAgICB+cwDQYJKoZIhvcNAQELBQAwEjEQMA4GA1UEAxMHUm9v\\ndCBDQTAeFw0yMzA4MTIxODA5MzZaFw0zMzA4MTIxODA5MzZaMBIxEDAOBgNVBAMT\\nB1Jvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCUTcFiT1GT\\nZq9ROKTuWm6IfFthO6ysthEKevwkgJGDRCwF+K6rx3j7izTDfLkXum5OPbcd/yiE\\nB40Yrq9X2ckX260xG9PjDmGUaq8q5sza85Gg2hrW6wiLF9y8yYK3/v7716d0y6st\\njt71pH554R98m0zHkbkmrFEagWR5cEoVM6MPZp2wdDnOFBBRiB1BrbHMpAFiKJ6s\\noqm1yhUwCeeR/Hs09JF8KfOFhV4qAEVvE1cviHucCEvLBaG6xBzbKvYV2iOPu6u2\\no818wphqmSZYoj3/O4/EyVgvj1VdSqmkTSudiiIhLAa8/2JKrW1v7wFQjRkwNwdf\\nh6UR5liIUwk7AgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTAD\\nAQH/MB0GA1UdDgQWBBRtEF/Jyw6Zz3v0K5uA6aMOr9LXRTANBgkqhkiG9w0BAQsF\\nAAOCAQEAErmFo6JjEoFZv8R2gwNUq7ln+YEh2hX4myLlNDfTpYeGnn2Ge70Kmb0o\\ndkSyanDd9tGImcbEOttWAYve3vetvN3g+GONbf5pV7ClIbVV5MsjN/aGwj/TQWhu\\nttmfu9IV2b5HyFEM61eoHVrNoWiNpbNHTu5D/XF8sg5JkseTnJF06foykzAx28i6\\nJcttunYn5SoWTIS9Ydu07X7uBcTeFBcKfH0xg4QlsNppiM5lIxBbp0WjQ8jyWw+b\\nLyef4N6hmiaOf6P6qwaVZkEBhK6MVf1zadURuUSWAkhwGFjA7IbjbJ7OfYLXkYp3\\nmIrXQzjxz6AfyOcY/FsgcaDLf5xbYw==\\n-----END CERTIFICATE-----\\n\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://172.25.97.150/api/rest/securityManagement/v1/oauth/token", - "protocol": "https", - "host": [ - "172", - "25", - "97", - "150" - ], - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "CMCA Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"admin\",\r\n \"value\": \"rootaa\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "2", - "119" - ], - "port": "3040", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "LOGOUT 192.168.2.119", - "request": { - "method": "DELETE", - "header": [ - { - "key": "accessToken", - "value": "fb69dc20-cc40-4109-2afb-067152506847", - "type": "text" - }, - { - "key": "Content-Type", - "value": "", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "192.168.2.119:3030/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "2", - "119" - ], - "port": "3030", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "handshake 192.168.2.119", - "request": { - "method": "POST", - "header": [], - "url": { - "raw": "192.168.2.119:3040/api/rest/securityManagement/v1/oauth/handshake", - "host": [ - "192", - "168", - "2", - "119" - ], - "port": "3040", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "handshake" - ] - } - }, - "response": [] - }, - { - "name": "Invalid content-type case", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"test\",\r\n \"value\": \"123456\"\r\n}", - "options": { - "raw": { - "language": "javascript" - } - } - }, - "url": { - "raw": "192.168.6.188:3000/api/rest/securityManagement/v1/oauth/token", - "host": [ - "192", - "168", - "6", - "188" - ], - "port": "3000", - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - } - ] - }, - { - "name": "New EMS test", - "item": [ - { - "name": "System Management", - "item": [ - { - "name": "ALL NEs systemState", - "request": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "{{Authorization}}", - "type": "text" - } - ], - "url": { - "raw": "{{omc_local}}/api/rest/systemManagement/v1/elementType/ALL/objectType/systemState", - "host": [ - "{{omc_local}}" - ], - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "ALL", - "objectType", - "systemState" - ] - }, - "description": "Get ALL NEs systemState" - }, - "response": [ - { - "name": "ALL NEs systemState", - "originalRequest": { - "method": "GET", - "header": [ - { - "key": "Authorization", - "value": "{{Authorization}}", - "type": "text" - } - ], - "url": { - "raw": "{{omc_local}}/api/rest/systemManagement/v1/elementType/ALL/objectType/systemState", - "host": [ - "{{omc_local}}" - ], - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "ALL", - "objectType", - "systemState" - ] - } - }, - "_postman_previewlanguage": null, - "header": null, - "cookie": [], - "body": null - } - ] - }, - { - "name": "Get UDM state From OMC", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "33bf9e86-2a05-8377-4619-bb01b0a8e18e", - "type": "text", - "disabled": true - } - ], - "url": { - "raw": "{{omc_local}}/api/rest/systemManagement/v1/elementType/{{elementTypeValue}}/objectType/systemState?ne_id='SZ_R01'", - "host": [ - "{{omc_local}}" - ], - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "{{elementTypeValue}}", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_R01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get UDM state From NF", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.15.63:3030/api/rest/systemManagement/v1/elementType/udm/objectType/systemState?ne_id='SZ_01'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get OMC state From Local", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/ems/objectType/systemState?ne_id='SZ_T01'", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "ems", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_T01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get OMC state From Remote", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "668e3aba-b7bd-4918-36df-5a27f0703969", - "type": "text" - } - ], - "url": { - "raw": "192.168.0.229:3030/api/rest/systemManagement/v1/elementType/udm/objectType/systemState?ne_id='SZ_01'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get OMC sysinfo From Remote", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/ems/objectType/systemState?ne_id='SZ_T01'", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "ems", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_T01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get EMS state from 192.168.0.229", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "ed516ed3-ac0a-312e-a1ab-207655ba8fa0", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.0.229:3030/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "protocol": "http", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "all", - "objectType", - "systemState" - ] - } - }, - "response": [] - }, - { - "name": "Get ALL NF --192.168.30.20:3030/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/systemManagement/v1/elementType/smf/objectType/systemState?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "smf", - "objectType", - "systemState" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - }, - { - "name": "Get SINGLE NF --192.168.30.20:3030/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/smf/objectType/systemState?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "smf", - "objectType", - "systemState" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - }, - { - "name": "Get OMC Local Time", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "omc-1e618113-42d3-3efe-6ae6-baa0b7e26ad4", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.219:3040/api/rest/systemManagement/v1/elementType/OMC/objectType/time", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "OMC", - "objectType", - "time" - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Get sysInfo & licenseInfo", - "item": [ - { - "name": "Get ALL SMF", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "all", - "objectType", - "systemState" - ] - } - }, - "response": [] - }, - { - "name": "Get UDM state From OMC", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3030/api/rest/systemManagement/v1/elementType/UDM/objectType/systemState?ne_id='SZ_01'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "UDM", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get UDM state From NF", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.15.63:3030/api/rest/systemManagement/v1/elementType/udm/objectType/systemState?ne_id='SZ_01'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get OMC state From Local", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/ems/objectType/systemState?ne_id='SZ_T01'", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "ems", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_T01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get OMC sysInfo From Remote", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "b18fcf3e-9076-eebd-2d8e-a9d855666f39", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/sysInfo/smf/sz_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "sysInfo", - "smf", - "sz_01" - ] - } - }, - "response": [] - }, - { - "name": "Get OMC sysinfo From Remote", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/ems/objectType/systemState?ne_id='SZ_T01'", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "ems", - "objectType", - "systemState" - ], - "query": [ - { - "key": "ne_id", - "value": "'SZ_T01'" - } - ] - } - }, - "response": [] - }, - { - "name": "Get EMS state from 192.168.0.229", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "ed516ed3-ac0a-312e-a1ab-207655ba8fa0", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.0.229:3030/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "protocol": "http", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "all", - "objectType", - "systemState" - ] - } - }, - "response": [] - }, - { - "name": "Get ALL NF --192.168.30.20:3030/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/systemManagement/v1/elementType/smf/objectType/systemState?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "smf", - "objectType", - "systemState" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - }, - { - "name": "Get SINGLE NF --192.168.30.20:3030/api/rest/systemManagement/v1/elementType/all/objectType/systemState", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/smf/objectType/systemState?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "smf", - "objectType", - "systemState" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "databaseManagement", - "item": [ - { - "name": "菜单目录查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu?SQL=select m.id, JSON_UNQUOTE(json_extract(t.`title_json`, '$.cn')) as title, m.parent_id, m.sort_id from title_info t, menu m where m.id IN (select am.menu_id from account_menu am where am.account_id = (select id FROM account where `name`='manager')) AND m.title_id = t.id ORDER BY m.id", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "menu" - ], - "query": [ - { - "key": "SQL", - "value": "select m.id, JSON_UNQUOTE(json_extract(t.`title_json`, '$.cn')) as title, m.parent_id, m.sort_id from title_info t, menu m where m.id IN (select am.menu_id from account_menu am where am.account_id = (select id FROM account where `name`='manager')) AND m.title_id = t.id ORDER BY m.id" - } - ] - } - }, - "response": [] - }, - { - "name": "表备份", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu?SQL=select m.id, JSON_UNQUOTE(json_extract(t.`title_json`, '$.cn')) as title, m.parent_id, m.sort_id from title_info t, menu m where m.id IN (select am.menu_id from account_menu am where am.account_id = (select id FROM account where `name`='manager')) AND m.title_id = t.id ORDER BY m.id", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "menu" - ], - "query": [ - { - "key": "SQL", - "value": "select m.id, JSON_UNQUOTE(json_extract(t.`title_json`, '$.cn')) as title, m.parent_id, m.sort_id from title_info t, menu m where m.id IN (select am.menu_id from account_menu am where am.account_id = (select id FROM account where `name`='manager')) AND m.title_id = t.id ORDER BY m.id" - } - ] - } - }, - "response": [] - }, - { - "name": "Get黄金指标说明kpi_desc", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_db/objectType/kpi_desc?SQL=select json_unquote(json_extract(title_json, '$.cn')) as title from kpi_title where ne_type='SMF'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "kpi_desc" - ], - "query": [ - { - "key": "SQL", - "value": "select json_unquote(json_extract(title_json, '$.cn')) as title from kpi_title where ne_type='SMF'" - } - ] - } - }, - "response": [] - }, - { - "name": "菜单account_priv192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu Copy 2", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu?SQL=select menu_json as menu from account_priv where account_id=(select id from account where name='manager')", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "menu" - ], - "query": [ - { - "key": "SQL", - "value": "select menu_json as menu from account_priv where account_id=(select id from account where name='manager')" - } - ] - } - }, - "response": [] - }, - { - "name": "分页查询用例", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/account?SQL=select * from account&PAGE=1&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "account" - ], - "query": [ - { - "key": "SQL", - "value": "select * from account" - }, - { - "key": "PAGE", - "value": "1" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "多SQL分页查询用例", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/account?SQL=select count(*) from account&SQL=select * from account&PAGE=2&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "account" - ], - "query": [ - { - "key": "SQL", - "value": "select count(*) from account" - }, - { - "key": "SQL", - "value": "select * from account" - }, - { - "key": "PAGE", - "value": "2" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "where条件查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://127.0.0.1:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sys_info?WHERE=status='0'", - "protocol": "http", - "host": [ - "127", - "0", - "0", - "1" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "sys_info" - ], - "query": [ - { - "key": "WHERE", - "value": "status='0'" - } - ] - } - }, - "response": [] - }, - { - "name": "where条件查询", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://127.0.0.1:3040/api/rest/databaseManagement/v1/omc_db/ne_info?WHERE=ne_type='amf'", - "protocol": "http", - "host": [ - "127", - "0", - "0", - "1" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "ne_info" - ], - "query": [ - { - "key": "WHERE", - "value": "ne_type='amf'" - } - ] - } - }, - "response": [] - }, - { - "name": "查询PARAM_CONFIG WHERE", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.2.119:3030/api/rest/databaseManagement/v1/omc_db/param_config?WHERE=id='1'", - "protocol": "http", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "param_config" - ], - "query": [ - { - "key": "WHERE", - "value": "id='1'" - } - ] - } - }, - "response": [] - }, - { - "name": "查询PARAM_CONFIG SQL", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/param_config?WHERE=id='1'", - "protocol": "http", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "param_config" - ], - "query": [ - { - "key": "WHERE", - "value": "id='1'" - } - ] - } - }, - "response": [] - }, - { - "name": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/alarm?SQL=SELECT COUNT(*) FROM ALARM WHERE ALARM_STATUS=1", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "alarm" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT COUNT(*) FROM ALARM WHERE ALARM_STATUS=1" - } - ] - } - }, - "response": [] - }, - { - "name": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/tb_menu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/systemManagement/v1/elementType/smf/objectType/systemState", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "smf", - "objectType", - "systemState" - ] - } - }, - "response": [] - }, - { - "name": "多SQL查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/elementType/omc_db/objectType/ne_state?SQL=SELECT count(*) FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'&SQL=SELECT *,CONCAT(DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:'),FLOOR(SECOND(timestamp)/10)*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'GROUP BY ne_type,DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:00') ORDER BY interval_start", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "ne_state" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT count(*) FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'" - }, - { - "key": "SQL", - "value": "SELECT *,CONCAT(DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:'),FLOOR(SECOND(timestamp)/10)*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'GROUP BY ne_type,DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:00') ORDER BY interval_start" - } - ] - } - }, - "response": [] - }, - { - "name": "多SQL查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu Copy", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/elementType/omc_db/objectType/ne_state?SQL=SELECT *, CONCAT(DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:'),FLOOR(SECOND(timestamp))*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'GROUP BY ne_type,DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:00') ORDER BY interval_start&PAGE=1&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "ne_state" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT *, CONCAT(DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:'),FLOOR(SECOND(timestamp))*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'GROUP BY ne_type,DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:00') ORDER BY interval_start" - }, - { - "key": "PAGE", - "value": "1" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "多SQL查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu Copy 2", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/elementType/omc_db/objectType/ne_state?SQL=SELECT count(*) FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'&SQL=SELECT *,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00' GROUP BY ne_type,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) ORDER BY interval_start&PAGE=1&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "ne_state" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT count(*) FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'" - }, - { - "key": "SQL", - "value": "SELECT *,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00' GROUP BY ne_type,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) ORDER BY interval_start" - }, - { - "key": "PAGE", - "value": "1" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"user\": [\r\n {\r\n \"name\": \"test3\",\r\n \"real_name\": \"113\",\r\n \"password\": \"PASSWORD(\\\"rootaa\\\")\",\r\n \"group_name\": \"admin\",\r\n \"phone\": \"1999\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/user", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "user" - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录operation_log-192.168.30.59:3030", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"operation_log\": [\r\n {\r\n \"account_name\":\"manager\",\r\n \"account_type\": 1,\r\n \"op_ip\": \"192.168.30.59\",\r\n \"subsys_tag\": \"SMF_0\",\r\n \"op_type\": 2,\r\n \"op_content\": \"0\"\r\n \"op_result\": \"0\"\r\n \"op_result\": \"0\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/insert/omc_db/operation_log", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "insert", - "omc_db", - "operation_log" - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录alarm_log", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"alarm_log\": [\r\n {\r\n \"ne_type\": \"SMF\",\r\n \"ne_id\": \"SMF_0\",\r\n \"alarm_id\": \"2\",\r\n \"alarm_code\": \"2\",\r\n \"alarm_seq\": \"3\",\r\n \"event_time\": \"2023-03-29 15:52:09\"\r\n\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/dataManagement/v1/omc_db/alarm_log", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "dataManagement", - "v1", - "omc_db", - "alarm_log" - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录ne_info", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": [\r\n {\r\n \"ne_type\": \"SMF\",\r\n \"ne_id\": \"SMF_0\",\r\n \"alarm_id\": \"2\",\r\n \"alarm_code\": \"2\",\r\n \"alarm_seq\": \"3\",\r\n \"event_time\": \"2023-03-29 15:52:09\"\r\n\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/alarm_log", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "alarm_log" - ] - } - }, - "response": [] - }, - { - "name": "Backup alarm_log", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": [\r\n {\r\n \"ne_type\": \"SMF\",\r\n \"ne_id\": \"SMF_0\",\r\n \"alarm_id\": \"2\",\r\n \"alarm_code\": \"2\",\r\n \"alarm_seq\": \"3\",\r\n \"event_time\": \"2023-03-29 15:52:09\"\r\n\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/alarm_log", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "alarm_log" - ] - } - }, - "response": [] - }, - { - "name": "INSERT多条记录", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"menu\": [\r\n {\r\n \"id\": 3,\r\n \"title\": \"test3\",\r\n \"icon\": \"113\",\r\n \"href\": \"1113\",\r\n \"parent_id\": 2,\r\n \"remark\": \"0\"\r\n },\r\n {\r\n \"href\": \"31\",\r\n \"icon\": \"313\",\r\n \"id\": 2,\r\n \"parent_id\": 1,\r\n \"remark\": \"0\",\r\n \"title\": \"test1\"\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/insert/omc_pub", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "insert", - "omc_pub" - ] - } - }, - "response": [] - }, - { - "name": "UPDATE单条记录", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"user\": {\r\n \"name\": \"test3\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/omc_db/user?WHERE=name=test3", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "user" - ], - "query": [ - { - "key": "WHERE", - "value": "name=test3" - } - ] - } - }, - "response": [] - }, - { - "name": "UPDATE MeasureTask", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"measure_task\": {\r\n \"id\": \"28\",\r\n \"ne_type\": \"SMF\",\r\n \"ne_ids\": \"[\\\"SZ_01\\\"]\",\r\n \"kpi_set\": \"[{\\\"Code\\\":\\\"SMFHA01\\\",\\\"KPIs\\\":[\\\"SMF.AttCreatePduSession\\\",\\\"SMF.AttCreatePduSession._Dnn\\\"]}]\",\r\n \"schedule\": \"[{\\\"Type\\\":\\\"\\\",\\\"Days\\\":[]}]\",\r\n \"start_time\": \"\",\r\n \"end_time\": \"\",\r\n \"granul_option\": \"30M\",\r\n \"status\": \"Inactive\",\r\n \"create_time\": \"2023-5-25 21:59:9\",\r\n \"periods\": \"[]\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/databaseManagement/v1/omc_db/measure_task", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "measure_task" - ] - } - }, - "response": [] - }, - { - "name": "UPDATE config单条记录", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": {\r\n \"value\": \"10\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/omc_db/config?WHERE=config_tag='logDuration'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "config" - ], - "query": [ - { - "key": "WHERE", - "value": "config_tag='logDuration'" - } - ] - } - }, - "response": [] - }, - { - "name": "UPDATE config CASE", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": {\r\n \"value\": \"CASE config_tag WHEN 'historyDuration' THEN 3 WHEN 'syncTaskPeriod' THEN 4 END\"\r\n }\r\n}\r\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/config?WHERE=config_tag in ('historyDuration', 'syncTaskPeriod')", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "config" - ], - "query": [ - { - "key": "WHERE", - "value": "config_tag in ('historyDuration', 'syncTaskPeriod')" - } - ] - } - }, - "response": [] - }, - { - "name": "DELETE记录", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/databaseManagement/v1/delete/omc_db/alarm?WHERE=alarm_id in (17,19)", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "delete", - "omc_db", - "alarm" - ], - "query": [ - { - "key": "WHERE", - "value": "alarm_id in (17,19)" - } - ] - } - }, - "response": [] - }, - { - "name": "DELETE alarm 历史告警超过90天记录", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/databaseManagement/v1/delete/omc_db/alarm?WHERE=event_time ", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "delete", - "omc_db", - "alarm" - ], - "query": [ - { - "key": "WHERE", - "value": "event_time " - } - ] - } - }, - "response": [] - }, - { - "name": "模糊查询ALARM带%", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/alarm?SQL=SELECT * FROM ALARM WHERE object_id like 'AMF%25'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "alarm" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT * FROM ALARM WHERE object_id like 'AMF%25'" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "dataManagement", - "item": [ - { - "name": "表备份", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu?SQL=select m.id, JSON_UNQUOTE(json_extract(t.`title_json`, '$.cn')) as title, m.parent_id, m.sort_id from title_info t, menu m where m.id IN (select am.menu_id from account_menu am where am.account_id = (select id FROM account where `name`='manager')) AND m.title_id = t.id ORDER BY m.id", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "menu" - ], - "query": [ - { - "key": "SQL", - "value": "select m.id, JSON_UNQUOTE(json_extract(t.`title_json`, '$.cn')) as title, m.parent_id, m.sort_id from title_info t, menu m where m.id IN (select am.menu_id from account_menu am where am.account_id = (select id FROM account where `name`='manager')) AND m.title_id = t.id ORDER BY m.id" - } - ] - } - }, - "response": [] - }, - { - "name": "Get黄金指标说明kpi_desc", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_db/objectType/kpi_desc?SQL=select json_unquote(json_extract(title_json, '$.cn')) as title from kpi_title where ne_type='SMF'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "kpi_desc" - ], - "query": [ - { - "key": "SQL", - "value": "select json_unquote(json_extract(title_json, '$.cn')) as title from kpi_title where ne_type='SMF'" - } - ] - } - }, - "response": [] - }, - { - "name": "菜单account_priv192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu Copy 2", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu?SQL=select menu_json as menu from account_priv where account_id=(select id from account where name='manager')", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "menu" - ], - "query": [ - { - "key": "SQL", - "value": "select menu_json as menu from account_priv where account_id=(select id from account where name='manager')" - } - ] - } - }, - "response": [] - }, - { - "name": "分页查询用例", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/account?SQL=select * from account&PAGE=1&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "account" - ], - "query": [ - { - "key": "SQL", - "value": "select * from account" - }, - { - "key": "PAGE", - "value": "1" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "多SQL分页查询用例", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/account?SQL=select count(*) from account&SQL=select * from account&PAGE=2&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "account" - ], - "query": [ - { - "key": "SQL", - "value": "select count(*) from account" - }, - { - "key": "SQL", - "value": "select * from account" - }, - { - "key": "PAGE", - "value": "2" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "where条件查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://127.0.0.1:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sys_info?WHERE=status='0'", - "protocol": "http", - "host": [ - "127", - "0", - "0", - "1" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "sys_info" - ], - "query": [ - { - "key": "WHERE", - "value": "status='0'" - } - ] - } - }, - "response": [] - }, - { - "name": "where条件查询", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://127.0.0.1:3040/api/rest/databaseManagement/v1/omc_db/ne_info?WHERE=ne_type='amf'", - "protocol": "http", - "host": [ - "127", - "0", - "0", - "1" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "ne_info" - ], - "query": [ - { - "key": "WHERE", - "value": "ne_type='amf'" - } - ] - } - }, - "response": [] - }, - { - "name": "loc measure_data", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://127.0.0.1:3040/api/rest/databaseManagement/v1/omc_db/ne_info?WHERE=ne_type='amf'", - "protocol": "http", - "host": [ - "127", - "0", - "0", - "1" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "ne_info" - ], - "query": [ - { - "key": "WHERE", - "value": "ne_type='amf'" - } - ] - } - }, - "response": [] - }, - { - "name": "查询PARAM_CONFIG WHERE", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.2.119:3030/api/rest/databaseManagement/v1/omc_db/param_config?WHERE=id='1'", - "protocol": "http", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "param_config" - ], - "query": [ - { - "key": "WHERE", - "value": "id='1'" - } - ] - } - }, - "response": [] - }, - { - "name": "查询PARAM_CONFIG SQL", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/param_config?WHERE=id='1'", - "protocol": "http", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "param_config" - ], - "query": [ - { - "key": "WHERE", - "value": "id='1'" - } - ] - } - }, - "response": [] - }, - { - "name": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/alarm?SQL=SELECT COUNT(*) FROM ALARM WHERE ALARM_STATUS=1", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "alarm" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT COUNT(*) FROM ALARM WHERE ALARM_STATUS=1" - } - ] - } - }, - "response": [] - }, - { - "name": "192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/tb_menu", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.20:3030/api/rest/systemManagement/v1/elementType/smf/objectType/systemState", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "smf", - "objectType", - "systemState" - ] - } - }, - "response": [] - }, - { - "name": "json sql查询", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/dataManagement/v1/omc_db/mml_command?sql=/api/rest/dataManagement/v1/omc_db/mml_command?sql=select operation, object, mml_display, json_extract(param_json,'$[*].name') as params FROM mml_command", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "dataManagement", - "v1", - "omc_db", - "mml_command" - ], - "query": [ - { - "key": "sql", - "value": "/api/rest/dataManagement/v1/omc_db/mml_command?sql=select operation, object, mml_display, json_extract(param_json,'$[*].name') as params FROM mml_command" - } - ] - } - }, - "response": [] - }, - { - "name": "多SQL查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu Copy", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/elementType/omc_db/objectType/ne_state?SQL=SELECT *, CONCAT(DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:'),FLOOR(SECOND(timestamp))*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'GROUP BY ne_type,DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:00') ORDER BY interval_start&PAGE=1&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "ne_state" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT *, CONCAT(DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:'),FLOOR(SECOND(timestamp))*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'GROUP BY ne_type,DATE_FORMAT(timestamp, '%Y-%m-%d %H:%i:00') ORDER BY interval_start" - }, - { - "key": "PAGE", - "value": "1" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "多SQL查询192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/sysmenu Copy 2", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/elementType/omc_db/objectType/ne_state?SQL=SELECT count(*) FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'&SQL=SELECT *,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00' GROUP BY ne_type,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) ORDER BY interval_start&PAGE=1&LIMIT=10", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_db", - "objectType", - "ne_state" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT count(*) FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00'" - }, - { - "key": "SQL", - "value": "SELECT *,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) AS interval_start,AVG(JSON_EXTRACT(cpu_usage, '$.nfCpuUsage')) AS nfCpuUsageAvg,AVG(JSON_EXTRACT(cpu_usage, '$.sysCpuUsage')) AS sysCpuUsageAvg,AVG(JSON_EXTRACT(mem_usage, '$.totalMem')) AS totalMemAvg,AVG(JSON_EXTRACT(mem_usage, '$.nfUsedMem')) AS nfUsedMemAvg, AVG(JSON_EXTRACT(mem_usage, '$.sysMemUsage')) AS sysMemUsageAvg FROM ne_state WHERE ne_type = 'SMF' AND ne_id = 'SZ_0' AND timestamp BETWEEN '2023-5-13 00:00:00 ' AND ' 2023-5-14 00:00:00' GROUP BY ne_type,CONCAT(DATE_FORMAT(timestamp, '%25Y-%25m-%25d %25H:%25i:'),FLOOR(SECOND(timestamp)/10)*10) ORDER BY interval_start" - }, - { - "key": "PAGE", - "value": "1" - }, - { - "key": "LIMIT", - "value": "10" - } - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录192.168.30.20:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/menu", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"user\": [\r\n {\r\n \"name\": \"test3\",\r\n \"real_name\": \"113\",\r\n \"password\": \"PASSWORD(\\\"rootaa\\\")\",\r\n \"group_name\": \"admin\",\r\n \"phone\": \"1999\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/user", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "user" - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录operation_log-192.168.30.59:3030", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"operation_log\": [\r\n {\r\n \"account_name\":\"manager\",\r\n \"account_type\": 1,\r\n \"op_ip\": \"192.168.30.59\",\r\n \"subsys_tag\": \"SMF_0\",\r\n \"op_type\": 2,\r\n \"op_content\": \"0\"\r\n \"op_result\": \"0\"\r\n \"op_result\": \"0\"\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/insert/omc_db/operation_log", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "insert", - "omc_db", - "operation_log" - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录alarm_log", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"alarm_log\": [\r\n {\r\n \"ne_type\": \"SMF\",\r\n \"ne_id\": \"SMF_0\",\r\n \"alarm_id\": \"2\",\r\n \"alarm_code\": \"2\",\r\n \"alarm_seq\": \"3\",\r\n \"event_time\": \"2023-03-29 15:52:09\"\r\n\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/dataManagement/v1/omc_db/alarm_log", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "dataManagement", - "v1", - "omc_db", - "alarm_log" - ] - } - }, - "response": [] - }, - { - "name": "insert单条记录ne_info", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": [\r\n {\r\n \"ne_type\": \"SMF\",\r\n \"ne_id\": \"SMF_0\",\r\n \"alarm_id\": \"2\",\r\n \"alarm_code\": \"2\",\r\n \"alarm_seq\": \"3\",\r\n \"event_time\": \"2023-03-29 15:52:09\"\r\n\r\n }\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/alarm_log", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "alarm_log" - ] - } - }, - "response": [] - }, - { - "name": "INSERT多条记录", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"menu\": [\r\n {\r\n \"id\": 3,\r\n \"title\": \"test3\",\r\n \"icon\": \"113\",\r\n \"href\": \"1113\",\r\n \"parent_id\": 2,\r\n \"remark\": \"0\"\r\n },\r\n {\r\n \"href\": \"31\",\r\n \"icon\": \"313\",\r\n \"id\": 2,\r\n \"parent_id\": 1,\r\n \"remark\": \"0\",\r\n \"title\": \"test1\"\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/insert/omc_pub", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "insert", - "omc_pub" - ] - } - }, - "response": [] - }, - { - "name": "UPDATE单条记录", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"user\": {\r\n \"name\": \"test3\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/omc_db/user?WHERE=name=test3", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "user" - ], - "query": [ - { - "key": "WHERE", - "value": "name=test3" - } - ] - } - }, - "response": [] - }, - { - "name": "UPDATE MeasureTask", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"measure_task\": {\r\n \"id\": \"28\",\r\n \"ne_type\": \"SMF\",\r\n \"ne_ids\": \"[\\\"SZ_01\\\"]\",\r\n \"kpi_set\": \"[{\\\"Code\\\":\\\"SMFHA01\\\",\\\"KPIs\\\":[\\\"SMF.AttCreatePduSession\\\",\\\"SMF.AttCreatePduSession._Dnn\\\"]}]\",\r\n \"schedule\": \"[{\\\"Type\\\":\\\"\\\",\\\"Days\\\":[]}]\",\r\n \"start_time\": \"\",\r\n \"end_time\": \"\",\r\n \"granul_option\": \"30M\",\r\n \"status\": \"Inactive\",\r\n \"create_time\": \"2023-5-25 21:59:9\",\r\n \"periods\": \"[]\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/databaseManagement/v1/omc_db/measure_task", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "measure_task" - ] - } - }, - "response": [] - }, - { - "name": "UPDATE config单条记录", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": {\r\n \"value\": \"10\"\r\n }\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/omc_db/config?WHERE=config_tag='logDuration'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "config" - ], - "query": [ - { - "key": "WHERE", - "value": "config_tag='logDuration'" - } - ] - } - }, - "response": [] - }, - { - "name": "UPDATE config CASE", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"data\": {\r\n \"value\": \"CASE config_tag WHEN 'historyDuration' THEN 3 WHEN 'syncTaskPeriod' THEN 4 END\"\r\n }\r\n}\r\n", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/databaseManagement/v1/omc_db/config?WHERE=config_tag in ('historyDuration', 'syncTaskPeriod')", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "omc_db", - "config" - ], - "query": [ - { - "key": "WHERE", - "value": "config_tag in ('historyDuration', 'syncTaskPeriod')" - } - ] - } - }, - "response": [] - }, - { - "name": "DELETE记录", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/databaseManagement/v1/delete/omc_db/alarm?WHERE=alarm_id in (17,19)", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "delete", - "omc_db", - "alarm" - ], - "query": [ - { - "key": "WHERE", - "value": "alarm_id in (17,19)" - } - ] - } - }, - "response": [] - }, - { - "name": "DELETE alarm 历史告警超过90天记录", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/databaseManagement/v1/delete/omc_db/alarm?WHERE=event_time ", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "delete", - "omc_db", - "alarm" - ], - "query": [ - { - "key": "WHERE", - "value": "event_time " - } - ] - } - }, - "response": [] - }, - { - "name": "模糊查询ALARM带%", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3030/api/rest/databaseManagement/v1/elementType/omc_pub/objectType/alarm?SQL=SELECT * FROM ALARM WHERE object_id like 'AMF%25'", - "host": [ - "{{omc_local}}" - ], - "port": "3030", - "path": [ - "api", - "rest", - "databaseManagement", - "v1", - "elementType", - "omc_pub", - "objectType", - "alarm" - ], - "query": [ - { - "key": "SQL", - "value": "SELECT * FROM ALARM WHERE object_id like 'AMF%25'" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Alarm", - "item": [ - { - "name": "Northbound Get Alarm", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "accessToken", - "value": "f4059857-600c-e1bc-f891-8d44e19d0393", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"neId\": \"SMF_0\",\r\n \"alarmId\": \"SMF0111\",\r\n \"alarmTitle\": \"test\",\r\n \"eventTime\": \"2023-03-29 15:52:09\",\r\n \"alarmCode\": 10,\r\n \"alarmType\": \"EquipmentAlarm\",\r\n \"origSeverity\": \"Major\",\r\n \"alarmStatus\": true,\r\n \"specificProblem\": \"string\",\r\n \"addInfo\": \"string\",\r\n \"locationInfo\": \"test\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/faultManagement/v1/alarms?alarmIds=11684414734622447476,11684414734622506456", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "faultManagement", - "v1", - "alarms" - ], - "query": [ - { - "key": "alarmIds", - "value": "11684414734622447476,11684414734622506456" - } - ] - } - }, - "response": [] - }, - { - "name": "Post Alarm from SMF", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "[{\r\n \"neType\": \"SMF\",\r\n \"neId\": \"SZ_01\",\r\n \"alarmId\": \"SMF0130\",\r\n \"alarmTitle\": \"test\",\r\n \"eventTime\": \"2023-07-19T21:45:15+08:00\",\r\n \"alarmCode\": 10,\r\n \"alarmType\": \"EquipmentAlarm\",\r\n \"origSeverity\": \"Critical\",\r\n \"alarmStatus\": 1,\r\n \"specificProblem\": \"string\",\r\n \"addInfo\": \"string\",\r\n \"locationInfo\": \"test\"\r\n}]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/faultManagement/v1/elementType/smf/objectType/alarms", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "faultManagement", - "v1", - "elementType", - "smf", - "objectType", - "alarms" - ] - } - }, - "response": [] - }, - { - "name": "Post Alarm from SMF", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "33bf9e86-2a05-8377-4619-bb01b0a8e18e", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "[{\r\n \"neType\": \"SMF\",\r\n \"neId\": \"SZ_01\",\r\n \"alarmId\": \"SMF0113\",\r\n \"alarmTitle\": \"test\",\r\n \"eventTime\": \"2023-03-29 15:56:09\",\r\n \"alarmCode\": 10,\r\n \"alarmType\": \"EquipmentAlarm\",\r\n \"origSeverity\": \"Critical\",\r\n \"alarmStatus\": 0,\r\n \"specificProblem\": \"string\",\r\n \"addInfo\": \"string\",\r\n \"locationInfo\": \"test\"\r\n}]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/faultManagement/v1/elementType/smf/objectType/alarms", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "faultManagement", - "v1", - "elementType", - "smf", - "objectType", - "alarms" - ] - } - }, - "response": [] - }, - { - "name": "Get Alarm from NF", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"objectId\": \"SMF_0\",\r\n \"alarmTitle\": \"test\",\r\n \"eventTime\": \"2023-03-29 15:52:09\",\r\n \"alarmCode\": 10,\r\n \"alarmType\": \"EquipmentAlarm\",\r\n \"perceivedSeverity\": 3,\r\n \"alarmStatus\": 1,\r\n \"specificProblem\": \"string\",\r\n \"additionalText\": \"string\",\r\n \"alarmSource\": \"test\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/faultManagement/v1/elementType/smf/objectType/alarms", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "faultManagement", - "v1", - "elementType", - "smf", - "objectType", - "alarms" - ] - } - }, - "response": [] - }, - { - "name": "Post Alarm from AMF", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"objectId\": \"AMF_0\",\r\n \"alarmTitle\": \"test\",\r\n \"eventTime\": \"2023-03-29 15:52:09\",\r\n \"alarmCode\": 6,\r\n \"alarmType\": \"EquipmentAlarm\",\r\n \"perceivedSeverity\": 3,\r\n \"alarmStatus\": 1,\r\n \"specificProblem\": \"string\",\r\n \"additionalText\": \"string\",\r\n \"alarmSource\": \"test\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/faultManagement/v1/elementType/amf/objectType/alarms", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "faultManagement", - "v1", - "elementType", - "amf", - "objectType", - "alarms" - ] - } - }, - "response": [] - }, - { - "name": "Post Alarm from SMF", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"Object\": \"SMF_0\"\r\n \"AlarmTitle\": \"test\"\r\n \"EventTime\": \"22212\"\r\n \"AlarmCode\": \"3\"\r\n \"AlarmType\": \"EquipmentAlarm\"\r\n \"PerceivedSeverity\": 3\r\n \"AlarmStatus\": 1\r\n \"SpecificProblem\": \"string\"\r\n \"AdditionalText\": \"string\"\r\n \"AlarmSource\": \"test\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/faultManagement/v1/elementType/smf/objectType/alarms", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "faultManagement", - "v1", - "elementType", - "smf", - "objectType", - "alarms" - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Parameter config", - "item": [ - { - "name": "Get System Parameter from UDM", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Get System Parameter from UDM Copy", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.1.190:8088/api/rest/systemManagement/v1/elementType/amf/objectType/config/guami", - "protocol": "http", - "host": [ - "192", - "168", - "1", - "190" - ], - "port": "8088", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "amf", - "objectType", - "config", - "guami" - ] - } - }, - "response": [] - }, - { - "name": "Get System Parameter from UDM", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Get subUEambr Parameter from UDM", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Get subsUEAmbr Parameter from UDM", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.1.187:8080/api/rest/systemManagement/v1/elementType/udm/objectType/config/subsUEAmbr", - "host": [ - "192", - "168", - "1", - "187" - ], - "port": "8080", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "subsUEAmbr" - ] - } - }, - "response": [] - }, - { - "name": "Get UDM smfSelection", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/smfSelection", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "smfSelection" - ] - } - }, - "response": [] - }, - { - "name": "Get UDM subUEambr Parameter from Copy 2", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Get UDM subUEambr Parameter from Copy 3", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.1.190:8088/api/rest/systemManagement/v1/elementType/amf/objectType/config/guami", - "protocol": "http", - "host": [ - "192", - "168", - "1", - "190" - ], - "port": "8088", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "amf", - "objectType", - "config", - "guami" - ] - } - }, - "response": [] - }, - { - "name": "Get IMS system param", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "http://192.168.1.190:8088/api/rest/systemManagement/v1/elementType/amf/objectType/config/guami", - "protocol": "http", - "host": [ - "192", - "168", - "1", - "190" - ], - "port": "8088", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "amf", - "objectType", - "config", - "guami" - ] - } - }, - "response": [] - }, - { - "name": "Put System Parameter to UDM", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": " {\r\n \"capacity\": 1000,\r\n \"priority\": 2\r\n }", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - }, - { - "name": "Put System Parameter to UDM Copy", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": " {\r\n \"capacity\": 1000,\r\n \"priority\": 2\r\n }", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - }, - { - "name": "Post System Parameter to UDM", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": " {\r\n \"capacity\": 1000,\r\n \"priority\": 2\r\n }", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete System Parameter to UDM", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": " {\r\n \"capacity\": 1000,\r\n \"priority\": 2\r\n }", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "NE Management", - "item": [ - { - "name": "Get NE Info", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Get System Parameter from UDM", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Get subUEambr Parameter from UDM", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/config/system?subsys_no=0&LOC=serviceIP", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "config", - "system" - ], - "query": [ - { - "key": "subsys_no", - "value": "0" - }, - { - "key": "LOC", - "value": "serviceIP" - } - ] - } - }, - "response": [] - }, - { - "name": "Put NE Info", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "7fdc9328-b6fe-f66d-c8c5-84e6f14ee2d8", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": " {\r\n \"pvFlag\": \"VNF\",\r\n \"province\": \"GD\",\r\n \"vendorName\": \"AGT\",\r\n \"dn\": \"cmjicai\"\r\n }", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/systemManagement/v1/elementType/udm/objectType/neInfo?ne_id=SZ_3", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "neInfo" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_3" - } - ] - } - }, - "response": [] - }, - { - "name": "Post NE Info", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - }, - { - "key": "Scheme", - "value": "https", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": " {\r\n \"neType\": \"UDM\",\r\n \"neId\": \"SZ_02\",\r\n \"neName\": \"UDM_SZ_01\",\r\n \"ip\": \"192.168.1.187\",\r\n \"port\": \"8080\",\r\n \"pvFlag\": \"VNF\",\r\n \"province\": \"GD\",\r\n \"vendorName\": \"AGT\",\r\n \"dn\": \"cmjicai\"\r\n }", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/neInfo?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "neInfo" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete NE info", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "33bf9e86-2a05-8377-4619-bb01b0a8e18e", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "" - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/neInfo?ne_id=SZ_2", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "neInfo" - ], - "query": [ - { - "key": "accessToken", - "value": "", - "disabled": true - }, - { - "key": "ne_id", - "value": "SZ_2" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "UE Management", - "item": [ - { - "name": "Get UE info from smf", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo?neId=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "ueManagement", - "v1", - "elementType", - "smf", - "objectType", - "ueInfo" - ], - "query": [ - { - "key": "neId", - "value": "1" - } - ] - } - }, - "response": [] - }, - { - "name": "Get UE info from smf Copy", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/ueManagement/v1/elementType/smf/objectType/ueInfo?neId=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "ueManagement", - "v1", - "elementType", - "smf", - "objectType", - "ueInfo" - ], - "query": [ - { - "key": "neId", - "value": "1" - } - ] - } - }, - "response": [] - }, - { - "name": "Get UE info from ims", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/ueManagement/v1/elementType/ims/objectType/ueInfo?imsi=460000100000093&neId=001", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "ueManagement", - "v1", - "elementType", - "ims", - "objectType", - "ueInfo" - ], - "query": [ - { - "key": "imsi", - "value": "460000100000093" - }, - { - "key": "neId", - "value": "001" - } - ] - } - }, - "response": [] - }, - { - "name": "Get NB info from amf", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "omc-95b9a0f9-a0a4-dd16-2d3d-ae1d030a5941", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.119:3040/api/rest/ueManagement/v1/elementType/amf/objectType/nbInfo?nbId=7&neId=002", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "ueManagement", - "v1", - "elementType", - "amf", - "objectType", - "nbInfo" - ], - "query": [ - { - "key": "nbId", - "value": "7" - }, - { - "key": "neId", - "value": "002" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Measure", - "item": [ - { - "name": "Patch Measure Task", - "request": { - "method": "PATCH", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.30.59:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask?id=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "id", - "value": "1" - } - ] - } - }, - "response": [] - }, - { - "name": "Post Measure Task", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask?id=3", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "id", - "value": "3" - } - ] - } - }, - "response": [] - }, - { - "name": "Post AMF Measure Task", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask?id=6", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "amf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "id", - "value": "6" - } - ] - } - }, - "response": [] - }, - { - "name": "Post Measure Report", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\":1,\r\n \"NeType\":\"SMF\"\r\n\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureReport" - ] - } - }, - "response": [] - }, - { - "name": "Post Measurement", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Index\": 2,\r\n \"NeName\": \"SMFRJBJJC01\",\r\n \"RmUID\": \"1101AGTHXSMF0000015704000100\",\r\n \"NeType\": \"SMF\",\r\n \"PmVersion\": \"5GC16.1.1\",\r\n \"Dn\": \"RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456\",\r\n \"Period\": \"15\",\r\n \"TimeZone\": \"UTC+8\",\r\n \"StartTime\": \"2023-05-23 22:26:28\",\r\n \"Datas\": [\r\n {\r\n \"ObjectType\": \"SmfFunction\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.AttCreatePduSession._Dnn\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"cmnet\",\r\n \"Value\": 1\r\n },\r\n {\r\n \"Name\": \"ims\",\r\n \"Value\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"ObjectType\": \"AddrPool\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"Total\",\r\n \"Value\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr._Ns\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"1001\",\r\n \"Value\": 2\r\n },\r\n {\r\n \"Name\": \"1002\",\r\n \"Value\": 1\r\n } \r\n ]\r\n } \r\n ]\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measurement" - ] - } - }, - "response": [] - }, - { - "name": "Get Measurement", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Index\": 2,\r\n \"NeName\": \"SMFRJBJJC01\",\r\n \"RmUID\": \"1101AGTHXSMF0000015704000100\",\r\n \"NeType\": \"SMF\",\r\n \"PmVersion\": \"5GC16.1.1\",\r\n \"Dn\": \"RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456\",\r\n \"Period\": \"15\",\r\n \"TimeZone\": \"UTC+8\",\r\n \"StartTime\": \"2023-05-23 22:26:28\",\r\n \"Datas\": [\r\n {\r\n \"ObjectType\": \"SmfFunction\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.AttCreatePduSession._Dnn\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"cmnet\",\r\n \"Value\": 1\r\n },\r\n {\r\n \"Name\": \"ims\",\r\n \"Value\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"ObjectType\": \"AddrPool\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"Total\",\r\n \"Value\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr._Ns\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"1001\",\r\n \"Value\": 2\r\n },\r\n {\r\n \"Name\": \"1002\",\r\n \"Value\": 1\r\n } \r\n ]\r\n } \r\n ]\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measurement" - ] - } - }, - "response": [] - }, - { - "name": "Post Measurement Copy", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Index\": 2,\r\n \"NeName\": \"SMFRJBJJC01\",\r\n \"RmUID\": \"1101AGTHXSMF0000015704000100\",\r\n \"NeType\": \"SMF\",\r\n \"PmVersion\": \"5GC16.1.1\",\r\n \"Dn\": \"RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456\",\r\n \"Period\": \"15\",\r\n \"TimeZone\": \"UTC+8\",\r\n \"StartTime\": \"2023-05-23 22:26:28\",\r\n \"Datas\": [\r\n {\r\n \"ObjectType\": \"SmfFunction\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.AttCreatePduSession._Dnn\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"cmnet\",\r\n \"Value\": 1\r\n },\r\n {\r\n \"Name\": \"ims\",\r\n \"Value\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"ObjectType\": \"AddrPool\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"Total\",\r\n \"Value\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr._Ns\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"1001\",\r\n \"Value\": 2\r\n },\r\n {\r\n \"Name\": \"1002\",\r\n \"Value\": 1\r\n } \r\n ]\r\n } \r\n ]\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measurement" - ] - } - }, - "response": [] - }, - { - "name": "Patch Measure Task", - "request": { - "method": "PATCH", - "header": [], - "url": { - "raw": "192.168.30.59:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask?taskId=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "taskId", - "value": "1" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Measure Task", - "request": { - "method": "DELETE", - "header": [], - "url": { - "raw": "192.168.30.59:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask?taskId=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "taskId", - "value": "1" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "TraceTask", - "item": [ - { - "name": "Patch Measure Task", - "request": { - "method": "PATCH", - "header": [], - "url": { - "raw": "192.168.30.59:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask?id=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "id", - "value": "1" - } - ] - } - }, - "response": [] - }, - { - "name": "Post Trace Task", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"traceType\": \"Interface\",\r\n \"startTime\": \"2023-07-04 13:00:00\",\r\n \"endTime\": \"2023-07-04 19:00:00\",\r\n \"neType\": \"UDM\",\r\n \"neId\": \"SZ_01\",\r\n \"interfaces\": [\"N8\",\"N10\"]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/traceManagement/v1/subscriptions", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "traceManagement", - "v1", - "subscriptions" - ] - } - }, - "response": [] - }, - { - "name": "Get trace data", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"traceType\": \"Interface\",\r\n \"startTime\": \"2023-07-04 13:00:00\",\r\n \"endTime\": \"2023-07-04 19:00:00\",\r\n \"neType\": \"UDM\",\r\n \"neId\": \"SZ_01\",\r\n \"interfaces\": [\"N8\",\"N10\"]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/traceManagement/v1/subscriptions", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "traceManagement", - "v1", - "subscriptions" - ] - } - }, - "response": [] - }, - { - "name": "Post Trace Task No NeType", - "request": { - "method": "POST", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"traceType\": \"Interface\",\r\n \"startTime\": \"2023-07-04 13:00:00\",\r\n \"endTime\": \"2023-07-04 19:00:00\",\r\n \"neType\": \"\",\r\n \"neId\": \"\",\r\n \"interfaces\": [\"N8\",\"N10\"]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/traceManagement/v1/subscriptions", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "traceManagement", - "v1", - "subscriptions" - ] - } - }, - "response": [] - }, - { - "name": "Put Trace Task No NeType", - "request": { - "method": "PUT", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\": 3,\r\n \"traceType\": \"Interface\",\r\n \"startTime\": \"2023-07-04 13:00:00\",\r\n \"endTime\": \"2023-07-04 19:00:00\",\r\n \"neType\": \"\",\r\n \"neId\": \"\",\r\n \"srcIp\": \"192.168.2.199\",\r\n \"signalPort\": 3030,\r\n \"interfaces\": [\"N8\",\"N10\",\"N11\"]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/traceManagement/v1/subscriptions", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "traceManagement", - "v1", - "subscriptions" - ] - } - }, - "response": [] - }, - { - "name": "Delete Trace Task No NeType", - "request": { - "method": "DELETE", - "header": [ - { - "key": "AccessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/traceManagement/v1/subscriptions?id=1&id=2", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "traceManagement", - "v1", - "subscriptions" - ], - "query": [ - { - "key": "id", - "value": "1" - }, - { - "key": "id", - "value": "2" - } - ] - } - }, - "response": [] - }, - { - "name": "Post AMF Measure Task", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/amf/objectType/measureTask?id=6", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "amf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "id", - "value": "6" - } - ] - } - }, - "response": [] - }, - { - "name": "Post Measure Report", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"id\":1,\r\n \"NeType\":\"SMF\"\r\n\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureReport", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureReport" - ] - } - }, - "response": [] - }, - { - "name": "Post Measurement", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Index\": 2,\r\n \"NeName\": \"SMFRJBJJC01\",\r\n \"RmUID\": \"1101AGTHXSMF0000015704000100\",\r\n \"NeType\": \"SMF\",\r\n \"PmVersion\": \"5GC16.1.1\",\r\n \"Dn\": \"RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456\",\r\n \"Period\": \"15\",\r\n \"TimeZone\": \"UTC+8\",\r\n \"StartTime\": \"2023-05-23 22:26:28\",\r\n \"Datas\": [\r\n {\r\n \"ObjectType\": \"SmfFunction\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.AttCreatePduSession._Dnn\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"cmnet\",\r\n \"Value\": 1\r\n },\r\n {\r\n \"Name\": \"ims\",\r\n \"Value\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"ObjectType\": \"AddrPool\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"Total\",\r\n \"Value\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr._Ns\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"1001\",\r\n \"Value\": 2\r\n },\r\n {\r\n \"Name\": \"1002\",\r\n \"Value\": 1\r\n } \r\n ]\r\n } \r\n ]\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measurement" - ] - } - }, - "response": [] - }, - { - "name": "Get Measurement", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Index\": 2,\r\n \"NeName\": \"SMFRJBJJC01\",\r\n \"RmUID\": \"1101AGTHXSMF0000015704000100\",\r\n \"NeType\": \"SMF\",\r\n \"PmVersion\": \"5GC16.1.1\",\r\n \"Dn\": \"RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456\",\r\n \"Period\": \"15\",\r\n \"TimeZone\": \"UTC+8\",\r\n \"StartTime\": \"2023-05-23 22:26:28\",\r\n \"Datas\": [\r\n {\r\n \"ObjectType\": \"SmfFunction\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.AttCreatePduSession._Dnn\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"cmnet\",\r\n \"Value\": 1\r\n },\r\n {\r\n \"Name\": \"ims\",\r\n \"Value\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"ObjectType\": \"AddrPool\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"Total\",\r\n \"Value\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr._Ns\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"1001\",\r\n \"Value\": 2\r\n },\r\n {\r\n \"Name\": \"1002\",\r\n \"Value\": 1\r\n } \r\n ]\r\n } \r\n ]\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measurement" - ] - } - }, - "response": [] - }, - { - "name": "Post Measurement Copy", - "request": { - "method": "POST", - "header": [ - { - "key": "Content-Type", - "value": "application/json", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"Index\": 2,\r\n \"NeName\": \"SMFRJBJJC01\",\r\n \"RmUID\": \"1101AGTHXSMF0000015704000100\",\r\n \"NeType\": \"SMF\",\r\n \"PmVersion\": \"5GC16.1.1\",\r\n \"Dn\": \"RJN-CMZJ-TZ,SubNetwork=5GC88,ManagedElement=SMF53456,SmfFunction=53456\",\r\n \"Period\": \"15\",\r\n \"TimeZone\": \"UTC+8\",\r\n \"StartTime\": \"2023-05-23 22:26:28\",\r\n \"Datas\": [\r\n {\r\n \"ObjectType\": \"SmfFunction\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.AttCreatePduSession._Dnn\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"cmnet\",\r\n \"Value\": 1\r\n },\r\n {\r\n \"Name\": \"ims\",\r\n \"Value\": 0\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"ObjectType\": \"AddrPool\",\r\n \"KPIs\": [\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"Total\",\r\n \"Value\": 1\r\n }\r\n ]\r\n },\r\n {\r\n \"KPIID\": \"SMF.MeanAllcAddr._Ns\",\r\n \"KPIValues\": [\r\n {\r\n \"Name\": \"1001\",\r\n \"Value\": 2\r\n },\r\n {\r\n \"Name\": \"1002\",\r\n \"Value\": 1\r\n } \r\n ]\r\n } \r\n ]\r\n } \r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measurement", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measurement" - ] - } - }, - "response": [] - }, - { - "name": "Patch Measure Task", - "request": { - "method": "DELETE", - "header": [], - "url": { - "raw": "192.168.30.59:3040/api/rest/performanceManagement/v1/elementType/smf/objectType/measureTask?taskId=1", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "performanceManagement", - "v1", - "elementType", - "smf", - "objectType", - "measureTask" - ], - "query": [ - { - "key": "taskId", - "value": "1" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "MML", - "item": [ - { - "name": "Post MML", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML UDM", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"dsp authdat:imsi=460000100000030\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/MML?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "MML" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "https test", - "item": [ - { - "name": "login https://192.168.0.229", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"grantType\": \"password\",\r\n \"userName\": \"admin\",\r\n \"value\": \"rootaa\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "https://192.168.0.229/api/rest/securityManagement/v1/oauth/token", - "protocol": "https", - "host": [ - "{{omc_local}}" - ], - "path": [ - "api", - "rest", - "securityManagement", - "v1", - "oauth", - "token" - ] - } - }, - "response": [] - }, - { - "name": "Post MML", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "get ne_info by https", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/oam/dataManagement/v1/omc_db/ne_info?loc=netype='AMF'", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "oam", - "dataManagement", - "v1", - "omc_db", - "ne_info" - ], - "query": [ - { - "key": "loc", - "value": "netype='AMF'" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML UDM", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"dsp authdat:imsi=460000100000030\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/MML?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "MML" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Export/Import NE", - "item": [ - { - "name": "Get Software from OMC", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "file", - "file": { - "src": "" - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/AMF/software/123", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "AMF", - "software", - "123" - ], - "query": [ - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Export CM From NF", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "file", - "file": { - "src": "" - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/cm?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "cm" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - }, - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Import CM to NF", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"fileName\":\"udm-sz_01-etc-20230627002725.zip\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/cm?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "cm" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - }, - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Active Software To NF", - "request": { - "method": "PUT", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "EMS", - "software", - "5GC16.1.1.20230628", - "SZ_T01" - ] - } - }, - "response": [] - }, - { - "name": "Rollback Software To NF", - "request": { - "method": "PATCH", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "/D:/goprojects/ems.agt/restagent/backup/smf-sz_01-etc-20230610140953.zip" - } - ] - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230628/SZ_T01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "EMS", - "software", - "5GC16.1.1.20230628", - "SZ_T01" - ] - } - }, - "response": [] - }, - { - "name": "Distribute Software To NF", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "/D:/goprojects/ems.agt/restagent/backup/smf-sz_01-etc-20230610140953.zip" - } - ] - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/EMS/software/5GC16.1.1.20230621/SZ_T01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "EMS", - "software", - "5GC16.1.1.20230621", - "SZ_T01" - ] - } - }, - "response": [] - }, - { - "name": "Upload Software To OMC Copy", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "/D:/goprojects/ems.agt/restagent/backup/smf-sz_01-etc-20230610140953.zip" - } - ] - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/AMF/software/123", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "AMF", - "software", - "123" - ] - } - }, - "response": [] - }, - { - "name": "Delete Software from OMC", - "request": { - "method": "DELETE", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "raw", - "raw": "{\r\n \"fileName\":\"udm-sz_01-etc-20230615171608.zip\"\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/cm?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "cm" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - }, - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML UDM", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"dsp authdat:imsi=460000100000030\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/MML?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "MML" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "others", - "item": [ - { - "name": "postdata", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "test.zip" - } - ] - }, - "url": { - "raw": "192.168.2.119:3050/postdata", - "host": [ - "{{omc_local}}" - ], - "port": "3050", - "path": [ - "postdata" - ], - "query": [ - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Import CM to NF", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "/C:/Users/simon/OneDrive/Desktop/pcap/Cims-ims-0-210611170824.pcap" - } - ] - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/cm?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "cm" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - }, - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML UDM", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"dsp authdat:imsi=460000100000030\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/MML?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "MML" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "aaaa", - "item": [ - { - "name": "4A get user", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "test.zip" - } - ] - }, - "url": { - "raw": "http://192.168.4.130:4040/api/rest/v1/nbi/4a/user", - "protocol": "http", - "host": [ - "192", - "168", - "4", - "130" - ], - "port": "4040", - "path": [ - "api", - "rest", - "v1", - "nbi", - "4a", - "user" - ], - "query": [ - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "sso ticket", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "test.zip" - } - ] - }, - "url": { - "raw": "http://192.168.4.130:4040/api/rest/v1/nbi/4a/user", - "protocol": "http", - "host": [ - "192", - "168", - "4", - "130" - ], - "port": "4040", - "path": [ - "api", - "rest", - "v1", - "nbi", - "4a", - "user" - ], - "query": [ - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Import CM to NF", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "/C:/Users/simon/OneDrive/Desktop/pcap/Cims-ims-0-210611170824.pcap" - } - ] - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/cm?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "cm" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - }, - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML UDM", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"dsp authdat:imsi=460000100000030\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/MML?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "MML" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "FileManager", - "item": [ - { - "name": "4A get user", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, - "request": { - "method": "GET", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "test.zip" - } - ] - }, - "url": { - "raw": "http://192.168.4.130:4040/api/rest/v1/nbi/4a/user", - "protocol": "http", - "host": [ - "192", - "168", - "4", - "130" - ], - "port": "4040", - "path": [ - "api", - "rest", - "v1", - "nbi", - "4a", - "user" - ], - "query": [ - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Upload file", - "request": { - "method": "POST", - "header": [ - { - "key": "accessToken", - "value": "3aa1f68d-9c31-3941-db76-aa591b694028", - "type": "text" - } - ], - "body": { - "mode": "formdata", - "formdata": [ - { - "key": "file", - "type": "file", - "src": "/C:/Users/simon/OneDrive/Desktop/pcap/Cims-ims-0-210611170824.pcap" - } - ] - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/systemManagement/v1/elementType/udm/objectType/cm?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "udm", - "objectType", - "cm" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - }, - { - "key": "", - "value": "", - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML UDM", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"dsp authdat:imsi=460000100000030\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/mml?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "mml" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - }, - { - "name": "Post MML Copy", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\r\n \"mml\": [\r\n \"date\",\r\n \"date\"\r\n ]\r\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "192.168.2.119:3040/api/rest/opeartionManagement/v1/elementType/udm/objectType/MML?ne_id=SZ_01", - "host": [ - "{{omc_local}}" - ], - "port": "3040", - "path": [ - "api", - "rest", - "opeartionManagement", - "v1", - "elementType", - "udm", - "objectType", - "MML" - ], - "query": [ - { - "key": "ne_id", - "value": "SZ_01" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Get 229 OMC Local Time", - "request": { - "method": "GET", - "header": [ - { - "key": "AccessToken", - "value": "omc-1e618113-42d3-3efe-6ae6-baa0b7e26ad4", - "type": "text" - } - ], - "url": { - "raw": "192.168.2.219:3040/api/rest/systemManagement/v1/elementType/OMC/objectType/time", - "host": [ - "192", - "168", - "2", - "219" - ], - "port": "3040", - "path": [ - "api", - "rest", - "systemManagement", - "v1", - "elementType", - "OMC", - "objectType", - "time" - ] - } - }, - "response": [] - } - ] - } - ] -} \ No newline at end of file diff --git a/extras/independ.sh b/extras/independ.sh deleted file mode 100644 index 72d81fa..0000000 --- a/extras/independ.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/bash - -pwddir=`pwd` -rootdir=$pwddir/depend-u22.04/ - -for subdepdir in $(find $rootdir -type d); do - path=`dirname $subdepdir` - if [ $path != $pwddir ]; then - echo $subdepdir - cd $subdepdir - filenum=`ls -l |grep "^-"|wc -l` - if [ $filenum -eq 1 ]; then - sudo dpkg -i *.deb - elif [ $filenum -gt 1 ]; then - sudo dpkg -i --ignore-depends *.deb - fi - fi -done \ No newline at end of file diff --git a/linux/lib/systemd/system/omc.service b/linux/lib/systemd/system/omc.service new file mode 100644 index 0000000..355cdcc --- /dev/null +++ b/linux/lib/systemd/system/omc.service @@ -0,0 +1,17 @@ +[Unit] +Description=omc service daemon +After=network-online.target kvdb.service + +[Service] +Type=simple +LimitNOFILE=65535 +LimitNPROC=65535 + +Restart=always +ExecStart=/usr/local/bin/omc -c /usr/local/etc/omc/omc.yaml +RestartSec=2 +RestartPreventExitStatus=SIGTERM SIGKILL +ExecReload=/bin/kill -HUP $MAINPID + +[Install] +WantedBy=multi-user.target diff --git a/linux/lib/systemd/system/sshsvc.service b/linux/lib/systemd/system/sshsvc.service new file mode 100644 index 0000000..13bdd26 --- /dev/null +++ b/linux/lib/systemd/system/sshsvc.service @@ -0,0 +1,17 @@ +[Unit] +Description=OMC SSH MML service daemon +After=network-online.target mysql.service + +[Service] +Type=simple +LimitNOFILE=65535 +LimitNPROC=65535 + +Restart=always +ExecStart=/usr/local/omc/bin/sshsvc -c /usr/local/omc/etc/sshsvc.yaml +RestartSec=2 +RestartPreventExitStatus=SIGTERM SIGKILL +ExecReload=/bin/kill -HUP $MAINPID + +[Install] +WantedBy=multi-user.target \ No newline at end of file diff --git a/linux/usr/local/bin/omc b/linux/usr/local/bin/omc new file mode 100644 index 0000000..9fb43d6 --- /dev/null +++ b/linux/usr/local/bin/omc @@ -0,0 +1 @@ +占位 \ No newline at end of file diff --git a/linux/usr/local/bin/sshsvc b/linux/usr/local/bin/sshsvc new file mode 100644 index 0000000..9fb43d6 --- /dev/null +++ b/linux/usr/local/bin/sshsvc @@ -0,0 +1 @@ +占位 \ No newline at end of file diff --git a/linux/usr/local/etc/omc/certs/omc-server.crt b/linux/usr/local/etc/omc/certs/omc-server.crt new file mode 100644 index 0000000..bb91ed0 --- /dev/null +++ b/linux/usr/local/etc/omc/certs/omc-server.crt @@ -0,0 +1,23 @@ +-----BEGIN CERTIFICATE----- +MIIDxTCCAq2gAwIBAgIUJLpIo8eueW/in9CvXZdr3oAVVJwwDQYJKoZIhvcNAQEL +BQAwcjELMAkGA1UEBhMCQVUxDDAKBgNVBAgMA09NQzERMA8GA1UEBwwIT01DLVRl +YW0xITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEMMAoGA1UECwwD +T01DMREwDwYDVQQDDAhPTUMtVGVhbTAeFw0yNTAzMTQwNzQ2MTNaFw0yNjAzMTQw +NzQ2MTNaMHIxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANPTUMxETAPBgNVBAcMCE9N +Qy1UZWFtMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxDDAKBgNV +BAsMA09NQzERMA8GA1UEAwwIT01DLVRlYW0wggEiMA0GCSqGSIb3DQEBAQUAA4IB +DwAwggEKAoIBAQDbSyUIbKefOlKStnr+rRwVlkr1IXdMsXmmEV9zoapXDz4j4N0H +9pzEkpwvxbP+r5186CfKzueHBNc7HWinm4wSCDR6exaxG3YGODxMuLnKGPtG2tml +XBf7USeiMGNKYEF/KWmjjIPw4/9P+6qdIuneX7i0AdGynJI+3JPDT8Iwky2Cm5B4 +LRJTSJMfHO0ayrWPDoUCvKIst8w9GkFLjsbZU+AppjWj0rYWc04Oci7zqoUiFeBh +mnQKbCVrlZ4i2CKwgfuxQV2ieSkQ0QoTAXDjocrL/mRmnpvoH0jB2np3OfVlEPBP +pR4q71vuUNkra/F4zPQRPUlqemfo8+4/k3TPAgMBAAGjUzBRMB0GA1UdDgQWBBTN ++1JjU2yWzQMeSMzS5HItc4WMHDAfBgNVHSMEGDAWgBTN+1JjU2yWzQMeSMzS5HIt +c4WMHDAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBZV5RfuZ2R +0Nhs05apqwFFg8k0vJ26KMXr0i6YnlKpksEYqjXqmB58qHze6sOy7h3248FyTFlC +5YWWwwOAMiPjiH4NKMnqTthdUA4kiZiGs92jB4U/GS3lHTpsXzNssvQ8Dys7zKoj +HxnJlYpT8F6/waPPRakuP657BAVux5aAloRtqd6kGV3Donp4DwEmhdZpn6Q12igw +/+m1e9Xhxiv++H+OXzTXLerQOuUkTzKw7Ajj3hY93SeX6DOONMmoyuV1undxbvWp +lVZXo9iTGfrMkiyKF75LUyBRvvd7K5MVXJwxu0l5rvnpn6/aO1+2BUCf1ldd9VEw +DSbfrW2FfOmc +-----END CERTIFICATE----- diff --git a/linux/usr/local/etc/omc/certs/omc-server.key b/linux/usr/local/etc/omc/certs/omc-server.key new file mode 100644 index 0000000..0e2c6ad --- /dev/null +++ b/linux/usr/local/etc/omc/certs/omc-server.key @@ -0,0 +1,28 @@ +-----BEGIN PRIVATE KEY----- +MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDbSyUIbKefOlKS +tnr+rRwVlkr1IXdMsXmmEV9zoapXDz4j4N0H9pzEkpwvxbP+r5186CfKzueHBNc7 +HWinm4wSCDR6exaxG3YGODxMuLnKGPtG2tmlXBf7USeiMGNKYEF/KWmjjIPw4/9P ++6qdIuneX7i0AdGynJI+3JPDT8Iwky2Cm5B4LRJTSJMfHO0ayrWPDoUCvKIst8w9 +GkFLjsbZU+AppjWj0rYWc04Oci7zqoUiFeBhmnQKbCVrlZ4i2CKwgfuxQV2ieSkQ +0QoTAXDjocrL/mRmnpvoH0jB2np3OfVlEPBPpR4q71vuUNkra/F4zPQRPUlqemfo +8+4/k3TPAgMBAAECggEACunzfuGBeiWPRH6md77/0yc2tc/OPdfmA64rqk0/yrNs +gUvzVC524OWhtlLy7AMA0IhGqrZKGZMpGb0TSfwuKBuWbl4VOV1Hg3Rls9/MXKg0 +9p11EDYZeh2GM8aQD9HjO0PsCQK48lKL5gbSwp1L4bsGg0Galna/ueHad3GkatcL +aSlFnnvzk4glAxT093F43lAxS463iPX7ueG/2322z0Ib+c6wGEFRcoYNI0/2Ax/u +6UdWxuHUs+7gDLcVa9FN7vx1UBoqAu49WlCfmtvzDTDyK7xLWlvKCx3O8uSLv4aw +/YMRg/yTulUj0dqIUcs/u/UN6AJc8Xk0H+rTpTfgcQKBgQDyq+FFvtG2xm2Ig0/9 +BLRdXPM4VgyokPxOL+j9H7LJfrjdz0cnGEuoOfBT8hDX2zFgC6dqAESSnAbPVQJP +6PaYJ8UtOWhwNUAfpRlid1/Y3iDRHWOirjeMKZRh6xN95m21FVbJUg6LfxTf8HWA +OgNwPsfjPL1Jdinw+OX++EvTBwKBgQDnVo5vRBqnLJl85Q7WXQFqjW9j7S1P8ZVL +JmAyNHlpdaNCF2VD164qDQEAi2FDLeDgV5UnAxOeDh/0Z0a3ncp8QLUkwqksBqwa +dhsUF5Jf0Dy3EjiP2w6FsTYanKGuTtV44ovlFTtXL1SSn2ijMVS17YmJgz6LhJbE +wvry6Vd1+QKBgAN7/k8PD1nNfZMhN4vNfn18sS1U5vegpU7GF1VTGDEWdbcRm9bu +3V87/bxm1GEVD59ua2f1OwbT4LEnalIVaT0EDSu6EErUKOiLaVLlneWyQsxd3Klg +UQHdMvk4892x6k9YUBex6u2L1JPmkvlVW+lHrX0QyTL91FpWaI8Bp60PAoGBAMR/ +hh7Gl2kWfg1TNyYn+9L47fvP8yQrjOc3YpBieBp2/MRfwPk+U0aOoyJGQchhSNjm +K9/mQhyH3Oapbqz6j4q5H+RooG+v/zG+zkNjvkY6R8gs5vRyWkR/APjbwI2hkrvK +mo9sWGo23rxoQOYVOeIKMUAnxdGWPsZE5Am+4DZpAoGBAJAF8MP5SlNRSF6zM3Lw +Qf5CQjsyXhll+A/ueOf1iQ+8r7xdxa6dNtcTcOZVVDsbXIBJ4/3HGTLfQCcGrhLN +KK9wljtkiYJ0h6IqcXnhp69uRV4SKRInyVEjNkiBotBPu5y6CYz5MAXFdM87q7jO +ehVc6QGJ9vLnfnwEFbAMArmv +-----END PRIVATE KEY----- diff --git a/linux/usr/local/etc/omc/certs/omc-web.crt b/linux/usr/local/etc/omc/certs/omc-web.crt new file mode 100644 index 0000000..bb91ed0 --- /dev/null +++ b/linux/usr/local/etc/omc/certs/omc-web.crt @@ -0,0 +1,23 @@ +-----BEGIN CERTIFICATE----- +MIIDxTCCAq2gAwIBAgIUJLpIo8eueW/in9CvXZdr3oAVVJwwDQYJKoZIhvcNAQEL +BQAwcjELMAkGA1UEBhMCQVUxDDAKBgNVBAgMA09NQzERMA8GA1UEBwwIT01DLVRl +YW0xITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEMMAoGA1UECwwD +T01DMREwDwYDVQQDDAhPTUMtVGVhbTAeFw0yNTAzMTQwNzQ2MTNaFw0yNjAzMTQw +NzQ2MTNaMHIxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANPTUMxETAPBgNVBAcMCE9N +Qy1UZWFtMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxDDAKBgNV +BAsMA09NQzERMA8GA1UEAwwIT01DLVRlYW0wggEiMA0GCSqGSIb3DQEBAQUAA4IB +DwAwggEKAoIBAQDbSyUIbKefOlKStnr+rRwVlkr1IXdMsXmmEV9zoapXDz4j4N0H +9pzEkpwvxbP+r5186CfKzueHBNc7HWinm4wSCDR6exaxG3YGODxMuLnKGPtG2tml +XBf7USeiMGNKYEF/KWmjjIPw4/9P+6qdIuneX7i0AdGynJI+3JPDT8Iwky2Cm5B4 +LRJTSJMfHO0ayrWPDoUCvKIst8w9GkFLjsbZU+AppjWj0rYWc04Oci7zqoUiFeBh +mnQKbCVrlZ4i2CKwgfuxQV2ieSkQ0QoTAXDjocrL/mRmnpvoH0jB2np3OfVlEPBP +pR4q71vuUNkra/F4zPQRPUlqemfo8+4/k3TPAgMBAAGjUzBRMB0GA1UdDgQWBBTN ++1JjU2yWzQMeSMzS5HItc4WMHDAfBgNVHSMEGDAWgBTN+1JjU2yWzQMeSMzS5HIt +c4WMHDAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQBZV5RfuZ2R +0Nhs05apqwFFg8k0vJ26KMXr0i6YnlKpksEYqjXqmB58qHze6sOy7h3248FyTFlC +5YWWwwOAMiPjiH4NKMnqTthdUA4kiZiGs92jB4U/GS3lHTpsXzNssvQ8Dys7zKoj +HxnJlYpT8F6/waPPRakuP657BAVux5aAloRtqd6kGV3Donp4DwEmhdZpn6Q12igw +/+m1e9Xhxiv++H+OXzTXLerQOuUkTzKw7Ajj3hY93SeX6DOONMmoyuV1undxbvWp +lVZXo9iTGfrMkiyKF75LUyBRvvd7K5MVXJwxu0l5rvnpn6/aO1+2BUCf1ldd9VEw +DSbfrW2FfOmc +-----END CERTIFICATE----- diff --git a/linux/usr/local/etc/omc/certs/omc-web.key b/linux/usr/local/etc/omc/certs/omc-web.key new file mode 100644 index 0000000..0e2c6ad --- /dev/null +++ b/linux/usr/local/etc/omc/certs/omc-web.key @@ -0,0 +1,28 @@ +-----BEGIN PRIVATE KEY----- +MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDbSyUIbKefOlKS +tnr+rRwVlkr1IXdMsXmmEV9zoapXDz4j4N0H9pzEkpwvxbP+r5186CfKzueHBNc7 +HWinm4wSCDR6exaxG3YGODxMuLnKGPtG2tmlXBf7USeiMGNKYEF/KWmjjIPw4/9P ++6qdIuneX7i0AdGynJI+3JPDT8Iwky2Cm5B4LRJTSJMfHO0ayrWPDoUCvKIst8w9 +GkFLjsbZU+AppjWj0rYWc04Oci7zqoUiFeBhmnQKbCVrlZ4i2CKwgfuxQV2ieSkQ +0QoTAXDjocrL/mRmnpvoH0jB2np3OfVlEPBPpR4q71vuUNkra/F4zPQRPUlqemfo +8+4/k3TPAgMBAAECggEACunzfuGBeiWPRH6md77/0yc2tc/OPdfmA64rqk0/yrNs +gUvzVC524OWhtlLy7AMA0IhGqrZKGZMpGb0TSfwuKBuWbl4VOV1Hg3Rls9/MXKg0 +9p11EDYZeh2GM8aQD9HjO0PsCQK48lKL5gbSwp1L4bsGg0Galna/ueHad3GkatcL +aSlFnnvzk4glAxT093F43lAxS463iPX7ueG/2322z0Ib+c6wGEFRcoYNI0/2Ax/u +6UdWxuHUs+7gDLcVa9FN7vx1UBoqAu49WlCfmtvzDTDyK7xLWlvKCx3O8uSLv4aw +/YMRg/yTulUj0dqIUcs/u/UN6AJc8Xk0H+rTpTfgcQKBgQDyq+FFvtG2xm2Ig0/9 +BLRdXPM4VgyokPxOL+j9H7LJfrjdz0cnGEuoOfBT8hDX2zFgC6dqAESSnAbPVQJP +6PaYJ8UtOWhwNUAfpRlid1/Y3iDRHWOirjeMKZRh6xN95m21FVbJUg6LfxTf8HWA +OgNwPsfjPL1Jdinw+OX++EvTBwKBgQDnVo5vRBqnLJl85Q7WXQFqjW9j7S1P8ZVL +JmAyNHlpdaNCF2VD164qDQEAi2FDLeDgV5UnAxOeDh/0Z0a3ncp8QLUkwqksBqwa +dhsUF5Jf0Dy3EjiP2w6FsTYanKGuTtV44ovlFTtXL1SSn2ijMVS17YmJgz6LhJbE +wvry6Vd1+QKBgAN7/k8PD1nNfZMhN4vNfn18sS1U5vegpU7GF1VTGDEWdbcRm9bu +3V87/bxm1GEVD59ua2f1OwbT4LEnalIVaT0EDSu6EErUKOiLaVLlneWyQsxd3Klg +UQHdMvk4892x6k9YUBex6u2L1JPmkvlVW+lHrX0QyTL91FpWaI8Bp60PAoGBAMR/ +hh7Gl2kWfg1TNyYn+9L47fvP8yQrjOc3YpBieBp2/MRfwPk+U0aOoyJGQchhSNjm +K9/mQhyH3Oapbqz6j4q5H+RooG+v/zG+zkNjvkY6R8gs5vRyWkR/APjbwI2hkrvK +mo9sWGo23rxoQOYVOeIKMUAnxdGWPsZE5Am+4DZpAoGBAJAF8MP5SlNRSF6zM3Lw +Qf5CQjsyXhll+A/ueOf1iQ+8r7xdxa6dNtcTcOZVVDsbXIBJ4/3HGTLfQCcGrhLN +KK9wljtkiYJ0h6IqcXnhp69uRV4SKRInyVEjNkiBotBPu5y6CYz5MAXFdM87q7jO +ehVc6QGJ9vLnfnwEFbAMArmv +-----END PRIVATE KEY----- diff --git a/build/lib/systemd/system/.gitkeep b/linux/usr/local/etc/omc/database/.gitkeep similarity index 100% rename from build/lib/systemd/system/.gitkeep rename to linux/usr/local/etc/omc/database/.gitkeep diff --git a/build/usr/local/omc/backup/.gitkeep b/linux/usr/local/etc/omc/default/.gitkeep similarity index 100% rename from build/usr/local/omc/backup/.gitkeep rename to linux/usr/local/etc/omc/default/.gitkeep diff --git a/debbuild/etc/nginx/conf.d/omc.conf b/linux/usr/local/etc/omc/nginx/omc.conf similarity index 94% rename from debbuild/etc/nginx/conf.d/omc.conf rename to linux/usr/local/etc/omc/nginx/omc.conf index 0e1facc..fd43506 100644 --- a/debbuild/etc/nginx/conf.d/omc.conf +++ b/linux/usr/local/etc/omc/nginx/omc.conf @@ -21,14 +21,14 @@ server { # OMC location / { - root /usr/local/omc/htdocs/front; + root /usr/local/etc/omc/web; try_files $uri $uri/ /index.html; index index.html index.htm; } location /omc-api/ { - proxy_pass http://127.0.0.1:33030/; + proxy_pass https://127.0.0.1:33443/; proxy_connect_timeout 180s; proxy_send_timeout 180s; @@ -46,7 +46,7 @@ server { } location /api/rest/ { - proxy_pass http://127.0.0.1:33030/api/rest/; + proxy_pass https://127.0.0.1:33443/api/rest/; proxy_cache_bypass $http_upgrade; proxy_set_header Upgrade $http_upgrade; diff --git a/linux/usr/local/etc/omc/script/cpnetools.sh b/linux/usr/local/etc/omc/script/cpnetools.sh new file mode 100644 index 0000000..ce2249e --- /dev/null +++ b/linux/usr/local/etc/omc/script/cpnetools.sh @@ -0,0 +1,38 @@ +#!/bin/bash + +tooldir=/usr/local/bin +toollist="zip unzip" + +# distribute to hosts in file nehosts +while read line + do + if [[ "$line" =~ ^[^[:space:]]*# || -z "$line" ]]; then + continue + fi + user=`echo $line | cut -d " " -f 2` + ip=`echo $line | cut -d " " -f 1` + passwd=`echo $line | cut -d " " -f 3` + + for toolname in $toollist;do + expect <&2 + ;; + esac + done +} + +USER="root" +PASSWORD="1000omc@kp!" +PORT="33066" +DBNAME="omc_db" +OMCRootDir=/usr/local/omc +OMCBinDir=${OMCRootDir}/bin +UpgradeSQLDir=${OMCRootDir}/etc/db/upgrade +Upgvue3SQLDir=${OMCRootDir}/etc/db/upgvue3 +InstallSQLDir=${OMCRootDir}/etc/db/install +OMCStaticDir=${OMCRootDir}/static + +check_args "$@" + +case "${M_ARG}" in + install) + ${OMCBinDir}/importdb.sh ${M_ARG} + + if [ "${C_ARG_LOWER}" != "" ]; then + CustomizedDir=${OMCStaticDir}/${C_ARG_LOWER}.d + if [ ! -d "${CustomizedDir}" ]; then + echo "Not found ${C_ARG_UPPER} customized directory, nothing to be done" + exit 1 + fi + echo -n "Setting ${C_ARG_UPPER} customized OMC ..." + for SQL in ${CustomizedDir}/db/*.sql; do + mysql -u${USER} -p${PASSWORD} -P ${PORT} --protocol tcp -D ${DBNAME} < ${SQL}; + done + cp -rf ${CustomizedDir}/logo/* ${OMCStaticDir}/logo + cp -rf ${CustomizedDir}/doc/* ${OMCStaticDir}/helpDoc + if [ "${C_ARG_LOWER}" == "ba" ]; then + rm -rf ${OMCStaticDir}/logo/zh_* + rm -rf ${OMCStaticDir}/helpDoc/zh_* + fi + #perl -0777 -i -pe 's/omcuser/bluearcus/g' ${OMCRootDir}/etc/default/restconf.yaml + #perl -0777 -i -pe 's/omcuser/bluearcus/g' ${OMCBinDir}/nehosts + if [ $? = 0 ]; then + echo "done" + fi + fi + ;; + upgrade | upgvue3) + ${OMCBinDir}/importdb.sh ${M_ARG} + ;; + skip) + if [ "${C_ARG_LOWER}" != "" ]; then + CustomizedDir=${OMCStaticDir}/${C_ARG_LOWER}.d + if [ ! -d "${CustomizedDir}" ]; then + echo "Not found ${C_ARG_UPPER} customized directory, nothing to be done" + exit 1 + fi + echo -n "Setting ${C_ARG_UPPER} customized OMC ..." + for SQL in ${CustomizedDir}/db/*.sql; do + mysql -u${USER} -p${PASSWORD} -P ${PORT} --protocol tcp -D ${DBNAME} < ${SQL}; + done + cp -rf ${CustomizedDir}/logo/* ${OMCStaticDir}/logo + cp -rf ${CustomizedDir}/doc/* ${OMCStaticDir}/helpDoc + if [ "${C_ARG_LOWER}" == "ba" ]; then + rm -rf ${OMCStaticDir}/logo/zh_* + rm -rf ${OMCStaticDir}/helpDoc/zh_* + fi + if [ $? = 0 ]; then + echo "done" + fi + fi + ;; + *) + ${OMCBinDir}/importdb.sh + ;; +esac + +exit 0 \ No newline at end of file diff --git a/linux/usr/local/etc/omc/script/setup.sh b/linux/usr/local/etc/omc/script/setup.sh new file mode 100644 index 0000000..5d210bf --- /dev/null +++ b/linux/usr/local/etc/omc/script/setup.sh @@ -0,0 +1,121 @@ +#!/bin/bash + +OMCBinFile=/usr/local/bin/omc +OMCEtcDir=/usr/local/etc/omc +confFile=$OMCEtcDir/omc.yaml +VariableFile=$OMCEtcDir/omc.conf +# Read the value of the variable from file +source $VariableFile + +# Initializing variables +T_PARAM="" +C_PARAM="" +M_PARAM="" + +# usage +usage() { + echo "Usage: bash $0 [OPTION]" + echo + echo "Program Initialization OPTION:" + echo " -i, --install Specify the install" + echo " -u, --upgrade Specify the upgrade" + echo " -m, --mode Available the mode (standard/lite)" + echo " -c, --customize Available the customize (omc/agt/ba)" + echo " -h Display this help message" + echo + exit 1 +} + +# ========================= + +while [[ $# -gt 0 ]]; do + case "$1" in + -i|--install) + T_PARAM="install" + shift + ;; + -u|--upgrade) + T_PARAM="upgrade" + shift + ;; + -t|--type) + T_PARAM="$2" + shift 2 # 跳过 -t 参数和值 + ;; + -m|--mode) + M_PARAM="$2" + shift 2 # 跳过 -m 参数和值 + ;; + -c|--customize) + C_PARAM="$2" + shift 2 # 跳过 -c 参数和值 + ;; + -h) + usage + ;; + *) + echo "Error: Unknown option: $1" + usage + ;; + esac +done + +# Make sure -i or -u comes first. +if [ -z "$T_PARAM" ]; then + echo "Error: You must specify -i (install) or -u (upgrade) first." + usage +fi +# echo "Type parameter: $T_PARAM" + +# Determine if -m is passed in +if [ -n "$M_PARAM" ]; then + # Check that mode is within the standard range + if [[ "$M_PARAM" != "standard" && "$M_PARAM" != "lite" ]]; then + echo "Error: M_PARAM can only be 'standard' or 'lite'." + exit 1 + fi + sed -i "s/MODE=.*/MODE=${M_PARAM}/" $VariableFile + sed -i "s/serverVersion: \"standard\"/serverVersion: \"${M_PARAM}\"/" $confFile + sed -i "/database:/,/defaultDataSourceName:/s/\"standard\"/\"${M_PARAM}\"/" $confFile + MODE=$M_PARAM +fi +# echo "Mode parameter: $MODE" + +# Determine if -c is passed in +if [ -n "$C_PARAM" ]; then + # Check if customize is within the standard + if [[ "$C_PARAM" != "omc" && "$C_PARAM" != "agt" && "$C_PARAM" != "ba" ]]; then + echo "Error: C_PARAM can only be 'omc', 'agt' or 'ba'." + exit 1 + fi + sed -i "s/VENDORS=.*/VENDORS=${C_PARAM}/" $VariableFile + VENDORS=$C_PARAM +fi +# echo "Customize parameter: $VENDORS" + +# ========================= +if [[ "$T_PARAM" == "install" && "$MODE" == "standard" ]]; then + if ! command -v mysql &> /dev/null && ! command -v mariadb &> /dev/null; then + echo "MySQL or MariaDB not installed" + exit 1 + fi + rm -rf $OMCEtcDir/database/lite + rm -rf $OMCEtcDir/default/omc_db.sqlite +fi +if [[ "$T_PARAM" == "install" && "$MODE" == "lite" ]]; then + rm -rf $OMCEtcDir/database/standard + cp -rf $OMCEtcDir/default/omc_db.sqlite $OMCEtcDir/database/omc_db.sqlite +fi + +# ========================= +$OMCBinFile -c $confFile --sqlPath $OMCEtcDir/database/$MODE/$T_PARAM --sqlSource $MODE + + +# ========================= Customize +if [[ "$T_PARAM" == "install" && -d $OMCEtcDir/vendor ]]; then + cp -rf $OMCEtcDir/vendor/$VENDORS/web/* $OMCEtcDir/web/background + cp -rf $OMCEtcDir/vendor/$VENDORS/static/* /usr/local/omc/static + $OMCBinFile -c $confFile --sqlPath $OMCEtcDir/vendor/$VENDORS/database/$MODE --sqlSource $MODE +fi + +# bash setup.sh -i -m standard -c omc diff --git a/linux/usr/local/etc/omc/script/sshcpid.sh b/linux/usr/local/etc/omc/script/sshcpid.sh new file mode 100644 index 0000000..830ce91 --- /dev/null +++ b/linux/usr/local/etc/omc/script/sshcpid.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +# 判断id_rsa密钥文件是否存在 +if [ ! -f ~/.ssh/id_rsa ];then + ssh-keygen -t rsa -P "" -f ~/.ssh/id_rsa +else + echo "id_rsa has created ..." +fi + +ip=$1 +user=$2 +passwd=$3 + +#分发到$ip主机. +expect <&2 - usage - exit 2 - ;; - esac -done - -if [ ! -d ${rootdir} ]; then - echo "Not exist directory: ${rootdir}" - exit 3 -fi - -bedir=${rootdir}/be.ems - -builddir=${rootdir}/build.ems -buildcustomized=${builddir}/customized -customizeddir=${buildcustomized}/${c_arg}.d - -fedir=${rootdir}/fe.ems.vue3 -feassetsdir=${fedir}/src/assets -felocalesdir=${fedir}/src/i18n/locales -feconstantsdir=${fedir}/src/constants -fehooksdir=${fedir}/src/hooks - -makefe() { - cd ${fedir} - git checkout ${feassetsdir} - git checkout ${felocalesdir} - git checkout ${feconstantsdir} - git checkout ${fehooksdir} - git pull - if [ "${pkgtype}" == "badeb" ]; then - cp -rf ${customizeddir}/images/* ${feassetsdir} - cp -rf ${customizeddir}/locales/* ${felocalesdir} - find "${feconstantsdir}" -type f -name '*.ts' -exec sed -i 's/[一-龥（）“”，。？！］～·]//g' {} + - find "${fehooksdir}" -type f -name '*.ts' -exec sed -i 's/[一-龥（）“”，。？！］～·]//g' {} + - fi - npm install --force --registry https://registry.npmmirror.com - echo -n "Building front-end vue ... " - npm run build 1>/dev/null - if [ $? = 0 ]; then - echo "done" - fi - git checkout ${feassetsdir} - git checkout ${felocalesdir} - git checkout ${feconstantsdir} - git checkout ${fehooksdir} -} - -makebe() { - cd ${builddir} - #chmod +x mkpkg.sh - chmod +x build.sh - ./build.sh ${be_args[@]} -} - -case "${m_arg}" in - fe) - makefe - ;; - all) - makefe - makebe - ;; - be | *) - makebe - ;; -esac \ No newline at end of file diff --git a/pkg/deb/DEBIAN/control b/pkg/deb/DEBIAN/control new file mode 100644 index 0000000..249b0b1 --- /dev/null +++ b/pkg/deb/DEBIAN/control @@ -0,0 +1,9 @@ +Package: OMC +Version: {version}-{date} +Section: OMC-Team +Prioritt: optional +Architecture: {arch} +Maintainer: OMC-Team +Depends: +Description: + OMC is a management application for the 5GC core network. diff --git a/pkg/deb/DEBIAN/postinst b/pkg/deb/DEBIAN/postinst new file mode 100644 index 0000000..e65cee5 --- /dev/null +++ b/pkg/deb/DEBIAN/postinst @@ -0,0 +1,54 @@ +# !/bin/bash +# 安装后执行脚本 +RootDir=/usr/local/etc/omc + +# Perform post-installation configuration +echo "" +echo "Output: $RootDir" +echo "Please Run:" +echo " sudo systemctl start|stop|status|restart omc.service" +echo "" + +# Check if this is the first installation or upgrade +if [ ! -f $RootDir/omc.conf ]; then + # First installation, perform the related operations + chmod +rx /usr/local/bin/omc + cp $RootDir/default/omc.conf $RootDir/omc.conf + cp $RootDir/default/omc.yaml $RootDir/omc.yaml + cp $RootDir/default/sshsvc.yaml $RootDir/sshsvc.yaml + + # read environment parameter and to do + if [ -n "$M_PARAM" ] && [ -n "$C_PARAM" ]; then + bash $RootDir/script/setup.sh -i -m $M_PARAM -c $C_PARAM + elif [ -n "$C_PARAM" ]; then + bash $RootDir/script/setup.sh -i -c $C_PARAM + else + bash $RootDir/script/setup.sh -i + fi + if [ $? -ne 0 ]; then + echo "Initialization failure." + rm -rf $RootDir + exit 1 + fi + + rm -rf $RootDir/vendor + + systemctl daemon-reload + systemctl enable omc.service + systemctl enable sshsvc.service + systemctl daemon-reload + systemctl restart omc.service + systemctl restart sshsvc.service +else + # Operation when upgrading + + bash $RootDir/script/setup.sh -u + if [ $? -ne 0 ]; then + echo "Upgrade failed." + exit 1 + fi + + systemctl daemon-reload + systemctl start omc.service + systemctl start sshsvc.service +fi diff --git a/pkg/deb/DEBIAN/postrm b/pkg/deb/DEBIAN/postrm new file mode 100644 index 0000000..8146c19 --- /dev/null +++ b/pkg/deb/DEBIAN/postrm @@ -0,0 +1,23 @@ +# !/bin/bash +# 卸载后执行脚本 + +case "$1" in + remove) + # 卸载操作 + + # 删除服务文件 + systemctl daemon-reload + systemctl disable omc.service + systemctl disable sshsvc.service + rm -rf /lib/systemd/system/omc.service + rm -rf /lib/systemd/system/sshsvc.service + systemctl daemon-reload + + # 移除相关文件 + rm -rf /usr/local/bin/omc + rm -rf /usr/local/etc/omc + ;; + upgrade) + # 更新操作 + ;; +esac diff --git a/pkg/deb/DEBIAN/preinst b/pkg/deb/DEBIAN/preinst new file mode 100644 index 0000000..65d6431 --- /dev/null +++ b/pkg/deb/DEBIAN/preinst @@ -0,0 +1,4 @@ +# !/bin/bash +# 安装前执行脚本 + +rm -rf /usr/local/etc/omc/default diff --git a/pkg/deb/DEBIAN/prerm b/pkg/deb/DEBIAN/prerm new file mode 100644 index 0000000..cca94f6 --- /dev/null +++ b/pkg/deb/DEBIAN/prerm @@ -0,0 +1,7 @@ +# !/bin/bash +# 卸载前执行脚本 + +# 停止服务 +systemctl daemon-reload +systemctl stop omc.service +systemctl stop sshsvc.service diff --git a/build/usr/local/omc/license/.gitkeep b/pkg/rpm/BUILD/.gitkeep similarity index 100% rename from build/usr/local/omc/license/.gitkeep rename to pkg/rpm/BUILD/.gitkeep diff --git a/pkg/rpm/SPECS/omc.spec b/pkg/rpm/SPECS/omc.spec new file mode 100644 index 0000000..56f9050 --- /dev/null +++ b/pkg/rpm/SPECS/omc.spec @@ -0,0 +1,102 @@ +Name: omc +Version: {version} +Release: {date} +Summary: OMC-Team + +License: GPL +Group: Applications/Communications +BuildArch: {arch} + + +# 软件说明 +%description +OMC-Team for NE + + +# 打包前脚本 ======== +%prep +rm -rf ${RPM_BUILD_ROOT} && mkdir -p ${RPM_BUILD_ROOT} +cp -rf ${RPM_BUILD_DIR}/* ${RPM_BUILD_ROOT}/ + + +# 安装前脚本 ======== +%pre +rm -rf /usr/local/etc/omc/default + + +# 安装后脚本 ======== +%post +RootDir=/usr/local/etc/omc + +# 执行安装后配置 +echo "" +echo "Output: $RootDir" +echo "Please Run:" +echo " sudo systemctl start|stop|status|restart omc.service" +echo "Setting Firewall:" +echo " add: " +echo " firewall-cmd --zone=public --add-port=33030/tcp --permanent && firewall-cmd --reload" +echo " remove: " +echo " firewall-cmd --zone=public --remove-port=33030/tcp --permanent && firewall-cmd --reload" +echo "" + +# 检查是否是第一次安装或是升级 +if [ ! -f $RootDir/omc.yaml ]; then + # 第一次安装，执行相关操作 + chmod +rx /usr/local/bin/omc + cp $RootDir/default/omc.yaml $RootDir/omc.yaml + cp $RootDir/default/oam_manager.yaml $RootDir/oam_manager.yaml + + systemctl daemon-reload + systemctl enable omc.service + systemctl daemon-reload + systemctl stop omc.service + systemctl start omc.service +else + # 升级时的操作 + systemctl daemon-reload + systemctl start omc.service +fi + + +# 卸载前脚本 ======== +%preun +# 停止服务 +systemctl daemon-reload +systemctl stop omc.service + + +# 卸载后脚本 ======== +%postun +case "$1" in + 0) + # 卸载操作 + + # 删除服务文件 + systemctl daemon-reload + systemctl disable omc.service + rm -rf /lib/systemd/system/omc.service + systemctl daemon-reload + + # 移除相关文件 + rm -rf /usr/local/bin/omc + rm -rf /usr/local/etc/omc + ;; + 1) + # 更新操作 + ;; +esac + + +# 包含的文件 ======== +%files +%defattr(-,root,root,-) +/usr/local/etc/omc/* +/usr/local/bin/omc +/lib/systemd/system/omc.service + + +# 更新日志 ======== +%changelog +* Wed Jan 01 2025 omc - {version} +- Build package {date}. diff --git a/build/usr/local/omc/log/.gitkeep b/release/deb/amd64/.gitkeep similarity index 100% rename from build/usr/local/omc/log/.gitkeep rename to release/deb/amd64/.gitkeep diff --git a/build/usr/local/omc/mmlhome/.gitkeep b/release/deb/arm64/.gitkeep similarity index 100% rename from build/usr/local/omc/mmlhome/.gitkeep rename to release/deb/arm64/.gitkeep diff --git a/release/debs/amd64/.gitkeep b/release/debs/amd64/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/release/debs/arm64/.gitkeep b/release/debs/arm64/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/build/usr/local/omc/mmllog/.gitkeep b/release/rpm/amd64/.gitkeep similarity index 100% rename from build/usr/local/omc/mmllog/.gitkeep rename to release/rpm/amd64/.gitkeep diff --git a/build/usr/local/omc/software/.gitkeep b/release/rpm/arm64/.gitkeep similarity index 100% rename from build/usr/local/omc/software/.gitkeep rename to release/rpm/arm64/.gitkeep diff --git a/release/rpms/amd64/.gitkeep b/release/rpms/amd64/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/release/rpms/arm64/.gitkeep b/release/rpms/arm64/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/rpmbuild/BUILD/etc/nginx/conf.d/omc.conf b/rpmbuild/BUILD/etc/nginx/conf.d/omc.conf deleted file mode 100644 index 0e1facc..0000000 --- a/rpmbuild/BUILD/etc/nginx/conf.d/omc.conf +++ /dev/null @@ -1,71 +0,0 @@ -server { - listen 44080; - listen 44443; - listen [::]:44080; - listen [::]:44443; - server_name localhost; - - client_max_body_size 100M; - keepalive_timeout 180s; - - #access_log /var/log/nginx/host.access.log main; - - # ssl_certificate /usr/local/omc/etc/certs/omc-server.crt; - # ssl_certificate_key /usr/local/omc/etc/certs/omc-server.key; - # ssl_client_certificate /usr/local/omc/etc/certs/omc-ca.crt; - # ssl_verify_client on; - # ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3; - # ssl_session_timeout 5m; - # ssl_ciphers EECDH+CHACHA20:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5; - # ssl_prefer_server_ciphers on; - - # OMC - location / { - root /usr/local/omc/htdocs/front; - - try_files $uri $uri/ /index.html; - index index.html index.htm; - } - - location /omc-api/ { - proxy_pass http://127.0.0.1:33030/; - - proxy_connect_timeout 180s; - proxy_send_timeout 180s; - proxy_read_timeout 180s; - - proxy_cache_bypass $http_upgrade; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; - } - - location /api/rest/ { - proxy_pass http://127.0.0.1:33030/api/rest/; - - proxy_cache_bypass $http_upgrade; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $host; - proxy_set_header X-Forwarded-Port $server_port; - } - - #error_page 404 /404.html; - - # redirect server error pages to the static page /50x.html - # - error_page 500 502 503 504 /50x.html; - location = /50x.html { - root /usr/share/nginx/html; - } -} - diff --git a/rpmbuild/BUILD/usr/lib/systemd/system/.gitkeep b/rpmbuild/BUILD/usr/lib/systemd/system/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/rpmbuild/BUILD/usr/lib64/libwireshark.so.15.0.12 b/rpmbuild/BUILD/usr/lib64/libwireshark.so.15.0.12 deleted file mode 100644 index 69ed074..0000000 Binary files a/rpmbuild/BUILD/usr/lib64/libwireshark.so.15.0.12 and /dev/null differ diff --git a/rpmbuild/BUILD/usr/lib64/libwiretap.so.12.0.12 b/rpmbuild/BUILD/usr/lib64/libwiretap.so.12.0.12 deleted file mode 100644 index 28202b7..0000000 Binary files a/rpmbuild/BUILD/usr/lib64/libwiretap.so.12.0.12 and /dev/null differ diff --git a/rpmbuild/BUILD/usr/lib64/libwsutil.so.13.1.0 b/rpmbuild/BUILD/usr/lib64/libwsutil.so.13.1.0 deleted file mode 100644 index fe34cef..0000000 Binary files a/rpmbuild/BUILD/usr/lib64/libwsutil.so.13.1.0 and /dev/null differ diff --git a/rpmbuild/BUILD/usr/local/bin/tshark b/rpmbuild/BUILD/usr/local/bin/tshark deleted file mode 100644 index 16131f1..0000000 Binary files a/rpmbuild/BUILD/usr/local/bin/tshark and /dev/null differ diff --git a/rpmbuild/BUILD/usr/local/omc/.ssh/id_rsa b/rpmbuild/BUILD/usr/local/omc/.ssh/id_rsa deleted file mode 100644 index b9e6a0e..0000000 --- a/rpmbuild/BUILD/usr/local/omc/.ssh/id_rsa +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/rpmbuild/BUILD/usr/local/omc/.ssh/id_rsa.pub b/rpmbuild/BUILD/usr/local/omc/.ssh/id_rsa.pub deleted file mode 100644 index 93e845f..0000000 --- a/rpmbuild/BUILD/usr/local/omc/.ssh/id_rsa.pub +++ /dev/null @@ -1 +0,0 @@ -ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCjzE0MHy0P2sQmG1OKvArwLEzR77BwxPp+4N9NKBz8lEyNch4zoHvoLDaUJKPBMwTrScZnxhvRJNde6hz5Z0QVxZolVKV95fMfgb9YICzDfPF3Bphae5q/PBYUJNfrC9SAjQeHV4CCO6xk6LV8O/Nfw8uaXwtuN3yfpUWd5mRWKMc3GHV4vxerfKoIQZN6etLhIEYibAhCJ21P0uoWzZl7ceLmkG+6qrRSbyC0bCnrN3+wjN4bwtflrEFJk3XQGuRbVsYLzux+mMm9p22+CLPRl/FUPF3x4/wKCsqr7JDSxx80HSPhk4g/1nCTpDR9hAfF6A9ww2va/k8jMeYPBO8Owe7erLEZzvg5WQAR3Wj05eJpJD99BeC91S5KW6AFQDfDHxWWprSibd/Jj9dtct2pK2ZxW0ph9OJ49ftRhzT1iVi4UnJwnG5/qLfwl6Tnx+qnQ1If/9lY/99erCTATzFTMSImKrRz7CnuPlcw8WkzCYpWKKe0kJLkL2cRD5Qi4yk= simon@simonzhangsz diff --git a/rpmbuild/BUILD/usr/local/omc/.ssh/private_key.pem b/rpmbuild/BUILD/usr/local/omc/.ssh/private_key.pem deleted file mode 100644 index b9e6a0e..0000000 --- a/rpmbuild/BUILD/usr/local/omc/.ssh/private_key.pem +++ /dev/null @@ -1,38 +0,0 @@ ------BEGIN OPENSSH PRIVATE KEY----- -b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAABlwAAAAdzc2gtcn -NhAAAAAwEAAQAAAYEAo8xNDB8tD9rEJhtTirwK8CxM0e+wcMT6fuDfTSgc/JRMjXIeM6B7 -6Cw2lCSjwTME60nGZ8Yb0STXXuoc+WdEFcWaJVSlfeXzH4G/WCAsw3zxdwaYWnuavzwWFC -TX6wvUgI0Hh1eAgjusZOi1fDvzX8PLml8Lbjd8n6VFneZkVijHNxh1eL8Xq3yqCEGTenrS -4SBGImwIQidtT9LqFs2Ze3Hi5pBvuqq0Um8gtGwp6zd/sIzeG8LX5axBSZN10BrkW1bGC8 -7sfpjJvadtvgiz0ZfxVDxd8eP8CgrKq+yQ0scfNB0j4ZOIP9Zwk6Q0fYQHxegPcMNr2v5P -IzHmDwTvDsHu3qyxGc74OVkAEd1o9OXiaSQ/fQXgvdUuSlugBUA3wx8Vlqa0om3fyY/XbX -LdqStmcVtKYfTiePX7UYc09YlYuFJycJxuf6i38Jek58fqp0NSH//ZWP/fXqwkwE8xUzEi -Jiq0c+wp7j5XMPFpMwmKViintJCS5C9nEQ+UIuMpAAAFiMzUaEPM1GhDAAAAB3NzaC1yc2 -EAAAGBAKPMTQwfLQ/axCYbU4q8CvAsTNHvsHDE+n7g300oHPyUTI1yHjOge+gsNpQko8Ez -BOtJxmfGG9Ek117qHPlnRBXFmiVUpX3l8x+Bv1ggLMN88XcGmFp7mr88FhQk1+sL1ICNB4 -dXgII7rGTotXw781/Dy5pfC243fJ+lRZ3mZFYoxzcYdXi/F6t8qghBk3p60uEgRiJsCEIn -bU/S6hbNmXtx4uaQb7qqtFJvILRsKes3f7CM3hvC1+WsQUmTddAa5FtWxgvO7H6Yyb2nbb -4Is9GX8VQ8XfHj/AoKyqvskNLHHzQdI+GTiD/WcJOkNH2EB8XoD3DDa9r+TyMx5g8E7w7B -7t6ssRnO+DlZABHdaPTl4mkkP30F4L3VLkpboAVAN8MfFZamtKJt38mP121y3akrZnFbSm -H04nj1+1GHNPWJWLhScnCcbn+ot/CXpOfH6qdDUh//2Vj/316sJMBPMVMxIiYqtHPsKe4+ -VzDxaTMJilYop7SQkuQvZxEPlCLjKQAAAAMBAAEAAAGATRJTapG8zUn9o4SWIaBrcSkXGG -0000sMJuk+iPqH8R0CjEeXCGnKA6vSHpDC8KRF+0QidC/WZOl14XY9HelGMwxghJI4sG2j -oT6WvyuchHtkzsGurFyeqr7mEKJpanKNkdNKKJe2oxDbBDwvMP6wfG4PflqccUbwf9nvUO -XYbmYPntAGbkNUKt+kze+1Khti4IUkGwxEMoSEvdubRBGH13r17dEmkWnDIUqi0+JVMxVR -IsyVsfBTUAFmUu1ssPgFnD81z9G9OTic2A5zd+QDfXlJWbjJACtuM/4IotkZZ/M6rsVlYn -AY8Vqfs/8C53giSF5R4iiR29FIU3Luts9dJJQyQ94rXunK00iifyh18qisBKwh9rjxYn3J -wFeZeXzKRg/cLuY1Z74QBWjWzukadvu7dC9bWFZ2k3zKBPTodcpXr1QDwFT4mgEYAFXbQN -8RjFGZrhr2jbsnoM71QlcGv9RjxMPNep+BwnYvPSZ1Piu3nmQqNtysg6ur3ZEHJeLVAAAA -wHZ5m4TECDOgkL138faHQycfd9Yi/Yj1akSwVvtGpiPd35ir1bOp52H/Ea3ymDwh6PvOSk -NjpvwqCXSX5nIQWrQQiDHMKA4pCfAtzbJ68fhWmfzWUaWGIcrnhnoxXzMYgXS/Gp6fwqOf -5JH4jm3uM5knXLTz0E0WofYnLgDo6CAuANl9bSQDfPYh8tuNndoQd9190r+15uLhv/pIM7 -MsZzifBrE2cgSBIunIERdQbD9JwNCeDPIrV8aQbOJDyuJDbwAAAMEA1nYx8GVZM/0cSZqG -V9C4i6debJEep2k91z7XvjFRZJrTYYZavWJPEUmmqNjsJg0Bdad4g3SdK2iJ4W5CHzDm2S -Zn08j7on/ybcD2c1ZnXbwKrzPXRymc62xxwSDD95m/R5cSvN/Pmy57QfymQNPaNXMkhKq1 -nzF56bljW0FHVFnrgUHpbLUOEc0QHXO4d2PaUNptLVxquOJI/VDW2GKKQWaIsdYKPJEDO9 -GBe/LaUDzodd1s1isly86DLEgT2HwbAAAAwQDDhgO/kOI1N0jMOpE5gotcrhQc353jrP16 -mKOdcp9MVHiioRybsyRdnbDIYKXbQz2ZRwmz2RBh55uPQjLcfi82GlIm2rdTL8KzP9vLpc -WAbZ7dcbv1lLyIlr4Yf33LgAChxJQTGNad771cwYFrtwTYk16O0Mdv302L0DgDTJUvhzJb -0ZuIk2nmzumSH1pOYmZl8Oa+UM7YSZNCWEpM7/S5laNISQ6dF/yy6Del2sQk/1/JCMUK0d -GLCkyCiaW9igsAAAASc2ltb25Ac2ltb256aGFuZ3N6AQ== ------END OPENSSH PRIVATE KEY----- diff --git a/rpmbuild/BUILDROOT/.gitkeep b/rpmbuild/BUILDROOT/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/rpmbuild/RPMS/.gitkeep b/rpmbuild/RPMS/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/rpmbuild/SOURCES/.gitkeep b/rpmbuild/SOURCES/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/rpmbuild/SPECS/omc.spec b/rpmbuild/SPECS/omc.spec deleted file mode 100644 index ca84844..0000000 --- a/rpmbuild/SPECS/omc.spec +++ /dev/null @@ -1,155 +0,0 @@ -%define __check_files %{nil} -%define __spec_build_pre %{nil} -%define __arch_install_post %{nil} -%define release_version 1 -%define release_date %(echo `date +%%Y%%m%%d`) -%define project_lname omc -%define project_Uname OMC - -Name: %{project_lname} -Summary: 5GC OMC -Version: 2.2503.2 -Release: %{release_date} -Vendor: omc -URL: https://www.omc.com/ -License: commercial -Group: Applications/Communications -#BuildRoot: $PWD/rpmoutput -%description -5GC OMC - -%prep -rm -rf ${RPM_BUILD_ROOT}/* -mkdir -p ${RPM_BUILD_ROOT} -cp -rf ${RPM_BUILD_DIR}/* ${RPM_BUILD_ROOT}/ -chmod +rx ${RPM_BUILD_ROOT}/usr/local/omc -chmod +rx ${RPM_BUILD_ROOT}/usr/local/omc/* -chmod +rx ${RPM_BUILD_ROOT}/usr/local/bin/* -chmod +x ${RPM_BUILD_ROOT}/usr/local/omc/htdocs/front -chmod +rx ${RPM_BUILD_ROOT}/usr/lib64/* - -# 安装完成后执行 -%post -OMCRootDir=/usr/local/omc -OMCEtcDir=${OMCRootDir}/etc -FERootDir=${OMCRootDir}/htdocs/front -OMCBinDir=${OMCRootDir}/bin -OMCStaticDir=${OMCRootDir}/static -UsrLocalBinDir=/usr/local/bin -OMCDaemon=omcd -NginxEtcDir=/etc/nginx -CFileList="restconf.yaml sshsvc.yaml omc.conf" -LogoFileList="zh_brand.png zh_icon.png en_brand.png en_icon.png" - -echo -n "Stopping OMC service ... " -systemctl stop restagent.service -systemctl stop sshsvc.service -echo "done" - -for CFile in ${CFileList}; do - if [ ! -e "${OMCEtcDir}/${CFile}" ]; then - cp -f ${OMCEtcDir}/default/${CFile} ${OMCEtcDir} - #else - # mv -f ${OMCEtcDir}/${CFile} ${OMCEtcDir}/${CFile}.bak - # cp -f ${OMCEtcDir}/default/${CFile} ${OMCEtcDir} - #if [ -e "${OMCBinDir}/upgconf.sh" ]; then - # ${OMCBinDir}/upgconf.sh - #fi - fi -done - -if [ ! -e "${FERootDir}/config.js" ]; then cp ${FERootDir}/default/config.js ${FERootDir}; fi -for LogoFile in ${LogoFileList}; do - if [ ! -e "${OMCStaticDir}/logo/${LogoFile}" ]; then - cp ${OMCStaticDir}/omc.d/logo/${LogoFile} ${OMCStaticDir}/logo; - fi -done -if ! id -u omc >/dev/null 2>&1 ; then useradd -d /opt/omc -m -s /bin/bash -p1000ftp@kp omc; else echo "user omc exist"; fi -mkdir -p /opt/omc/ftp -mkdir -p /opt/omc/ftp/log -cd ${UsrLocalBinDir} -if [ ! -e ${OMCDaemon} ]; then ln -s ${OMCBinDir}/omcsvc.sh ${OMCDaemon}; fi - -# setting firewall -PortList="80 443 44080 44443 33030 22222" -for Port in ${PortList}; do - firewall-cmd --zone=public --add-port=${Port}/tcp --permanent -done -firewall-cmd --reload - -systemctl daemon-reload -systemctl enable restagent.service -systemctl enable sshsvc.service - -# read environment parameter and to do -if [ "$M_PARAM" = "install" -o "$M_PARAM" = "upgrade" ]; then - echo "M parameter: $M_PARAM" - if [ -n "$C_PARAM" ]; then - echo "C parameter: $C_PARAM" - ${OMCRootDir}/bin/setomc.sh -m $M_PARAM -c $C_PARAM - else - ${OMCRootDir}/bin/setomc.sh -m $M_PARAM - fi - # exit while failed to run setomc.sh - if [ $? -ne 0 ]; then - echo "setomc.sh execution failed. Exiting." - exit 1 - fi -fi - -echo -n "Starting OMC service ... " -systemctl start sshsvc.service -systemctl start restagent.service -echo "done" - -# 卸载时执行 -%postun -UsrLocalBinDir=/usr/local/bin -rm -f ${UsrLocalBinDir}/omcd - -# setting firewall -PortList="80 443 44080 44443 33030 22222" -for Port in ${PortList}; do - firewall-cmd --zone=public --remove-port=${Port}/tcp --permanent -done -firewall-cmd --reload - -if [ "$1" = "0" ] ; then - sudo systemctl stop restagent.service - sudo systemctl stop sshsvc.service - #rm -rf /usr/local/omc - rm -rf /etc/nginx/conf.d/omc.conf - sudo systemctl disable restagent.service - sudo systemctl disable sshsvc.service - sudo systemctl daemon-reload -else - sudo systemctl daemon-reload - sudo systemctl stop restagent.service - sudo systemctl stop sshsvc.service - sudo systemctl start sshsvc.service - sudo systemctl start restagent.service -fi - -# 规定那些文件必须放入安装程序中，如果没有就报错 -%files -%defattr(-,root,root) -/usr/local/omc/.ssh -/usr/local/omc/mmllog -/usr/local/omc/mmlhome -/usr/local/omc/bin -/usr/local/omc/etc -/usr/local/omc/htdocs -# %exclude /usr/local/omc/htdocs/front/wiregasm/wiregasm.wasm.gz -/usr/local/omc/log -/usr/local/omc/backup -/usr/local/omc/upload -/usr/local/omc/software -/usr/local/omc/license -/usr/local/omc/database -/usr/local/omc/static -#/etc/nginx/conf.d/omc.conf -/lib/systemd/system/restagent.service -/lib/systemd/system/sshsvc.service - - - diff --git a/rpmbuild/SRPMS/.gitkeep b/rpmbuild/SRPMS/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/build/usr/local/omc/static/logo/.gitkeep b/tmp/.gitkeep similarity index 100% rename from build/usr/local/omc/static/logo/.gitkeep rename to tmp/.gitkeep