すべてのプロダクト
Search

このプロダクト

    :ListInstances

    ドキュメントセンター

    :ListInstances

    最終更新日:Nov 18, 2025

    指定されたリージョン内の ApsaraMQ for RocketMQ インスタンスをクエリします。

    操作説明

    重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースを管理およびクエリするために使用できる管理 API です。OpenAPI はコントロールプレーンにのみ統合してください。メッセージの送受信のためにコアデータプレーンで OpenAPI を使用しないでください。これにより、データリンクへの潜在的なリスクを防ぐことができます。

    今すぐお試しください

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

    list

    *Instance

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

    		 なし なし

    リクエスト構文

    GET /instances HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    filter

    string

    任意

    フィルター条件。このパラメーターを指定しない場合、すべてのインスタンスがクエリされます。

    rmq-cn-7e22ody****
    pageNumber

    integer

    任意

    ページ番号。

    有効な値: 1～100,000,000。

    1 未満の値を指定した場合、システムは 1 を使用します。100,000,000 を超える値を指定した場合、システムは 100,000,000 を使用します。

    1
    pageSize

    integer

    任意

    各ページで返されるエントリ数。

    有効な値: 10～200。

    10 未満の値を指定した場合、システムは 10 を使用します。200 を超える値を指定した場合、システムは 200 を使用します。

    10
    resourceGroupId

    string

    任意

    インスタンスが属するリソースグループの ID。

    rg-acfmx7caj******
    tags

    string

    任意

    インスタンスのフィルターに使用されるリソースタグのリスト。

    [{"key": "rmq-test", "value": "test"}]
    seriesCodes

    array

    任意

    インスタンスのプライマリシリーズコード。

    有効な値:

    • standard: Standard Edition

    • ultimate: Platinum Edition

    • professional: Professional Edition

    • dedicated: 排他的エディション

    • shared: 共有エディション

    string

    任意

    インスタンスのプライマリシリーズコード。

    standard
    storageSecretKey

    string

    任意

    ストレージ暗号鍵。

    xxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<MyPage<InstanceDto>>

    requestId

    string

    リクエスト ID。この ID はリクエストごとに一意です。問題のトラブルシューティングにこの ID を使用します。

    84445A20-2B50-5306-A3C0-AF99FC1833C6
    success

    boolean

    呼び出しが成功したかどうかを示します。

    true
    data

    object

    返されたデータ。

    pageNumber

    integer

    ページ番号。

    1
    pageSize

    integer

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

    10
    totalCount

    integer

    エントリの総数。

    100
    list

    array<object>

    ページ分割されたデータ。

    array<object>

    regionId

    string

    インスタンスが存在するリージョンの ID。

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    instanceName

    string

    インスタンス名。

    test instance
    status

    string

    インスタンスのステータス。

    有効な値:

    • RELEASED

    • RUNNING

    • STOPPED

    • CHANGING

    • CREATING

    列挙値:

    • RELEASED :

      解放済み

    • RUNNING :

      実行中

    • STOPPED :

      停止済み

    • CHANGING :

      変更中

    • CREATING :

      作成中

    RUNNING
    startTime

    string

    インスタンスが作成された時刻。

    2022-08-01 00:00:00
    expireTime

    string

    インスタンスの有効期限が切れる時刻。

    2022-09-01 00:00:00
    releaseTime

    string

    インスタンスが解放された時刻。

    2022-09-07 00:00:00
    userId

    string

    インスタンスが属するユーザーの ID。

    6W0xz2uPfiwp****
    commodityCode

    string

    ApsaraMQ for RocketMQ 5.x シリーズインスタンスの商品コード (例: ons_rmqsub_public_cn)。

    ons_rmqsub_public_cn
    serviceCode

    string

    インスタンスのサービスコード。ApsaraMQ for RocketMQ のサービスコードは rmq です。

    rmq
    seriesCode

    string

    インスタンスのプライマリシリーズコード。

    有効な値:

    • standard: Standard Edition

    • Ultimate: Enterprise Platinum Edition

    • professional: Professional Edition

    • shared: 共有エディション

    • dedicated: 排他的エディション

    列挙値:

    • standard :

      Standard Edition

    • ultimate :

      Platinum Edition

    • professional :

      Professional Edition

    standard
    subSeriesCode

    string

    インスタンスのサブシリーズコード。

    有効な値:

    • cluster_ha: 高可用性クラスター版

    • single_node: シングルノード版

    • serverless: サーバーレス版

    列挙値:

    • cluster_ha :

      High-availability Edition

    • single_node :

      シングルノード版

    cluster_ha
    paymentType

    string

    インスタンスの課金方法。

    有効な値:

    • PayAsYouGo: 従量課金

    • Subscription: サブスクリプション

    列挙値:

    • PayAsYouGo :

      従量課金 (後払い)

    • Subscription :

      サブスクリプション (前払い)

    Subscription
    remark

    string

    インスタンスに関する備考。

    This is remark for instance.
    topicCount

    integer

    インスタンスに作成された Topic の数。

    20
    groupCount

    integer

    インスタンスに作成された使用者グループの数。

    10
    createTime

    string

    インスタンスバージョンの更新時刻。

    2022-08-01 00:00:00
    updateTime

    string

    インスタンスが最後に変更された時刻。

    2022-08-02 00:00:00
    resourceGroupId

    string

    インスタンスが属するリソースグループの ID。

    rg-acfmx7caj******
    tags

    array<object>

    リソースタグのリスト。

    object

    リソースタグ。

    key

    string

    リソースタグのキー。

    key
    value

    string

    リソースタグの値。

    value
    productInfo

    object

    プロダクト情報。

    traceOn

    boolean

    メッセージトレース機能が有効になっているかどうかを示します。

    • true: 有効

    • false: 無効

    このパラメーターはまだ有効ではありません。このパラメーターが有効になっているかどうかに関係なく、メッセージトレース機能はデフォルトでサポートされています。

    true
    capacityType

    string

    容量モード:

    • provisioned: 予約およびエラスティック

    • ondemand: 従量課金

    provisioned
    code

    string

    エラーコード。

    MissingPageNumber
    message

    string

    エラーメッセージ。

    Parameter pageNumber is mandatory for this action .
    httpStatusCode

    integer

    HTTP ステータスコード。

    400
    dynamicCode

    string

    動的エラーコード。

    PageNumber
    dynamicMessage

    string

    動的エラーメッセージ。

    pageNumber

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "84445A20-2B50-5306-A3C0-AF99FC1833C6",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 100,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "instanceName": "test instance",
        "status": "RUNNING",
        "startTime": "2022-08-01 00:00:00",
        "expireTime": "2022-09-01 00:00:00",
        "releaseTime": "2022-09-07 00:00:00",
        "userId": "6W0xz2uPfiwp****",
        "commodityCode": "ons_rmqsub_public_cn",
        "serviceCode": "rmq",
        "seriesCode": "standard",
        "subSeriesCode": "cluster_ha",
        "paymentType": "Subscription",
        "remark": "This is remark for instance.",
        "topicCount": 20,
        "groupCount": 10,
        "createTime": "2022-08-01 00:00:00",
        "updateTime": "2022-08-02 00:00:00",
        "resourceGroupId": "rg-acfmx7caj******",
        "tags": [
          {
            "key": "key",
            "value": "value"
          }
        ],
        "productInfo": {
          "traceOn": true,
          "capacityType": "provisioned"
        }
      }
    ]
  },
  "code": "MissingPageNumber",
  "message": "Parameter pageNumber is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "PageNumber",
  "dynamicMessage": "pageNumber"
}

    エラーコード

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

    変更履歴

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