すべてのプロダクト
Search

このプロダクト

    :ListTopics

    ドキュメントセンター

    :ListTopics

    最終更新日:Nov 06, 2025

    指定されたインスタンス内の Topic をクエリします。

    今すぐお試しください

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

    list

    *Topic

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

    		 なし なし

    リクエスト構文

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

    パスパラメータ

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    クエリする Topic が属するインスタンスの ID。

    rmq-cn-7e22ody****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    filter

    string

    任意

    フィルター条件。このパラメーターを空のままにすると、インスタンス内のすべての Topic がクエリされます。

    topic_test
    pageNumber

    integer

    任意

    返すページのページ番号。

    1
    pageSize

    integer

    任意

    各ページで返すエントリ数。

    3
    messageTypes

    array

    任意

    Topic のメッセージタイプ。

    string

    任意

    クエリする Topic のメッセージタイプ。このパラメーターを空のままにすると、すべてのメッセージタイプの Topic がクエリされます。 有効な値:

    • TRANSACTION: トランザクションメッセージ

    • FIFO: 順序メッセージ

    • DELAY: スケジュールメッセージまたは遅延メッセージ

    • NORMAL: 通常メッセージ

    • LITE: 軽量 Topic

    列挙値:

    • TRANSACTION :

      トランザクションメッセージ

    • FIFO :

      順序メッセージ

    • DELAY :

      スケジュールメッセージと遅延メッセージ

    • NORMAL :

      通常メッセージ

    NORMAL

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<MyPage>

    requestId

    string

    リクエスト ID。この ID は各リクエストに固有であり、問題のトラブルシューティングに使用できます。

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

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

    true
    data

    object

    返されたデータ。

    pageNumber

    integer

    返されたページのページ番号。

    1
    pageSize

    integer

    ページごとに返されるエントリ数。

    3
    totalCount

    integer

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

    1
    list

    array<object>

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

    object

    regionId

    string

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

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    topicName

    string

    Topic 名。

    topic_test
    messageType

    string

    Topic のメッセージタイプ。

    列挙値:

    • TRANSACTION :

      トランザクションメッセージ

    • FIFO :

      順序メッセージ

    • DELAY :

      スケジュールメッセージと遅延メッセージ

    • NORMAL :

      通常メッセージ

    NORMAL
    status

    string

    Topic のステータス。

    列挙値:

    • RUNNING :

      実行中

    • CREATING :

      作成中

    RUNNING
    remark

    string

    Topic に関する備考。

    This is the remark for test.
    createTime

    string

    Topic が作成された時刻。

    2022-08-01 20:05:50
    updateTime

    string

    Topic が最後に変更された時刻。

    2022-08-01 20:05:50
    maxSendTps

    integer

    1 秒あたりに送信できるメッセージの最大数。

    1000
    liteTopicExpiration

    integer

    軽量 Topic の有効期限。単位: 分。

    20
    code

    string

    エラーコード。

    Topic.NotFound
    message

    string

    エラーメッセージ。

    The topic cannot be found.
    httpStatusCode

    integer

    HTTP ステータスコード。

    400
    dynamicCode

    string

    動的エラーコード。

    TopicName
    dynamicMessage

    string

    動的エラーメッセージ。

    topicName

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": {
    "pageNumber": 1,
    "pageSize": 3,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageType": "NORMAL",
        "status": "RUNNING",
        "remark": "This is the remark for test.",
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50",
        "maxSendTps": 1000,
        "liteTopicExpiration": 20
      }
    ]
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

    エラーコード

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

    変更履歴

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