1. 接口描述
接口请求域名: rum.tencentcloudapi.com 。
返回吞吐率、首次消息时延或流畅度在整个时间窗及各时间桶上的平均值和 P50、P75、P95、P99。错误率与卡死率返回 InvalidParameter。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTDEMSSEPercentile。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| AppId | 是 | String | 应用 ID。这里是业务应用标识,不是腾讯云账号 AppId。 示例值:7 |
| StartTime | 是 | Integer | 开始时间,Unix 毫秒。 示例值:1710000000000 |
| EndTime | 是 | Integer | 结束时间,Unix 毫秒。须通过现有时间范围校验。 示例值:1710003600000 |
| Metric | 是 | String | 指标。只允许 token_throughput、first_message_delay、fluency。error_rate 与 stall_rate 返回 InvalidParameter。 示例值:first_message_delay |
| Filters | 否 | String | 筛选条件 JSON 字符串,格式为 [{Key,Op,Values}]。Op 只允许 in。Key 只允许 model_version、app_version、platform、os、region、is_error、is_stall、network_type、server_ip、isp、user_id。is_error 与 is_stall 的值只允许 true 或 false。 示例值:[{"Key":"model_version","Op":"in","Values":["gpt-4o"]}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| IntervalSec | Integer | 时间桶宽度,单位秒,与趋势查询使用同一套分桶。 示例值:3600 |
| Average | Float | 整个时间窗的算术平均。没有有效样本时为 null。 注意:此字段可能返回 null,表示取不到有效值。 示例值:420 |
| P50 | Float | 整个时间窗的 50 分位。没有有效样本时为 null。 注意:此字段可能返回 null,表示取不到有效值。 示例值:380 |
| P75 | Float | 整个时间窗的 75 分位。没有有效样本时为 null。 注意:此字段可能返回 null,表示取不到有效值。 示例值:510 |
| P95 | Float | 整个时间窗的 95 分位。没有有效样本时为 null。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2400 |
| P99 | Float | 整个时间窗的 99 分位。没有有效样本时为 null。 注意:此字段可能返回 null,表示取不到有效值。 示例值:8000 |
| Points | Array of TDEMSSEPercentilePoint | 各时间桶的平均值和分位。没有样本的桶不返回,全部没有样本时为空数组。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询大模型体验分位
输入示例
POST / HTTP/1.1
Host: rum.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTDEMSSEPercentile
<公共请求参数>
{
"AppId": "7",
"StartTime": 1710000000000,
"EndTime": 1710003600000,
"Filters": "[{\"Key\":\"model_version\",\"Op\":\"in\",\"Values\":[\"gpt-4o\"]}]",
"Metric": "first_message_delay"
}
输出示例
{
"Response": {
"IntervalSec": 3600,
"Average": 420,
"P50": 380,
"P75": 510,
"P95": 2400,
"P99": 8000,
"Points": [
{
"Time": 1710000000000,
"Average": 400,
"P50": 360,
"P75": 500,
"P95": 2100,
"P99": 7600
}
],
"RequestId": "37858f63-fa66-42f2-86af-52a83f742841"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 请求未CAM授权 |
| FailedOperation | 操作失败。 |
| FailedOperation.DataBaseException | 数据操作异常 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterCombination | 无效参数组合 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |