1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于修改aws导入任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyS3Recharge。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TaskId | 是 | String | 导入任务Id 示例值:e7a88e07-*-92aa-2777c1333d2f |
| TopicId | 是 | String | 日志主题Id。
示例值:3faf22cb-*-a3c3-c0831917aa15 |
| Name | 否 | String | s3导入任务名称,最大支持128个字节。 同一个TopicId下的s3任务Name必须唯一 示例值:test_del_1 |
| TaskType | 否 | Integer | s3导入任务类型. 枚举值:
示例值:1 |
| Enable | 否 | Integer | 是否启用 枚举值:
示例值:1 |
| Bucket | 否 | String | s3存储桶 示例值:echo-***7597 |
| S3Region | 否 | String | 地域 示例值:ap-so* |
| AccessKeyId | 否 | String | 访问密钥 ID(Access Key ID) 示例值:AKIA*CQG |
| SecretAccessKey | 否 | String | 访问密钥Key(Secret Access Key) 示例值:+AW****IYOxU |
| Endpoint | 否 | String | 自定义端点 示例值:https://cos.example.com |
| LogType | 否 | String | 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文; 示例值:multiline_fullregex_log |
| Prefix | 否 | String | s3文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。 示例值:csv/ |
| Compress | 否 | String | 压缩模式。支持: "", "gzip", "lzop", "snappy"。 示例值:gzip |
| ExtractRuleInfo | 否 | ExtractRuleInfo | 提取规则,如果设置了ExtractRule,则必须设置LogType |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改s3导入任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyS3Recharge
<公共请求参数>
{
"TaskId": "e7a88e07-*********-92aa-2777c1333d2f",
"TopicId": "3faf22cb-*********-a3c3-c0831917aa15",
"Name": "test_del_1",
"TaskType": 1,
"Enable": 1,
"Bucket": "echo-***********7597",
"S3Region": "ap-so*********",
"AccessKeyId": "AKIA*************CQG",
"SecretAccessKey": "+AW********************************IYOxU",
"Endpoint": "https://cos.example.com",
"LogType": "multiline_fullregex_log",
"Prefix": "csv/",
"Compress": "gzip",
"ExtractRuleInfo": {
"LogRegex": "\\s*\\[(\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2},\\d{3})\\]\\s+\\[(\\w+)\\]\\s+([\\s\\S]*)\\s*",
"BeginRegex": "\\[\\d+-\\d+-\\w+:\\d+:\\d+,\\d+\\]\\s+\\[\\w+\\]\\s+.*",
"Keys": [
"timestamp"
],
"UnMatchUpLoadSwitch": true,
"UnMatchLogKey": "LogParseFailure"
}
}
输出示例
{
"Response": {
"RequestId": "b696bb96-e1d6-45b7-a646-db03d17c1a41"
}
}
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 | 操作失败。 |
| FailedOperation.Timeout | 操作超时 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.DbDuplication | 数据库唯一键冲突。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |