变更主题
更新时间:2023-06-30
该接口用于变更集群中指定主题(topic)的配置信息。
- 集群处于服务中状态(ACTIVE)。
请求结构
PUT /v{version}/clusters/{clusterId}/topics/{topicName} HTTP/1.1
Host: kafka-api.bj.baidubce.com
Authorization: authorization string
{
"partitionNum": partitionNum,
"otherConfigs": {
"message.timestamp.type":"message.timestamp.type",
"cleanup.policy":"cleanup.policy",
"min.insync.replicas":"min.insync.replicas",
"retention.ms":"retention.ms",
"segment.ms":"segment.ms",
"max.message.bytes":"max.message.bytes"
}
}
请求头域
除公共头域外,无其他特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
clusterId | String | 是 | URL参数 | 待查询的集群ID |
topicName | String | 是 | URL参数 | 待变更topic的名称 |
partitionNum | int | 否 | RequestBody参数 | topic的目标变更分区数,只支持增大分区数,不支持缩减分区数,最大分区数为500 |
otherConfigs | Map<String, String> | 否 | RequestBody参数 | 待变更topic的配置项,具体支持的配置项参见TopicConfig |
返回头域
除公共头域外,无其他特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
topicName | String | 变更成功的topic名称 |
错误码
错误码 | 错误描述 | HTTP状态码 | 描述 |
---|---|---|---|
ERROR_PARAMS | 请求参数错误 | 400 | 请求参数错误 |
CLUSTER_NOT_FOUND | 集群不存在 | 451 | 集群不存在 |
CLUSTER_HAD_DELETED | 集群已删除 | 451 | 集群已删除 |
CLUSTER_NOT_BELONGED | 未拥有该集群 | 451 | 未拥有该集群 |
CLUSTER_NOT_ACTIVE | 集群非运行状态 | 451 | 集群非运行状态 |
TOPIC_NOT_EXIST | 主题不存在 | 451 | 主题不存在 |
TOPIC_PARTITION_ILLEGAL | Topic 分区数不合法 | 451 | TOPIC_PARTITION_ILLEGAL |
TOPIC_REDUCE_PARTITION_IS_NOT_ALLOWED | 不允许缩减 Topic 分区 | 451 | TOPIC_REDUCE_PARTITION_IS_NOT_ALLOWED |
INTERNAL_ERROR | 服务内部错误 | 500 | 服务内部错误 |
请求示例
PUT http://kafka-api.bj.baidubce.com/v2/clusters/33a168bb70c0459787416077114ab233/topics/test
Authorization: bce-auth-v1/ec7f277752364a61af9f3bcb10eb803e/2023-05-08T09:39:11Z/3600/host;x-bce-console-rpc-id;x-bce-date/b8f6045003584ec16618f7aac47a8af72bea075ccc7576e8763838bc6a3d86fb
Host: kafka-api.bd.baidubce.com
x-bce-console-rpc-id: cf57b4b1-a86f-4423-86fb-736c22068d84
x-bce-date: 2023-05-08T09:39:11Z
{
"partitionNum": 4,
"otherConfigs": {
"message.timestamp.type":"CreateTime",
"cleanup.policy":"delete",
"min.insync.replicas":"1",
"retention.ms":"604800000",
"segment.ms":"604800000",
"max.message.bytes":"1048588"
}
}
返回示例
HTTP/1.1 200 OK
X-Bce-Request-Id: 97e6d4ad-6fca-4609-ad4d-9a27c4d1a362
Date: Mon, 08 May 2023 09:39:11 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"topicName": "test"
}