tencent cloud

1. API Description

Domain name for API request: apm.intl.tencentcloudapi.com.

This API is a general API used to obtain metric data. Users submit request parameters as needed and receive the corresponding metric data.
The API call frequency is limited to 20 requests per second and 1200 requests per minute. The number of data points per request is limited to 1440.
Usage of the General Interface for Fetching Metric Data
DescribeGeneralMetricData is a general interface for querying metric data, supporting flexible data retrieval. The query method of this interface is similar to using the following SQL statement:
SELECT {Metrics} FROM {ViewName} WHERE {Filters} GROUP BY {GroupBy}.

1. View (ViewName)
   Determines the data domain you want to query.
   Examples: service_metric (Service Monitoring View), db_metric (Database View), etc. For views supported by APM, please refer to Metric Views
2. Metrics (Metrics)
   Used to specify one or more metric items to be included in the returned results.
   Examples: request_count (Total Requests), duration_avg (Average Latency), error_rate (Error Rate). For metrics supported by APM, please refer to the APM Metric Protocol Standard.
3. Filters (Filters)
   Supports one or more filtering conditions in the form of Key-Value pairs.
   Example: Querying only a specific service: service.name = "order-service". Common dimensions and specific dimensions supported by each ViewName can be used as keys in filtering conditions. For more details, please refer to the APM Metric Protocol Standard.
4. Aggregation (GroupBy)
   Supports one or more aggregation dimensions, equivalent to the GROUP BY clause in SQL.
   Example: Grouping by the interface name operation to view the performance of each interface. Common dimensions and specific dimensions supported by each ViewName can be used as aggregation dimensions. For more details, please refer to the APM Metric Protocol Standard.
5. Granularity (Period)
   This parameter determines whether the data needs to be aggregated by time slices.
   • Period = 1 (Time Series Mode): The returned results are aggregated by time slices. The multiple values contained in the TimeSerial and DataSerial correspond one-to-one, representing the aggregation results for specific time slices. Time Series Mode is primarily used for displaying time trend charts.
   • Period = 0 (Summary Statistics Mode): In the returned results, the DataSerial contains only a single value, representing the summarized data for the entire time range.

A maximum of 20 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Fetch Interface Analysis List Data

Scenario Description: View the total request volume of each interface over a specific period, or monitor metrics such as average response time, P99, maximum response time, and error rate. Key Configurations: * ViewName: Query the service_metric (basic performance metrics) view. * Metrics: Return request_count (request volume) data. * Filters: Specify span.kind (invocation role) and service.name (application name) as filter conditions. * GroupBy: Aggregate by operation (interface name). * Period: Set to 0, indicating no time-slicing; this calculates the total summary value for the entire time range. Request Parameter Example: Query the total number of requests for all interfaces under the service apm-test within a specified time range, grouped and displayed by interface name.

Input Example

{
  "InstanceId": "apm-instanceKey",
  "ViewName": "service_metric",
  "Metrics": [
    "request_count"
  ],
  "Filters": [
    {
      "Key": "span.kind",
      "Value": "server"
    },
    {
      "Key": "service.name",
      "Value": "apm-test"
    }
  ],
  "GroupBy": [
    "operation"
  ],
  "StartTime": 1768377000,
  "EndTime": 1768377900,
  "Period": 0
}

Output Example

{
    "Response": {
        "Records": [
            {
                "MetricName": "service_request_count_sum",
                "Tags": [
                    {
                        "Key": "operation",
                        "Value": "GET /mall/test"
                    }
                ],
                "TimeSerial": [],
                "DataSerial": [
                    18
                ]
            }
        ],
        "RequestId": "bfcc1a20-b6ff-455b-8fab-1d9883f4f629"
    }
}

Example2 Fetch API Analysis List Detail Data

Scenario Description:View the traffic trends and latency change trends of a specific service over a period of time. This is typically used for rendering line charts on the front end. Key Configurations: * ViewName: Query the service_metric (basic performance metrics) view. * Metrics: Return request_count (request volume) data. * Filters: Specify span.kind (invocation role), service.name (application name), and operation (interface/endpoint) as filter conditions. * GroupBy: Not specified, indicating that aggregation by specific dimensions is not required. * Period: Set to 1, representing aggregation by time slices. Request Parameter Example: Query the per-minute request count trend for the specific interface POST /mall/test under the application apm-test within a specified time range.

Input Example

{
  "InstanceId": "apm-instanceKey",
  "ViewName": "service_metric",
  "Metrics": [
    "request_count"
  ],
  "Filters": [
    {
      "Key": "span.kind",
      "Value": "server"
    },
    {
      "Key": "service.name",
      "Value": "apm-test"
    },
    {
      "Key": "operation",
      "Value": "POST /mall/test"
    }
  ],
  "StartTime": 1768377000,
  "EndTime": 1768377900,
  "Period": 1
}

Output Example

{
    "Response": {
        "Records": [
            {
                "MetricName": "service_request_count_sum",
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "apm-test"
                    }
                ],
                "TimeSerial": [
                    1768377000,
                    1768377060,
                    1768377120
                ],
                "DataSerial": [
                    1,
                    null,
                    1
                ]
            }
        ],
        "RequestId": "4d62d7d5-e4b7-491b-874e-3563968f1626"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.