Overview of control APIs
Updated at:
Copy as MD
This document lists all control Application Programming Interfaces (APIs) and their enumeration parameters.
| Enumeration parameter | Enumeration value | Description |
| InstanceClass | tsdb.1x.basic | The instance type. |
| InstanceStatus |
| The status of the instance. |
| ChargeType |
| Payment method |
| AggregatorType |
| The aggregation type. |
| DownSampleTime |
| The time range for downsampling. |
| DeletionJobStatus |
| The status of the data deletion job. |
| DeletionJobType |
| The type of the data deletion job. |
Control APIs
| API | Description |
| CreateHiTSDBInstance | Creates an instance. |
| DeleteHiTSDBInstance | Deletes an instance. |
| ModifyHiTSDBInstanceClass | Upgrades or downgrades a TSDB instance. Only scale-out operations for shared instances are supported. |
| DescribeRegions | Lists the deployment regions. |
| DescribeHiTSDBInstanceList | Queries the database to obtain a list of instances. |
| DescribeHiTSDBInstance | Obtains the details of an instance. |
| ModifyHiTSDBInstanceSecurityIpList | Configures the IP address whitelist for an instance. |
| RestartHiTSDBInstance | Restarts an instance. |
| RenameHiTSDBInstanceAlias | Modifies the alias of an instance. |
| DeleteHiTSDBInstanceData | Deletes data from an instance. |
| DescribeHiTSDBInstanceDataTtl | Queries the TTL of data in an instance. |
| ExploreHiTSDBInstanceDataMetricList | Obtains the list of metrics for an instance. |
| ExploreHiTSDBInstanceDataTagKeyList | Obtains the list of tag keys for an instance. |
| ExploreHiTSDBInstanceDataTagValueList | Obtains the list of tag values for an instance. |
| ExploreHiTSDBInstanceData | Obtains the time series data within an instance. |
| ExploreHiTSDBInstanceDeletionJobList | Obtains a list of deletion job records. Jobs are identified as data deletion or timeline deletion based on the JobType parameter. |
| UpdateHiTSDBInstanceDataTtl | Updates the data TTL. |
Is this page helpful?