ApsaraMQ for RocketMQ:OnsTopicStatus - ApsaraMQ for RocketMQ

操作説明

説明

Alibaba Cloud が提供する API 操作は、Alibaba Cloud サービスのリソースを管理および照会するために使用されます。これらの API 操作は、管理システムにのみ統合することを推奨します。メッセージングサービスのコアシステムでは、これらの API 操作を使用しないでください。使用した場合、システムリスクが発生する可能性があります。

この操作によって返される情報に基づいて、Topic のリソース使用量を判断できます。返される情報には、Topic 内のメッセージの総数と、メッセージが 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mq:QueryTopicStatus

get

Topic

acs:mq:{#regionId}:{#accountId}:{#TopicName}

Topic

acs:mq:{#regionId}:{#accountId}:{#InstanceId}%{#TopicName}

なし

mq:OnsInstanceBaseInfo

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Topic	string	必須	照会する Topic の名前。	test
InstanceId	string	任意	照会する Topic が含まれるインスタンスの ID。	MQ_INST_188077086902****_BXSuW61e

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。このパラメーターは共通パラメーターです。各リクエストには一意の ID があります。この ID を使用して、問題のトラブルシューティングを行うことができます。	427EE49D-D762-41FB-8F3D-9BAC96C3****
Data	object	照会された Topic のデータ構造。
Perm	integer	Topic に対して実行できる操作を示します。有効な値： 2：Topic にメッセージを公開できます。 4：Topic をサブスクライブできます。 6：Topic へのメッセージの公開とサブスクライブができます。	6
LastTimeStamp	integer	Topic 内で最新のメッセージが準備完了になった時点。Topic にメッセージが存在しない場合、このパラメーターの戻り値は 0 です。このパラメーターの値は、ミリ秒単位の UNIX タイムスタンプです。準備完了メッセージと準備完了時間の定義については、「用語」をご参照ください。	1570864984364
TotalCount	integer	Topic のすべてのパーティションにあるメッセージの総数。	2310

例

成功レスポンス

JSONJSON

{
  "RequestId": "427EE49D-D762-41FB-8F3D-9BAC96C3****",
  "Data": {
    "Perm": 6,
    "LastTimeStamp": 1570864984364,
    "TotalCount": 2310
  }
}

エラーコード

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

変更履歴

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