文档

OnsGroupCreate - 创建客户端Group ID

更新时间:
一键部署

调用OnsGroupCreate创建客户端Group ID。

接口说明

注意 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。
本接口一般是在发布新应用、业务逻辑实现等需要新的 Group 的情况下使用。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mq:CreateGroupWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
GroupIdstring

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

  • 长度限制为 2~64 个字符,只能包含字母、数字、短划线(-)和下划线(_)。

  • 若创建的 Group 所在实例有命名空间,则 Group ID 需要保证实例内唯一,不能和本实例下已有的 Group ID 或 Topic 名称重复;跨实例之间可以重名,例如实例 A 的 Group ID 可以和实例 B 的 Group ID 重复,也可以和实例 B 的 Topic 名称重复。

  • 若创建的 Group 所在实例无命名空间,则 Group ID 需要保证跨实例和跨地域全局唯一,全局范围内不能和已有的 Group ID 或 Topic 名称重复。

说明
  • Group ID 创建后,将无法再修改。
    • 实例是否有命名空间,可以在消息队列 RocketMQ 版控制台实例详情页面的基础信息区域查看。
    GID_test_groupId
    Remarkstring

    备注。

    test
    InstanceIdstring

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

    MQ_INST_111111111111_DOxxxxxx
    GroupTypestring

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

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

    返回参数

    名称类型描述示例值
    object

    返回信息。

    RequestIdstring

    公共参数,每个请求的 ID 都是唯一的,可用于排查和定位问题。

    A07E3902-B92E-44A6-B6C5-6AA111111****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    400%s%s, please check and retry later-
    400Group.NumLimitedgroup count exceed limit.Gid数量超出限制

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

    变更历史

    变更时间变更内容概要操作
    2023-10-07OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更

    控制台操作

    除了调用 OnsGroupCreate 接口,您还可以通过消息队列 RocketMQ 版控制台创建 Group ID。具体操作,请参见 Group 管理