1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于创建日志或指标主题。
默认接口请求频率限制:100次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateTopic。 |
| Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| LogsetId | 是 | String | 日志集ID
示例值:64aebb76-644b-4e60-90f6-3c183094da40-ab2f-47ab-9dcd-31413b057812 |
| TopicName | 是 | String | 主题名称
示例值:testname |
| PartitionCount | 否 | Integer | 主题分区个数。默认创建1个,最大支持创建10个分区。 示例值:1 |
| Tags.N | 否 | Array of Tag | 标签描述列表,通过指定该参数可以同时绑定标签到相应的主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 |
| AutoSplit | 否 | Boolean | 是否开启自动分裂,默认值为true 示例值:true |
| MaxSplitPartitions | 否 | Integer | 开启自动分裂后,每个主题能够允许的最大分区数,默认值为50 示例值:50 |
| StorageType | 否 | String | 日志主题的存储类型,可选值 hot(标准存储),cold(低频存储);默认为hot。指标主题不支持该配置。 示例值:hot |
| Period | 否 | Integer | 存储时间,单位天。
示例值:30 |
| Describes | 否 | String | 主题描述 示例值:xx部门xx任务topic |
| HotPeriod | 否 | Integer | 0:日志主题关闭日志沉降。 示例值:7 |
| Encryption | 否 | Integer | 加密相关参数。 支持加密地域并且开白用户可以传此参数,其他场景不能传递该参数。 示例值:0 |
| CustomKmsInfo | 否 | CustomKmsInfo | 用户自定义 KMS 密钥信息;为空则使用默认密钥(别名 KMS-CLS) 当参数 Encryption为 1 时有效。 |
| BizType | 否 | Integer | 主题类型
示例值:0 |
| TopicId | 否 | String | 主题自定义ID,格式为:用户自定义部分-用户APPID。未填写该参数时将自动生成ID。
示例值:eb9ec10d-1343-4386-9a6e-75fd9d68726e |
| IsWebTracking | 否 | Boolean | 免鉴权开关。 false:关闭; true:开启。默认为false。 示例值:false |
| Extends | 否 | TopicExtendInfo | 主题扩展信息 |
| IsSourceFrom | 否 | Boolean | 开启记录公网来源ip和服务端接收时间 示例值:false |
| BillingMode | 否 | Integer | 计费模式 枚举值:
默认值:0 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopicId | String | 主题ID 示例值:xxxx-xx-xx-xx-xxxxxxxx |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建日志主题
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTopic
<公共请求参数>
{
"LogsetId": "6b2c40ae-2bd0-445e-adf2-3129a59fb6d5",
"TopicName": "cloud_topic_test",
"PartitionCount": 1,
"AutoSplit": true,
"MaxSplitPartitions": 10,
"StorageType": "hot",
"Period": 30,
"Describes": "场景日志主题",
"BizType": 0,
"IsSourceFrom": false,
"BillingMode": 0
}
输出示例
{
"Response": {
"TopicId": "8aa25df8-6065-45de-8b3e-b65f8797e2a1",
"RequestId": "cca37d5e-f542-44f4-a1bf-5fa09fb66439"
}
}
示例2 创建日志主题并打标签
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTopic
<公共请求参数>
{
"LogsetId": "7fb0245e-2006-4e0f-9153-c5f6b7110b4c",
"TopicName": "business_log_test1",
"PartitionCount": 1,
"Tags": [
{
"Key": "business_log_key",
"Value": "business_log_value"
}
],
"AutoSplit": true,
"MaxSplitPartitions": 3,
"StorageType": "hot",
"Period": 1,
"Describes": "业务日志",
"BizType": 0,
"IsWebTracking": false,
"Extends": {
"AnonymousAccess": {
"Operations": [
"realtimeProducer"
],
"Conditions": [
{
"Attributes": "VpcID",
"Rule": 1,
"ConditionValue": "vpc-********"
}
]
}
},
"IsSourceFrom": true,
"BillingMode": 0
}
输出示例
{
"Response": {
"TopicId": "6ce29951-838f-44de-a321-35e3e25798eb",
"RequestId": "4207ca55-4498-4c6b-a329-d27c8c4fd144"
}
}
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.InvalidPeriod | 离线存储保存时间不得少于7天。 |
| FailedOperation.TopicCreating | topic创建中 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.TopicConflict | 指定日志集下已经有同名的日志主题。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.BillingTopicOutOfLimit | 一个uin只能创建一个billing topic |
| LimitExceeded.Logset | 日志集数量超出限制。 |
| LimitExceeded.Topic | 日志主题数目超过限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| ResourceNotFound.LogsetNotExist | 指定的日志集不存在。 |
| UnsupportedOperation.UnsupportedRegion | 当前地域不支持 |