すべてのプロダクト
Search

このプロダクト

    :QueryCustomAuthConnectBlack

    ドキュメントセンター

    :QueryCustomAuthConnectBlack

    最終更新日:Dec 21, 2025

    接続ブラックリスト内のクライアント ID を照会します。

    今すぐお試しください

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

    get

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    ApsaraMQ for MQTT インスタンスの ID。

    post-111****
    ClientId

    string

    任意

    照会するクライアントの ID。

    GID_test@@@test
    NextToken

    string

    任意

    前のページで返されたデータの最後の位置を示すトークン。次のバッチのデータを取得するには、前のリクエストで返された NextToken の値を使用してこの操作を再度呼び出します。この操作を初めて呼び出す場合、またはすべての結果を照会する場合は、NextToken を空の文字列に設定します。

    xOfRU60sGEwN1OlFBIL8Ew==
    Size

    integer

    必須

    照会するクライアントの数。最大値：100。

    100

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    RequestId

    string

    リクエスト ID。

    020F6A43-19E6-4B6E-B846-44EB31DF****
    Code

    integer

    HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。その他のステータスコードは、リクエストが失敗したことを示します。エラーコードのリストについては、「エラーコード」をご参照ください。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：true および false。

    True
    Message

    string

    返されたメッセージ。

    operation success.
    Data

    object

    返されたデータ。

    Results

    array<object>

    返された結果。

    object

    ClientId

    string

    クライアント ID。

    GID_TEST@@@test
    Effect

    string

    アクセスを許可するか拒否するかを示します。

    ALLOW
    PermitAction

    string

    承認された権限。

    CONNECT
    NextToken

    string

    次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。

    AAAAAZ0cM0HTqLXvgm7oMHWXcvc=

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "ClientId": "GID_TEST@@@test",
        "Effect": "ALLOW",
        "PermitAction": "CONNECT"
      }
    ],
    "NextToken": "AAAAAZ0cM0HTqLXvgm7oMHWXcvc="
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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 InvalidParameter.%s An error occurred while validating the parameter. The parameter may be missing or invalid.
    404 ApiNotSupport The specified API is not supported.

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

    変更履歴

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