zyc_data_rsync/doc_json/res_client.json

{
  "apiVersion": "1.0",
  "apis": [
    {
      "description": "getInstances",
      "operations": [
        {
          "method": "GET",
          "summary": "根据资源树节点ID和资源类型ID获取主资源列表",
          "notes": "获取主资源列表",
          "nickname": "getInstances",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "资源树节点ID,可通过/res/client/getResTypes4Json接口获得",
              "name": "treeNodeId",
              "paramType": "path",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "资源类型ID,可通过/res/client/getResTypes4Json接口获得",
              "name": "resTypeId",
              "paramType": "path",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "主资源列表."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "主资源列表."
        }
      ],
      "path": "/res/client/getInstances/{treeNodeId}/{resTypeId}"
    },
    {
      "description": "getMetrics",
      "operations": [
        {
          "method": "GET",
          "summary": "根据资源类型ID获取该资源类型下的所有性能指标定义",
          "notes": "根据资源类型ID获取该资源类型下的所有性能指标定义",
          "nickname": "getMetrics",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "资源类型ID，可通过/res/client/getResTypes4Json接口获得",
              "name": "resTypeId",
              "paramType": "path",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "指标列表."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "指标列表."
        }
      ],
      "path": "/res/client/getMetrics/{resTypeId}"
    },
    {
      "description": "getResProtocols",
      "operations": [
        {
          "method": "POST",
          "summary": "获取资源的链接信息",
          "notes": "根据资源ID列表，获取链接信息",
          "nickname": "getResProtocols",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "资源ID，多个ID用逗号隔开",
              "name": "resIds",
              "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": "/res/client/getResProtocols"
    },
    {
      "description": "getResTypes4Json",
      "operations": [
        {
          "method": "POST",
          "summary": "获取资源类型列表",
          "notes": "获取资源类型列表",
          "nickname": "getResTypes4Json",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "资源模板列表."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "资源模板列表."
        }
      ],
      "path": "/res/client/getResTypes4Json"
    },
    {
      "description": "getSubResInstances4Json",
      "operations": [
        {
          "method": "GET",
          "summary": "根据资源数ID和子资源类型ID获取子资源列表",
          "notes": "根据资源数ID和子资源类型ID获取子资源列表",
          "nickname": "getSubResInstances4Json",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "主资源树节点Id，可通过/res/client/getSubResTypes/{resTypeId}接口获得",
              "name": "treeNodeId",
              "paramType": "path",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "子资源类型ID，可通过/res/client/getSubResTypes/{resTypeId}接口获得",
              "name": "subResTypeId",
              "paramType": "path",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "子资源列表."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "子资源列表."
        }
      ],
      "path": "/res/client/getSubResInstances4Json/{treeNodeId}/{subResTypeId}"
    },
    {
      "description": "getSubResTypes",
      "operations": [
        {
          "method": "GET",
          "summary": "根据资源类型ID获取子资源类型定义",
          "notes": "根据资源类型的ID获取子资源类型定义",
          "nickname": "getSubResTypes",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "资源类型ID，可通过/res/client/getResTypes4Json接口获得",
              "name": "resTypeId",
              "paramType": "path",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "子模板列表."
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "子模板列表."
        }
      ],
      "path": "/res/client/getSubResTypes/{resTypeId}"
    },
    {
      "description": "resTypeNumber",
      "operations": [
        {
          "method": "GET",
          "summary": "通过主资源类型ID获取资源数量",
          "notes": "通过主资源类型ID获取资源数量",
          "nickname": "resTypeNumber",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "资源类型ID,可通过/res/client/getResTypes4Json接口获得,填写“ALL”获取所以资源数量总和",
              "name": "resTypeIds",
              "paramType": "query",
              "items": {
                "type": "string"
              },
              "type": "array",
              "uniqueItems": false,
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": null,
              "responseModel": "资源数量"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "资源数量"
        }
      ],
      "path": "/res/client/resTypeNumber"
    }
  ],
  "basePath": "/adapter",
  "consumes": [
    "application/json"
  ],
  "models": {
    "主资源列表.": {
      "description": "",
      "id": "主资源列表.",
      "properties": {
        "resInstances": {
          "description": "ResTypeVO对象集合",
          "items": {
            "type": "ResTypeVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "ResTypeVO": {
      "description": "",
      "id": "ResTypeVO",
      "properties": {
        "name": {
          "description": "资源类型名称",
          "required": false,
          "type": "string"
        },
        "id": {
          "description": "资源类型ID",
          "required": false,
          "type": "string"
        },
        "resInstList": {
          "description": "主资源List(其中对象为ResInstanceVO)",
          "items": {
            "type": "ResInstanceVO"
          },
          "required": false,
          "type": "array"
        },
        "treeNodeId": {
          "description": "Tree Node Id 可通过/res/client/getResTypes4Json接口获得",
          "required": false,
          "type": "string"
        },
        "parentId": {
          "description": "主资源类型ID",
          "required": false,
          "type": "string"
        },
        "subResTypeList": {
          "description": "子资源类型List（其中对象为ResTypeVO）",
          "items": {
            "type": "ResTypeVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "ResInstanceVO": {
      "description": "",
      "id": "ResInstanceVO",
      "properties": {
        "name": {
          "description": "资源名称",
          "required": false,
          "type": "string"
        },
        "main": {
          "description": "是否主资源.",
          "required": false,
          "type": "boolean"
        },
        "ip": {
          "description": "资源IP.",
          "required": false,
          "type": "string"
        },
        "instId": {
          "description": "主资源ID",
          "required": false,
          "type": "string"
        },
        "subInstId": {
          "description": "子资源ID",
          "required": false,
          "type": "string"
        },
        "resTypeId": {
          "description": "资源类型ID.",
          "required": false,
          "type": "string"
        },
        "subResInstVOList": {
          "description": "子资源List.",
          "items": {
            "type": "ResInstanceVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "指标列表.": {
      "description": "",
      "id": "指标列表.",
      "properties": {
        "metricList": {
          "description": "MetricVO对象集合",
          "items": {
            "type": "MetricVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "MetricVO": {
      "description": "",
      "id": "MetricVO",
      "properties": {
        "metricId": {
          "description": "指标ID",
          "required": false,
          "type": "string"
        },
        "metricName": {
          "description": "指标名称",
          "required": false,
          "type": "string"
        },
        "metricUnit": {
          "description": "指标单位",
          "required": false,
          "type": "string"
        },
        "metricType": {
          "description": "指标类型",
          "required": false,
          "type": "string"
        }
      }
    },
    "资源连接信息": {
      "description": "",
      "id": "资源连接信息",
      "properties": {
        "connectInfo": {
          "description": "链接信息集合",
          "items": {
            "type": "链接信息"
          },
          "required": false,
          "type": "array"
        },
        "resId": {
          "required": false,
          "type": "string"
        }
      }
    },
    "资源连接信息结果对象": {
      "description": "",
      "id": "资源连接信息结果对象",
      "properties": {
        "resConnections": {
          "description": "资源链接信息集合",
          "items": {
            "type": "资源连接信息"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "链接信息": {
      "description": "",
      "id": "链接信息",
      "properties": {
        "propId": {
          "required": false,
          "type": "string"
        },
        "propValue": {
          "required": false,
          "type": "string"
        }
      }
    },
    "资源模板列表.": {
      "description": "",
      "id": "资源模板列表.",
      "properties": {
        "resTypes": {
          "description": "ResTypeVO对象集合",
          "items": {
            "type": "ResTypeVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "子模板列表.": {
      "description": "",
      "id": "子模板列表.",
      "properties": {
        "subResTypes": {
          "description": "ResTypeVO对象集合",
          "items": {
            "type": "ResTypeVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "子资源列表.": {
      "description": "",
      "id": "子资源列表.",
      "properties": {
        "subResInstances": {
          "description": "ResInstanceVO对象集合",
          "items": {
            "type": "ResInstanceVO"
          },
          "required": false,
          "type": "array"
        }
      }
    },
    "ResNumPojo": {
      "description": "",
      "id": "ResNumPojo",
      "properties": {
        "resTypeId": {
          "required": false,
          "type": "string"
        },
        "resTypeName": {
          "required": false,
          "type": "string"
        },
        "num": {
          "required": false,
          "format": "int32",
          "type": "integer"
        }
      }
    },
    "资源数量": {
      "description": "",
      "id": "资源数量",
      "properties": {
        "resNumPojo": {
          "description": "resNumPojo对象集合",
          "items": {
            "type": "ResNumPojo"
          },
          "required": false,
          "type": "array"
        }
      }
    }
  },
  "produces": [
    "application/json"
  ],
  "resourcePath": "/res/client",
  "swaggerVersion": "1.2"
}