1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
本接口用以查询七层域名业务的回源时序数据,可以通过指定查询维度 DimensionName 进行分组查询,返回多组时序数据。
单次请求最多返回 50,000 个数据项 TimingDataItem 。数据项总数的计算规则如下:
指标个数 * 时间点个数 * 维度值个数 = 数据项总数
-
指标个数:
MetricNames的列表长度。 -
时间点个数:
(EndTime - StartTime) / Interval。 -
维度值个数:
- 当未指定
DimensionName时,默认按账号维度汇总数据,维度值个数为 1。 - 当
DimensionName = domain时,维度值个数为Filters中domain过滤条件指定的域名列表长度。 - 当
DimensionName = origin-status-code-category时,维度值个数默认为6。 - 当
DimensionName = origin-status-code时,维度值个数默认为600。
- 当未指定
DimensionName 可以与 Filters 组合使用,通过在 Filters 中指定 DimensionName 对应的过滤条件以限制维度值个数。
示例
以查询某一小时的具体状态码维度的时序数据为例,假设查询条件如下:
MetricNames = ["l7Flow_request_hy"](指标个数 = 1)StartTime = 2025-10-01T06:00:00+08:00,EndTime = 2025-10-01T06:59:59+08:00,Interval = "min"(时间点个数 = 60)DimensionName = origin-status-code,Filters = [{"originStatusCode": ["0", "4xx", "5xx"]}](维度值个数 = 201)
则数据项总数为:
1 × 60 × 201 = 12060
未超过限制。
注意:若查询的数据项总数超过 50,000,系统会返回错误 LimitExceeded.TimingDataItemLimitExceeded。
此时,请通过调整入参减少单次查询的数据项至 50,000 以内,可采取的做法有:
-
减少时间点个数:
- 缩短查询时间范围(
StartTime到EndTime之间的时间跨度)。 - 选择更大的时间间隔(
Interval)。
- 缩短查询时间范围(
-
减少维度值个数:
- 调整
Filters,指定更少的domain或originStatusCode列表。
- 调整
-
减少指标值个数:
- 调整
MetricNames,指定更少的查询指标。
- 调整
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeTimingL7OriginPullData。 |
| Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ZoneIds.N | 是 | Array of String | 站点 ID 集合,此参数必填。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据,请用 * 代替,查询账号级别数据需具备本接口全部站点资源权限。 |
| MetricNames.N | 是 | Array of String | 指标列表,取值有:
|
| StartTime | 是 | Timestamp ISO8601 | 开始时间。 |
| EndTime | 是 | Timestamp ISO8601 | 结束时间。查询时间范围(EndTime - StartTime)需小于等于 31 天。 |
| Interval | 否 | String | 查询时间粒度,取值有:
|
| Filters.N | 否 | Array of QueryCondition | 过滤条件,详细的过滤条件如下:
注意:当 DimensionName 不为空时,仅支持 equals 运算符。 |
| DimensionName | 否 | String | 查询维度名称,取值有:
若 若
DimensionName = origin-status-code 时:注意:当指定 DimensionName 查询时,禁止并发调用。若超出查询频率限制,会返回错误 InvalidParameter.ActionInProgress 。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 查询结果的总条数。 |
| TimingDataRecords | Array of TimingDataRecord | 回源时序数据列表。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询全部站点的七层回源数据
查询全部站点下所有域名 2025-12-01T00:00:00Z ~ 2025-12-02T00:00:00Z 期间 l7Flow_outFlux_hy 指标的汇总数据。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7OriginPullData
<公共请求参数>
{
"ZoneIds": [
"*"
],
"MetricNames": [
"l7Flow_outFlux_hy"
],
"StartTime": "2025-12-01T00:00:00Z",
"EndTime": "2025-12-02T00:00:00Z"
}
输出示例
{
"Response": {
"TimingDataRecords": [
{
"TypeKey": "1300224863",
"TypeValue": [
{
"Avg": 157,
"Detail": [
{
"Timestamp": 1764547200,
"Value": 0
}
],
"Max": 4643,
"MetricName": "l7Flow_outFlux_hy",
"Sum": 45461
}
]
}
],
"TotalCount": 1,
"RequestId": "853e9004-b4b0-4ae8-8a8f-510fe42f01e2"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ActionInProgress | 操作频繁,请稍后重试。 |
| InvalidParameterValue.FiltersMustIncludeDimensionName | 当指定 DimensionName 参数时,Filters 字段必须包含与 DimensionName 对应的过滤条件。 |
| LimitExceeded.QueryTimeLimitExceeded | 查询时间范围超出限制。 |
| LimitExceeded.TimingDataItemLimitExceeded | 本次查询的时序数据项超出上限。 |
| OperationDenied.OriginPullDataNotSupported | 当前主账号不具备回源数据查询接口权限,请联系售后服务。 |