时序数据库相关接口

删除时序数据库记录

用于实例创建失败时，删除时序数据库在mysql中的记录

URI

DELETE /tsdb/v1/tsdbs/{tsdbId}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 删除对象id

返回参数

不涉及

示例

请求示例 不涉及

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前时序数据库不存在 404 当前时序数据库不存在
301.001400 删除时序数据库失败 400 删除时序数据库失败

更新时序数据库名称

时序数据库实例支持名称变更，用户可编辑实例名称进行修改。

URI

PUT /tsdb/v1/tsdbs/{tsdbId}/action/rename

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 修改实例对象id
tsdbName params String 是 修改后实例对象名称

返回参数

不涉及

示例

请求示例

请求方法: PUT
URI: /tsdb/v1/tsdbs/{tsdbId}?tsdbName=newname

响应示例

规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前时序数据库不存在 404 当前时序数据库不存在
301.001400 更新时序数据库名称失败 400 更新时序数据库名称失败

查看时序数据库列表

查看当前账户下可用时序数据库列表

URI

GET /tsdb/v1/tsdbs

请求参数

不涉及

返回参数

名称 位置 类型 是否必须 描述
tsdbDtoList body List(TsdbDto) 是 查询实例信息

示例

请求示例 不涉及

响应示例

[
    {
        "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": false,
        "clusterUrl": "http://10.110.25.114:32632",
        "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
        "region": "cn-north-3",
        "billMode": "monthly",
        "suitCode": "std_3000",
        "expiredTime": null
    },
    {
        "id": "99b861d7-a789-4f8e-88e7-9d7b3db876ea",
        "createdTime": 1559178531657,
        "updatedTime": 1559178531657,
        "name": "TSDB-1111",
        "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": false,
        "clusterUrl": "http://10.110.25.114:32632",
        "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
        "region": "cn-north-3",
        "billMode": "monthly",
        "suitCode": "std_3000",
        "expiredTime": null
    }
]

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前登录用户owner为空 404 当前登录用户owner为空

查看时序数据库详细信息

根据时序数据库ID查看时序数据库详细信息

URI

GET /tsdb/v1/tsdbs/{tsdbId}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id

返回参数

名称 位置 类型 是否必须 描述
tsdbDto body (TsdbDto) 是 查询实例信息

示例

请求示例 不涉及

响应示例

{
    "id": "1f18a3d3-be42-45f6-b9e5-aa3864ed47dd",
    "name": "TSDB-20190514135947",
    "domain": "tsdb.tsdb-fuwofrbk.10.110.25.114.xip.io",
    "port": 80,
    "status": "RUNNING",
    "spec": null,
    "environment": "9439c591-b8c9-486d-8793-8d8f8eb9f292",
    "namespace": "tsdb",
    "isDeleted": null,
    "createdTime": 1557813625055,
    "updatedTime": 1557813782373,
    "deployMode": "SINGLE",
    "replicaNum": 1,
    "ownerId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
    "serviceUrl": "http://10.110.25.114:32096",
    "webUrl": "https://tsdb.tsdb-fuwofrbk.10.110.25.114.xip.io",
    "maxDpNum": 500000,
    "wrtDpPers": 3000,
    "storageSize": 40,
    "storageClass": "ceph",
    "clusterUrl": "http://10.110.25.114:32096",
    "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
    "region": "cn-north-3",
    "billMode": "hourlySettlement",
    "suitCode": "std_3000"
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 查询时序数据库不存在 404 查询时序数据库不存在

分页查看时序数据库列表

分页查看当前账户下可用时序数据库列表

URI

GET /tsdb/v1/tsdbs/{pageNo}/{pageSize}

请求参数

名称 位置 类型 是否必须 描述
pageNo path String 是 分页数
pageSize path String 是 分页包含总数

返回参数

名称 位置 类型 是否必须 描述
tsdbDtoPage body PageDto(TsdbDto） 是 查询实例信息

示例

请求示例 不涉及

响应示例

{
    "totalPage": 1,
    "pageSize": 2,
    "start": 0,
    "num": 2,
    "data": [
        {
            "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": null,
            "namespace": "tsdb",
            "isDeleted": false,
            "clusterUrl": "http://10.110.25.114:32632",
            "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
            "region": "cn-north-3",
            "billMode": "monthly",
            "suitCode": "std_3000",
            "expiredTime": null
        },
        {
            "id": "99b861d7-a789-4f8e-88e7-9d7b3db876ea",
            "createdTime": 1559178531657,
            "updatedTime": 1559178531657,
            "name": "TSDB-1111",
            "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": null,
            "namespace": "tsdb",
            "isDeleted": false,
            "clusterUrl": "http://10.110.25.114:32632",
            "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
            "region": "cn-north-3",
            "billMode": "monthly",
            "suitCode": "std_3000",
            "expiredTime": null
        }
    ],
    "total": 2,
    "page": 1
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 查询时序数据库不存在 404 查询时序数据库不存在

查看时序数据库数量

查看可用时序数据库数量

URI

GET /tsdb/v1/instance-num

请求参数

不涉及

返回参数

名称 位置 类型 是否必须 描述
code body Integer 是 http请求返回值
data body Integer 是 实例数量

示例

请求示例 不涉及

响应示例

{
  "data": 9
}

返回值

请参考通用请求返回值

查看时序数据库服务信息

查询时序数据库服务中实例总数量、区域分布、实例创建和运行等情况。

URI

GET /tsdb/v1/statistics

请求参数

不涉及

返回参数

名称 位置 类型 是否必须 描述
totalNum body Integer 是 当前区域实例数量
runNum body Integer 是 当前区域运行实例数量
recentNum body Integer 是 当前区域近期创建实例数量
willExpired body Integer 是 当前区域近期将要失效的实例数量
expired body Integer 是 当前区域近期失效的实例数量

示例

请求示例 不涉及

响应示例

{
    "totalNum": 2,
    "runNum": 0,
    "recentNum": 0,
    "willExpired": 0,
    "expired": 0
}

返回值

请参考通用请求返回值

用户管理接口

增加用户

时序数据库服务用户可以为当前实例添加不同角色的时序数据库用户

URI

POST /tsdb/v1/tsdbs/{tsdbId}/users

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库服务
userPto body UserPto 是 用户详细信息JSON对象

返回参数

不涉及

请求示例

请求示例

{"name": "test", "password": "123456aB", "role": "RW"}

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.002400 用户密码为空 400 用户密码为空
301.002404 当前时序数据库不存在 404 当前时序数据库不存在
301.002400 时序数据库运行状态异常 400 时序数据库运行状态异常
301.002400 当前时序数据库已经存在用户 400 当前时序数据库已经存在用户
301.002400 添加用户至时序数据库失败 400 添加用户至时序数据库失败

删除用户

删除指定用户

URI

DELETE /tsdb/v1/tsdbs/{tsdbId}/users/{userName}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
userName path String 是 用户名

返回参数

不涉及

示例

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.002404 时序数据库用户不存在 404 时序数据库用户不存在
301.002404 当前时序数据库不存在 404 当前时序数据库不存在
301.002400 时序数据库运行状态异常 400 时序数据库运行状态异常
301.002400 删除时序数据库用户失败 400 删除时序数据库用户失败

查看用户列表

查看当前时序数据库实例所有用户

URI

GET /tsdb/v1/tsdbs/{tsdbId}/users/{pageNo}/{pageSize}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
pageNo path Integer 是 分页数
pageSize path Integer 是 分页包含总数

返回参数

名称 位置 类型 是否必须 描述
userDtoList body List(UserDto） 是 用户分页列表

示例

请求示例 不涉及

响应示例

{
    "totalCount": 2,
    "pageNo": 1,
    "start": 0,
    "num": 2,
    "data": [
        {
            "id": "test-user-id-1",
            "name": "test33",
            "role": "RW",
            "createdTime": 1557813536184,
            "updatedTime": 1557813536184
        },
        {
            "id": "test-user-id-2",
            "name": "test22",
            "role": "RW",
            "createdTime": 1557813459656,
            "updatedTime": 1557815188244
        }
    ],
    "totalPage": 1,
    "pageSize": 50

}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.002404 当前时序数据库不存在 404 当前时序数据库不存在

修改用户密码或角色

对tsdb实例用户进行密码修改，角色变更

URI

PATCH /tsdb/v1/tsdbs/{tsdbId}/users

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
paramType params String 是 所要修改参数
userPto body UserPto 是 用户详细信息JSON对象

返回参数

不涉及

示例

请求示例

请求方法: PATCH
URI: /tsdb/v1/tsdbs/{tsdbId}/users?paramType=role
userPto: {role: "admin", name: "test", password: "123456aB"}

响应示例

规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.002404 时序数据库用户不存在 404 时序数据库用户不存在
301.002404 当前时序数据库不存在 404 当前时序数据库不存在
301.002400 时序数据库运行状态异常 400 时序数据库运行状态异常
301.002400 重置时序数据库用户密码失败 400 重置时序数据库用户密码失败
301.002400 更新时序数据库用户失败 400 更新时序数据库用户失败

数据操作接口

导入示例数据

用户可以进行示例数据导入，进行时序数据库各项功能的使用。

URI

POST /tsdb/v1/tsdbs/{tsdbId}/action/import-sample-data

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
step params String 是 写入数据条数

返回参数

不涉及

示例

请求示例

请求方法: POST
URI: /tsdb/v1/tsdbs/{tsdbId}/action/import-sample-data?step=400

响应示例

规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.005404 当前时序数据库不存在 404 当前时序数据库不存在
301.005400 导入示范数据到数据库失败 400 导入示范数据到数据库失败

下载示例数据

用户可下载示例数据文件，查询示例数据。

URI

GET /tsdb/v1/tsdbs/action/download-sample-data

请求参数

不涉及

返回参数

下载文件到本地目录

示例

请求示例 不涉及

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

数据清理

用户可以手动清理数据库中废弃数据。

URI

POST /tsdb/v1/tsdbs/{tsdbId}/action/clean

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库ID标识
cleanPto body CleanPto 是 条件

返回参数

不涉及

示例

请求示例

{
  "id": "bb177ef6-191a-4516-bcfd-6f04632edb13",
  "metrics": [
    {
      "name": "temperature",
      "tagFilters": null
    }
  ],
  "name": "test",
  "timeRange": {"type": 1, "start": "2015-05-01T06:52:49.831Z", "end": "2015-05-31T06:52:49.831Z"}
}

响应示例

规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.004400 清理时序数据库任务失败 400 清理时序数据库任务失败
301.004400 输入时间格式错误 400 输入时间格式错误
301.004404 清理时序数据库不存在 404 清理时序数据库不存在

增加自动清理任务

增加时序数据库实例数据定时清理任务

URI

POST /tsdb/v1/tsdbs/{tsdbId}/action/auto-clean

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
retain params String 是 数据保留天数

返回参数

不涉及

示例

请求示例

请求方法: POST
URI: /tsdb/v1/tsdbs/{tsdbId}/action/auto-clean?retain=3

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.009400 时序数据库非正常运行 400 时序数据库非正常运行
301.009400 自动清理数据任务已存在 400 自动清理数据任务已存在
301.009400 自动清理数据作业添加失败 400 自动清理数据作业添加失败

查询自动清理任务详情

查询实例对应自动清理任务信息

URI

GET /tsdb/v1/tsdbs/{tsdbId}/action/auto-clean

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id

返回参数

名称 位置 类型 是否必须 描述
ClnJobDto body ClnJobDto(ClnJobDto) 是 查询自动清理任务信息

示例

请求示例 不涉及

响应示例

{
    "clnJobName": "TSDB-20190614162345ACln",
    "retain": 3,
    "timeUnit": "DAY",
    "tsdbName": "TSDB-20190614162345",
    "cronExpression": "0 0 0 * * ?",
    "createdTime": 1560821228000
}

返回值

请参考通用请求返回值

修改自动清理任务

修改实例自动清理任务的保留天数

URI

PUT /tsdb/v1/tsdbs/{tsdbId}/action/auto-clean

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id

返回参数

不涉及

示例

请求示例

请求方法: PUT
URI: /tsdb/v1/tsdbs/{tsdbId}/action/auto-clean?retain=5

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.009400 修改自动清理数据作业失败 400 修改自动清理数据作业失败

删除自动清理任务

删除实例对应自动清理任务

URI

DELETE /tsdb/v1/tsdbs/{tsdbId}/action/auto-clean

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id

返回参数

不涉及

请求示例 不涉及

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.009400 删除自动清理数据作业失败 400 删除自动清理数据作业失败

数据查询相关接口

查询业务数据并保存模板

根据设定条件进行时序数据查询

描述

  • 指定查询时间范围
  • 指定查询度量
  • 指定聚合函数以及标签筛选
  • 指定降采样相关参数

URI

POST /tsdb/v1/tsdbs/{tsdbId}/query

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
queryPto body QueryPto 是 查询条件

返回参数

名称 位置 类型 是否必须 描述
result body JSONObject 是 查询的时间序列
series result JSONObject 是 查询的时间序列
name series String 是 时间序列标签
type series String 是 时间序列表现形式
data series Set 是 时间序列值
xaxis result JSONObject 是 时间序列时间轴

示例

请求示例

{
  "id": null,
  "templateName": temp123,
  "isDownSample": true,
  "metric": {
          "name": "pm25",
          "aggFunc": "ave",
          "downSampling": {
              "interpolation": "none", 
              "aggFunc": "first",
              "sampleTime": 10,
              "sampleTimeUnit": "d"
            },
          "tagFilters": [{
                  "type": "wildcard",
                  "group": true,
                  "value": "*",
                  "name": "city"
              }]
      },
      "timeRange": {
              "type": 1,
              "start": "2014-12-31T16:00:00.000Z",
              "end": "2015-12-30T16:00:00.000Z"
              }
}

响应示例

{"series":[{"name":"city=北京,zip_code=100000","type":"line","data":[17.6,18.8]},{"name":"city=上海,zip_code=200000","type":"line","data":[22.4,21.6]},{"name":"city=广州,zip_code=510000","type":"line","data":[28.0,30.0]}],"xaxis":{"name":null,"type":"category","data":["1430524800","1430611200"]},"yaxis":{"name":null,"type":"value"}}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008400 failed to save template 400 模板保存失败
301.008400 查询时序数据库结果为空 400 查询时序数据库结果为空
301.008404 查询时序数据库不存在 404 查询时序数据库不存在

查询监控数据

时序数据库支持服务监控，可通过接口查询时序数据库监控数据。

描述

  • 监控指标分为每分钟读取、写入点数，每秒钟写入点数等指标

URI

POST /tsdb/v1/tsdbs/{tsdbId}/monitor

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
monitorPto body MonitorPto 是 查询条件

返回参数

名称 位置 类型 是否必须 描述
result body JsonObject 是 查询监控信息
tsd result JsonArray 是 监控tsd标识
data result JsonArray 是 监控图表信息
name result JsonArray 是 监控指标名称

示例

请求示例

{
  "metrics": [
    {
      "name": "read.request",
      "aggFunc":"sum"
    }
  ],
  "resolution": "m",
  "timeRange": {
    "end": {"value":0,"unit":"m"},
    "start": {"value":30,"unit":"m"},
    "type": 2
  }
}

响应示例

{"tsd":["172.31.98.76:4242","172.31.98.76:4242"],"data":[{"readRequest":4,"time":"1577255700","writeRequest":0}],"name":["read.request","write.request"]}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008400 查询监控时序数据库结果为空 400 查询监控时序数据库结果为空
301.008400 查询数据库监控指标出错 400 查询数据库监控指标出错
301.008404 查询监控时序数据库不存在 404 查询监控时序数据库不存在

分页查询模板列表

URI

GET /tsdb/v1/tsdbs/{tsdbId}/templates/{pageNo}/{pageSize}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
pageNo path String 是 分页数
pageSize path String 是 分页包含总数

返回参数

名称 位置 类型 是否必须 描述
templateDtoList body List(TemplateDto) 是 模板分页列表

示例

请求示例 不涉及

响应示例

{
    "totalPage": 1,
    "pageSize": 99,
    "start": 0,
    "num": 2,
    "data": [{
        "id": "7534a4c0-fefa-4c61-b9e1-4ebebca4dc6c",
        "name": "temp1",
        "tsdbId": "51eec88b-edc3-4b12-b722-86587f441c99",
        "metric": {
            "tagFilters": [{
                "name": "city",
                "groupBy": true,
                "type": "wildcard",
                "value": "*"
            }, {
                "name": "city",
                "groupBy": false,
                "type": "literal_or",
                "value": "北京"
            }],
            "name": "temperature",
            "aggFunc": "min",
            "downSampling": {
                "interpolation": "none",
                "sampleTimeUnit": "m",
                "aggFunc": "count",
                "sampleTime": 15
            }
        },
        "createdTime": 1560478811762,
        "updatedTime": 1560751282190,
        "timeRange": {
            "start": "2014-12-31T16:00:00.000Z",
            "end": "2015-12-30T16:00:00.000Z",
            "type": 1
        },
        "isDownSample": false
    }, {
        "id": "0c135adf-f7e1-4ee3-a7cd-978041c364cc",
        "name": "temp2",
        "tsdbId": "51eec88b-edc3-4b12-b722-86587f441c99",
        "metric": {
            "tagFilters": null,
            "name": "temperature",
            "aggFunc": "count"
        },
        "createdTime": 1560494859281,
        "updatedTime": 1560504275947,
        "timeRange": {
            "start": "2014-12-31T16:00:00.000Z",
            "end": "2015-12-30T16:00:00.000Z",
            "type": 1
        },
        "isDownSample": false
    }],
    "pageNo": 1,
    "totalCount": 2
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在

删除查询模板

URI

DELETE /tsdb/v1/tsdbs/{tsdbId}/templates/{templateId}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
templateId path String 是 查询模板id

返回参数

不涉及

示例

请求示例 不涉及

响应示例 规范请参考响应。

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在
301.008404 模板不存在 404 模板不存在
301.008400 删除模板失败 400 删除模板失败

查询单个模板详情

URI

GET /tsdb/v1/tsdbs/{tsdbId}/templates/{templateId}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
templateId path String 是 查询模板id

返回参数

不涉及

示例

请求示例 不涉及

响应示例

{
    "id": "7534a4c0-fefa-4c61-b9e1-4ebebca4dc6c",
    "name": "temp123",
    "tsdbId": "51eec88b-edc3-4b12-b722-86587f441c99",
    "metric": {
        "tagFilters": [{
            "name": "city",
            "groupBy": true,
            "type": "wildcard",
            "value": "*"
        }, {
            "name": "city",
            "groupBy": false,
            "type": "literal_or",
            "value": "北京"
        }],
        "name": "pm25",
        "aggFunc": "min",
        "downSampling": {
            "interpolation": "none",
            "sampleTimeUnit": "m",
            "aggFunc": "count",
            "sampleTime": 15
        }
    },
    "createdTime": 1560478811762,
    "updatedTime": 1560751282190,
    "timeRange": {
        "start": "2014-12-31T16:00:00.000Z",
        "end": "2015-12-30T16:00:00.000Z",
        "type": 1
    },
    "isDownSample": false
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在
301.008404 模板不存在 404 模板不存在

查询实例中指标列表

获取实例中所存所有指标名称的列表

URI

GET /tsdb/v1/tsdbs/{tsdbId}/templates/metric

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id

返回参数

名称 位置 类型 是否必须 描述
metricList body List 是 查询实例中指标列表

示例

请求示例 不涉及

响应实例

{
    "data": ["metric1", "metric2"],
    "totalCount": 2
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在
301.008404 查询度量值失败 404 查询度量值失败

查询指标中所有标签组

可根据指标名称获取该指标内所有的标签组

URI

GET /tsdb/v1/tsdbs/{tsdbId}/templates/metric/{metricValue}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
metricValue path String 是 指标名称

返回参数

名称 位置 类型 是否必须 描述
tagsMap body List> 是 查询指标中所有标签组
totalCount body String 是 返回所有标签组的个数

示例

请求示例 不涉及

响应实例

{
    "data": [
        {
            "city": "北京",
            "latitude": "39.881315",
            "zip_code": "100000",
            "longitude": "116.414208"
        },
        {
            "city": "北京",
            "latitude": "40.085332",
            "zip_code": "100000",
            "longitude": "116.585305"
        }
     ],
    "totalCount": 2
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在
301.008404 查询标签值失败 404 查询标签值失败

查询指标中所有标签的键

根据指标名称获取该指标下所有的标签的键

URI

GET /tsdb/v1/tsdbs/{tsdbId}/templates/metric/{metricValue}/tagK

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
metricValue path String 是 指标名称

返回参数

名称 位置 类型 是否必须 描述
tagKList body List 是 指标中所有标签键列表
totalCount body String 是 返回标签键的个数

示例

请求示例 不涉及

响应实例

{
    "data": [
        "city",
        "latitude",
        "zip_code",
        "longitude"
    ],
    "totalCount": 4
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在
301.008404 查询标签值失败 404 查询标签值失败

查询标签键下的所有值

URI

POST /tsdb/v1/tsdbs/{tsdbId}/templates/metric/{metricValue}/tagK/{tagK}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
metricValue path String 是 指标名称
tagK path String 是 标签键
filter body Map 否 过滤参数

返回参数

名称 位置 类型 是否必须 描述
tagVList body List 是 标签键中所有值的列表
totalCount body String 是 标签键中所有值的个数

示例

请求示例 不涉及

响应实例

{
    "data": [
        "北京",
        "上海",
        "广州"
    ],
    "totalCount": 3
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.008404 当前时序数据库不存在 404 当前时序数据库不存在
301.008404 查询标签值失败 404 查询标签值失败

数据操作记录接口

查看数据操作记录

可根据任务记录类型查看导入数据记录列表或清理数据记录列表

URI

GET /tsdb/v1/tsdbs/{tsdbId}/tasks/{pageNo}/{pageSize}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库id
pageNo path String 是 分页数
pageSize path String 是 分页包含总数
type params String 是 操作记录类型

返回参数

名称 位置 类型 是否必须 描述
taskDtoPage body PageDto(TaskDto) 是 查询实例信息

示例

请求示例

请求方法: GET
URI: /tsdb/v1/tsdbs/{tsdbId}/tasks/{pageNo}/{pageSize}?type=import

响应示例

{
    "totalCount": 1,
    "pageNo": 1,
    "start": 0,
    "num": 1,
    "data": [
        {
            "id": "8fdf1b2b-487f-45a9-b16f-279512eb7946",
            "name": "import-data-to-[TSDB-201905151590]",
            "status": "SUCCESS",
            "error": "{\"total\":27375,\"failed\":0}",
            "createdTime": 1557908500970,
            "updatedTime": 1557908508781,
            "tagFilters": null,
            "dataPointsNum": 27375,
            "tsdbName": "TSDB-201905151590",
            "failedDps": 0,
            "fileType": "CSV",
            "type": import
        }
    ],
    "totalPage": 1,
    "pageSize": 50
 }

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.006404 当前时序数据库不存在 404 当前时序数据库不存在
301.006400 请输入正确类型参数 400 请输入正确类型参数

opentsdb接口

获取用户token

对引用的opentsdb组件加入了权限校验，调用需要权限校验的接口时需要首先调用此接口获取用户token。

URI

POST /api/auth/token

请求参数

名称 位置 类型 是否必须 描述
Content-Type HEADER String 是 编码格式，此处为application/x-www-form-urlencoded
username path String 是 用户名
password path String 是 用户密码

返回参数

名称 数据类型 描述
token String 访问令牌

示例

请求示例

curl -l –H "Content-Type:application/x-www-form-urlencoded" -X POST "http://localhost:4242/api/auth/token?username=usr_01&password=password_01"

响应示例

{"token":"eda3a6de8137f46cfa29ff9c69c3cc56"}

返回值

请参考通用请求返回值

写入数据

写入数据到时序数据库

URI

POST /api/put

请求参数

名称 位置 数据类型 是否必须 描述
summary PATH String 否 是否返回汇总信息
details PATH String 否 是否返回详细信息
sync PATH String 否 在返回结果之前是否等待数据刷写到存储
Authorization HEADER String 是 用户认证token
Content-Type HEADER String 是 编码格式，此处为application/json
metric body String 是 要存储的指标名称
timestamp body Integer 是 时间戳，毫秒或者秒级。时间戳不能包含非数字字符
value body Integer, Float, String 是 记录当前此数据点的值。它可能被引用或不被引用，并且必须符合OpenTSDB的值规则：../../user_guide/writing
tags body Map 是 标签名称/标签值对的映射。至少必须提供一对。

返回参数

名称 数据类型 描述
token String 访问令牌

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X POST -d '{"metric":"sys.cpu.user","timestamp":1346846400, "value":69,"tags":{"host":"webserver01","cpu":"0"}}' http://localhost:4242/api/put?details&sync&summary

响应示例

{
  "success": 1,
  "failed": 0
}

返回值

请参考通用请求返回值

查询数据

查询时序数据库数据

URI

POST /api/query

请求参数

名称 位置 数据类型 是否必须 描述
Authorization HEADER String 是 用户认证token
Content-Type HEADER String 是 编码格式，此处为application/json
start body String, Integer 是 查询数据的开始时间
end body String, Integer 否 查询数据的结束时间
queries body Array 是 一个或多个子查询用于选择要返回的时间序列。
aggregator queries String 是 使用聚合函数名称。
metric queries String 是 查询数据指标名称。
tags queries Map 否 查询数据标签名称。
filters queries List 否 对于得到的查询数据进行过滤
downsample queries String 否 利用此功能减少数据返回的数量

返回参数

名称 描述
metric 检索数据指标名称
tags 检索数据标签名称
aggregateTags 检索时采用的聚合函数
DPS 检索得到的数据，由时间戳和值组成

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X POST -d '{"start":1529980200, "queries":[{"aggregator":"none","metric":"sys.cpu.user","tags":{"host":"webserver01","cpu":"0"}}]}' http://localhost:4242/api/query

响应示例

[{"metric":"sys.cpu.user","tags":{"host":"webserver01"},"aggregateTags":[],"dps":{"1546326483":57}}]

返回值

请参考通用请求返回值

监控实例使用信息

监控实例使用信息

URI

GET /tsdb/v1/tsdbs/{tsdbId}/monitor/storage

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 查询对象id
storageType query String 是 查询类型

返回参数

名称 位置 类型 是否必须 描述
result body JsonObject 是 查询监控信息
tsd result String 是 监控tsd标识
data result JsonArray 是 监控图表信息
name result String 是 监控指标名称

示例

请求示例 不涉及

响应示例

{"tsd":"","data":[{"createTime":1577256742445,"storageUsage":"375.92KB","storageSize":"40GB","storageUsageGB":"0.000359"}],"name":"hard disk usage"}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前时序数据库不存在 404 当前时序数据库不存在
301.001400 查询时序数据库监控失败 400 查询时序数据库监控失败

查询时序数据库参数配置信息

查询时序数据库参数配置信息

URI

GET /tsdb/v1/tsdbs/param/{tsdbId}/findParamConfig

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 查询对象id

返回参数

名称 位置 类型 是否必须 描述
tsdbId body String 是 查询实例ID
result body JsonArray 是 查询参数配置信息

示例

请求示例 不涉及

响应示例

{"result":[{"paramType":"BOOL","min":null,"enumValue":["true","false"],"max":null,"defaultValue":"true","name":"tsd.uid.lru.enable","description":"将UID缓存从无限制映射更改为LRU缓存","runningValue":"false"}],"tsdbId":"53ab164b-b327-4d67-b34c-fede55b6dc04"}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前时序数据库不存在 404 当前时序数据库不存在
301.001400 查询时序数据库参数失败 400 查询时序数据库参数失败

查询时序数据库参数配置修改记录

查询时序数据库参数配置修改记录

URI

GET /tsdb/v1/tsdbs/param/{tsdbId}/changeLog

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 查询对象id

返回参数

名称 位置 类型 是否必须 描述
result body JsonArray 是 查询参数修改记录
changeList result JsonArray 是 查询参数修改具体值
description result String 是 修改记录描述信息
createdTime result String 是 修改记录时间
id result String 是 修改记录ID
operatorId result String 是 修改用户ID
operatorName result String 是 修改用户名称
tsdbId result String 是 修改实例ID
status result String 是 修改状态

示例

请求示例 不涉及

响应示例

[{"changeList":[{"newValue":"1","paramName":"tsd.http.request.max_chunk","oldValue":"131072"},{"newValue":"false","paramName":"tsd.uid.lru.enable","oldValue":"true"},{"newValue":"false","paramName":"tsd.http.request.enable_chunked","oldValue":"true"},{"newValue":"false","paramName":"tsd.core.auto_create_metrics","oldValue":"true"}],"description":"1啊","createdTime":1582786944352,"id":"7a3e5bfe-96e1-4b23-941d-401c9f40e5ec","operatorId":"4a78a1fb-0225-414a-b831-59b1a3c6e090","operatorName":"yujinglc","tsdbId":"53ab164b-b327-4d67-b34c-fede55b6dc04","status":"1"}]

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前时序数据库不存在 404 当前时序数据库不存在
301.001400 查询时序数据库修改记录失败 400 查询时序数据库修改记录失败

更改时序数据库参数

更改时序数据库参数

URI

POST /tsdb/v1/tsdbs/param/{tsdbId}/updateParam

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 查询对象id
decription body String 是 修改参数描述
configInfo body JsonObject 是 所修改的参数

返回参数

不涉及

示例

请求示例

{"description":"","configInfo":{"tsd.storage.enable_appends":"true"}}

响应示例 不涉及

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前时序数据库不存在 404 当前时序数据库不存在
301.001400 修改参数失败 400 修改参数失败

购买时序数据库实例

购买时序数据库实例

URI

POST /tsdb/v1/bss/buy

请求参数

名称 位置 类型 是否必须 描述
billType body String 是 数据库计费方式
duration body String 否 购买月数
dataPoint body String 是 写入数据点
timeSeries body String 否 最大时间序列
diskVolume body String 是 存储容量
instancePassword body String 是 实例密码
instanceName body String 否 实例名称
userName body String 是 用户名称
password body String 是 用户密码

返回参数

不涉及

示例

请求示例

{
    "billType": "monthly",
    "duration":"1",
    "dataPoint": "50000",
    "timeSeries": "1000",
    "diskVolume": "1000",
    "instancePassword": "Admin1996",
    "instanceName": "openApi测试",
    "userName": "yujinglc",
    "password": "lc123456"
}

响应示例 不涉及

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001400 输入参数错误 400 输入参数错误
301.001400 购买数据库失败 400 购买数据库失败

更改时序数据库配置

更改时序数据库配置

URI

POST /tsdb/v1/bss/change

请求参数

名称 位置 类型 是否必须 描述
billType body String 是 数据库计费方式
duration body String 否 购买月数
dataPoint body String 是 写入数据点
timeSeries body String 否 最大时间序列
diskVolume body String 是 存储容量
instancePassword body String 否 实例密码
instanceName body String 否 实例名称
userName body String 是 用户名称
password body String 是 用户密码
tsdbId body String 是 实例ID

返回参数

不涉及

示例

请求示例

{
    "billType": "monthly",
    "duration":"1",
    "dataPoint": "50000",
    "timeSeries": "1000",
    "diskVolume": "1000",
    "instancePassword": "Admin1996",
    "instanceName": "openApi测试",
    "userName": "yujinglc",
    "password": "lc123456",
    "tsdbId":"892da262-2037-440d-a4b0-a8ef0d5c8cf6"
}

响应示例 不涉及

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001400 输入参数错误 400 输入参数错误
301.001400 数据库更配失败 400 数据库更配失败

其他服务获取实例列表

其他服务获取实例列表

URI

GET /tsdb/v1/tsdbs/list/{mainAccount}

请求参数

名称 位置 类型 是否必须 描述
mainAccount path String 是 主账号

返回参数

名称 位置 类型 是否必须 描述
code result Integer 是 结果状态
data result List 是 实例列表
message result String 是 结果说明

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/tsdb/v1/tsdbs/list/mainAccount

响应示例

{
    "code": 200,
    "data": [
    {
        "instanceName": "TSDB-2021test",
        "instanceId": "0678e56e-688f-4f19-8d66-624d69ccf5ce",
        "domainName": "http://1b181e46dcd2f912-mgt-test.inspurcloud.cn/opentsdb",
        "vm_ips": {
            "vm_address": "192.168.0.0",
            "eip_address": "10.100.0.1"
        }
    },
    {
        "instanceName": "TSDB-2021test2",
        "instanceId": "0adadsf6e-688f-4f19-8d66-6241231254dadsf",
        "domainName": "http://1b181e46dcxcv12-mgt-test.inspurcloud.cn/opentsdb",
        "vm_ips": {
            "vm_address": "192.168.0.1",
            "eip_address": "10.100.0.2"
        }
    }],
    "message": "success"
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 主账号为空或不存在 404 主账号为空或不存在

SOSS相关接口

SOSS获取集群实例指标

SOSS获取集群实例指标

URI

GET /soss/tsdb/v1/metric/instance

请求参数

无

返回参数

名称 位置 类型 是否必须 描述
result body Set 是 集群实例指标
code result Integer 是 结果状态
requestId result String 是 请求Id
message result String 是 结果说明

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/soss/tsdb/v1/metric/instance

响应示例

{
    "requestId":c8db1a3a-e40c-4ae1-a114-d3f89f65e83f
    "code": 200,
    "message": "get cluster info success, using time 200s."
     "data": 9
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.002400 get cluster info failed 400 获取集群实例指标失败

SOSS分页获取实例列表

SOSS分页获取实例列表

URI

GET /soss/tsdb/v1/metric/instancelist/{pageNo}/{pageSize}

请求参数

名称 位置 类型 是否必须 描述
name query String 否 名称
pageNo path String 是 分页数
pageSize path String 是 分页包含总数

返回参数

名称 位置 类型 是否必须 描述
tsdbDtoPage body PageDto(TsdbDto） 是 查询实例信息

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/soss/tsdb/v1/tsdbs/instancelist/1/99

响应示例

{
    "pageNo": 1,
    "pageSize": 99,
    "totalCount": 2,
    "totalPage": 1,
    "data": [
        {
            "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": null,
            "namespace": "tsdb",
            "isDeleted": false,
            "clusterUrl": "http://10.110.25.114:32632",
            "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
            "region": "cn-north-3",
            "billMode": "monthly",
            "suitCode": "std_3000",
            "expiredTime": null
        },
        {
            "id": "99b861d7-a789-4f8e-88e7-9d7b3db876ea",
            "createdTime": 1559178531657,
            "updatedTime": 1559178531657,
            "name": "TSDB-1111",
            "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": null,
            "namespace": "tsdb",
            "isDeleted": false,
            "clusterUrl": "http://10.110.25.114:32632",
            "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
            "region": "cn-north-3",
            "billMode": "monthly",
            "suitCode": "std_3000",
            "expiredTime": null
        }
    ],
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 查询时序数据库不存在 404 查询时序数据库不存在

SOSS获取用户实例

SOSS获取用户实例

URI

GET /soss/tsdb/v1/tsdbs

请求参数

不涉及

返回参数

名称 位置 类型 是否必须 描述
tsdbDtoList body List(TsdbDto) 是 查询实例信息

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/soss/tsdb/v1/tsdbs

响应示例

[
    {
        "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": false,
        "clusterUrl": "http://10.110.25.114:32632",
        "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
        "region": "cn-north-3",
        "billMode": "monthly",
        "suitCode": "std_3000",
        "expiredTime": null
    },
    {
        "id": "99b861d7-a789-4f8e-88e7-9d7b3db876ea",
        "createdTime": 1559178531657,
        "updatedTime": 1559178531657,
        "name": "TSDB-1111",
        "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": false,
        "clusterUrl": "http://10.110.25.114:32632",
        "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
        "region": "cn-north-3",
        "billMode": "monthly",
        "suitCode": "std_3000",
        "expiredTime": null
    }
]

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 当前登录用户owner为空 404 当前登录用户owner为空

SOSS获取实例详情

SOSS获取实例详情

URI

GET /soss/tsdb/v1/metric/{tsdbId}

请求参数

名称 位置 类型 是否必须 描述
tsdbId path String 是 时序数据库ID标识

返回参数

名称 位置 类型 是否必须 描述
tsdbDto body (TsdbDto) 是 查询实例信息

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/soss/tsdb/v1/metric/1f18a3d3-be42-45f6-b9e5-aa3864ed47dd

响应示例

{
    "id": "1f18a3d3-be42-45f6-b9e5-aa3864ed47dd",
    "name": "TSDB-20190514135947",
    "domain": "tsdb.tsdb-fuwofrbk.10.110.25.114.xip.io",
    "port": 80,
    "status": "RUNNING",
    "spec": null,
    "environment": "9439c591-b8c9-486d-8793-8d8f8eb9f292",
    "namespace": "tsdb",
    "isDeleted": null,
    "createdTime": 1557813625055,
    "updatedTime": 1557813782373,
    "deployMode": "SINGLE",
    "replicaNum": 1,
    "ownerId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
    "serviceUrl": "http://10.110.25.114:32096",
    "webUrl": "https://tsdb.tsdb-fuwofrbk.10.110.25.114.xip.io",
    "maxDpNum": 500000,
    "wrtDpPers": 3000,
    "storageSize": 40,
    "storageClass": "ceph",
    "clusterUrl": "http://10.110.25.114:32096",
    "creatorId": "d603f7fb-c745-4a94-b8fb-09ef483130fc",
    "region": "cn-north-3",
    "billMode": "hourlySettlement",
    "suitCode": "std_3000"
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.001404 查询时序数据库不存在 404 查询时序数据库不存在

openAPI相关接口

openapi创建实例

openapi创建实例

URI

POST /tsdb/v1/open-tsdbs

请求参数

名称 位置 类型 是否必须 描述
orderType body String 是 订单类型
region body String 是 区域
name body String 是 实例名称
cluster body JsonObject 是 集群名称
clusterType body String 是 实例类别
userName body String 是 用户名
password body String 是 用户密码
enableHA body Boolean 是 高可用
enableSecurity body Boolean 是 开启安全
instanceGroups body JsonArray 是 实例组
instanceType body String 是 节点规格
volumeCount body Integer 是 附加盘数量
volumeSize body Integer 是 附加盘容量
volumeType body String 是 附加盘类型
group body String 是 节点类型
network body JsonObject 是
subnetId body String 是 子网ID
networkId body String 是 虚拟私有网络ID
eip body JsonObject 否 弹性公网IP，null为不开通
dataPoint body Integer 数据点
TimeSeries_max body Integer 最大时间序列数

返回参数

名称 位置 类型 描述
name body String 集群名称
userId body String 用户ID
userName body String 用户名称
orderType body String 类型
createdTime body Data 创建时间
result body String 创建结果
message body String 通知信息
id body Long 集群ID

示例

请求示例

{
    "orderType": "new",
    "region": "cn-north-3",
    "billType": "hourlySettlement",
    "name": " tsdb-20210717163927",
    "cluster": {
        "clusterType": "opentsdb",
        "userName": "admin",
        "password": "adminA123",
        "enableHA": false,
        "enableSecurity": false
    },
    "instanceGroups": [{
            "instanceType": "tsdb_4C16G100G_general",
            "volumeCount": 0,
            "volumeSize": 100,
            "volumeType": "SATA",
            "group": "master"
        },
        {
            "instanceType": "tsdb_2C8G100G_general",
            "nodeCount": 3,
            "volumeCount": 0,
            "volumeSize": 100,
            "volumeType": "SATA",
            "group": "worker"
        }
    ],
    "network": {
        "subnetId": "a13bfb37-cdd9-456d-9e87-4c67bf5ffeb0",
        "networkId": "61ff9c76-3c77-41f2-8095-b6ba9ef43243",
        "eip": null
    },
}

响应示例

{
    "name": " tsdb-20210717163927",
    "userId": "c4dc81c6-da86-427e-b9f9-60e495062a70",
    "creatorName": "xuewei81",
    "orderType": "new",
    "createdTime": 1577416692873,
    "result": "success",
    "message": "tsdb集群tsdb-20210717163927开始创建."
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
300.011400 集群操作请求校验失败 500 集群操作请求校验失败

openapi退订实例

openapi退订实例

URI

DELETE /tsdb/v1/open-tsdbs/unsubscribe

请求参数

名称 位置 类型 是否必须 描述
orderType body String 是 订单类型
id body Long 是 集群ID
instanceId body String 是 实例ID

返回参数

名称 位置 类型 描述
name body String 集群名称
userId body String 用户ID
userName body String 用户名称
orderType body String 类型
createdTime body Data 创建时间
result body String 创建结果
message body String 通知信息
id body Long 集群ID

示例

请求示例

{
    "orderType": "unsubscribe",
    "id": 11220,
    "instanceId": "83e9fab2-86a2-4c0a-bd90-b4e5a933168d"
}

响应示例

{
    "name": "tsdb-20210718084549",
    "userId": "7b4f8548-7334-486c-a4d2-8d5b3a89c4a7",
    "creatorName": "usertest",
    "orderType": "unsubscribe",
    "createdTime": 1563381949441,
    "result": "success",
    "message": "Start unsubscribing the cluster",
    "id": 11220
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
300.011400 集群操作请求校验失败 500 集群操作请求校验失败

EIP相关接口

获取节点和EIP

获取节点和EIP

URI

GET /tsdb/v1/eip/{serviceId}/details

请求参数

名称 位置 类型 是否必须 描述
serviceId path String 是 时序数据库ID标识

返回参数

名称 位置 类型 是否必须 描述
result body Set 是 用户实例数量
code result Integer 是 结果状态
requestId result String 是 请求Id
message result String 是 结果说明

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/tsdb/v1/eip/1f18a3d3-be42-45f6-b9e5-aa3864ed47dd/details

响应示例

{
    "code": 200,
    "message": "success",
    "requestId": "6403fa30-64c9-4a11-9e2e-0572157b4e0a",
    "result": [
        {
            "instanceId": "51f9d5f2-6902-4b8c-8186-f2e04ae16438",
            "vmName": "TSDB-influxdb-0",
            "vmAddress": "172.31.2.01",
            "eipId": "0bf5bb1a-448e-40c6-82f5-1ef88c2fa832",
            "eipAddress": "10.110.0.1",
            "port": "80"
        }
    ]
}

返回值

请参考通用请求返回值

错误码

无

绑定EIP

绑定EIP

URI

POST /tsdb/v1/eip/action/bind-eip

请求参数

名称 位置 类型 是否必须 描述
tsdbEip body String 是 时序数据库EIP

返回参数

名称 位置 类型 是否必须 描述
result body Set 是 EIP信息
code result Integer 是 结果状态
requestId result String 是 请求Id
message result String 是 结果说明

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/tsdb/v1/eip/action/bind-eip

响应示例

{
    "code": 200,
    "message": "success",
    "requestId": "6403fa30-64c9-4a11-9e2e-0572157b4eca"
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.011311 未经授权 404 未经授权
301.011404 当前时序数据库EIP绑定失败 404 当前时序数据库EIP绑定失败
301.011400 当前时序数据库EIP绑定失败 400 当前时序数据库EIP绑定失败

解绑EIP

解绑EIP

URI

POST /tsdb/v1/eip/action/unbind-eip

请求参数

名称 位置 类型 是否必须 描述
tsdbEip body String 是 时序数据库EIP

返回参数

名称 位置 类型 是否必须 描述
result body Set 是 EIP信息
code result Integer 是 结果状态
requestId result String 是 请求Id
message result String 是 结果说明

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242/tsdb/v1/eip/action/unbind-eip

响应示例

{
    "requestId":c8db1a3a-e40c-4ae1-a114-d3f89f65e83f
    "code": 200,
    "message": "success"
}

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
301.011311 未经授权 404 未经授权
301.011404 解绑当前时序数据库EIP失败 404 解绑当前时序数据库EIP失败
301.011400 解绑当前时序数据库EIP失败 400 解绑当前时序数据库EIP失败

规格相关接口

获取openTSDB实例规格

获取openTSDB实例规格

URI

GET /tsdb/v1/tsdbs/spec/{clusterType}

请求参数

名称 位置 类型 是否必须 描述
clusterType path String 是 实例类别

返回参数

名称 位置 类型 是否必须 描述
tsdbSpecs body List 是 实例数量规格

示例

请求示例

curl -l -H "Content-type: application/json" -H "Authorization: bearer token_value0001" -X GET  http://localhost:4242//tsdb/v1/tsdbs/spec/opentsdb

响应示例

[
    {
        "code": "TSDB_Standard",
        "clusterType": "opentsdb",
        "master": "tsdb_4C16G100G_general",
        "masterNodeCount": 2,
        "work": "tsdb_2C8G100G_general",
        "workNodeCount": 2,
        "cpu": 16,
        "memory": 56,
        "sysVolumeSize": 400
    },
    {
        "code": "TSDB_Professional",
        "clusterType": "opentsdb",
        "master": "tsdb_4C16G100G_general",
        "masterNodeCount": 2,
        "work": "tsdb_4C16G100G_general",
        "workNodeCount": 3,
        "cpu": 24,
        "memory": 88,
        "sysVolumeSize": 500
    },
    {
        "code": "TSDB_Enterprise",
        "clusterType": "opentsdb",
        "master": "tsdb_8C32G100G_general",
        "masterNodeCount": 2,
        "work": "tsdb_8C32G100G_general",
        "workNodeCount": 4,
        "cpu": 52,
        "memory": 200,
        "sysVolumeSize": 600
    }
]

返回值

请参考通用请求返回值

错误码

错误代码 错误信息 Http状态码 说明
300.011400 tsdb实例规格查询失败 500 tsdb实例规格查询失败