全部产品

管控类 API

更新时间:2017-09-05 17:22:04   分享:   

简介

HiTSDB 提供管控类 API 给用户,用于协助用户使用第三方系统、工具,或自建平台对 HiTSDB 实例和数据进行管控。而本文档即对这些 API 的请求、返回参数、及格式进行说明。

枚举类型

枚举字段 枚举字段别名 枚举值 备注
InstanceClass hitsdb.n1.6xlarge 实例规格,目前仅有一种对应500 G,50,000 tps
InstanceStatus CREATING(“CREATING”, 0, “创建中”)
ACTIVATION(“ACTIVATION”, 1, “运行中”)
DELETED(“DELETED”, 8, “已删除”)
ChargeType PREPAY,POSTPAY 付款方式,有两种:预付款,后付款
AggregatorType count,sum,avg,min,max 聚合类型
DownSampleTime 1m,5m,15m,30m,1h,12h,24h 采样时间区间
DeletionJobStatus SUBMITTED(已提交), STARTED(执行中), FINISHED(已完成), FAILED(执行失败) 删除数据任务状态

接口列表

DescribeRegions

部署 Region 列表

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region 的 ID

返回参数

字段 类型 描述
RegionId String 实例所在 Region 的 ID
LocalName String 实例所在 Region 的名称

返回格式

  1. {
  2. "RequestId": "BDDB1954-002B-4249-B2DF-2CDDA0259668",
  3. "Regions": {
  4. "Region": [
  5. {
  6. "RegionId": "cn-shenzhen-tsdb",
  7. "LocalName": "华南1"
  8. },
  9. {
  10. "RegionId": "cn-hangzhou-hitsdb",
  11. "LocalName": "华东2-tsdb"
  12. },
  13. {
  14. "RegionId": "cn-qingdao-tsdb",
  15. "LocalName": "青岛1"
  16. }
  17. ]
  18. }
  19. }

DescribeHiTSDBInstanceList

查询数据库获取实例列表

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region 的 ID
StatusList String [] 状态过滤列表,JSON 格式,枚举值为 InstanceStatus
PageSize Integer 30 每页记录数
PageNumber Integer 1 页码
QueryStr String 别名关键字

返回参数

字段 类型 描述
PageSize Int 页大小
PageNumber Int 页码
Total Int 总条数
InstanceList List 实例列表
InstanceId String 实例 ID
InstanceStorage String 实例存储, 单位 G
ZoneId String 实例可用区 ID
InstanceClass String 实例规格
GmtCreated String 实例创建日期
ChargeType String 实例付费类型
GmtExpire String 实例过期时间
InstanceAlias String 实例别名
UserId String 用户 ID
InstanceStatus String 实例状态, 枚举
NetworkType String 实例网络类型, 枚举
ReverseVpcIp String 实例反向 VPC IP
ReverseVpcPort String 实例反向 VPC 端口
InstanceDescription String 实例描述
RegionId String 实例所在 Region ID
InstanceTps String 实例 Tps 性能, 单位<请求/秒>

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "PageSize": 100,
  5. "RequestId": "D1BDDC07-6DEF-4DE3-BCA0-2A9B8BB69E91",
  6. "PageNumber": 1,
  7. "Total": 2,
  8. "InstanceList": [
  9. {
  10. "InstanceStorage": "200",
  11. "ZoneId": "cn-hangzhou-e",
  12. "InstanceId": "hb-bp17pca5t4ristmb1",
  13. "InstanceClass": "hitsdb.n1.6xlarge",
  14. "GmtCreated": "2017-07-30 23:30:38.0",
  15. "ChargeType": "POSTPAY",
  16. "GmtExpire": "2018-07-30 23:30:38.0",
  17. "InstanceAlias": "fenghaotest-730-1123",
  18. "UserId": "1623695425786218",
  19. "InstanceStatus": "ACTIVATION",
  20. "NetworkType": "VPC",
  21. "ReverseVpcIp": "100.100.64.1",
  22. "ReverseVpcPort": "7834",
  23. "InstanceDescription": "",
  24. "RegionId": "cn-hangzhou",
  25. "InstanceTps": "50000"
  26. },
  27. {
  28. "InstanceStorage": "200",
  29. "ZoneId": "cn-hangzhou-e",
  30. "InstanceId": "hb-bp100012um014wzlw",
  31. "InstanceClass": "hitsdb.n1.6xlarge",
  32. "GmtCreated": "2017-07-30 21:12:37.0",
  33. "ChargeType": "POSTPAY",
  34. "GmtExpire": "2018-07-30 21:12:37.0",
  35. "InstanceAlias": "异常实例-2",
  36. "UserId": "1623695425786218",
  37. "InstanceStatus": "ACTIVATION",
  38. "NetworkType": "VPC",
  39. "ReverseVpcIp": "100.100.64.1",
  40. "ReverseVpcPort": "7831",
  41. "InstanceDescription": "",
  42. "RegionId": "cn-hangzhou",
  43. "InstanceTps": "50000"
  44. }
  45. ]
  46. },
  47. "requestId": "D1BDDC07-6DEF-4DE3-BCA0-2A9B8BB69E91",
  48. "successResponse": true
  49. }

