1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于创建cos导入任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCosRecharge。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TopicId | 是 | String | 日志主题 ID 示例值:ae13f7db-00b5-41ac-916e-407802axxxxx |
LogsetId | 是 | String | 日志集ID 示例值:0af7e6bb-fc91-4ee8-ad24-1129e9cxxxxx |
Name | 是 | String | 投递任务名称 示例值:cos导入 |
Bucket | 是 | String | COS存储桶,详见产品支持的存储桶命名规范。 示例值:examplebucket-1250000000 |
BucketRegion | 是 | String | COS存储桶所在地域,详见产品支持的地域列表。 示例值:ap-guangzhou |
LogType | 是 | String | 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文; 默认为minimalist_log 示例值:minimalist_log |
Prefix | 否 | String | COS文件所在文件夹的前缀。默认为空,投递存储桶下所有的文件。 示例值:var/xxx |
Compress | 否 | String | supported: "", "gzip", "lzop", "snappy"; 默认空 示例值:gzip |
ExtractRuleInfo | 否 | ExtractRuleInfo | 提取规则,如果设置了ExtractRule,则必须设置LogType |
TaskType | 否 | Integer | COS导入任务类型。1:一次性导入任务;2:持续性导入任务。默认为1:一次性导入任务 示例值:1 |
Metadata.N | 否 | Array of String | 元数据。 示例值:["bucket","object"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Id | String | COS导入任务id 注意:此字段可能返回 null,表示取不到有效值。 示例值:ca092608-98e8-4ad9-83c5-a6b3bbexxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建cos导入任务
创建cos导入任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCosRecharge
<公共请求参数>
{
"TopicId": "ae13f7db-00b5-41ac-916e-407802axxxxx",
"LogsetId": "0af7e6bb-fc91-4ee8-ad24-1129e9cxxxxx",
"Name": "test_name",
"Bucket": "examplebucket-1250000000",
"BucketRegion": "ap-guangzhou",
"Prefix": "text_prefix",
"LogType": "minimalist_log",
"Compress": "gzip",
"ExtractRuleInfo": {
"TimeKey": "date",
"TimeFormat": "%Y-%m-%d %H:%M:%S",
"Delimiter": "|",
"LogRegex": ".*",
"BeginRegex": "^",
"Keys": [
"date",
"",
"content"
],
"FilterKeyRegex": [
{
"Key": "xxx",
"Regex": "ssss"
}
],
"UnMatchLogKey": "testlog",
"UnMatchUpLoadSwitch": true,
"Backtracking": -1
}
}
输出示例
{
"Response": {
"Id": "ca092608-98e8-4ad9-83c5-a6b3bbexxxxx",
"RequestId": "dc78ee34-237b-41c7-8fcd-601a99b271f6"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.Timeout | 操作超时 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DbDuplication | 数据库唯一键冲突。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.ACLFailed | ACL校验失败。 |
OperationDenied.AccountDestroy | 账户已销毁。 |
OperationDenied.AccountIsolate | 账户欠费。 |
OperationDenied.AccountNotExists | 账户不存在。 |
ResourceNotFound.TopicNotExist | 日志主题不存在。 |