zyc_data_rsync/doc_json/res.json

{
  "apiVersion": "1.0",
  "apis": [
    {
      "description": "getResInstanceById",
      "operations": [
        {
          "method": "POST",
          "summary": "通过主资源ID获取单个主资源以及包含的所有子资源.",
          "notes": "通过主资源ID获取单个主资源以及包含的所有子资源.",
          "nickname": "getResInstanceById",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "主资源ID（可通过/res/getResInstanceList接口获得）",
              "name": "resId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "ResInstPojo"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "ResInstPojo"
        }
      ],
      "path": "/res/getResInstanceById"
    },
    {
      "description": "getResInstanceList",
      "operations": [
        {
          "method": "POST",
          "summary": "获取所有资源及子资源信息",
          "notes": "获取所有资源及子资源信息",
          "nickname": "getResInstanceList",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "资源类型ID（可通过/res/client/getResTypes4Json接口获得）",
              "name": "resType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "资源列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "资源列表数据"
        }
      ],
      "path": "/res/getResInstanceList"
    },
    {
      "description": "getResMetricList",
      "operations": [
        {
          "method": "POST",
          "summary": "获取主资源指标详细信息",
          "notes": "获取主资源指标详细信息",
          "nickname": "getResMetricList",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "主资源ID（可通过/res/getResInstanceList接口获得）",
              "name": "resId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "指标类型,默认取所有类型(可用性指标：AVAIL 配置指标：CONF 信息指标：INFO 性能指标：PERF)",
              "name": "metricType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "主资源指标详细信息."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "主资源指标详细信息."
        }
      ],
      "path": "/res/getResMetricList"
    },
    {
      "description": "getSubResMetricList",
      "operations": [
        {
          "method": "POST",
          "summary": "获取子资源指标详细信息",
          "notes": "获取子资源指标详细信息",
          "nickname": "getSubResMetricList",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "子资源ID（可通过/res/getResInstanceList接口获得）",
              "name": "subResId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "指标类型,默认取所有类型(可用性指标：AVAIL 配置指标：CONF 信息指标：INFO 性能指标：PERF)",
              "name": "metricType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "主资源指标详细信息."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "主资源指标详细信息."
        }
      ],
      "path": "/res/getSubResMetricList"
    },
    {
      "description": "getResList",
      "operations": [
        {
          "method": "GET",
          "summary": "获取主资源列表",
          "notes": "获取主资源列表",
          "nickname": "getResList",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "description": "资源树节点ID（00：代表所有资源）",
              "name": "treeNodeId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "description": "域ID,可通过/login接口获得",
              "name": "domainId",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "可用性状态，默认为全部 1:可用，-1：不可用，-2:未知，all:全部",
              "name": "state",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "页数",
              "name": "pageIndex",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "每页条数，默认值为20",
              "name": "pageSize",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "排序字段,只可按照一个字段排序，sortColumn和sortType同时不为空才生效",
              "name": "sortColumn",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            },
            {
              "allowMultiple": false,
              "description": "排序方式(ASC/DESC),sortColumn和sortType同时不为空才生效",
              "name": "sortType",
              "paramAccess": "",
              "paramType": "query",
              "type": "string",
              "required": false
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "主资源列表数据"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "主资源列表数据"
        }
      ],
      "path": "/res/list"
    }
  ],
  "basePath": "/adapter",
  "consumes": [
    "application/json"
  ],
  "models": {
    "ResVO": {
      "description": "",
      "id": "ResVO",
      "properties": {
        "state": {
          "description": "可用状态",
          "required": false,
          "type": "string"
        },
        "name": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "location": {
          "description": "物理位置",
          "required": false,
          "type": "string"
        },
        "type": {
          "description": "资源类型",
          "required": false,
          "type": "string"
        },
        "desc": {
          "description": "描述",
          "required": false,
          "type": "string"
        },
        "policyName": {
          "description": "策略名称",
          "required": false,
          "type": "string"
        },
        "usability": {
          "description": "可用率",
          "required": false,
          "type": "string"
        },
        "sysoid": {
          "description": "系统OID",
          "required": false,
          "type": "string"
        },
        "venderName": {
          "description": "厂商名称",
          "required": false,
          "type": "string"
        },
        "nameDisplay": {
          "description": "资源展示名称",
          "required": false,
          "type": "string"
        },
        "contact": {
          "description": "联系人ID",
          "required": false,
          "type": "string"
        },
        "modelNumber": {
          "description": "设备型号",
          "required": false,
          "type": "string"
        },
        "ip": {
          "description": "资源IP",
          "required": false,
          "type": "string"
        },
        "treeNodeId": {
          "description": "tree节点ID",
          "required": false,
          "type": "string"
        },
        "resTypeId": {
          "description": "资源类型ID",
          "required": false,
          "type": "string"
        },
        "resId": {
          "description": "资源ID",
          "required": false,
          "type": "string"
        },
        "series": {
          "description": "系列",
          "required": false,
          "type": "string"
        },
        "mac": {
          "description": "mac地址",
          "required": false,
          "type": "string"
        },
        "locationName": {
          "description": "物理位置",
          "required": false,
          "type": "string"
        },
        "contactName": {
          "description": "联系人名称",
          "required": false,
          "type": "string"
        },
        "memRate": {
          "description": "内存利用率",
          "required": false,
          "type": "string"
        },
        "cpuRate": {
          "description": "CPU利用率",
          "required": false,
          "type": "string"
        },
        "busy": {
          "description": "繁忙度",
          "required": false,
          "type": "string"
        },
        "sysInfo": {
          "description": "系统信息",
          "required": false,
          "type": "string"
        },
        "venderId": {
          "description": "厂商ID",
          "required": false,
          "type": "string"
        }
      }
    },
    "主资源列表数据": {
      "description": "",
      "id": "主资源列表数据",
      "properties": {
        "resList": {
          "description": "ResVO 对象集合",
          "items": {
            "type": "ResVO"
          },
          "required": false,
          "type": "array"
        },
        "totalPage": {
          "description": "总页数(分页显示时使用)",
          "required": false,
          "format": "int32",
          "type": "integer"
        },
        "pageIndex": {
          "description": "当前显示页(分页显示时使用)",
          "required": false,
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "获取资源列表的查询对象": {
      "description": "",
      "id": "获取资源列表的查询对象",
      "properties": {
        "treeNodeId": {
          "description": "资源树节点ID（00：代表所有资源）",
          "required": true,
          "type": "string"
        },
        "domainId": {
          "description": "域ID,可通过/login接口获得",
          "required": false,
          "type": "string"
        },
        "state": {
          "description": "可用性状态，默认为全部 1:可用，-1：不可用，-2:未知，all:全部",
          "required": false,
          "type": "string"
        },
        "pageIndex": {
          "description": "页数",
          "required": false,
          "type": "string"
        },
        "pageSize": {
          "description": "每页条数，默认值为20",
          "required": false,
          "type": "string"
        },
        "sortColumn": {
          "description": "排序字段,只可按照一个字段排序，sortColumn和sortType同时不为空才生效",
          "required": false,
          "type": "string"
        },
        "sortType": {
          "description": "排序方式(ASC/DESC),sortColumn和sortType同时不为空才生效",
          "required": false,
          "type": "string"
        }
      }
    },
    "资源列表数据": {
      "description": "",
      "id": "资源列表数据",
      "properties": {
        "resInstList": {
          "description": "resInstPojo 对象集合",
          "items": {
            "type": "ResInstPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "SubResPojo": {
      "description": "",
      "id": "SubResPojo",
      "properties": {
        "subName": {
          "description": "子资源名称",
          "required": false,
          "type": "string"
        },
        "resId": {
          "description": "主资源ID",
          "required": false,
          "type": "string"
        },
        "subResId": {
          "description": "子资源ID",
          "required": false,
          "type": "string"
        },
        "subResType": {
          "description": "子资源类型",
          "required": false,
          "type": "string"
        },
        "manage": {
          "description": "是否加入了监控(ture/false)",
          "required": false,
          "type": "boolean"
        }
      }
    },
    "通过资源类型获取资源列表的查询对象": {
      "description": "",
      "id": "通过资源类型获取资源列表的查询对象",
      "properties": {
        "resType": {
          "description": "资源类型ID（可通过/res/client/getResTypes4Json接口获得）",
          "required": false,
          "type": "string"
        }
      }
    },
    "ResInstPojo": {
      "description": "",
      "id": "ResInstPojo",
      "properties": {
        "resName": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "resType": {
          "description": "资源类型",
          "required": false,
          "type": "string"
        },
        "resId": {
          "description": "资源ID",
          "required": false,
          "type": "string"
        },
        "resIp": {
          "description": "资源IP",
          "required": false,
          "type": "string"
        },
        "subResList": {
          "description": "子资源对象集合",
          "items": {
            "type": "SubResPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "通过主资源ID获取单个主资源以及包含的所有子资源的查询对象": {
      "description": "",
      "id": "通过主资源ID获取单个主资源以及包含的所有子资源的查询对象",
      "properties": {
        "resId": {
          "description": "主资源ID（可通过/res/getResInstanceList接口获得）",
          "required": true,
          "type": "string"
        }
      }
    },
    "获取主资源指标详细信息的查询对象": {
      "description": "",
      "id": "获取主资源指标详细信息的查询对象",
      "properties": {
        "resId": {
          "description": "主资源ID（可通过/res/getResInstanceList接口获得）",
          "required": true,
          "type": "string"
        },
        "metricType": {
          "description": "指标类型,默认取所有类型(可用性指标：AVAIL 配置指标：CONF 信息指标：INFO 性能指标：PERF)",
          "required": false,
          "type": "string"
        }
      }
    },
    "ResMetricPojo": {
      "description": "",
      "id": "ResMetricPojo",
      "properties": {
        "metricValue": {
          "description": "值",
          "required": false,
          "type": "string"
        },
        "metricId": {
          "description": "指标Id",
          "required": false,
          "type": "string"
        },
        "metricName": {
          "description": "指标名称",
          "required": false,
          "type": "string"
        },
        "metricUnit": {
          "description": "指标单位",
          "required": false,
          "type": "string"
        },
        "resId": {
          "description": "主资源ID",
          "required": false,
          "type": "string"
        },
        "metricStatus": {
          "description": "指标状态",
          "required": false,
          "type": "string"
        },
        "metricStatus4Display": {
          "description": "指标状态的显示",
          "required": false,
          "type": "string"
        },
        "subResId": {
          "description": "子资源ID",
          "required": false,
          "type": "string"
        },
        "metricType": {
          "description": "指标类型",
          "required": false,
          "type": "string"
        },
        "gatherTime": {
          "required": false,
          "format": "date-time",
          "type": "string"
        }
      }
    },
    "主资源指标详细信息.": {
      "description": "",
      "id": "主资源指标详细信息.",
      "properties": {
        "resMetricList": {
          "description": "ResMetricPojo对象集合",
          "items": {
            "type": "ResMetricPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "GetSubResMetricListPojo": {
      "description": "",
      "id": "GetSubResMetricListPojo",
      "properties": {
        "subResId": {
          "description": "子资源ID（可通过/res/getResInstanceList接口获得）",
          "required": true,
          "type": "string"
        },
        "metricType": {
          "description": "指标类型,默认取所有类型(可用性指标：AVAIL 配置指标：CONF 信息指标：INFO 性能指标：PERF)",
          "required": false,
          "type": "string"
        }
      }
    }
  },
  "produces": [
    "application/json"
  ],
  "resourcePath": "/res",
  "swaggerVersion": "1.2"
}