总览

操作接口

cluster

查询clusterId以及clusterName全量数据 (get)

示例

【GET】 /v1/cluster

返回值

  1. {
  2. "errMsg": "",
  3. "errCode": 0,
  4. "result": true,
  5. "data": "[{\"clusterId\":1,\"clusterName\":\"1124\", \"masterIp\":\"127.0.0.1\"}]"
  6. }

topic

添加topicTask

  1. type (必填) 请求类型,字段填写:op_query
  2. clusterId (必填) 请求集群id
  3. addTopicTasks (必填) topicTasks,创建task任务json
  4. user (必填) 之后接入权限验证需要验证用户,这里预留出来

addTopicTasks目前只包括一个字段为topicName 之后接入region设计会新加入region字段表示不同区域的broker 目前一个addTopicTask会在cluster中的所有broker创建topic

AddTopicTasks 为以下对象的List,可携带多个创建topic请求

  1. topicName (必填) topic名称

示例

【POST】 /v1/task?method=addTopicTask

  1. {
  2. "clusterId": "1",
  3. "addTopicTasks": [{"topicName": "1"}],
  4. "user": "test"
  5. }

返回json格式样例

  1. {
  2. "errMsg": "There are topic tasks [a12322] already in adding status",
  3. "errCode": 200,
  4. "result": false,
  5. "data": ""
  6. }

result为false为写入task失败

查询某一个topic是否创建成功(业务可以写入)

  1. clusterId (必填) 请求集群id
  2. topicName (必填) 查询topic名称
  3. user (必填) 之后接入权限验证需要验证用户,这里预留出来

示例

【POST】 /v1/topic?method=queryCanWrite

  1. {
  2. "clusterId": "1",
  3. "topicName": "1",
  4. "user": "test"
  5. }

返回json格式样例

  1. { "result":true, "errCode":0, "errMsg":"OK", }
  2. { "result":false, "errCode": 100, "errMsg":"topic test is not writable"}
  3. { "result":false, "errCode": 101, "errMsg":"no such topic in master"}

result为false为不可写