1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
获取日志离线导出任务列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeOfflineExportTask。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Limit | 是 | Integer | 分页参数 示例值：10 |
| Offset | 是 | Integer | 分页参数 示例值：0 |
| TaskName | 否 | String | 任务ID/任务名称 示例值：flow_border_out_31 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReturnCode | Integer | 返回状态码 0 成功 非0不成功 示例值：0 |
| ReturnMsg | String | 返回信息 success 成功 其他 不成功 示例值：success |
| Data | Array of OfflineExportTask | 离线导出任务列表 |
| Total | Integer | 任务数量 示例值：10 |
| ExportRemainQuota | Integer | 剩余导出文件配额，单位B 示例值：1073741824 |
| ExportQuota | Integer | 导出文件配额，单位B 示例值：1073741824 |
| ExportLimit | Integer | 导出数据限制 示例值：100 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取日志离线导出任务列表
获取日志离线导出任务列表
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOfflineExportTask
<公共请求参数>
{
"TaskName": "test-export",
"Limit": 1,
"Offset": 1
}输出示例
{
"Response": {
"Data": [
{
"TaskId": "322372",
"TaskName": "flow_border_out_31",
"DataLength": 0,
"Progress": 0,
"Status": 0,
"ExpireTime": "",
"ErrorInfo": "",
"CreateTime": "2025-01-07 09:18:56",
"UseUserCos": 0
}
],
"ExportLimit": -1,
"ExportQuota": 1099511627776,
"ExportRemainQuota": 1099511627776,
"RequestId": "64eb2796-219e-4f5c-a2a7-928c2dd99880",
"ReturnCode": 0,
"ReturnMsg": "success",
"Total": 142440
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
