预览cos导入信息

最近更新时间: 2026-09-17 00:06:36

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

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

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

接口更新时间：2025-01-18 01:07:04。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：SearchCosRechargeInfo
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
TopicId	是	否	String	日志主题 ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
LogsetId	是	否	String	日志集ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002
Name	是	否	String	投递任务名称示例值： cos导入任务
Bucket	是	否	String	COS存储桶，详见产品支持的存储桶命名规范。示例值： examplebucket-1-1250000000
BucketRegion	是	否	String	COS存储桶所在地域，详见产品支持的地域列表。示例值： region
Prefix	否	否	String	COS文件所在文件夹的前缀。默认为空，投递存储桶下所有的文件。示例值： var/log
Compress	否	否	String	压缩模式: "", "gzip", "lzop", "snappy"; 默认"" 示例值： gzip

3. 输出参数

参数名称	类型	描述
Data	Array of String	匹配到的存储桶下的某个文件的前几行数据示例值： [{"metric":{"code":"InternalError","region":"region","service_name":"service1","url":"api1"},"values":[[1735040190,"100"],[1735040205,"91"],[1735040310,"98"],[1735040325,"85"],[1735040340,"76"],[1735040730,"100"]]}]
Sum	Uint64	匹配到的存储桶下的文件个数示例值： 1
Path	String	当前预览文件路径示例值： https://bucket1.region.demo.com/csv/g.gz
Msg	String	预览获取数据失败原因示例值：授权失败，请确认授权
Status	Int64	状态示例值： 0
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。

5. 示例

示例1 预览cos导入信息

输入示例

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

{
    "TopicId": "e6a94ed2-8191-49ac-ab67-90e33d2f1111",
    "LogsetId": "11114ed2-8191-49ac-ab67-90e33d2f3974",
    "Name": "test_name",
    "Bucket": "examplebucket-1-1250000000",
    "BucketRegion": "ap-region",
    "Prefix": "text_prefix",
    "Compress": "gzip"
}

输出示例

{
    "Response": {
        "Msg": "", 
        "Status":0,
        "Data": [
            "2021-11-09 20:16:29.038 INFO    apis/report.go:108      report data success, size 1",
            "2021-11-09 20:16:29.039 INFO    apis/report.go:108      report data success, size 1",
            "2021-11-09 20:16:29.040 INFO    apis/report.go:108      report data success, size 1",
            "2021-11-09 20:16:29.041 INFO    apis/report.go:108      report data success, size 1",
            "2021-11-09 20:16:29.042 INFO    apis/report.go:108      report data success, size 1"
        ],
        "Sum": 10000,
        "Path":"https://bucket1.ap-region.myapi.com/csv/test.gz",
        "RequestId": "e6a94ed2-8191-49ac-ab67-90e33d2f3974"
    }
}