すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:ListInstanceAcl

    ドキュメントセンター

    ApsaraMQ for RocketMQ:ListInstanceAcl

    最終更新日:Dec 21, 2025

    インスタンスのアクセス制御リスト (ACL) を照会します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:ListInstanceAcl

    list

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /instances/{instanceId}/acl HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    rmq-cn-7e22ody****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    pageNumber

    integer

    任意

    ページ番号。ページは 1 から始まります。

    1
    pageSize

    integer

    任意

    1 ページあたりのエントリ数。

    10
    filter

    string

    任意

    ACL をフィルターするために指定する条件。このパラメーターを指定しない場合、すべての ACL が照会されます。

    CID-TEST

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果。

    requestId

    string

    リクエスト ID。

    DA4D2F89-E2C8-5F04-936B-60D55B055FA7
    success

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    object

    返されたデータ。

    pageNumber

    integer

    ページ番号。

    1
    pageSize

    integer

    1 ページあたりのエントリ数。

    10
    totalCount

    integer

    返されたエントリの総数。

    24
    list

    array<object>

    ページネーション情報。

    object

    ACL。

    regionId

    string

    リージョン ID。

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    aclType

    string

    ACL タイプ。

    有効な値：

    • APACHE：オープンソース ACL。

    列挙値:

    • APACHE :

      オープンソース ACL

    APACHE
    username

    string

    ユーザー名。

    test
    resourceType

    string

    リソースタイプ。

    有効な値：

    • Group

    • Topic

    列挙値:

    • Group :

      コンシューマーグループ

    • Topic :

      トピック

    Topic
    resourceName

    string

    リソース名。

    test
    decision

    string

    決定結果。

    有効な値：

    • Deny：アクセスは拒否されます。

    • Allow：アクセスは許可されます。

    列挙値:

    • Deny :

      アクセスを拒否

    • Allow :

      アクセスを許可します。

    Allow
    actions

    array

    ACL によって許可される操作のタイプ。

    string

    ACL によって許可される操作のタイプ。

    有効な値：

    • SUB：メッセージのサブスクリプション。

    • Pub：メッセージの送信。

    列挙値:

    • Sub :

      サブスクリプション

    • Pub :

      送信

    Pub
    ipWhitelists

    array

    IP アドレスホワイトリスト。

    string

    IP アドレスホワイトリスト。

    0.0.0.0/0
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    The instance cannot be found.
    httpStatusCode

    integer

    HTTP ステータスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    InstanceId
    accessDeniedDetail

    string

    アクセス拒否の詳細。このパラメーターは、Resource Access Management (RAM) ユーザーに必要な権限がないためにアクセスが拒否された場合にのみ返されます。

    xxx

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "DA4D2F89-E2C8-5F04-936B-60D55B055FA7",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 24,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "aclType": "APACHE",
        "username": "test",
        "resourceType": "Topic",
        "resourceName": "test",
        "decision": "Allow",
        "actions": [
          "Pub"
        ],
        "ipWhitelists": [
          "0.0.0.0/0"
        ]
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

    エラーコード

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

    変更履歴

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