使用 OnsGroupCreate 创建客户端 Group ID。

创建的该 Group ID 用于发布和订阅消息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String OnsGroupCreate

系统规定参数。取值:OnsGroupCreate。

GroupId String GID_test_groupId

创建的消息消费集群的 Group ID。取值说明如下:

  • 以 “GID_“ 或者 “GID-“ 开头,只能包含字母、数字、短横线(-)和下划线(_)。
  • 长度限制在 5–64 字节之间。
说明 Group ID 一旦创建,将无法再修改。
InstanceId String MQ_INST_111111111111_DOxxxxxx

需创建的 Group ID 所对应的实例 ID。

Remark String test

备注。

GroupType String tcp

指定创建的 Group ID 适用的协议。TCP 协议和 HTTP 协议的 Group ID 不可以共用,需要分别创建。取值说明如下:

  • tcp:默认值,表示创建的 Group ID 仅适用于 TCP 协议的消息收发。
  • http:表示创建的 Group ID 仅适用于 HTTP 协议的消息收发。

返回数据

名称 类型 示例值 描述
RequestId String A07E3902-B92E-44A6-B6C5-6AA1111111799

为公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://[Endpoint]/?Action=OnsGroupCreate
&GroupId=GID_test_groupId
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&Remark=test
&GroupType=tcp
&<公共请求参数>

正常返回示例

XML 格式

<OnsGroupCreateResponse>
  <RequestId>A07E3902-B92E-44A6-B6C5-6AA1111111799</RequestId>
</OnsGroupCreateResponse>

JSON 格式

{
    "RequestId":"A07E3902-B92E-44A6-B6C5-6AA1111111799"
}

错误码

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