文档中心

外观

前缀相关接口 ​

前缀查询 ​

请求参数 ​

  • 请求服务：业务系统 SNMS 服务器的 HTTP 端口（默认 8000）
  • 请求方式：GET
  • 请求路径：/snms/api/prefix/query
  • Header：
参数类型是否必填最大长度备注示例值
AuthorizationString是-Bearer + 空格 + token(身份接口获取)admin
Content-TypeString是-application/jsonapplication/json
  • Param：
参数类型是否必填最大长度备注示例值
prefixString是64要查询的前缀88.709.1

请求示例 ​

/snms/api/prefix/query?prefix=88.709.1

响应参数 ​

  • 公共响应参数
参数类型最大长度备注示例值
statusInteger-状态码(详见状态码说明）1
messageString-状态码描述success
dataObject-返回数据-
  • 响应参数
参数参数类型最大长度备注示例值
data.prefixString-前缀名称88.709.1
data.createDateString-前缀创建时间2020-02-07 11:45:35
data.ghrNameString-前缀注册服务机构工业互联网标识解析国家顶级节点--北京
data.statusInt-前缀状态（状态是否有效 0停用1启用2待删除3被驳回 4待审核 5审核中）1
data.entNameCnString-企业中文名称layone
data.entWebSiteString-企业官方地址
data.entIndustryString-企业所属行业B
data.entAddrCnString-企业中文地址eee
data.entDescString-企业简介简介

响应示例 ​

json
{
    "message": "success",
    "status": 1,
    "data": {
        "prefix": "88.709.1",
        "createDate": "2020-02-0711:45:35",
        "ghrName": "工业互联网标识解析国家顶级节点--北京",
        "status": 1,
        "entNameCn": "layone",
        "entSite": null,
        "entIndustry": "B",
        "entAddrCn": "eee",
        "entDesc": null
    }
}
{
    "message": "success",
    "status": 1,
    "data": {
        "prefix": "88.709.1",
        "createDate": "2020-02-0711:45:35",
        "ghrName": "工业互联网标识解析国家顶级节点--北京",
        "status": 1,
        "entNameCn": "layone",
        "entSite": null,
        "entIndustry": "B",
        "entAddrCn": "eee",
        "entDesc": null
    }
}

异常示例 ​

json
{
    "message":"系统繁忙",
    "status":-1,
    "data": null
}
{
    "message":"系统繁忙",
    "status":-1,
    "data": null
}

注意事项 ​

管理员角色能调用该接口（例：admin用户） 其他用户可查看已申请的前缀

前缀列表 ​

请求参数 ​

  • 请求服务：业务系统 SNMS 服务器的 HTTP 端口（默认 8000）
  • 请求方式：GET
  • 请求路径：/snms/api/prefix/page
  • Header：
参数类型是否必填最大长度备注示例值
AuthorizationString是-Bearer + 空格 + token(身份接口获取)admin
Content-TypeString是-application/jsonapplication/json
  • Param：
参数类型是否必填最大长度备注示例值
entNameString非必填-单位名称teleinfo
entPrefixString非必填-企业前缀88.709.1
startDateDate非必填-开始时间2022-01-01 00:00:00
endDateDate非必填-结束时间2022-01-01 00:00:00
currentPageInteger非必填-当前页数1
pageSizeInteger非必填-页面大小10

请求示例 ​

/snms/api/prefix/query?entPrefix=&entName=&startDate=&endDate=&currentPage=&pageSize=

响应参数 ​

  • 公共响应参数
参数类型最大长度备注示例值
statusInteger-状态码(详见状态码说明）1
messageString-状态码描述success
dataObject-返回数据-
  • 响应参数
参数参数类型最大长度备注示例值
data.firstBoolean---
data.lastBoolean---
data.totalPagesInteger---
data.totalElementsLong---
data.numberInteger---
data.sizeInteger---
data.sortSort---
data.numberOfElementsInteger---
data.contentList---
data.content.idLong-Id123
data.content.createDateLocalDateTime-创建时间2022-01-01 00:00:00
data.content.updateDateLocalDateTime-更新时间2022-01-01 00:00:00
data.content.entPrefixString-企业前缀88.123
data.content.entIdLong-企业ID1523
data.content.stateInteger-状态 0停用1启用1
data.content.entNameString-企业名称teleinfo
data.content.proxyStateInteger-托管状态 1未托管2托管申请中3托管被驳回4已托管1

响应示例 ​

json
{
    "message": "success",
    "status": 1,
    "data": {
        "first": true,
        "last": false,
        "totalPages": 2,
        "totalElements": 14,
        "number": 1,
        "size": 10,
        "sort": null,
        "numberOfElements": 10,
        "content": [
            {
                "id": 16,
                "entprefix": "企业前缀",
                "entId": "5",
                "state": "1",
                "entName": "单位名称",
                "proxyState": "1",
                "createDate": "2021-12-28 13:47:29",
                "updateDate": "2021-12-29 13:47:29"
            },
            {
                "id": 15,
                "entprefix": "企业前缀",
                "entId": "1",
                "state": "1",
                "entName": "单位名称",
                "proxyState": 1,
                "createDate": "2021-11-20 11:08:57",
                "updateDate": "2021-12-03 17:48:52"
            }
        ]
    }
}
{
    "message": "success",
    "status": 1,
    "data": {
        "first": true,
        "last": false,
        "totalPages": 2,
        "totalElements": 14,
        "number": 1,
        "size": 10,
        "sort": null,
        "numberOfElements": 10,
        "content": [
            {
                "id": 16,
                "entprefix": "企业前缀",
                "entId": "5",
                "state": "1",
                "entName": "单位名称",
                "proxyState": "1",
                "createDate": "2021-12-28 13:47:29",
                "updateDate": "2021-12-29 13:47:29"
            },
            {
                "id": 15,
                "entprefix": "企业前缀",
                "entId": "1",
                "state": "1",
                "entName": "单位名称",
                "proxyState": 1,
                "createDate": "2021-11-20 11:08:57",
                "updateDate": "2021-12-03 17:48:52"
            }
        ]
    }
}

异常示例 ​

json
{
    "message":"系统繁忙",
    "status":-2,
    "data": null
}
{
    "message":"系统繁忙",
    "status":-2,
    "data": null
}

注意事项 ​

管理员角色能调用该接口（例：admin用户） 其他用户可查看已申请的前缀

托管前缀配置 ​

  • 前缀配置时，如果想要托管前缀，选择“托管前缀配置”，执行成功后，用户将变成托管用户；前缀配置时，如果不想托管前缀，选择“未托管前缀配置”，执行成功后，用户仍然为企业用户。
  • 两个接口的请求路径、请求方式、响应参数均相同，只有请求参数不同。

请求参数 ​

  • 请求服务：业务系统 SNMS 服务器的 HTTP 端口（默认 8000）
  • 请求方式：POST
  • 请求路径：/snms/api/ent/config
  • Header：
参数类型是否必填最大长度备注示例值
AuthorizationString是-Bearer + 空格 + token(身份接口获取)admin
Content-TypeString是-application/jsonapplication/json
  • Body：
参数类型是否必填最大长度备注示例值
proxyServerIdLong必填20托管服务器id1
entPrefixConfigObject必填-配置信息-
entPrefixConfig.entPrefixString必填64企业前缀88.101.1304

请求示例 ​

json
{
    "proxyServerId": 1,
    "entPrefixConfig": {
      "entPrefix": "88.101.1304"
    }
}
{
    "proxyServerId": 1,
    "entPrefixConfig": {
      "entPrefix": "88.101.1304"
    }
}

响应参数 ​

参数类型最大长度备注示例值
statusInteger-状态码(详见状态码说明)1
messageString-状态码描述success
dataBoolean-是否操作成功true

响应示例 ​

json
{
    "message": "success",
    "status": 1,
    "data": true
}
{
    "message": "success",
    "status": 1,
    "data": true
}

异常示例 ​

json
{
    "message":"系统繁忙",
    "status":-1,
    "data": null
}
{
    "message":"系统繁忙",
    "status":-1,
    "data": null
}

注意事项 ​

  • 托管服务器id 在界面“系统管理-托管配置”中可查
  • 该接口调用的前提：企业已申请且国家顶级节点业务管理系统审核通过
  • 管理员角色和企业用户能调用该接口（例：admin用户）

未托管前缀配置 ​

  • 前缀配置时，如果想要托管前缀，选择“托管前缀配置”，执行成功后，用户将变成托管用户；前缀配置时，如果不想托管前缀，选择“未托管前缀配置”，执行成功后，用户仍然为企业用户。
  • 两个接口的请求路径、请求方式、响应参数均相同，只有请求参数不同。

请求参数 ​

  • 请求服务：业务系统 SNMS 服务器的 HTTP 端口（默认 8000）
  • 请求方式：POST
  • 请求路径：/snms/api/ent/config
  • Header：
参数类型是否必填最大长度备注示例值
AuthorizationString是-Bearer + 空格 + token(身份接口获取)admin
Content-TypeString是-application/jsonapplication/json
  • Body：
参数类型是否必填最大长度备注示例值
entPrefixConfigObject必填-配置信息-
entPrefixConfig.entPrefixString必填64企业前缀88.101.1304
entPrefixConfig.hdlTypeString必填255hdl类型HS_SITE
entPrefixConfig.httpPortString非必填11http端口
entPrefixConfig.ipString必填255ip地址2031:0000:1F1F:0000:0000:0100:11A0:ADDF
entPrefixConfig.ipTypeString必填1ip类型4:V4,6:V66
entPrefixConfig.tcpPortString非必填11tcp端口2643
entPrefixConfig.udpPortString非必填11udp端口-

请求示例 ​

json
{
    "entPrefixConfig": {
        "entPrefix": "88.101.1304",
        "hdlType": "HS_SITE",
        "ipType": 6,
        "ip": "2031:0000:1F1F:0000:0000:0100:11A0:ADDF",
        "tcpPort": "2643",
        "udpPort": "",
        "httpPort": ""
    }
}
{
    "entPrefixConfig": {
        "entPrefix": "88.101.1304",
        "hdlType": "HS_SITE",
        "ipType": 6,
        "ip": "2031:0000:1F1F:0000:0000:0100:11A0:ADDF",
        "tcpPort": "2643",
        "udpPort": "",
        "httpPort": ""
    }
}

响应参数 ​

参数类型最大长度备注示例值
statusInteger-状态码(详见状态码说明)1
messageString-状态码描述success
dataBoolean-是否操作成功true

响应示例 ​

json
{
    "message": "success",
    "status": 1,
    "data": true
}
{
    "message": "success",
    "status": 1,
    "data": true
}

异常示例 ​

json
{
    "message":"系统繁忙",
    "status":-1,
    "data": null
}
{
    "message":"系统繁忙",
    "status":-1,
    "data": null
}

注意事项 ​

  • 该接口调用的前提：企业已申请且国家顶级节点业务管理系统审核通过
  • http端口、tcp端口、udp端口至少填写一个
  • 管理员角色和企业用户能调用该接口（例：admin用户）

Released under the MIT License.

Copyright © 2021-2022 teleinfo.cn