1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
新建CLS投递任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateCLSDeliverTask。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| TaskName | 是 | String | 任务名称 参数格式: 示例值:b***_test_ap-tokyo_cross |
| SourceTopicConfig | 是 | SourceTopicConfig | 源主题信息 |
| TargetTopicConfig | 是 | TargetTopicConfig | 目标主题信息 |
| DeliverRule | 是 | DeliverRule | 投递规则 |
| Compliance | 是 | Integer | 合规承诺。 枚举值:
示例值:1 |
| HasServicesLog | 否 | Integer | 是否开启投递服务日志。 枚举值:
默认值:2 示例值:2 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务id 示例值:5c1f1002-ceb1-4b45-a2f9-bcfc1fbd23ed |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建投递任务
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCLSDeliverTask
<公共请求参数>
{
"TaskName": "b*******_test_ap-tokyo_cross",
"SourceTopicConfig": {
"TopicFilterType": 1,
"LogsetId": "ca5938d1-e027-409c-a345-16ce7b5e8d98",
"Topics": [
{
"TopicId": "b*******-test-ok-1254077820"
}
]
},
"TargetTopicConfig": {
"AccountType": 1,
"Region": "ap-*****",
"LogsetId": "16bcb721-0101-4c6f-8c4c-aa0e290ab5da",
"TopicId": "32d29136-bdfc-4749-928b-a0b24d62a3b8"
},
"DeliverRule": {
"DataScope": 3
},
"Compliance": 1,
"HasServicesLog": 2
}
输出示例
{
"Response": {
"TaskId": "5c1f1002-ceb1-4b45-a2f9-bcfc1fbd23ed",
"RequestId": "2ade24da-8ed5-4680-bf2e-c2b9e1be01f8"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound.LogsetNotExist | 指定的日志集不存在。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |