zyc_data_rsync/doc_json/login.json

{
  "apiVersion": "1.0",
  "apis": [
    {
      "description": "login",
      "operations": [
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            },
            {
              "code": 500,
              "message": "请求出错,返回JSON: {message:\"错误信息\"}"
            },
            {
              "code": 502,
              "message": "缺少ssoToken或ssoToken已过期"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        },
        {
          "method": "GET",
          "summary": "登录BMC",
          "notes": "登录成功，在消息头的Set-Cookie中可以获取SSOToken,请求其他接口时，需在Cookie中携带SSOToken，才可通过系统认证，获取数据。SSOToken的有效时长为30分钟。",
          "nickname": "login",
          "produces": [
            "application/json"
          ],
          "consumes": [
            "application/json"
          ],
          "parameters": [
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "用户名",
              "name": "username",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "",
              "description": "密码",
              "name": "password",
              "paramType": "query",
              "type": "string",
              "required": true
            },
            {
              "allowMultiple": false,
              "defaultValue": "RIIL",
              "description": "调用接口的客户端，默认为RIIL",
              "name": "_openCLIENT",
              "paramType": "query",
              "type": "string",
              "required": true
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "登录成功",
              "responseModel": "sso登录成功返回消息"
            }
          ],
          "deprecated": "false",
          "type": "sso登录成功返回消息"
        }
      ],
      "path": "/login"
    }
  ],
  "basePath": "/adapter",
  "consumes": [
    "application/json"
  ],
  "models": {
    "Void": {
      "description": "",
      "id": "Void",
      "properties": {}
    },
    "domain": {
      "description": "",
      "id": "domain",
      "properties": {
        "domainId": {
          "description": "domain",
          "required": false,
          "type": "string"
        },
        "domainName": {
          "description": "domainName",
          "required": false,
          "type": "string"
        }
      }
    },
    "sso登录成功返回消息": {
      "description": "",
      "id": "sso登录成功返回消息",
      "properties": {
        "success": {
          "description": "登录结果标志",
          "required": false,
          "type": "boolean"
        },
        "domainList": {
          "description": "用户信息集合",
          "items": {
            "type": "domain"
          },
          "required": false,
          "type": "array"
        },
        "errMsg": {
          "description": "登录失败时的错误信息",
          "required": false,
          "type": "string"
        }
      }
    }
  },
  "produces": [
    "application/json"
  ],
  "resourcePath": "/login",
  "swaggerVersion": "1.2"
}