1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口仅创建下载任务,任务返回的下载地址,请用户调用DescribeExports查看任务列表。其中有下载地址CosPath参数。参考文档https://cloud.tencent.com/document/product/614/56449
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateExport。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TopicId | 是 | String | 日志主题ID 示例值:ee20bb16-3025-4048-b81a-dd436373062e |
Count | 是 | Integer | 日志导出数量, 最大值5000万 示例值:100 |
Query | 是 | String | 日志导出检索语句,不支持[SQL语句] 示例值:status:200 |
From | 是 | Integer | 日志导出起始时间,毫秒时间戳 示例值:1607499107000 |
To | 是 | Integer | 日志导出结束时间,毫秒时间戳 示例值:1607499207000 |
Order | 否 | String | 日志导出时间排序。desc,asc,默认为desc 示例值:desc |
Format | 否 | String | 日志导出数据格式。json,csv,默认为json 示例值:json |
SyntaxRule | 否 | Integer | 语法规则, 默认值为0。 0:Lucene语法,1:CQL语法。 示例值:1 |
DerivedFields.N | 否 | Array of String | 导出字段 示例值:["timestamp","a","b"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ExportId | String | 日志导出ID。 示例值:57196a6a-7622-47be-bc92-d2ebea959a0f |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建日志导出
本接口仅创建下载任务,任务返回的下载地址,请用户调用DescribeExports查看任务列表。其中有下载地址CosPath参数。
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateExport
<公共请求参数>
{
"TopicId": "ee20bb16-3025-4048-b81a-dd436373062e",
"Query": "status:200",
"Count": 100,
"Order": "desc",
"Format": "json",
"From": 1607499107000,
"To": 1607499207000
}
输出示例
{
"Response": {
"ExportId": "57196a6a-7622-47be-bc92-d2ebea959a0f",
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.TopicClosed | 日志主题已关闭。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded.Export | 创建日志导出任务数量超出限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AccountDestroy | 账户已销毁。 |
OperationDenied.AccountIsolate | 账户欠费。 |
OperationDenied.AccountNotExists | 账户不存在。 |
ResourceNotFound.TopicNotExist | 日志主题不存在。 |