tencent cloud

All product documents
APIs
DocumentationAPIsPerformance Testing ServicePTS-related APIsDescribeAvailableMetrics
DescribeAvailableMetrics
Last updated: 2025-03-17 11:03:45
DescribeAvailableMetrics
Last updated: 2025-03-17 11:03:45

1. API Description

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

This API is used to query all supported metrics.

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: DescribeAvailableMetrics.
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.

3. Output Parameters

Parameter Name Type Description
MetricSet Array of MetricInfo All supported metrics of the product.
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 all supported metrics

Input Example

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

{}

Output Example

{
    "Response": {
        "MetricSet": [
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Request RPS"
                        "Unit": "reqs/s"
                    },
                    {
                        "Aggregation": "MaxRateOverTime",
                        "Legend": "Request RPS Peak"
                        "Unit": "reqs/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total Requests"
                        "Unit": "reqs"
                    },
                    {
                        "Aggregation": "ErrorPercentage",
                        "Legend": "Request Failure Rate"
                        "Unit": "%"
                    },
                    {
                        "Aggregation": "ErrorPercentageByResult",
                        "Legend": "Request Failure Rate (Result Code)"
                        "Unit": "%"
                    }
                ],
                "Alias": "RequestsCount",
                "Description": "Request Quantity"
                "InnerMetric": false,
                "Metric": "pts_engine_req_total",
                "MetricType": "counter",
                "Unit": "reqs"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "Response Time Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Timings",
                        "Legend": "Average Time Distribution at Each Stage"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "Average Response Time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Response Time P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Response Time P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Response Time P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Response Time P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestDuration",
                "Description": "Request Response Time"
                "InnerMetric": false,
                "Metric": "pts_engine_req_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Checkpoint RPS"
                        "Unit": "checks/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total Checkpoints"
                        "Unit": "checks"
                    },
                    {
                        "Aggregation": "ErrorPercentage",
                        "Legend": "Checkpoint Error Rate"
                        "Unit": "%"
                    }
                ],
                "Alias": "ChecksCount",
                "Description": "Number of Checkpoints"
                "InnerMetric": false,
                "Metric": "pts_engine_checks_total",
                "MetricType": "counter",
                "Unit": "checks"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Gauge",
                        "Legend": "Concurrency"
                        "Unit": "VUs"
                    },
                    {
                        "Aggregation": "MaxOverTime",
                        "Legend": "Peak Concurrency"
                        "Unit": "VUs"
                    }
                ],
                "Alias": "NumberVirtualUsers",
                "Description": "Concurrent Users"
                "InnerMetric": false,
                "Metric": "pts_engine_num_vus",
                "MetricType": "gauge",
                "Unit": "VUs"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Send Rate"
                        "Unit": "bytes/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total Sent"
                        "Unit": "bytes"
                    },
                    {
                        "Aggregation": "UsagePercentage",
                        "Legend": "Outbound Bandwidth Utilization"
                        "Unit": "%"
                    }
                ],
                "Alias": "SendBytesCount",
                "Description": "Bytes Sent"
                "InnerMetric": false,
                "Metric": "pts_engine_send_bytes_total",
                "MetricType": "counter",
                "Unit": "bytes"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Receive Rate"
                        "Unit": "bytes/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total Received"
                        "Unit": "bytes"
                    },
                    {
                        "Aggregation": "UsagePercentage",
                        "Legend": "Ingress Bandwidth Utilization"
                        "Unit": "%"
                    }
                ],
                "Alias": "ReceiveBytesCount",
                "Description": "Bytes Received"
                "InnerMetric": false,
                "Metric": "pts_engine_receive_bytes_total",
                "MetricType": "counter",
                "Unit": "bytes"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Scenario Execution TPS"
                        "Unit": "iters/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total Scenario Executions"
                        "Unit": "iters"
                    }
                ],
                "Alias": "IterationsCount",
                "Description": "Number of Scenario Iterations"
                "InnerMetric": false,
                "Metric": "pts_engine_iterations_total",
                "MetricType": "counter",
                "Unit": "iters"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Requests Sent RPS"
                        "Unit": "reqs/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total Requests Sent"
                        "Unit": "reqs"
                    }
                ],
                "Alias": "RequestSentCount",
                "Description": "Number of Requests Sent"
                "InnerMetric": false,
                "Metric": "pts_engine_req_sent_total",
                "MetricType": "counter",
                "Unit": "reqs"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "Scenario Execution Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "Average Scenario Execution Time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Scenario Execution P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Scenario Execution P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Scenario Execution P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Scenario Execution P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "IterationDuration",
                "Description": "Scenario Execution Time"
                "InnerMetric": false,
                "Metric": "pts_engine_iterations_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "Sending Time Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "Average Time Spent in Sending Request"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Sending Time P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Sending Time P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Sending Time P95"
                        "Unit": ""
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Sending Time P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestSendingDuration",
                "Description": "Time Spent in Sending Request Phase"
                "InnerMetric": false,
                "Metric": "pts_engine_req_send_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "Response Waiting Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "Average Response Waiting Time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Response Waiting P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Response Waiting P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Response Waiting P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Response Waiting P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestWaitingDuration",
                "Description": "time spent in waiting for response phase"
                "InnerMetric": false,
                "Metric": "pts_engine_req_wait_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "download response body Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "download response body average time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Download Response Time P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Download Response Time P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Download Response Time P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Download Response Time P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestReceivingDuration",
                "Description": "Download Response Time"
                "InnerMetric": false,
                "Metric": "pts_engine_req_receive_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "Waiting for Connection Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "Average Waiting for Connection Time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Waiting for Connection P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Waiting for Connection P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Waiting for Connection P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Waiting for Connection P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestBlockingDuration",
                "Description": "Waiting for Connection Time"
                "InnerMetric": false,
                "Metric": "pts_engine_req_block_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "Establishing Connection Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "Average Establishing Connection Time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "Establishing Connection P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "Establishing Connection P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "Establishing Connection P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "Establishing Connection P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestConnectingDuration",
                "Description": "Establishing connection time"
                "InnerMetric": false,
                "Metric": "pts_engine_req_connect_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Percentiles",
                        "Legend": "TLS Handshake Percentiles"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "Avg",
                        "Legend": "TLS Handshake Average Time"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P50",
                        "Legend": "TLS Handshake P50"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P90",
                        "Legend": "TLS Handshake P90"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P95",
                        "Legend": "TLS Handshake P95"
                        "Unit": "s"
                    },
                    {
                        "Aggregation": "P99",
                        "Legend": "TLS Handshake P99"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestHandshakingDuration",
                "Description": "TLS handshake time"
                "InnerMetric": false,
                "Metric": "pts_engine_req_tls_handshake_duration_seconds",
                "MetricType": "histogram",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Max",
                        "Legend": "Maximum Response Time"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestMaxDuration",
                "Description": "Maximum request response time"
                "InnerMetric": true,
                "Metric": "pts_engine_req_max_duration_seconds",
                "MetricType": "gauge",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Min",
                        "Legend": "Minimum Response Time"
                        "Unit": "s"
                    }
                ],
                "Alias": "RequestMinDuration",
                "Description": "Minimum request response time"
                "InnerMetric": true,
                "Metric": "pts_engine_req_min_duration_seconds",
                "MetricType": "gauge",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "UsagePercentage",
                        "Legend": "CPU usage rate",
                        "Unit": "%"
                    }
                ],
                "Alias": "ContainerCPUUsageCount",
                "Description": "stress machine cpu usage",
                "InnerMetric": true,
                "Metric": "container_cpu_usage_seconds_total",
                "MetricType": "counter",
                "Unit": "s"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "UsagePercentage",
                        "Legend": "memory usage rate",
                        "Unit": "%"
                    }
                ],
                "Alias": "ContainerMemUsage",
                "Description": "Memory usage of pressure tester"
                "InnerMetric": true,
                "Metric": "container_memory_usage_bytes",
                "MetricType": "gauge",
                "Unit": "bytes"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "Sending rate"
                        "Unit": "bytes/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "Total number sent"
                        "Unit": "bytes"
                    }
                ],
                "Alias": "ContainerNetworkSendCount",
                "Description": "sent bytes of pressure tester"
                "InnerMetric": true,
                "Metric": "container_network_transmit_bytes_total",
                "MetricType": "counter",
                "Unit": "bytes"
            },
            {
                "Aggregations": [
                    {
                        "Aggregation": "Rate",
                        "Legend": "receive rate"
                        "Unit": "bytes/s"
                    },
                    {
                        "Aggregation": "Count",
                        "Legend": "total receipts"
                        "Unit": "bytes"
                    }
                ],
                "Alias": "ContainerNetworkReceiveCount",
                "Description": "Pressure tester received bytes"
                "InnerMetric": true,
                "Metric": "container_network_receive_bytes_total",
                "MetricType": "counter",
                "Unit": "bytes"
            }
        ],
        "RequestId": "50233a27-a7c0-4e3e-b598-bf213373aa99"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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