1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
es导入预览
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeEsRechargePreview。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Name | 是 | String | 名称:长度不超过64字符。 示例值:template_1 |
| TopicId | 是 | String | 日志主题id。 - 通过 获取日志主题列表 获取日志主题Id。 - 通过 创建日志主题 获取日志主题Id。 示例值:715094e3-01b0-4aeb-91f5-ee9f46a4a13c |
| Index | 是 | String | 索引信息。不同索引可以通过英文逗号分隔,支持通配符 示例值:base-2026-01- |
| Query | 是 | String | es查询语句。 示例值:tags.service.name:session |
| EsInfo | 是 | EsInfo | es集群配置信息。 |
| ImportInfo | 是 | EsImportInfo | es导入信息。 |
| TimeInfo | 是 | EsTimeInfo | es导入时间字段信息。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of String | 预览数据信息 示例值:["{"@timestamp":"2025-11-24T16:14:00+08:00""type":"mqtt_probe_metric"}"] |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 es数据预览
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEsRechargePreview
<公共请求参数>
{
"Name": "preview_test",
"TopicId": "d8f1bad5-80ad-427a-8dc9-3108778e39aa",
"Index": "louder_search",
"Query": "ab",
"EsInfo": {
"EsType": 2,
"AccessMode": 2,
"User": "es_user",
"Address": "127.0.0.1",
"Port": 9200,
"Password": "abc@syz"
},
"ImportInfo": {
"Type": 1,
"MaxDelay": 120,
"CheckInterval": 60
},
"TimeInfo": {
"Type": 1
}
}
输出示例
{
"Response": {
"Data": [
"{\"@__TIMESTAMP__\":1747258435179,\"Label_index\":null}"
],
"RequestId": "e0897b10-09df-49de-b0ec-8644f12972ec"
}
}
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 | 请求未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.Timeout | 操作超时 |
| InternalError | 内部错误。 |
| InternalError.DbError | DB错误。 |
| InternalError.IllegalRole | 角色非法。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DbDuplication | 数据库唯一键冲突。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.RecordOutOfLimit | 记录超过限制 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |