1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于获取cos导入配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeS3Recharges。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TopicId | 是 | String | 日志主题Id。
示例值:3faf22cb-5396-4aca-a3c3-c0831917aa15 |
| Filters.N | 否 | Array of Filter |
注意:每次请求的 Filters 的上限为10,Filter.Values 的上限为10。 |
| Offset | 否 | Integer | 分页的偏移量,默认值为0。 示例值:0 |
| Limit | 否 | Integer | 分页单页限制数目,默认值为20,最大值100。 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Infos | Array of S3RechargeInfo | S3导入任务配置列表 |
| Total | Integer | 任务总数 示例值:2 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询s3导入任务列表
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeS3Recharges
<公共请求参数>
{
"TopicId": "3faf22cb-5396-4aca-a3c3-c0831917aa15",
"Filters": [
{
"Key": "bucket",
"Values": [
"echo*************597"
]
}
],
"Offset": 0,
"Limit": 10
}
输出示例
{
"Response": {
"Infos": [
{
"AccessKeyId": "AKI**************CQG",
"Bucket": "echo*************597",
"Compress": "gzip",
"CreateTime": 1783153774,
"Enable": 1,
"Endpoint": "https://cos.example.com",
"ExtractRule": {
"Address": "",
"AdvanceFilterRules": [],
"Backtracking": null,
"BeginRegex": "\\[\\d+-\\d+-\\w+:\\d+:\\d+,\\d+\\]\\s+\\[\\w+\\]\\s+.*",
"Delimiter": "",
"EventLogRules": [],
"FilterKeyRegex": [],
"IsGBK": 0,
"JsonStandard": 0,
"Keys": [
"timestamp"
],
"LogRegex": "\\s*\\[(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2},\\d{3})\\]\\s+\\[(\\w+)\\]\\s+([\\s\\S]*)\\s*",
"MetaTags": [],
"MetadataType": 0,
"ParseProtocol": "",
"PathRegex": "",
"Protocol": "",
"RawLogKey": "",
"TimeFormat": "",
"TimeKey": "",
"UnMatchLogKey": "LogParseFailure",
"UnMatchUpLoadSwitch": true
},
"LogType": "multiline_fullregex_log",
"LogsetId": "7fb0245e-2006-4e0f-9153-c5f6b7110b4c",
"Metadata": [
"bucket"
],
"Name": "test_del_1",
"Prefix": "csv/",
"Progress": 0,
"S3Region": "ap-so*********",
"Status": 0,
"TaskId": "b2fbb75a-b5ee-479c-9db4-541c63c0b4c4",
"TaskType": 1,
"TopicId": "3faf22cb-5396-4aca-a3c3-c0831917aa15",
"UpdateTime": 1783153774
}
],
"Total": 2,
"RequestId": "ce50cc05-e9ea-49cf-88f5-3d5aa2346986"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.TopicConflict | 指定日志集下已经有同名的日志主题。 |
| LimitExceeded | 超过配额限制。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |