简体中文
简体中文
English
联系我们
注册
登录

面板 API

更新时间:2021-07-19 04:01:02下载pdf

本文介绍了面板 API 的接口。

接口

tuya.open.midas.common.atop

版本

1.0

参数

参数 数据类型 是否必填 说明
apiCode String 必填 在数据分析平台创建 API 时生成的 APICode
params JSON 必填 在数据分析平台创建 API 时自定义的参数 JSON 格式。详见 API 管理

返回值

参数 类型 说明
result JSON 返回值的对象

result 说明

参数 类型 说明
success Boolean 请求是否成功
errorCode String 接口失败时的错误码,成功时不返回该数据
errorMsg String 接口失败时的错误信息,成功时无此字段
result JSON 返回的具体数据

result 说明

参数 类型 说明
data List 响应的具体数据,里面的格式就是您在数据分析平台创建 API 时定义的返回值格式
pageNo Integer 当前第几页
totalCount Integer 一共有多少条数据

请求示例

{
  "apiCode":"your API code",
  "params":{"page":1,"size":10}

}

响应示例

{
  "result": {
    "data": [],
    "pageNo": 1,
    "totalCount": 0
  },
  "t": 1626490993755,
  "success": true,
  "status": "ok"
}

常见错误码

错误码 说明
JSON_FORMAT_ERROR params 参数的 JSON 格式异常
API_NOT_EXISTS API 不存在
PARAMS_ERROR 参数格式异常
PARAMS_IS_REQUIRE 存在必填参数未填
PARAMS_IS_NOT_IN_REQUEST 存在不在列表里的参数
PARAMS_TYPE_ERROR 参数类型错误