CreateGroupId - ApsaraMQ for MQTT - Alibaba Cloud ドキュメントセンター

このオペレーションを呼び出して、グループ ID を作成できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこのオペレーションを呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター	タイプ	必須	例	説明
Action	String	はい	CreateGroupId	実行するオペレーション。値: CreateGroupId
GroupId	String	はい	GID_test	作成するグループ ID。有効な値: 名前は 7 ～ 64 文字で、文字、数字、ハイフン（-）、アンダースコア（_）を含めることができます。 "GID_" または "GID-" で始まる必要があります。グループ ID は、作成後に変更することはできません。詳細については、「用語」をご参照ください。
InstanceId	String	はい	mqtt-cn-0pp1ldu automatic snapshot policies *	グループ ID が属するインスタンスの ID。
リージョン ID	String	はい	cn-hangzhou	グループ ID が属するインスタンスのリージョン。

説明これらのパラメーターの詳細については、「共通パラメーター」および「API リクエストの実行」をご参照ください。

レスポンスパラメーター

パラメーター	タイプ	例	説明
RequestId	String	2 C7D722 D-0F3D-4415-A9CD-A464D82C5FB4	リクエストの ID。これは共通パラメーターです。各リクエストには一意の ID があります。

例

サンプルリクエスト

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/? Action=CreateGroupId
&GroupId=GID_test
&InstanceId=mqtt-cn-0pp1ldu static website hosting * // 静的 Web サイトホスティング
&RegionId=cn-hangzhou
&<Common request parameters> // 共通リクエストパラメーター

サンプルの成功レスポンス

XML 形式

<CreateGroupIdResponse>
  <RequestId>2C7D722D-0F3D-4415-A9CD-A464D82C5FB4</RequestId>
</CreateGroupIdResponse>

JSON 形式

{
  "RequestId": "2C7D722D-0F3D-4415-A9CD-A464D82C5FB4"
}

エラーコード

HTTP ステータスコード	エラー	エラーメッセージ	説明
500	CreateGroupIdError	Failed to create GroupId. Try again later.	グループ ID の作成に失敗しました。後でもう一度お試しください。
400	GroupIdAlreadyExsited	The specified GroupId already exists.	現在のグループ ID は既に存在します。
400	GroupIdAlreadyUsedByOtherUsers	The current GroupId is used by another user. Please change to a different GroupId.	指定されたグループ ID は既に別のユーザーが所有しています。
500	InternalError	An error occurred while processing your request. Try again later.	MQTT バックエンドサービスが異常です。もう一度お試しください。
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.	リソース権限の検証に失敗したため、エラーメッセージが返されました。インスタンス、トピック、およびグループ ID の権限と承認ポリシーを確認してください。

エラーコードの一覧については、API エラーセンターをご覧ください。