文档中心>API 中心>云压测>PTS相关接口>查询指标所有的label及values值

查询指标所有的label及values值

最近更新时间:2024-03-12 01:44:49

我的收藏

1. 接口描述

接口请求域名: pts.tencentcloudapi.com 。

查询指标所有的label及values值

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMetricLabelWithValues。
Version String 公共参数,本接口取值:2021-07-28。
Region String 公共参数,本接口不需要传递此参数。
JobId String job id
示例值:job-12345
ProjectId String project id
示例值:project-12345
ScenarioId String scenario id
示例值:scenario-12345

3. 输出参数

参数名称 类型 描述
MetricLabelWithValuesSet Array of MetricLabelWithValues 指标所有的label和values数组
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询指标所有的label及values值

查询指标所有的label及values值

输入示例

POST / HTTP/1.1
Host: pts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMetricLabelWithValues
<公共请求参数>

{
    "JobId": "job-jbn1pvne",
    "ScenarioId": "scenario-frfvrab4",
    "ProjectId": "project-c9drst6a"
}

输出示例

{
    "Response": {
        "MetricLabelWithValuesSet": [
            {
                "MetricName": "pts_engine_req_total",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_req_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_checks_total",
                "LabelValuesSet": [
                    {
                        "LabelName": "check",
                        "LabelValues": [
                            "body.args.name1 equals value1",
                            "status is 200"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_num_vus",
                "LabelValuesSet": []
            },
            {
                "MetricName": "pts_engine_send_bytes_total",
                "LabelValuesSet": []
            },
            {
                "MetricName": "pts_engine_receive_bytes_total",
                "LabelValuesSet": []
            },
            {
                "MetricName": "pts_engine_iterations_total",
                "LabelValuesSet": []
            },
            {
                "MetricName": "pts_engine_iterations_duration_seconds",
                "LabelValuesSet": []
            },
            {
                "MetricName": "pts_engine_req_send_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_req_wait_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_req_receive_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_req_block_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_req_connect_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            },
            {
                "MetricName": "pts_engine_req_tls_handshake_duration_seconds",
                "LabelValuesSet": [
                    {
                        "LabelName": "service",
                        "LabelValues": [
                            "http://httpbin.org/get",
                            "http://www.baidu.com"
                        ]
                    },
                    {
                        "LabelName": "status",
                        "LabelValues": [
                            "200",
                            "502"
                        ]
                    },
                    {
                        "LabelName": "result",
                        "LabelValues": [
                            "502 Bad Gateway",
                            "ok"
                        ]
                    },
                    {
                        "LabelName": "method",
                        "LabelValues": [
                            "GET"
                        ]
                    },
                    {
                        "LabelName": "proto",
                        "LabelValues": [
                            "HTTP/1.1"
                        ]
                    },
                    {
                        "LabelName": "region",
                        "LabelValues": [
                            "ap-shanghai"
                        ]
                    }
                ]
            }
        ],
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.ResourceNotFound 资源不存在。
InternalError 内部错误。
InvalidParameter 参数错误。