1. 接口描述
接口请求域名： teo.tencentcloudapi.com 。
通过本接口查询实时日志投递任务列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRealtimeLogDeliveryTasks。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| Offset | 否 | Integer | 分页查询偏移量。默认值：0。 |
| Limit | 否 | Integer | 分页查询限制数目。默认值：20，最大值：1000。 |
| Filters.N | 否 | Array of AdvancedFilter | 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有实时日志投递任务信息。详细的过滤条件如下： cls: 推送到腾讯云 CLS； custom_endpoint：推送到自定义 HTTP(S) 地址； s3：推送到 AWS S3 兼容存储桶地址。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合查询条件的实时日志投递任务个数。 |
| RealtimeLogDeliveryTasks | Array of RealtimeLogDeliveryTask | 符合查询条件的所有实时日志投递任务列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询某个站点下的所有实时日志投递任务信息
查询指定 zone-id 下的所有实时日志投递任务信息。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealtimeLogDeliveryTasks
<公共请求参数>
{
"ZoneId": "zone-2ur49nglp1a2",
"Offset": 0,
"Limit": 1000
}输出示例
{
"Response": {
"RealtimeLogDeliveryTasks": [
{
"Area": "overseas",
"CLS": {
"LogSetId": "980611e5-3eb2-430f-a0cc-e1c4e84a9e40",
"LogSetRegion": "ap-guangzhou",
"TopicId": "d258c060-dc6e-4586-8b7c-6a951667fa7a"
},
"CreateTime": "2024-03-26T03:00:39+08:00",
"CustomEndpoint": null,
"CustomFields": [],
"DeliveryConditions": [],
"DeliveryStatus": "enabled",
"EntityList": [
"qqqq.loliyu.com"
],
"Fields": [
"RequestID",
"ClientIP",
"ClientRegion",
"RequestTime",
"RequestHost",
"RequestBytes",
"RequestMethod",
"RequestUrl",
"RequestUrlQueryString",
"RequestUA",
"RequestRange",
"RequestReferer",
"RequestProtocol",
"RemotePort",
"EdgeCacheStatus",
"EdgeResponseStatusCode",
"EdgeResponseBytes",
"EdgeResponseTime",
"EdgeInternalTime",
"ClientState",
"ClientISP",
"EdgeServerID",
"EdgeServerIP"
],
"LogFormat": null,
"LogType": "domain",
"S3": null,
"Sample": 0,
"TaskId": "f0e1686a-1c4e-4f15-967b-5afb2a0803ea",
"TaskName": "ccc",
"TaskType": "cls",
"UpdateTime": "2024-03-26T03:10:13+08:00"
}
],
"RequestId": "05205d07-f582-444d-b558-b338a3f68857",
"TotalCount": 1
}
}示例2 根据加速域名查询对应实时日志投递任务信息
查询指定加速域名对应的实时日志投递任务信息。根据输出返回结果中的 TotalCount 为 0 可以判断此加速域名暂未被添加到任何实时日志投递任务中。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRealtimeLogDeliveryTasks
<公共请求参数>
{
"ZoneId": "zone-2o7b38ba1hvr",
"Offset": 0,
"Limit": 20,
"Filters": [
{
"Name": "entity-list",
"Values": [
"domain.example.com"
]
}
]
}输出示例
{
"Response": {
"TotalCount": 0,
"RealtimeLogDeliveryTasks": [],
"RequestId": "f025c1f0-cb83-41b1-bb7d-565af7e28479"
}
}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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |