1. 接口描述
接口请求域名： tdmq.tencentcloudapi.com 。
修改主题备注和分区数
默认接口请求频率限制：50次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyTopic。 |
| Version | 是 | String | 公共参数，本接口取值：2020-02-17。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvironmentId | 是 | String | 环境（命名空间）名称。 示例值：default |
| TopicName | 是 | String | 主题名。 示例值：test_topic |
| Partitions | 是 | Integer | 分区数，必须大于或者等于原分区数，若想维持原分区数请输入原数目，修改分区数仅对非全局顺序消息起效果，不允许超过32个分区。 示例值：3 |
| ClusterId | 是 | String | Pulsar 集群的ID 示例值：pulsar-xxxxx |
| Remark | 否 | String | 备注，128字符以内。 示例值：修改分区为3 |
| MsgTTL | 否 | Integer | 未消费消息过期时间，单位：秒，取值范围：60秒~15天。 示例值：60 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Partitions | Integer | 分区数 示例值：3 |
| Remark | String | 备注，128字符以内。 示例值：修改分区为3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改主题属性
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTopic
<公共请求参数>
{
"EnvironmentId": "abc",
"TopicName": "abc",
"Partitions": 1,
"Remark": "abc",
"ClusterId": "abc",
"MsgTTL": 1
}输出示例
{
"Response": {
"Partitions": 3,
"Remark": "修改分区为3",
"RequestId": "c276a96f-1612-47ad-9562-da06d4fdf1ed"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | CAM鉴权不通过。 |
| FailedOperation | 操作失败。 |
| FailedOperation.GetTopicPartitionsFailed | 获取主题分区数失败。 |
| FailedOperation.UpdateTopic | 主题更新失败。 |
| InternalError.SystemError | 系统错误。 |
| InvalidParameterValue.InvalidParams | 参数值不在允许范围内。 |
| MissingParameter.NeedMoreParams | 必要参数没有传递。 |
| ResourceNotFound.Cluster | 集群不存在。 |
| ResourceNotFound.Topic | 主题不存在。 |