You can call this operation to delete an existing Message Queue for MQTT (MQTT) group ID from the specified MQTT broker.

Scenarios

This operation is only applicable to users of the Enterprise Platinum Edition.

When you replace old applications with new ones, you can delete the group IDs that are no longer used either in the console or by calling this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. After you call this operation in OpenAPI Explorer, OpenAPI Explorer dynamically generates SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes OnsMqttGroupIdDelete

The operation that you want to perform. Set the value to OnsMqttGroupIdDelete.

GroupId String Yes GID_test_groupId

The group ID that you want to delete.

RegionId String Yes mq-internet-access

The region of the MQTT instance to which the group ID you want to delete belongs.

InstanceId String No MQ_INST_111111111111_DOxxxxxx

The ID of the MQTT instance to which the group ID you want to delete belongs. This parameter is required for instances with separate namespaces.

Response parameters

Parameter Type Example Description
RequestId String BD96ED5A-04CB-4FC2-BCE5-625FD603B6C3

The ID of the request, which is a common parameter. Each request has a unique ID to facilitate troubleshooting and fault locating.

Examples

Sample request


http(s)://[Endpoint]/? Action=OnsMqttGroupIdDelete
&GroupId=GID_test_groupId
&RegionId=mq-internet-access
&InstanceId=MQ_INST_111111111111_DOxxxxxx
&<Common request parameters>

Sample success response

XML format

<OnsMqttGroupIdDeleteResponse>
  <RequestId>BD96ED5A-04CB-4FC2-BCE5-625FD603B6C3</RequestId>
</OnsMqttGroupIdDeleteResponse>

JSON format

{
	"RequestId":"BD96ED5A-04CB-4FC2-BCE5-625FD603B6C3"
}

Error codes

For a list of error codes, visit the API Error Center.