调用方式

请求结构

1.通信协议

支持HTTP或HTTPS协议请求通信。为了获得更高的安全性,推荐使用HTTPS协议发送请求。

2.请求规则

https:// + 请求域名 +请求路径 + ? +最终请求参数串

3.请求方法

方法 说明
GET 请求服务器返回指定资源。
PUT 请求服务器更新指定资源。
POST 请求服务器新增资源或执行特殊操作。
DELETE 请求服务器删除指定资源,如删除对象等。
HEAD 请求服务器资源头部。
PATCH 请求服务器更新资源的部分内容。
当资源不存在的时候,PATCH可能会去创建一个新的资源。

4.字符编码

API的请求及返回结果均使用UTF-8字符集进行编码。

签名机制

a).Token认证

Token认证 点击按钮,跳转至【IAM接口文档】-【Token认证】页面

b).AK/SK认证

AK/SK认证 点击按钮,跳转至【IAM接口文档】-【AK/SK认证】页面

公共参数

通用请求返回值

正常返回
返回值 说明
200 请求成功。
202 任务提交成功,当前系统繁忙,下发的任务会延迟处理。
204 任务提交成功。
异常返回
返回值 说明
300 multiple choices 被请求的资源存在多个可供选择的响应。
400 Bad Request 服务器未能处理请求。
401 Unauthorized 被请求的页面需要用户名和密码。
403 Forbidden 对被请求页面的访问被禁止。
404 Not Found 服务器无法找到被请求的页面。
405 Method Not Allowed 请求中指定的方法不被允许。
406 Not Acceptable 服务器生成的响应无法被客户端所接受。
407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。
408 Request Timeout 请求超出了服务器的等待时间。
409 Conflict 由于冲突,请求无法被完成。
500 Internal Server Error 请求未完成。服务异常。
501 Not Implemented 请求未完成。服务器不支持所请求的功能。
502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。
503 Service Unavailable 请求未完成。系统暂时异常。
504 Gateway Timeout 网关超时。

提交任务类请求结果

响应
  • 错误代码命名规则 错误代码以纯数字方式命名,共9位,xxx.yyyzzz,前三位xxx是应用码,中三位yyy是模块/资源码,后三位zzz是具体的错误码。
代码 代码类型 代码说明
xxx 应用码 时序数据库服务代码301
yyy 模块资源码 001 实例管理
002 用户管理
003 数据查询
004 数据清理
005 数据导入导出
006 任务管理
007 概况管理
008 模板管理
009 数据自动清理
zzz 错误码 通用请求返回值
  • 正常响应要素说明
名称 参数类型 说明
result JsonObject 请求响应实体数据(存在为空的情况)
  • 异常响应要素说明
名称 参数类型 说明
requestId String 用户发起请求的uuid
code String xxx.yyyzzz
message String 请求返回消息
  • 响应样例

正常响应:

{ "id": "4e6fd0c7-8639-4c78-b694-3de40774ad4f", "createdTime": 1559179635011, "updatedTime": 1559179635011, "name": "4234235345", "deployMode": "SINGLE", "replicaNum": 1, "ownerId": "d603f7fb-c745-4a94-b8fb-09ef483130fc", "domain": "10.110.25.114.xip.io", "status": "CREATE_FAILED", "maxDpNum": 500000, "wrtDpPers": 3000, "storageSize": 40, "environment": "9439c591-b8c9-486d-8793-8d8f8eb9f292", "namespace": "tsdb", "isDeleted": null, "clusterUrl": "http://10.110.25.114:32632", "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc", "region": "cn-north-3", "billMode": "monthly", "suitCode": "std_3000", "expiredTime": null }

异常响应:

{"requestId":"0fc60cdb-2ad6-4ccb-8fc8-66fd2e9580eb","code":"301.001400","message":"查询时序数据库 TSDB-test 结果为空!"}