创建日志主题

最近更新时间:2024-06-26 01:12:09

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

本接口用于创建日志主题。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTopic。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
LogsetId String 日志集ID
示例值:xxxxxx-xx-xx-xx-xxxxxxxx
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 生命周期,单位天,标准存储取值范围1~3600,低频存储取值范围7~3600天。取值为3640时代表永久保存。
不传此值,默认获取该日志主题对应日志集的Period值(当获取失败时默认为30天)。
示例值:30
Describes String 日志主题描述
示例值:xx部门xx任务topic
HotPeriod Integer 0:关闭日志沉降。
非0:开启日志沉降后标准存储的天数,HotPeriod需要大于等于7,且小于Period。
仅在StorageType为 hot 时生效。
示例值:7
IsWebTracking Boolean 免鉴权开关。 false:关闭; true:开启。默认为false。
开启后将支持指定操作匿名访问该日志主题。详情请参见日志主题
示例值:false
Extends TopicExtendInfo 日志主题扩展信息

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": "xxxxxx-xx-xx-xx-xxxxxxxx",
    "TopicName": "testname",
    "PartitionCount": 1,
    "Tags": [],
    "Period": 12
}

输出示例

{
    "Response": {
        "TopicId": "xxxx-xx-xx-xx-xxxxxxxx",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.InvalidPeriod 离线存储保存时间不得少于7天。
FailedOperation.TopicCreating topic创建中
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.TopicConflict 指定日志集下已经有同名的日志主题。
LimitExceeded 超过配额限制。
LimitExceeded.Logset 日志集数量超出限制。
LimitExceeded.Topic 日志主题数目超过限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.LogsetNotExist 指定的日志集不存在。