消息生產者和消費者客戶端接入云消息隊列 MQTT 版服務端收發消息時，需要指定Client ID，用于唯一標識一個客戶端。 Client ID由兩部分組成，組織形式為<GroupID>@@@<DeviceID>，DeviceID由客戶端自定義，GroupID需要提前在云消息隊列 MQTT 版服務端創建。
接口說明
每成功調用一次 CreateGroupId 接口，都會計算為一次消息 TPS，從而影響您的計費。詳情請參見計費說明。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 是 | 您需創建的 Group ID。取值說明如下：
| GID_test |
| InstanceId | string | 是 | 創建的 Group ID 所在的實例 ID。 | mqtt-cn-0pp1ldu**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "2C7D722D-0F3D-4415-A9CD-A464D82C****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | GroupIdAlreadyExsited | The specified GroupId already exists. | 當前Group ID已經存在。 |
| 400 | GroupIdAlreadyUsedByOtherUsers | The current GroupId is used by another user. Please change to a different GroupId. | 當前Group ID已經被其他用戶占用，請更換其他名稱。 |
| 400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 參數校驗失敗，可能缺失或者傳入值非法。 |
| 400 | InstancePermissionCheckFailed | An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. | 實例權限校驗失敗，請確認MQTT實例的所屬關系以及授權策略。 |
| 400 | InstanceNotFound | Failed to find the instance. The instanceId may be invalid. | 無法找到實例。 |
| 400 | PermissionCheckFailed | An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings. | 資源權限校驗失敗，請檢查實例、Topic和Group ID的所屬權限和授權策略。 |
| 500 | CreateGroupIdError | Failed to create GroupId. Try again later. | 創建Group ID請求執行失敗，請稍后重試。 |
| 500 | InternalError | An error occurred while processing your request. Try again later. | MQTT后端服務異常，請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史