tencent cloud

All product documents
APIs
DocumentationAPIsPerformance Testing ServicePTS-related APIsDescribeSampleQuery
DescribeSampleQuery
Last updated: 2025-03-17 11:03:22
DescribeSampleQuery
Last updated: 2025-03-17 11:03:22

1. API Description

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

This API is used to query metrics and return metric content at a specific time point.

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: DescribeSampleQuery.
Version Yes String Common Params. The value used for this API: 2021-07-28.
Region No String Common Params. This parameter is not required for this API.
JobId Yes String Job ID.
ScenarioId Yes String Scenario ID.
Metric Yes String Metric name. For the value range, refer to all metric names returned by the DescribeMetricLabelWithValues API.
Aggregation Yes String Aggregation function. Range of values: Rate, Count, Avg, P90, P95, P99, Gauge.
ProjectId Yes String Project ID.
Labels.N No Array of Label Label filtering condition. For supported labels, refer to all metrics and labels returned by the DescribeMetricLabelWithValues API.

3. Output Parameters

Parameter Name Type Description
MetricSample CustomSample Returned metric.

Note: This field may return null, indicating that no valid value is found.
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 Querying the Total Number of Requests

This example shows you how to query the total number of requests for a specific job.

Input Example

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

{
    "ProjectId": "project-xx",
    "JobId": "123",
    "ScenarioId": "123",
    "Metric": "pts_engine_req_total",
    "Aggregation": "Count"
}

Output Example

{
    "Response": {
        "MetricSample": {
            "Metric": "pts_engine_req_total",
            "Aggregation": "Count",
            "Unit": "reqs",
            "Labels": [
                {
                    "LabelName": "method",
                    "LabelValue": "GET"
                }
            ],
            "Value": "1159362",
            "Timestamp": 1631693039208
        },
        "RequestId": "70805f6a-d7e1-4247-9d5a-fde3afe2b377"
    }
}

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

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.
FailedOperation Operation failed.
FailedOperation.ResourceNotFound The resource does not exist.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Invalid parameter value.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon