ExploreHiTSDBInstanceData-Time Series Database(TSDB)-阿里云帮助中心

Queries time series data from a TSDB instance over a specified time range, with support for downsampling and tag-based filtering.

Request parameters

Parameter	Type	Required	Description
RegionId	String	Yes	The ID of the region where the instance resides.
InstanceId	String	Yes	The ID of the TSDB instance.
ReverseIp	String	Yes	The reverse VPC IP address of the instance.
ReversePort	Integer	Yes	The reverse VPC port of the instance.
Metric	String	Yes	The name of the metric to query.
Aggregator	String	Yes	The aggregator applied to the raw data before downsampling. Valid values: `count`, `sum`, `avg`, `min`, `max`.
Start	String	Yes	The start time of the query range.
End	String	Yes	The end time of the query range.
downSampleTime	String	Yes	The time precision for downsampling.
downSampleAggregator	String	Yes	The aggregator applied during downsampling. Valid values: `count`, `sum`, `avg`, `min`, `max`.
tagFilter	String	Yes	A JSON array of tag filter objects in nested list format. Each object specifies a set of tag key-value pairs. Example: `[{"city":"shanghai","host":"127.0.0.1"},{"city":"shanghai","host":"127.0.0.2"}]`

Note: None of the request parameters have default values. All parameters are required.

Response elements

Parameter	Type	Description
Metric	List	The name of the queried metric.
Start	String	The start time of the query range, in milliseconds.
End	String	The end time of the query range, in milliseconds.
TimeLines	List	The list of matched time series.
Tags	List	The tags associated with the time series.
TagKey	String	The tag key.
TagValue	String	The tag value.
Series	List	The data points in the time series.
Timestamp	Long	The timestamp of the data point, in milliseconds.
Value	Double	The sampled value at the corresponding timestamp.

Examples

Sample response

{
    "code": "200",
    "data": {
        "RequestId": "2553A660-E4EB-4AF4-A402-8AFF70A49143",
        "Metric": "cpu_load",
        "Start": "1365966062",
        "End": "1365966062",
        "TimeLines": [
            {
                "Tags": [
                    {
                        "TagKey": "host",
                        "TagValue": "127.0.0.1"
                    },
                    {
                        "TagKey": "city",
                        "TagValue": "shanghai"
                    }
                ],
                "Series": [
                    {
                        "Timestamp": 1495375200,
                        "Value": 5.0
                    },
                    {
                        "Timestamp": 1495375500,
                        "Value": 5.1
                    },
                    {
                        "Timestamp": 1495375800,
                        "Value": 5.2
                    }
                ]
            }
        ]
    },
    "requestId": "5EE70BFD-A272-417C-A6C2-37F081A49FE3",
    "successResponse": true
}