ModifyTopic
最近更新时间: 2025-10-20 17:05:57
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于修改日志主题。
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyTopic |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| TopicId | 是 | 否 | String | 日志主题ID |
| TopicName | 否 | 否 | String | 日志主题名称 |
| Tags | 否 | 否 | Array of Tag | 标签描述列表，通过指定该参数可以同时绑定标签到相应的日志主题。最大支持10个标签键值对，并且不能有重复的键值对。 |
| Status | 否 | 否 | Bool | 该日志主题是否开始采集 |
| AutoSplit | 否 | 否 | Bool | 是否开启自动分裂 |
| MaxSplitPartitions | 否 | 否 | Int64 | 若开启最大分裂，该主题能够能够允许的最大分区数 |
| Period | 否 | 否 | Int64 | 生命周期，单位天；可取值范围1~366 |
| UserSample | 否 | 否 | String | 用户自定义抽样配置 |
| UserSampleStatus | 否 | 否 | Bool | 用户抽样配置开关：默认关闭 |
| StorageType | 否 | 否 | String | 存储类型：low 低频 |
| Describes | 否 | 否 | String | 日志主题描述 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| LimitExceeded | 超过配额限制。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| FailedOperation.TopicIsolated | 日志主题已隔离。 |
| FailedOperation.TopicClosed | 日志主题已关闭。 |
| InvalidParameter.TopicConflict | 指定日志集下已经有同名的日志主题。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
| FailedOperation.InvalidPeriod | 离线存储保存时间不得少于7天。 |