カスタム認証 ID のクエリ - ApsaraMQ for MQTT - Alibaba Cloud - ApsaraMQ for MQTT

カスタム身分認証を照会します。

今すぐお試しください

この 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:QueryCustomAuthIdentity

get

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	ApsaraMQ for MQTT インスタンスの ID。	post-111****
Username	string	任意	ユーザー名。	test
IdentityType	string	任意	ID タイプ。	USER
ClientId	string	任意	デバイスのクライアント ID。ID タイプが CLIENT の場合にこのパラメーターを指定できます。	GID_test@@@test
NextToken	string	任意	現在のクエリの終了位置を示すトークン。次の呼び出しでこのトークンをパラメーターとして渡すことで、ページネーションを続行できます。最初の呼び出しまたは最後のページが返された場合、値は空の文字列です。	eyJhY2NvdW50IjoiMTM4MTcxODk3NDQzMjQ1OSIsImV2ZW50SWQiOiJGMkUxOUE3QS1FM0Q0LTVCOEYtQkU4OS1CNkMyM0RBM0UyRjIiLCJsb2dJZCI6IjY2LTEzODE3MTg5NzQ0MzI0NTkiLCJydyI6IlciLCJ0aW1lIjoxNjc4MzI2MTI1MDAwfQ
Size	integer	必須	クエリするエントリの数。最大値: 100。	100

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	11568B5B-13A8-4E72-9DBA-3A14F7D3****
Code	integer	応答コード。200: リクエストが成功しました。その他のコードはエラーを示します。エラーコードの詳細については、エラーコードを参照してください。	200
Success	boolean	リクエストが成功したかどうかを示します。true: リクエストが成功しました。false: リクエストが失敗した。	True
Message	string	追加情報。	operation success.
Data	object	クエリ結果。
Results	array<object>	返されたデータ。
	object	返されたデータ。
Username	string	ユーザー名。	test
Secret	string	AccessKey Secret。	62a5916d71767185b48907d85c2efa****
IdentityType	string	ID タイプ。有効な値： USER CLIENT	USER
ClientId	string	IdentityType が CLIENT に設定されている場合のクライアント ID。	GID_ICP@@@4d378084
SignMode	string	署名検証モード。 ORIGIN：パスワードと AccessKey Secret を比較します。 SIGNED：HMAC_SHA1 アルゴリズムを使用してクライアント ID に署名してパスワードを取得し、パスワードを比較します。	SIGNED
NextToken	string	さらに結果がある場合、NextToken が返されます。	AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ

例

成功レスポンス

JSONJSON

{
  "RequestId": "11568B5B-13A8-4E72-9DBA-3A14F7D3****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "Username": "test",
        "Secret": "62a5916d71767185b48907d85c2efa****",
        "IdentityType": "USER",
        "ClientId": "GID_ICP@@@4d378084",
        "SignMode": "SIGNED"
      }
    ],
    "NextToken": "AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter 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.
404	ApiNotSupport	The specified API is not supported.

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

変更履歴

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