すべてのプロダクト
Search

このプロダクト

    ApsaraMQ for RocketMQ:ListTopicSubscriptions

    ドキュメントセンター

    ApsaraMQ for RocketMQ:ListTopicSubscriptions

    最終更新日:Dec 21, 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:ListTopicSubscriptions

    list

    *Topic

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

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

    rmq-cn-zpr34udri0w
    topicName

    string

    必須

    ApsaraMQ for RocketMQ インスタンス上の Topic の名前。

    dev4-HMH_INSURANCE_NOMAL_TOPIC

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Result<List>

    requestId

    string

    リクエスト ID。

    92A9BE4E-B794-50C8-979C-0456E4D32943
    success

    boolean

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

    true
    data

    array<object>

    返されたデータ。

    object

    Topic のサブスクリプション。

    consumerGroupId

    string

    使用者グループ ID。

    CID-TEST
    topicName

    string

    Topic 名。

    topic_test
    messageModel

    string

    消費モード。有効値：BROADCASTING および CLUSTERING。

    BROADCASTING
    subscriptionStatus

    string

    サブスクリプションステータス。有効値：ONLINE および OFFLINE。

    ONLINE
    filterExpression

    string

    フィルター式。

    *
    filterExpressionType

    string

    フィルター式のタイプ。有効値：SQL、TAG、および UNSPECIFIED。値 SQL はメッセージが SQL 式でフィルターされることを示します。値 TAG はメッセージがタグでフィルターされることを示します。値 UNSPECIFIED はフィルター式のタイプが指定されていないことを示します。

    SQL
    consistency

    string

    メッセージ消費に一貫性があるかどうかを示します。有効値：

    • false：使用者グループに未消費のメッセージが存在します。

    • true：使用者グループに未消費のメッセージは存在しません。

    true
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    The instance cannot be found.
    httpStatusCode

    integer

    HTTP ステータスコード。

    200
    dynamicCode

    string

    動的エラーコード。

    Topic
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "92A9BE4E-B794-50C8-979C-0456E4D32943",
  "success": true,
  "data": [
    {
      "consumerGroupId": "CID-TEST",
      "topicName": "topic_test",
      "messageModel": "BROADCASTING",
      "subscriptionStatus": "ONLINE",
      "filterExpression": "*",
      "filterExpressionType": "SQL",
      "consistency": "true"
    }
  ],
  "code": "MissingInstanceId",
  "message": "The instance cannot be found.",
  "httpStatusCode": 200,
  "dynamicCode": "Topic",
  "dynamicMessage": "instanceId"
}

    エラーコード

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

    変更履歴

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