すべてのプロダクト
Search

このプロダクト

    :GetTopic

    ドキュメントセンター

    :GetTopic

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

    get

    *Topic

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

    		 なし なし

    リクエスト構文

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

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

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

    rmq-cn-7e22ody****
    topicName

    string

    必須

    Topic の名前。

    topic_test

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

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

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    結果

    requestId

    string

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

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

    boolean

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

    true
    data

    object

    返されたデータ。

    regionId

    string

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

    cn-hangzhou
    instanceId

    string

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

    rmq-cn-7e22ody****
    topicName

    string

    Topic の名前。

    topic_test
    messageType

    string

    Topic のメッセージタイプ。

    列挙値:

    • TRANSACTION :

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

    • FIFO :

      順序指定メッセージ

    • DELAY :

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

    • NORMAL :

      通常メッセージ

    NORMAL
    status

    string

    Topic のステータス。

    有効な値：

    • RUNNING：Topic は実行中です。

    • CREATING：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

    メッセージ送信の最大 TPS (1 秒あたりのトランザクション数)。

    1000
    liteTopicExpiration

    integer

    ライト Topic の有効期限。単位：分。

    60
    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": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "topicName": "topic_test",
    "messageType": "NORMAL",
    "status": "RUNNING",
    "remark": "This is the remark for test.\n",
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "maxSendTps": 1000,
    "liteTopicExpiration": 60
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

    エラーコード

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

    変更履歴

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