全部产品

数据协议介绍

更新时间:2017-08-08 11:26:29   分享:   

HiTSDB 兼容 OpenTSDB 协议。

请求方式是通过向指定的资源路径发送标准的 HTTP 请求,包含 GET、POST方法。

所有请求以及响应实体的类型均为:application/JSON

所有请求以及响应实体的编码均为:UTF-8

具体兼容协议以及其开发方式参见本章后续内容。

公共响应说明

返回码描述

返回码 描述
200 请求成功
204 请求成功,无内容返回,主要用于写数据
400 请求失败,请求参数或者内容错误或者缺失等,返回内容里面包含具体信息
404 请求路径未找到
405 请求方法不允许
406 请求资源不匹配
408 请求超时
412 返回结果超过服务器缓存
500 服务器内部错误
501 功能未实现
503 服务器资源不足

返回信息描述

错误返回描述

如果错误发生,API 将为各个错误码返回一个对应格式化的 JSON 对象,说明如下:

属性名 类型 是否必选 描述 举例
code Integer Yes HTTP 返回状态码 400
message String Yes 错误简述 Missing required parameter
details String Optional 错误详细描述 Missing value: type

所有的错误将返回一个 HTTP 的状态码和一个包含错误详情的响应内容。

错误返回举例
  1. {
  2. "error": {
  3. "code": 400,
  4. "message": "Missing parameter <code>type</code>"
  5. }
  6. }

成功返回描述

参考本章后续文档中相关功能的响应说明。

本文导读目录
本文导读目录
以上内容是否对您有帮助?