日志服务预览aws导入信息

1. 接口描述

接口请求域名： cls.tencentcloudapi.com 。

本接口用于预览aws导入信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SearchS3RechargeInfo。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
TopicId	是	String	日志主题Id。通过获取日志主题列表获取日志主题Id。示例值：3faf22cb-5396-4aca-a3c3-c0831917aa15
Name	是	String	s3导入任务名称,最大支持128个字节。示例值：test_del_1
Bucket	是	String	s3存储桶示例值：echo-test2-857317597
S3Region	是	String	地域示例值：ap-southeast-1
AccessKeyId	是	String	访问密钥 ID（Access Key ID）示例值：AKIA**QG
SecretAccessKey	是	String	访问密钥Key（Secret Access Key）示例值：+AT*YOxU
Endpoint	否	String	自定义端点示例值：https://cos.example.com
Prefix	否	String	s3文件所在文件夹的前缀。默认为空，投递存储桶下所有的文件。示例值：/csv
Compress	否	String	压缩模式。支持: "", "gzip", "lzop", "snappy"。默认值：不压缩示例值：gzip

3. 输出参数

参数名称	类型	描述
Data	Array of String	匹配到的存储桶下的某个文件的前几行数据示例值：["# Mock Logs\n"]
Sum	Integer	匹配到的存储桶下的文件个数示例值：11
Path	String	当前预览文件路径示例值：mock-logs/README.md
Msg	String	预览获取数据失败原因示例值：some cause of failure
Status	Integer	状态。 0：成功 10000：参数错误，请确认参数 10001：授权失败，请确认授权 10002：获取文件列表失败，请稍后再试。若无法解决，请咨询在线支持或提交工单处理。 10003：桶内无相应前缀文件，请使用正确的桶、文件前缀和压缩方式 10004：文件下载失败，请稍后再试。若无法解决，请咨询在线支持或提交工单处理。 10005：文件解压缩失败，请选择正确的压缩方式然后再试 10006：读取文件内容失败，请确认文件可读 10007：文件预览失败，请稍后再试。若无法解决，请咨询在线支持或提交工单处理。示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 预览s3导入信息

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchS3RechargeInfo
<公共请求参数>

{
    "TopicId": "3faf22cb-5396-4aca-a3c3-c0831917aa15",
    "Name": "test_del_1",
    "Bucket": "echo-test2-857317597",
    "S3Region": "ap-southeast-1",
    "AccessKeyId": "AKIA**************QG",
    "SecretAccessKey": "+A**************************T*******YOxU",
    "Endpoint": "https://cos.example.com",
    "Compress": ""
}

输出示例

{
    "Response": {
        "Data": [
            "# Mock Logs\n"
        ],
        "Msg": "",
        "Path": "mock-logs/README.md",
        "Status": 0,
        "Sum": 11,
        "RequestId": "a7aee2da-edbb-4764-bf33-4da89e3d6d38"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
FailedOperation.BucketNoFile	桶内无相应前缀文件，请使用正确的桶、文件前缀和压缩方式。
FailedOperation.DecompressFile	文件解压缩失败，请选择正确的压缩方式。
FailedOperation.DownLoadFile	文件下载失败，请稍后再试。
FailedOperation.GetListFile	获取文件列表失败，请稍后再试。
FailedOperation.PreviewFile	文件预览失败，请稍后再试。
FailedOperation.ReadFile	读取文件内容失败，请确认文件可读。
FailedOperation.Timeout	操作超时
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.DbDuplication	数据库唯一键冲突。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。
ResourceNotFound.TopicNotExist	日志主题不存在。

预览aws导入信息

本页目录：