GetTopic API 呼び出しによる Topic 詳細情報の取得 - ApsaraMQ for RocketMQ - Alibaba Cloud - ApsaraMQ for RocketMQ

指定された 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	Result
requestId	string	リクエスト 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: スケジュールされたメッセージまたは遅延メッセージ LITE: 軽量 Topic メッセージ NORMAL: 通常メッセージ列挙値: TRANSACTION : トランザクションメッセージ。 FIFO : 順序付きメッセージ。 DELAY : スケジュールされたメッセージまたは遅延メッセージ。 LITE : 軽量 Topic メッセージ。 NORMAL : 法線メッセージ。	NORMAL
status	string	Topic のステータス。有効な値: RUNNING: 実行中 CREATING: 作成中列挙値: RUNNING : 実行中。 CREATING : 作成中。	RUNNING
remark	string	Topic の備考。	これはテスト用の備考です
createTime	string	Topic が作成された時間。フォーマットは YYYY-MM-DD HH:mm:ss です。	2022-08-01 20:05:50
updateTime	string	Topic が最後に変更済みとなった時間。フォーマットは YYYY-MM-DD HH:mm:ss です。	2022-08-01 20:05:50
maxSendTps	integer	メッセージを送信するための TPS の最大値。	1000
liteTopicExpiration	integer	軽量 Topic の有効期限時間 (分単位)。	60
priority	integer	Topic に許可されるメッセージの優先度の最大値。有効な値: 0～9。値が大きいほど優先度が高くなります。	9
code	string	エラーコード。	Topic.NotFound
message	string	エラーメッセージ。	Topic が見つかりません
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,
    "priority": 9
  },
  "code": "Topic.NotFound",
  "message": "The topic cannot be found.",
  "httpStatusCode": 400,
  "dynamicCode": "TopicName",
  "dynamicMessage": "topicName"
}

エラーコード

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

変更履歴

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