1. API Description

API: GetMonitorData
Domain name for API request: monitor.tencentcloudapi.com

This API is used to get the monitoring data of a Tencent Cloud product by passing in the product's namespace, object dimension, and monitoring metrics.

API call rate limit: 20 calls/second (1,200 calls/minute). A single request can get the data of up to 10 instances and up to 1,440 data points.

This API may fail due to the rate limit if you need to call many metrics and objects. We recommend spreading call requests across a period of time.

To query the monitoring data of a CKafka topic, use the following input parameters:
&Namespace=QCE/CKAFKA
&Instances.N.Dimensions.0.Name=instanceId
&Instances.N.Dimensions.0.Value=Instance ID
&Instances.N.Dimensions.1.Name=topicId
&Instances.N.Dimensions.1.Value=Topic ID

2. Input Parameters

The list below contains only the API request parameters and some common request parameters. Common request parameters need to be added when a call is made. For more information, see Common Params.

2.1 Input parameters

2.1.1. Overview of input parameters

2.1.2. Overview of parameters in each dimension

2.2. Metric name

The statistical granularity (period) and dimension (dimension) may vary by metric. The DescribeBaseMetrics API can be used to get the period and dimension supported by each metric.

3. Output Parameters

4. Error Codes

5. Samples

Sample 1

This example shows you how to get the monitoring data for the production traffic of one CKafka topic using a statistical period of 60 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CKAFKA
&MetricName=CtopicProFlow
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2019-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=instanceId
&Instances.0.Dimensions.0.Value=ckafka-test
&Instances.0.Dimensions.1.Name=topicId
&Instances.0.Dimensions.1.Value=topic-test
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-05-08 16:40:00",
    "EndTime": "2019-05-08 16:45:00",
    "Period": 60,
    "MetricName": "CtopicProFlow",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "instanceId",
            "Value": "ckafka-test"
          },
          {
            "Name": "topicId",
            "Value": "topic-test"
          }
        ],
        "Timestamps": [
          1558429200,
          1558429260,
          1558429320,
          1558429380,
          1558429440,
          1558429500
        ],
        "Values": [
          18.213,
          18.219,
          17.911,
          18.243,
          17.916,
          17.939
        ]
      }
    ],
    "RequestId": "68a1ffe1-b314-4da8-8f8c-cdcfcff1d3fd"
  }
}

Sample 2

This example shows you how to get the monitoring data for the production traffic of multiple CKafka topics using a statistical period of 60 seconds for a specified length of time.

Sample input code

https://monitor.tencentcloudapi.com/?Action=GetMonitorData
&Namespace=QCE/CKAFKA
&MetricName=CtopicProFlow
&Period=60
&StartTime=2019-05-08T16:40:00+08:00
&EndTime=2019-05-08T16:45:00+08:00
&Instances.0.Dimensions.0.Name=instanceId
&Instances.0.Dimensions.0.Value=ckafka-test1
&Instances.0.Dimensions.1.Name=topicId
&Instances.0.Dimensions.1.Value=topic-test1
&Instances.1.Dimensions.0.Name=instanceId
&Instances.1.Dimensions.0.Value=ckafka-test2
&Instances.1.Dimensions.1.Name=topicId
&Instances.1.Dimensions.1.Value=topic-test2
&<Common request parameters>

Sample output code

{
  "Response": {
    "StartTime": "2019-05-08 16:40:00",
    "EndTime": "2019-05-08 16:45:00",
    "Period": 60,
    "MetricName": "CtopicProFlow",
    "DataPoints": [
      {
        "Dimensions": [
          {
            "Name": "instanceId",
            "Value": "ckafka-test1"
          },
          {
            "Name": "topicId",
            "Value": "topic-test1"
          }
        ],
        "Timestamps": [
          1558429200,
          1558429260,
          1558429320,
          1558429380,
          1558429440,
          1558429500
        ],
        "Values": [
          18.213,
          18.219,
          17.911,
          18.243,
          17.916,
          17.939
        ]
      },
      {
        "Dimensions": [
          {
            "Name": "instanceId",
            "Value": "ckafka-test2"
          },
          {
            "Name": "topicId",
            "Value": "topic-test2"
          }
        ],
        "Timestamps": [
          1558429200,
          1558429260,
          1558429320,
          1558429380,
          1558429440,
          1558429500
        ],
        "Values": [
          18.213,
          18.219,
          17.911,
          18.243,
          17.916,
          17.939
        ]
      }
    ],
    "RequestId": "68a1ffe1-b314-4da8-8f8c-cdcfcff1d3fd"
  }
}