文档

OnsGroupDelete - 删除Group

更新时间:
一键部署

调用OnsGroupDelete删除Group。

接口说明

注意
  • 阿里云提供的 OpenAPI 属于管控类 API,用于管理和查询阿里云服务的相关资源。仅推荐在管控链路集成,消息收发的核心数据链路中严禁依赖 OpenAPI 实现,否则可能会导致链路产生风险。

  • 删除 Group 后,由 Group ID 标识的消费者实例将立即停止接收消息,请慎重调用。

  • 本接口一般是在应用下线等资源回收场景下使用。Group 删除时后台需要做资源回收,速度较慢,因此不建议删除后立即又重新创建。如果删除失败,请根据错误码进行处理。

    调试

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

    授权信息

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

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

    请求参数

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

    待删除的消息消费集群的 Group ID。

    GID_test_groupId
    InstanceIdstring

    待删除的 Group 所属的实例 ID。

    MQ_INST_111111111111_DOxxxxxx

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

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

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

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    控制台操作

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

    • 本页导读 (1)
    文档反馈