DescribeServiceOverview

Last updated: 2025-11-14 16:38:05

DescribeServiceOverview

Last updated: 2025-11-14 16:38:05

1. API Description

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

This API is used to pull application overview data.

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

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeServiceOverview.
Version	Yes	String	Common Params. The value used for this API: 2021-06-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
Metrics.N	Yes	Array of QueryMetricItem	Metric list.
InstanceId	Yes	String	Business system id.
GroupBy.N	Yes	Array of String	Aggregation dimension.
StartTime	Yes	Integer	Start time (unit: sec).
EndTime	Yes	Integer	End time (unit: seconds).
Filters.N	No	Array of Filter	Filter criteria.
OrderBy	No	OrderBy	Sorting method . Value: fill in. -Asc: sorts query metrics in ascending order. - desc: sort query metrics in descending order.
Limit	No	Integer	Page size.
Offset	No	Integer	Paging starting point.

3. Output Parameters

Parameter Name	Type	Description
Records	Array of ApmMetricRecord	Indicator result set.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining Application Overview Data

Input Example

POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServiceOverview
<Common request parameters>

{
    "Filters": [
        {
            "Type": "=",
            "Key": "span.kind",
            "Value": "client"
        }
    ],
    "InstanceId": "apm-059oXBfTL",
    "Metrics": [
        {
            "Compare": "CompareByYesterday",
            "MetricName": "service_request_count_sum"
        }
    ],
    "StartTime": 1742374000,
    "EndTime": 1742374331,
    "GroupBy": [
        "service.name"
    ]
}

Output Example

{
    "Response": {
        "Records": [
            {
                "Fields": [
                    {
                        "CompareVal": "",
                        "CompareVals": [
                            {
                                "Key": "CompareByYesterday",
                                "Value": "-1.6%"
                            },
                            {
                                "Key": "CompareByLastWeek",
                                "Value": "-0.8%"
                            }
                        ],
                        "Key": "service_request_count_sum",
                        "LastPeriodValue": [
                            {
                                "Key": "CompareByYesterday",
                                "Value": 125
                            },
                            {
                                "Key": "CompareByLastWeek",
                                "Value": 124
                            }
                        ],
                        "Unit": "",
                        "Value": 126
                    }
                ],
                "Tags": [
                    {
                        "Key": "service.name",
                        "Value": "ot-java-delivery-service"
                    }
                ]
            }
        ],
        "RequestId": "c7a656fe-971c-47cc-8dc4-ae76630e4761"
    }
}

5. Developer Resources

SDK

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

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.

Error Code	Description
AuthFailure	CAM signature/authentication error.
AuthFailure.UnauthorizedOperation	AuthFailure.UnauthorizedOperation
FailedOperation	Operation failed.
FailedOperation.AppIdNotMatchInstanceInfo	The appid does not match the business system information.
FailedOperation.InstanceIdIsEmpty	Business system id is empty.
FailedOperation.InstanceNotFound	The apm business system does not exist.
FailedOperation.InvalidRequest	Invalid request.
InternalError	Internal error.
InvalidParameter	Parameter error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud