zyc_data_rsync/doc_json/ipam.json

{
  "apiVersion": "1.0",
  "apis": [
    {
      "description": "applyIpmacList",
      "operations": [
        {
          "method": "POST",
          "summary": "申请IP",
          "notes": "applyIpmacList",
          "nickname": "applyIpmacList",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "子网信息ID",
              "name": "segmentId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "MAC地址",
              "name": "mac",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "用户名",
              "name": "user",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "上联设备IP",
              "name": "devIp",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "上联接口索引",
              "name": "ifIdx",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "部门",
              "name": "department",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "申请AP结果"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "申请AP结果"
        }
      ],
      "path": "/ipam/applyIpmacList"
    },
    {
      "description": "daleteByIp",
      "operations": [
        {
          "method": "POST",
          "summary": "根据IP删除基准表记录",
          "notes": "daleteByIp",
          "nickname": "daleteByIp",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "IP",
              "name": "ip",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "结果"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "结果"
        }
      ],
      "path": "/ipam/daleteByIp"
    },
    {
      "description": "getIpmacAllSegmentList",
      "operations": [
        {
          "method": "POST",
          "summary": "获取所有子网列表信息",
          "notes": "getIpmacAllSegmentList",
          "nickname": "getIpmacAllSegmentList",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "子网信息列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "子网信息列表数据"
        }
      ],
      "path": "/ipam/getIpmacAllSegmentList"
    },
    {
      "description": "getIpmacListC",
      "operations": [
        {
          "method": "POST",
          "summary": "根据IP查询基准表IPMAC列表",
          "notes": "getIpmacListC",
          "nickname": "getIpmacListC",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "IP",
              "name": "ip",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "上联设备IP",
              "name": "devIp",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "查表标记，默认或者传入benchmark字符串时查基准表。其他情况查实时表",
              "name": "tableFlag",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "主资源及其包含的子资源数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "主资源及其包含的子资源数据"
        }
      ],
      "path": "/ipam/getIpmacList"
    },
    {
      "description": "getIpmacLocationList",
      "operations": [
        {
          "method": "POST",
          "summary": "获取网段列表信息",
          "notes": "getIpmacLocationList",
          "nickname": "getIpmacLocationList",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "网段列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "网段列表数据"
        }
      ],
      "path": "/ipam/getIpmacLocationList"
    },
    {
      "description": "getIpmacSegmentList",
      "operations": [
        {
          "method": "POST",
          "summary": "根据网段获取可用子网列表信息",
          "notes": "getIpmacSegmentList",
          "nickname": "getIpmacSegmentList",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "网段ID",
              "name": "locationId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "子网列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "子网列表数据"
        }
      ],
      "path": "/ipam/getIpmacSegmentList"
    },
    {
      "description": "modifyIpmacInfo",
      "operations": [
        {
          "method": "POST",
          "summary": "修改IP信息",
          "notes": "modifyIpmacInfo",
          "nickname": "modifyIpmacInfo",
          "produces": [
            "*/*"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "IP",
              "name": "ip",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "MAC地址",
              "name": "mac",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "用户名",
              "name": "user",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "上联设备IP",
              "name": "devIp",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "上联接口索引",
              "name": "ifIdx",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "部门",
              "name": "department",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "_openCLIENT 默认值是RIIL",
              "name": "_openCLIENT",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "结果"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "结果"
        }
      ],
      "path": "/ipam/modifyIpmacInfo"
    }
  ],
  "basePath": "/adapter",
  "consumes": [
    "application/json"
  ],
  "models": {
    "通过网段获取子网列表的查询对象": {
      "description": "",
      "id": "通过网段获取子网列表的查询对象",
      "properties": {
        "locationId": {
          "description": "网段ID",
          "required": true,
          "type": "string"
        }
      }
    },
    "子网列表数据": {
      "description": "",
      "id": "子网列表数据",
      "properties": {
        "segmentList": {
          "description": "ipmacSegmentPojo 对象集合",
          "items": {
            "type": "IpmacSegmentPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "获取登录信息": {
      "description": "",
      "id": "获取登录信息",
      "properties": {
        "_openCLIENT": {
          "description": "_openCLIENT 默认值是RIIL",
          "required": true,
          "type": "string"
        }
      }
    },
    "IpmacSegmentPojo": {
      "description": "",
      "id": "IpmacSegmentPojo",
      "properties": {
        "name": {
          "description": "子网名称",
          "required": false,
          "type": "string"
        },
        "id": {
          "description": "子网ID",
          "required": false,
          "type": "string"
        },
        "ipPlanrate": {
          "description": "网段规划率",
          "required": false,
          "type": "string"
        },
        "ipSubnet": {
          "description": "子网地址",
          "required": false,
          "type": "string"
        },
        "vlanId": {
          "description": "VLAN ID",
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "vlanName": {
          "description": "VLAN 名称",
          "required": false,
          "type": "string"
        },
        "locationId": {
          "description": "网段ID",
          "required": false,
          "type": "string"
        }
      }
    },
    "IpmacSegmentInfoPojo": {
      "description": "",
      "id": "IpmacSegmentInfoPojo",
      "properties": {
        "name": {
          "description": "子网名称",
          "required": false,
          "type": "string"
        },
        "id": {
          "description": "子网ID",
          "required": false,
          "type": "string"
        },
        "ipSubnet": {
          "description": "子网地址",
          "required": false,
          "type": "string"
        },
        "vlanId": {
          "description": "VLAN ID",
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "vlanName": {
          "description": "VLAN 名称",
          "required": false,
          "type": "string"
        },
        "locationId": {
          "description": "网段ID",
          "required": false,
          "type": "string"
        },
        "locationFullPath": {
          "description": "位置全名称",
          "required": false,
          "type": "string"
        },
        "locationName": {
          "description": "位置名称",
          "required": false,
          "type": "string"
        }
      }
    },
    "子网信息列表数据": {
      "description": "",
      "id": "子网信息列表数据",
      "properties": {
        "segmentList": {
          "description": "IpmacSegmentInfoPojo 对象集合",
          "items": {
            "type": "IpmacSegmentInfoPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "通过IP获取实时表记录": {
      "description": "",
      "id": "通过IP获取实时表记录",
      "properties": {
        "ip": {
          "description": "IP",
          "required": true,
          "type": "string"
        },
        "devIp": {
          "description": "上联设备IP",
          "required": false,
          "type": "string"
        },
        "tableFlag": {
          "description": "查表标记，默认或者传入benchmark字符串时查基准表。其他情况查实时表",
          "required": false,
          "type": "string"
        }
      }
    },
    "主资源及其包含的子资源数据": {
      "description": "",
      "id": "主资源及其包含的子资源数据",
      "properties": {
        "ipmacList": {
          "description": "ipmac集合",
          "items": {
            "type": "IpmacPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "IpmacPojo": {
      "description": "",
      "id": "IpmacPojo",
      "properties": {
        "id": {
          "description": "资源ID",
          "required": false,
          "type": "string"
        },
        "result": {
          "description": "查询无数据时的结果",
          "required": false,
          "type": "string"
        },
        "time": {
          "required": false,
          "format": "date-time",
          "type": "string"
        },
        "user": {
          "required": false,
          "type": "string"
        },
        "status": {
          "required": false,
          "type": "string"
        },
        "vlanId": {
          "required": false,
          "type": "string"
        },
        "vlanName": {
          "required": false,
          "type": "string"
        },
        "mac": {
          "description": "资源ID",
          "required": false,
          "type": "string"
        },
        "ipSetStr": {
          "description": "资源IP",
          "required": false,
          "type": "string"
        },
        "devIp": {
          "required": false,
          "type": "string"
        },
        "ifName": {
          "required": false,
          "type": "string"
        },
        "devId": {
          "required": false,
          "type": "string"
        },
        "devName": {
          "required": false,
          "type": "string"
        },
        "ifIdx": {
          "required": false,
          "type": "string"
        },
        "department": {
          "required": false,
          "type": "string"
        },
        "room": {
          "required": false,
          "type": "string"
        },
        "point": {
          "required": false,
          "type": "string"
        },
        "use": {
          "required": false,
          "type": "string"
        },
        "remark": {
          "required": false,
          "type": "string"
        },
        "devType": {
          "required": false,
          "type": "string"
        }
      }
    },
    "根据IP删除基准表记录": {
      "description": "",
      "id": "根据IP删除基准表记录",
      "properties": {
        "ip": {
          "description": "IP",
          "required": true,
          "type": "string"
        }
      }
    },
    "结果": {
      "description": "",
      "id": "结果",
      "properties": {
        "success": {
          "description": "成功",
          "required": false,
          "type": "string"
        }
      }
    },
    "申请AP结果": {
      "description": "",
      "id": "申请AP结果",
      "properties": {
        "success": {
          "description": "成功",
          "required": false,
          "type": "string"
        },
        "ip": {
          "description": "申请成功的IP",
          "required": false,
          "type": "string"
        }
      }
    },
    "申请IP": {
      "description": "",
      "id": "申请IP",
      "properties": {
        "segmentId": {
          "description": "子网信息ID",
          "required": true,
          "type": "string"
        },
        "mac": {
          "description": "MAC地址",
          "required": false,
          "type": "string"
        },
        "user": {
          "description": "用户名",
          "required": false,
          "type": "string"
        },
        "devIp": {
          "description": "上联设备IP",
          "required": false,
          "type": "string"
        },
        "ifIdx": {
          "description": "上联接口索引",
          "required": false,
          "type": "string"
        },
        "department": {
          "description": "部门",
          "required": false,
          "type": "string"
        }
      }
    },
    "修改IP": {
      "description": "",
      "id": "修改IP",
      "properties": {
        "ip": {
          "description": "IP",
          "required": true,
          "type": "string"
        },
        "mac": {
          "description": "MAC地址",
          "required": false,
          "type": "string"
        },
        "user": {
          "description": "用户名",
          "required": false,
          "type": "string"
        },
        "devIp": {
          "description": "上联设备IP",
          "required": false,
          "type": "string"
        },
        "ifIdx": {
          "description": "上联接口索引",
          "required": false,
          "type": "string"
        },
        "department": {
          "description": "部门",
          "required": false,
          "type": "string"
        }
      }
    },
    "网段列表数据": {
      "description": "",
      "id": "网段列表数据",
      "properties": {
        "locationList": {
          "description": "ipmacLocationPojo 对象集合",
          "items": {
            "type": "IpmacLocationPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "IpmacLocationPojo": {
      "description": "",
      "id": "IpmacLocationPojo",
      "properties": {
        "name": {
          "description": "网段名称",
          "required": false,
          "type": "string"
        },
        "id": {
          "description": "网段ID",
          "required": false,
          "type": "string"
        },
        "parentId": {
          "description": "网段父ID",
          "required": false,
          "type": "string"
        },
        "fullPathName": {
          "description": "网段全路径名称",
          "required": false,
          "type": "string"
        }
      }
    }
  },
  "produces": [
    "*/*"
  ],
  "resourcePath": "/ipam",
  "swaggerVersion": "1.2"
}