BatchAddConsumerGroupConsumers - 批量添加消费者组成员

更新时间:
复制 MD 格式

批量添加消费者组成员

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /v1/consumer-groups/{consumerGroupId}/consumers/batch-add HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

consumerGroupId

string

消费者组 ID。

csg-8c13d2b4f8a1

请求参数

名称

类型

必填

描述

示例值

body

object

批量添加消费者组成员请求体。

consumerIds

array

待添加到消费者组的消费者 ID 列表。

["cs-8c13d2b4f8a1"]

string

消费者 ID。

cs-8c13d2b4f8a1

返回参数

名称

类型

描述

示例值

object

Schema of Response

requestId

string

Id of the request

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

code

string

响应状态码。请求成功时返回 Ok。

Ok

message

string

响应消息。

success

data

object

响应数据。

successConsumerIds

array

成功添加到消费者组的消费者 ID 列表。

string

成功添加到消费者组的消费者 ID。

cs-8c13d2b4f8a1

skippedConsumerIds

array

已在消费者组中、本次跳过的消费者 ID 列表。

string

已在消费者组中、本次跳过的消费者 ID。

cs-8c13d2b4f8a1

failedConsumerIds

array

添加失败的消费者 ID 列表。

string

添加失败的消费者 ID。

cs-8c13d2b4f8a1

示例

正常返回示例

JSON格式

{
  "requestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "code": "Ok",
  "message": "success",
  "data": {
    "successConsumerIds": [
      "cs-8c13d2b4f8a1"
    ],
    "skippedConsumerIds": [
      "cs-8c13d2b4f8a1"
    ],
    "failedConsumerIds": [
      "cs-8c13d2b4f8a1"
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情