1. 接口描述
接口请求域名: cls.api3.fincloud.tencent.cn。
本接口用于创建日志主题。
默认接口请求频率限制:20次/秒。
接口更新时间:2025-07-30 00:32:22。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateTopic |
| Version | 是 | 否 | String | 公共参数,本接口取值:2020-10-16 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| LogsetId | 是 | 否 | String | 日志集ID 示例值: 57f5808c-4a55-11eb-b378-0242ac130002 |
| TopicName | 是 | 否 | String | 日志主题名称 示例值: topic_name |
| PartitionCount | 否 | 否 | Int64 | 日志主题分区个数。默认创建1个,最大支持创建10个分区。 示例值: 1 |
| Tags | 否 | 否 | Array of Tag | 标签描述列表,通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对,同一个资源只能绑定到同一个标签键下。 示例值:查看 |
| AutoSplit | 否 | 否 | Bool | 是否开启自动分裂,默认值为true。true表示开启自动分裂,false表示关闭自动分裂。 示例值: true |
| MaxSplitPartitions | 否 | 否 | Int64 | 开启自动分裂后,每个主题能够允许的最大分区数,默认值为50 示例值: 50 |
| StorageType | 否 | 否 | String | 日志主题的存储类型,可选值 hot(实时存储);默认为hot。 示例值: hot |
| Period | 否 | 否 | Int64 | 生命周期,单位天;可取值范围1~90。默认30天 示例值: 30 |
| SubAssumerName | 否 | 否 | String | 二级产品标识 测试 示例值: TKE_AUDIO |
| Describes | 否 | 否 | String | 日志主题描述 示例值: A部门日志主题 |
| HotPeriod | 否 | 否 | Uint64 | 0:关闭日志沉降。 非0:开启日志沉降后标准存储的天数。HotPeriod需要大于等于7,且小于Period。仅在StorageType为 hot 时生效 示例值: 7 |
| Encryption | 否 | 否 | Uint64 | 加密相关参数。 支持加密地域并且开白用户可以传此参数,其他场景不能传递该参数。 0或者不传: 不加密 1:kms-cls 云产品秘钥加密 示例值: 0 |
| BizType | 否 | 否 | Uint64 | 0: 日志主题topic 1: 时序主题topic 示例值: 0 |
| TopicId | 否 | 否 | String | 日志主题ID,格式为:用户自定义部分-用户appid,用户自定义部分仅支持小写字母、数字和-,且不能以-开头和结尾,长度为3至40字符,结尾使用-拼接用户appid 示例值: 57f5808c-4a55-11eb-b378-0242ac130002 |
| IsWebTracking | 否 | 否 | Bool | webtracking开关; false: 关闭 true: 开启 示例值: false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopicId | String | 日志主题ID 示例值: 57f5808c-4a55-11eb-b378-0242ac130002 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| LimitExceeded | 超过配额限制。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.LogsetNotExist | 指定的日志集不存在。 |
| LimitExceeded.Logset | 日志集数量超出限制。 |
| InvalidParameter.TopicConflict | 指定日志集下已经有同名的日志主题。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| FailedOperation.InvalidPeriod | 离线存储保存时间不得少于7天。 |
| LimitExceeded.Topic | 日志主题数目超过限制。 |