DeleteHiTSDBInstance

删除实例

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64"
  5. },
  6. "requestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  7. "successResponse": true
  8. }

DescribeHiTSDBInstance

获取实例详情

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID

返回参数

字段 类型 描述
InstanceId String 实例 ID
InstanceStorage String 实例存储, 单位 G
ZoneId String 实例可用区 ID
InstanceClass String 实例规格
GmtCreated String 实例创建日期
ChargeType String 实例付费类型
GmtExpire String 实例过期时间
InstanceAlias String 实例别名
UserId String 用户 ID
InstanceStatus String 实例状态, 枚举
NetworkType String 实例网络类型, 枚举
ReverseVpcIp String 实例反向 VPC IP
ReverseVpcPort String 实例反向 VPC 端口
InstanceDescription String 实例描述
RegionId String 实例所在 Region ID
InstanceTps String 实例 Tps 性能, 单位<请求/秒>
SecurityIpList List 实例白名单列表
Ip String 实例白名单 IP

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "InstanceStorage": "200",
  5. "ZoneId": "cn-shanghai-b",
  6. "RequestId": "B8161286-7E9A-40DD-8C9B-A578DE77214F",
  7. "InstanceId": "ts-uf6wji86i43sk2h4x",
  8. "InstancePort": "8242",
  9. "InstanceClass": "hitsdb.small",
  10. "GmtCreated": "2017-06-30 09:39:13.0",
  11. "ChargeType": "PREPAY",
  12. "GmtExpire": "2018-06-30 01:39:13.0",
  13. "InstanceAlias": "at7",
  14. "InstanceStatus": "ACTIVATION",
  15. "NetworkType": "VPC",
  16. "SecurityIpList": [
  17. {
  18. "Ip": "192.168.12.0/24"
  19. },
  20. {
  21. "Ip": "11.136.50.64"
  22. }
  23. ],
  24. "ReverseVpcIp": "100.100.66.1",
  25. "ReverseVpcPort": "5514",
  26. "InstanceDescription": "",
  27. "RegionId": "cn-shanghai",
  28. "InstanceTps": "50000"
  29. },
  30. "requestId": "B8161286-7E9A-40DD-8C9B-A578DE77214F",
  31. "successResponse": true
  32. }

ModifyHiTSDBInstanceSecurityIpList

设置实例的 IP 白名单

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 白名单组 ID
SecurityIpList String ip pattern 的列表,JSON 格式的字符串, [“127.0.0.1”, “192.168.0.1/24”]

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64"
  5. },
  6. "requestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  7. "successResponse": true
  8. }

RestartHiTSDBInstance

重启实例

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region id
InstanceId String 实例 ID

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64"
  5. },
  6. "requestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  7. "successResponse": true
  8. }

RenameHiTSDBInstanceAlias

修改实例别名

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region id
InstanceId String 实例 ID
InstanceAlias String 实例别名

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64"
  5. },
  6. "requestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  7. "successResponse": true
  8. }

