ListTopics によるイベントのクエリ - DataWorks

イベントをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
BeginTime	string	必須	クエリする時間範囲の開始時刻。ISO 8601 規格の yyyy-MM-dd'T'HH:mm:ssZ フォーマットで時刻を指定します。時刻は協定世界時 (UTC) である必要があります。	2019-03-24T00:00:00+0800
EndTime	string	必須	クエリする時間範囲の終了時刻。ISO 8601 規格の yyyy-MM-dd'T'HH:mm:ssZ フォーマットで時刻を指定します。時刻は協定世界時 (UTC) である必要があります。	2019-03-25T23:00:00+0800
TopicTypes	string	任意	イベントのタイプ。有効な値: SLOW、ERROR。SLOW は、現在のスケジューリングサイクルにおけるノードの実行持続時間が、以前のスケジューリングサイクルにおけるノードの平均実行持続時間よりも著しく長いことを示します。ERROR は、ノードの実行に失敗したことを示します。複数のタイプを指定できます。カンマ (,) で区切ります。	ERROR,SLOW
TopicStatuses	string	任意	イベントのステータス。有効な値: IGNORE、NEW、FIXING、RECOVER。IGNORE は、イベントが無視されたことを示します。NEW は、イベントが新しいイベントであることを示します。FIXING は、イベントが処理中であることを示します。RECOVER は、イベントが処理済みであることを示します。複数のステータスを指定できます。カンマ (,) で区切ります。	IGNORE,NEW,FIXING,RECOVER
NodeId	integer	任意	イベントをトリガーするノードの ID。このパラメーターまたは InstanceId パラメーターのいずれかを設定できます。	1234
InstanceId	integer	任意	イベントをトリガーするノードインスタンスの ID。このパラメーターまたは NodeId パラメーターのいずれかを設定できます。	12345
Owner	string	任意	イベントの所有者が使用する Alibaba Cloud アカウントの ID。	952795****
PageNumber	integer	必須	返すページ番号。有効な値: 1～30。デフォルト値: 1。	1
PageSize	integer	必須	1 ページあたりに返すエントリ数。デフォルト値: 10。最大値: 100。	10

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	返された HTTP ステータスコード。	200
RequestId	string	リクエストの ID。この ID を使用して問題のトラブルシューティングを行うことができます。	0000-ABCD-EFG****
ErrorMessage	string	返されたエラーメッセージ。	The specified parameters are invalid.
ErrorCode	string	返されたエラーコード。	1031203110005
Success	boolean	リクエストが成功したかどうかを示します。	true
Data	object	返されたイベントに関する情報。
PageNumber	integer	返されたページのページ番号。	1
PageSize	integer	1 ページあたりに返されるエントリ数。	10
TotalCount	integer	返されたイベントの総数。	100
Topics	array<object>	返されたイベント。
	object
TopicName	string	イベントの名前。	1234 Error
ProjectId	integer	ノードが属するワークスペースの ID。	1234
NodeOwner	string	ノードの所有者が使用する Alibaba Cloud アカウントの ID。	952795****
InstanceId	integer	イベントをトリガーするノードインスタンスの ID。	12345
FixTime	integer	イベントが処理されたタイムスタンプ。	1553508465000
TopicType	string	イベントのタイプ。有効な値: SLOW、ERROR。SLOW は、現在のスケジューリングサイクルにおけるノードの実行持続時間が、以前のスケジューリングサイクルにおけるノードの平均実行持続時間よりも著しく長いことを示します。ERROR は、ノードの実行に失敗したことを示します。	ERROR
TopicStatus	string	イベントのステータス。有効な値: IGNORE、NEW、FIXING、RECOVER。IGNORE は、イベントが無視されたことを示します。NEW は、イベントが新しいイベントであることを示します。FIXING は、イベントが処理中であることを示します。RECOVER は、イベントが処理済みであることを示します。	NEW
HappenTime	integer	イベントが発生したタイムスタンプ。イベントが発生した時刻とイベントが検出された時刻との間に時間差がある場合があります。	1553508465000
NodeName	string	ノードの名前。	Node Name
TopicId	integer	イベントの ID。	1234
AddTime	integer	イベントが検出されたタイムスタンプ。	1553524393000
NodeId	integer	イベントをトリガーするノードの ID。	1234

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The specified parameters are invalid.",
  "ErrorCode": "1031203110005",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Topics": [
      {
        "TopicName": "1234出错",
        "ProjectId": 1234,
        "NodeOwner": "952795****",
        "InstanceId": 12345,
        "FixTime": 1553508465000,
        "TopicType": "ERROR",
        "TopicStatus": "NEW",
        "HappenTime": 1553508465000,
        "NodeName": "节点名称",
        "TopicId": 1234,
        "AddTime": 1553524393000,
        "NodeId": 1234
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
500	Forbidden.Not.Server	The dataworksAPI service is not available in this area. Please try it in another area.
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.Api.Risk	The request for this resource has exceeded your daily available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

変更履歴

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