全部产品

管控类 API 概览

更新时间:2020-09-23 11:20:44

本页汇总罗列了所有管控类 API 及枚举类型的字段。关于这些管控类 API 的具体信息,请参阅《管控类 API》一节。

枚举字段列表

枚举字段 枚举值 描述
InstanceClass tsdb.1x.basic 实例规格
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 (执行失败) 删除数据任务状态
DeletionJobType DATA (数据), META (时间线) 删除数据任务类型

管控类 API 列表

API 描述
CreateHiTSDBInstance 创建实例
DeleteHiTSDBInstance 删除实例
ModifyHiTSDBInstanceClass TSDB实例变配
DescribeRegions 部署地域列表
DescribeHiTSDBInstanceList 查询数据库获取实例列表
DescribeHiTSDBInstance 获取实例详情
ModifyHiTSDBInstanceSecurityIpList 设置实例的 IP 白名单
RestartHiTSDBInstance 重启实例
RenameHiTSDBInstanceAlias 修改实例别名
DeleteHiTSDBInstanceData 对实例做数据删除操作
DescribeHiTSDBInstanceDataTtl 查询实例数据的 TTL
ExploreHiTSDBInstanceDataMetricList 获取实例的 Metrics 列表
ExploreHiTSDBInstanceDataTagKeyList 获取实例的 TagKey 列表
ExploreHiTSDBInstanceDataTagValueList 获取实例的 TagValue 列表
ExploreHiTSDBInstanceData 获取实例内的时间序列数据
ExploreHiTSDBInstanceDeletionJobList 获取删除任务记录列表, 接口内根据 JobType 不同分别标识为“数据删除任务”或“时间线删除任务”。
UpdateHiTSDBInstanceDataTtl 更新数据过期时间
ModifyHiTSDBInstanceClass TSDB实例变配,仅支持共享实例之间的变配扩容操作
CreateHiTSDBInstance 创建TSDB实例