QuerySessionByClientId を使用してクライアントの接続状態を確認 - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

操作説明

この API は、1 秒あたり最大 500 回呼び出すことができます。詳細については、「QPS の制限」をご参照ください。
QuerySessionByClientId API の呼び出しが成功するたびに、秒間トランザクション数 (TPS) が 1 増加します。これはインスタンスの課金に影響します。詳細については、「課金ルール」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:MqttInstanceAccess

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientId	string	必須	照会対象の MQTT クライアントの ID です。	GID_test@@@test
InstanceId	string	必須	ApsaraMQ for MQTT インスタンスの ID です。この ID は、MQTT クライアントが使用するインスタンスの ID と一致している必要があります。インスタンス ID は、ApsaraMQ for MQTT コンソールの [インスタンスの詳細] ページで取得できます。	post-cn-0pp12gl****

説明

その他のパラメーターについては、「共通パラメーター」および「エンドポイント」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object
OnlineStatus	boolean	MQTT クライアントが ApsaraMQ for MQTT ブローカーに接続されているかどうかを示します。有効な値： true false	true
RequestId	string	リクエスト ID です。このパラメーターは共通パラメーターです。	E4581CCF-62AF-44D9-B5B4-D1DBBC0E****

例

成功レスポンス

JSONJSON

{
  "OnlineStatus": true,
  "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBBC0E****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or 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.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
403	SystemOverFlow	An error occurred while processing your request. Please try again.
404	ApiNotSupport	The specified API is not supported.
417	InternalError	An error occurred while processing your request. Try again later.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。