1. API Description
Domain name for API request: pts.intl.tencentcloudapi.com.
This API is used to query metric matrix.
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.
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: DescribeSampleMatrixQuery. |
| 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. |
| ProjectId |
Yes |
String |
Project 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. |
| Filters.N |
No |
Array of Filter |
Use label rules to filter metrics. Rules include label name, label value, and operator (0 means equal, 1 means not equal). |
| GroupBy.N |
No |
Array of String |
Labels used for grouping, similar to group by in PromQL.
|
3. Output Parameters
| Parameter Name |
Type |
Description |
| MetricSampleMatrix |
CustomSampleMatrix |
Metric matrix.
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 Query metric matrix
POST / HTTP/1.1
Host: pts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSampleMatrixQuery
<Common request parameters>
{
"ProjectId": "project-btksohr0",
"JobId": "job-61ovraba",
"ScenarioId": "scenario-j1u85ixm",
"Metric": "pts_engine_req_duration_seconds",
"Aggregation": "P50"
}
Output Example
{
"Response": {
"MetricSampleMatrix": {
"Metric": "pts_engine_req_duration_seconds",
"Aggregation": "P50",
"Unit": "s",
"Streams": [
{
"Name": "Response Time P50"
"Labels": null,
"Values": [
{
"Timestamp": 1650517296000,
"Value": 0.032142349260523326
},
{
"Timestamp": 1650517299000,
"Value": 0.03377059214626565
},
{
"Timestamp": 1650517302000,
"Value": 0.03206904981580744
},
{
"Timestamp": 1650518490000,
"Value": 0.05
}
]
}
]
},
"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. |