edit-icon download-icon

ExploreHiTSDBInstanceData

Last Updated: Mar 30, 2018

Description

Obtains the time series data of the instance.

Request parameters

Name Type Required or not Description
RegionId String Yes ID of the region in which the instance is located
InstanceId String Yes Instance ID
ReverseIp String Yes Reverse VPC IP address of the instance
ReversePort Integer Yes Reverse VPC Port of the instance
Metric String Yes Metric name
Aggregator String Yes Downsample aggregation type. Options are count, sum, avg, min, and max.
Start String Yes Start time
End String Yes End time
downSampleTime String Yes Downsample time precision
downSampleAggregator String Yes Downsample aggregation type. Options are count, sum, avg, min, and max.
tagFilter String Yes Set the filter list in JSON format. It is a nested list. For example, [{"city":"shanghai", "host":"127.0.0.1"},{"city":"shanghai", "host":"127.0.0.2"}]

NOTE: All the above request parameters have no default value.

Response parameters

Name Type Description
Metric List Data metric
Start String Start time for data query, millisecond value
End String End time for data query, millisecond value
TimeLines List Data list
Tags List List of data tags
TagKey String TagKey of the data
TagValue String TagValue of the data
Series List List of data points
Timestamp Long Sampling time for the data point, millisecond value
Value Double Data sampling value

Return example

JSON format:

{
    "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
}
Thank you! We've received your feedback.