在服务器上创建微消息队列 MQTT 的分组,即 Group ID(GID)。

使用场景

本接口限企业铂金版用户专用,请前往企业铂金版购买页查看详情。

新应用上线时,在创建 Topic 资源后,如需使用 MQTT 客户端收发消息,首先需在控制台或者调用本接口创建 GID。

调试

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

请求参数

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

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

GroupId String GID_test

创建的 MQTT 分组的 ID

RegionId String cn-hangzhou

需将 Group 创建至的地域 ID

InstanceId String post-cn-0pp12gl****

需要创建 GID 的 MQTT 实例的 ID。针对有独立命名空间的实例,该参数为必填。

Topic String test

创建的 GID 需订阅的父级 Topic

返回数据

名称 类型 示例值 描述
RequestId String E052918F-CC0D-4FD8-948F-60E89C479E23

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

示例

请求示例


http(s)://[Endpoint]/?Action=OnsMqttGroupIdCreate
&GroupId=GID_test
&RegionId=cn-hangzhou
&Topic=test
&InstanceId=post-cn-0pp12gl****
&<公共请求参数>

正常返回示例

XML 格式

<OnsMqttGroupIdCreateResponse>
  <RequestId>E052918F-CC0D-4FD8-948F-60E89C479E23</RequestId>
</OnsMqttGroupIdCreateResponse>

JSON 格式

{
	"RequestId":"E052918F-CC0D-4FD8-948F-60E89C479E23"
}

错误码

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