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.
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. |
| 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. |
This example shows you how to query the total number of requests for a specific job.
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"
}{
"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"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
피드백