ListTraces - - Alibaba Cloud ドキュメントセンター

指定された 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:ListTraces

get

*Topic

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

なし

リクエスト構文

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

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	インスタンス ID。	rmq-cn-tl32upjeb08
topicName	string	必須	Topic 名。	topic_hpms_product_price_change

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
startTime	string	必須	開始時刻。	2023-05-10 10:42:11
endTime	string	必須	終了時刻。	2023-05-19 10:10:09
pageNumber	integer	必須	返す結果のページ番号。	1
pageSize	integer	必須	各ページで返すエントリ数。	10
queryType	string	必須	クエリタイプ。列挙値: MESSAGE_ID : MESSAGE_ID MESSAGE_KEY : MESSAGE_KEY TOPIC : TOPIC	MESSAGE_ID
messageId	string	任意	メッセージ ID。 `queryType` が `MESSAGE_ID` に設定されている場合、このパラメーターは必須です。	0100163E0EC1F1965C04C7906700000000
messageKey	string	任意	メッセージキー。 `queryType` が `MESSAGE_KEY` に設定されている場合、このパラメーターは必須です。	order_ceating
liteTopicName	string	任意	軽量 Topic の名前。	abc

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
requestId	string	リクエストの ID	EDFF77E1-1ED1-5389-B6A8-651D9433BBE5
success	boolean	リクエストが成功したかどうかを示します。	true
code	string	エラーコード。	Topic.NotFound
message	string	エラーメッセージ。	Parameter instanceId is mandatory for this action .
data	object	返されたデータ。
pageNumber	integer	返されたページのページ番号。	1
pageSize	integer	ページごとに返されるエントリ数。	10
totalCount	integer	返されたエントリの総数。	1
list	array<object>	ページ分割されたデータ。
	object	ページ分割されたデータ。
regionId	string	リージョン ID。	cn-hangzhou
instanceId	string	インスタンス ID。	rmq-cn-7e22ody****
topicName	string	Topic 名。	topic_test
messageId	string	メッセージ ID。	7F00000100207A4F0F294A938F7807AE
bornTime	string	メッセージが作成された時刻。	2023-03-22 12:17:08
messageTag	string	メッセージタグ。	xx
messageKeys	array	ビジネスキー。
	string	ビジネスキー。	xx
httpStatusCode	integer	HTTP ステータスコード。	200
dynamicCode	string	動的エラーコード。	InstanceId
dynamicMessage	string	動的エラーメッセージ。	InstanceId

例

成功レスポンス

JSONJSON

{
  "requestId": "EDFF77E1-1ED1-5389-B6A8-651D9433BBE5",
  "success": true,
  "code": "Topic.NotFound",
  "message": "Parameter instanceId is mandatory for this action .",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 1,
    "list": [
      {
        "regionId": "cn-hangzhou",
        "instanceId": "rmq-cn-7e22ody****",
        "topicName": "topic_test",
        "messageId": "7F00000100207A4F0F294A938F7807AE",
        "bornTime": "2023-03-22 12:17:08",
        "messageTag": "xx",
        "messageKeys": [
          "xx"
        ]
      }
    ]
  },
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId"
}

エラーコード

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

変更履歴

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