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