1. 接口描述
接口请求域名: clb.tencentcloudapi.com 。
创建主题,默认开启全文索引和键值索引。如果不存在CLB专有日志集,则创建失败。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateTopic。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TopicName | 是 | String | 日志主题的名称。 示例值:clb-topic |
PartitionCount | 否 | Integer | 主题分区Partition的数量,不传参默认创建1个,最大创建允许10个,分裂/合并操作会改变分区数量,整体上限50个。 示例值:3 |
TopicType | 否 | String | 日志类型,ACCESS:访问日志,HEALTH:健康检查日志,默认ACCESS。 示例值:ACCESS |
Period | 否 | Integer | 日志集的保存周期,单位:天,默认30天,范围[1, 3600]。 示例值:30 |
StorageType | 否 | String | 日志主题的存储类型,可选值 HOT(标准存储),COLD(低频存储);默认为HOT。 示例值:HOT |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TopicId | String | 日志主题的 ID。 示例值:b046ae5f-00cf-4e90-880c-215e5ae7b6xy |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建主题。
创建主题。
输入示例
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTopic
<公共请求参数>
{
"PartitionCount": "3",
"TopicName": "clb-topic"
}
输出示例
{
"Response": {
"TopicId": "b046ae5f-00cf-4e90-880c-215e5ae7b6xy",
"RequestId": "dccf2ce3-0277-465a-9c60-260cfb141d65"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.FormatError | 参数格式错误。 |
InvalidParameterValue.Duplicate | 参数值有重复。 |
InvalidParameterValue.InvalidFilter | Filter参数输入错误。 |
InvalidParameterValue.Length | 参数长度错误。 |
InvalidParameterValue.Range | 参数取值范围错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient | 资源不足。 |
UnauthorizedOperation | 未授权操作。 |