DeleteHiTSDBInstanceData

对实例做数据删除操作

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID
ReverseIp String 实例 反向 VPC IP
ReversePort Integer 实例 反向 VPC Port
Metric String 清理的 metric 列表,如果为空,不清理,JSON 格式,[“cpuload”, “mem”, “blahmetric”]
Start Long 清理的时间区间的 startTimestamp,单位 ms
End Long 清理的时间区间的 endTimestamp,单位 ms

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64"
  5. },
  6. "requestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  7. "successResponse": true
  8. }

DeleteHiTSDBInstanceMeta

对实例做数据 Meta 删除操作

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region id
InstanceId String 实例 ID
ReverseIp String 实例反向 VPC IP
ReversePort Integer 实例反向 VPC Port
Metric String 清理的 metric 列表,如果为空,不清理,JSON 格式,[“cpuload”, “mem”, “blahmetric”]
TagFilter String tagFilter

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64"
  5. },
  6. "requestId": "1556DCB0-043A-4444-8BD9-CF4A68E7EE64",
  7. "successResponse": true
  8. }

DescribeHiTSDBInstanceDataTtl

查询实例数据的 ttl

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region id
InstanceId String 实例 ID
ReverseIp String 实例反向 VPC IP
ReversePort Integer 实例反向 VPC Port

返回参数

字段 类型 描述
Ttl Long 数据 Ttl 值

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "EC28CA15-B65B-4B0C-9E7C-39AFF77D98AB",
  5. "Ttl": 2147483647
  6. },
  7. "requestId": "EC28CA15-B65B-4B0C-9E7C-39AFF77D98AB",
  8. "successResponse": true
  9. }

ExploreHiTSDBInstanceDataMetricList

获取实例的 metrics 列表

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region id
InstanceId String 实例 ID
ReverseIp String 实例反向 VPC IP
ReversePort Integer 实例反向 VPC Port
Prefix String “” 前缀
Max Long “” 返回最大条数

返回参数

字段 类型 描述
MetricList List 数据 metric 列表
Metric String 数据 metric 名称

返回格式

  1. {
  2. "RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143",
  3. "InstanceId": "instance1",
  4. "MetricList": [{
  5. "Metric": "hbase.lose.data.cont"
  6. }, {
  7. "Metric": "hbase.write.cost.cont"
  8. }, {
  9. "Metric": "hbase.write.cost.max"
  10. }, {
  11. "Metric": "hbase.write.cost.mean"
  12. }, {
  13. "Metric": "hbase.write.cost.mean_rate"
  14. }]
  15. }

ExploreHiTSDBInstanceDataTagKeyList

获取实例的 tag 列表

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID
ReverseIp String 实例 反向 VPC IP
ReversePort Integer 实例 反向 VPC Port
Metric String metric 名称
Prefix String 前缀
Max Long 返回最大条数

返回参数

字段 类型 描述
TagKeyList List 数据 tag key 列表
TagKey String 数据 tag key

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
  5. "TagKeyList": [
  6. {"TagKey":"hostname"},
  7. {"TagKey":"color"},
  8. {"TagKey":"category"},
  9. {"TagKey":"location"}
  10. ]
  11. },
  12. "requestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
  13. "successResponse": true
  14. }

ExploreHiTSDBInstanceDataTagValueList

获取实例的 tag 列表

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region id
TagKey String 限制 tagkey
InstanceId String 实例 ID
ReverseIp String 实例反向 VPC IP
ReversePort Integer 实例反向 VPC Port
Prefix String tagvalue 前缀
Max Long 返回最大条数

返回参数

字段 类型 描述
TagValueList List 数据 tag value 列表
TagValue String 数据 tag value

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
  5. "TagValueList": [
  6. {"TagValue": "ok"}
  7. ]
  8. },
  9. "requestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
  10. "successResponse": true
  11. }

ExploreHiTSDBInstanceData

获取实例内的时间序列数据

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID
ReverseIp String 实例反向 VPC IP
ReversePort Integer 实例反向 VPC Port
Metric String metric 名称
Aggregator String Aggregator 类型,见 enum
Start String 开始时间
End String 结束时间
downSampleTime String 采样时间精度
downSampleAggregator String 采样 Aggregator 类型,见 enum
tagFilter String 设置过滤列表,JSON 格式,嵌套 list, [{“city”:”shanghai”, “host”:”127.0.0.1”},{“city”:”shanghai”, “host”:”127.0.0.2”}]

返回参数

字段 类型 描述
Metric List 数据 metric
Start String 数据查询开始时间, 毫秒值
End String 数据查询结束时间, 毫秒值
TimeLines List 数据列表
Tags List 数据 tag 列表
TagKey String 数据 tag key
TagValue String 数据 tag value
Series List 数据点列表
Timestamp Long 数据点采样时间, 毫秒值
Value Double 数据采样 value

返回格式

  1. {
  2. "code": "200",
  3. "data":{
  4. "RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143",
  5. "Metric": "cpu_load",
  6. "Start": "1365966062",
  7. "End": "1365966062",
  8. "TimeLines": [{
  9. "Tags": [{
  10. "TagKey": "host",
  11. "TagValue": "127.0.0.1"
  12. },
  13. {
  14. "TagKey": "city",
  15. "TagValue": "shanghai"
  16. }
  17. ],
  18. "Series": [{
  19. "Timestamp": 1495375200,
  20. "Value": 5.0
  21. }, {
  22. "Timestamp": 1495375500,
  23. "Value": 5.1
  24. }, {
  25. "Timestamp": 1495375800,
  26. "Value": 5.2
  27. }]
  28. }]
  29. },
  30. "requestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
  31. "successResponse": true
  32. }

ExploreHiTSDBInstanceDeletionJobList

获取删除数据历史记录列表

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID
ReverseIp String 实例 反向 VPC IP
ReversePort Integer 实例 反向 VPC Port
PageNumber Integer 分页页码
PageSize Integer 单页数据量

返回参数

字段 类型 描述
PageSize Int 页大小
PageNumber Int 页码
Total Int 总条数
JobList List 数据删除任务列表
Id Long 任务id
Ip String 实例反向 VPC IP
Port String 实例反向 VPC Port
Metric String 数据 metric 的 JSON Array
StartTime Long 数据删除范围开始时间
EndTime Long 数据删除范围开始时间
JobStartTime String 数据删除任务执行开始时间
JobEndTime String 数据删除任务执行结束时间
Status String 数据删除状态枚举-DeletionJobStatus

返回格式

  1. {
  2. "code": "200",
  3. "data":{
  4. "RequestId":"2553A660-E4EB-4AF4-A402-8AFF70A49143",
  5. "JobList": [
  6. {
  7. "Status": "FINISHED",
  8. "EndTime": 1501430449883,
  9. "InstanceId": "hb-uf6z26x3gaz99n511",
  10. "Ip": "100.100.66.1",
  11. "Port": 6073,
  12. "StartTime": 1501423200882,
  13. "Metric": "[\"ali.air_condition.temprature\"]",
  14. "JobStartTime": 1501430475065,
  15. "id": 22,
  16. "JobEndTime": 1501430476114
  17. },
  18. ...
  19. ],
  20. "PageNumber": 1,
  21. "PageSize": 10,
  22. "Total": 100
  23. },
  24. "requestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
  25. "successResponse": true
  26. }

UpdateHiTSDBInstanceDataTtl

更新数据过期时间

请求参数

字段 类型 是否必须 默认值 描述
RegionId String 实例所在 Region ID
InstanceId String 实例 ID
ReverseIp String 实例反向 VPC IP
ReversePort Integer 实例反向 VPC Port
Ttl Long 数据保留实现,单位为

返回格式

  1. {
  2. "code": "200",
  3. "data": {
  4. "RequestId": "EC6A17BC-B326-4626-B3BE-932B003DB3A9"
  5. },
  6. "requestId": "EC6A17BC-B326-4626-B3BE-932B003DB3A9",
  7. "successResponse": true
  8. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?