文档中心

消息队列kafka API参考手册

最近更新时间：2023-04-16 17:00:00

3 主题管理

3.1 CreateTopic

调用 CreateTopic 接口创建 topic。

3.1.1 使用说明

POST https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/create

3.1.2 请求参数

说明：经过网关调用接口时不需要传入表 3-1。
表3-1 header 中请求参数

表3-2 body 中的请求参数

3.1.3 返回数据

3.1.4 示例

1. 请求示例
POST https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/create
{
      "TopicName": "topic-1010-1",
      "Partition": 1,
      "TopicReplicationFactor": 3,
      "CleanupPolicy": "delete",
      "RetentionMs": "259200000",
      "MinInsyncReplicas": 1,
      "Remark": "topic-1010-1",
      "InstanceId": "cmq-kafka-861bda97563341a9"
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "44eb0963-b380-4529-b21e-4f4719a83296",
      "TopicID": "Vhqb4kvxCH",
      "ClusterID": "VgWPfOl8RL",
      "TopicName": "topic-1010-1",
      "Partition": 1,
      "ReplicationFactor": 3,
      "Remark": "topic-1010-1",
      "CreateTime": 1665366764,
      "UpdateTime": 1665366764
}

3.2 DeleteTopic

调用 DeleteTopic 接口删除 topic。

3.2.1 使用说明

DELETE https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/delete

3.2.2 请求参数

说明：经过网关调用接口时不需要传入表 3-3。
表3-3 header 中请求参数

表3-4 body 中的请求参数

3.2.3 返回数据

3.2.4 示例

1. 请求示例
DELETE https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/delete
{
      "InstanceId": "cmq-kafka-861bda97563341a9",
     "TopicId": "VhP6V09xOf"
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "44eb0963-b380-4529-b21e-4f4719a83296"
}

3.3 GetTopicList

调用 GetTopicList 接口获取 topic 列表。

3.3.1 使用说明

GET https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/list

3.3.2 请求参数

说明：经过网关调用接口时不需要传入表 3-5。
表3-5 header 中请求参数

表3-6 URL 中的请求参数

3.3.3 返回数据

表3-7 Topics 中的结构

3.3.4 示例

1. 请求示例
GET
https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/list?InstanceId=cmq-kafka-861bda97563341a9&PageNum=1&PageSize=10
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "73817557-d409-46f2-a36a-1322a2ac01e6",
      "TotalCount": 4,
      "PageSize": 10,
      "PageNumber": 1,
      "Topics": [
      {
          "TopicID": "Vhqb4kvxCH",
          "ClusterID": "VgWPfOl8RL",
          "TopicName": "topic-1010-1",
          "Partition": 1,
          "ReplicationFactor": 3,
          "Remark": "topic-1010-1",
          "CreateTime": 1665366764,
          "UpdateTime": 1665366764
      },
      {
          "TopicID": "VhQNVrRWSV",
          "ClusterID": "VgWPfOl8RL",
          "TopicName": "topic-109-2",
          "Partition": 1,
          "ReplicationFactor": 3,
          "Remark": "test-109-2",
          "CreateTime": 1665311730,
          "UpdateTime": 1665311730
      },
      {
          "TopicID": "VhN0DwY8oH",
          "ClusterID": "VgWPfOl8RL",
          "TopicName": "topic3",
          "Partition": 1,
          "ReplicationFactor": 3,
          "Remark": "",
          "CreateTime": 1665304644,
          "UpdateTime": 1665304644
      },
      {
          "TopicID": "VgWbM2ycMx",
          "ClusterID": "VgWPfOl8RL",
          "TopicName": "topic1",
          "Partition": 4,
          "ReplicationFactor": 4,
          "Remark": "",
          "CreateTime": 1665194652,
          "UpdateTime": 1665194652
      }
      ]
}

3.4 GetTopic

调用 GetTopic 接口获取 topic 具体信息。

3.4.1 使用说明

GET https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/get

3.4.2 请求参数

说明：经过网关调用接口时不需要传入表 3-8。
表3-8 header 中请求参数

表3-9 body 中的请求参数

3.4.3 返回数据

3.4.4 示例

1. 请求示例
GET https://{Endpoint}/cmqk/kafka/v1.0/cluster/topic/get
{
      "InstanceId": "cmq-kafka-861bda97563341a9",
     "TopicId": "VhP6V09xOf"
}
2. 正常返回示例
HTTPS/1.1 200 OK
Content-Type:application/json
{
      "RequestId": "1f860745-38e2-4d37-8aaf-6dfab8274150",
      "TopicID": "VhN0DwY8oH",
      "InstanceID": "cmq-kafka-861bda97563341a9",
    "TopicName": "topic3",
      "Partition": 1,
      "ReplicationFactor": 3,
      "Remark": "",
      "CreateTime": 1665304644,
      "UpdateTime": 1665304644,
      "ConsumerGroupNum": 0,
      "MessageNum": 0,
      "ConsumerGroupList": [],
      "ClusterName": "cmq-kafka-v44nhn1t9syxcm15",
      "LastConsumerTime": 0
}

意见反馈

文档内容是否对您有帮助？

如您有其他疑问，您也可以通过在线客服来与我们联系探讨在线客服