GetInstance API を使用したインスタンス情報のクエリ - DataWorks

インスタンスに関する情報を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:*

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	integer	必須	インスタンス ID。ListInstances 操作を呼び出して ID を照会できます。	1234
ProjectEnv	string	必須	ワークスペースの環境。有効な値：PROD および DEV。	PROD

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
HttpStatusCode	integer	HTTP ステータスコード。	200
RequestId	string	リクエスト ID。	E6F0DBDD-5AD****
ErrorMessage	string	インスタンスのスケジューリングに失敗した場合に返されるエラーメッセージ。	test
Success	boolean	リクエストが成功したかどうかを示します。	true
ErrorCode	string	エラーコード。	0
Data	object	インスタンスの詳細。
Status	string	インスタンスを生成するノードのステータス。有効な値： NOT_RUN：ノードは実行されていません。 WAIT_TIME：ノードはスケジューリング時間を待っています。 WAIT_RESOURCE：ノードはリソースを待っています。 RUNNING：ノードは実行中です。 CHECKING：ノードの Data Quality がチェックされています。 CHECKING_CONDITION：ノードのブランチ条件がチェックされています。 FAILURE：ノードの実行に失敗しました。 SUCCESS：ノードは正常に実行されました。	NOT_RUN
CycTime	integer	インスタンスのスケジューリング時間。	1590422400000
BeginRunningTime	integer	インスタンスの実行が開始された時間。	1590416703313
FinishTime	integer	インスタンスの実行が完了した時間。	1590416703313
CreateTime	integer	インスタンスが生成された時間。	1590416703313
DagId	integer	ワークフロー ID。	338450167
Priority	integer	インスタンスの優先度。有効な値：1、3、5、7、8。値が大きいほど優先度が高くなります。デフォルト値：1。	1
TaskType	string	インスタンスを生成するノードのスケジューリングタイプ。有効な値： NORMAL(0)：ノードは自動トリガーノードです。スケジューリングシステムは定期的にノードを実行します。 MANUAL(1)：ノードは手動トリガーノードです。スケジューリングシステムは定期的にノードを実行しません。 PAUSE(2)：ノードは凍結ノードです。スケジューリングシステムは定期的にノードを実行しますが、ノードの実行を開始するとステータスを失敗に設定します。 SKIP(3)：ノードはドライランノードです。スケジューリングシステムは定期的にノードを実行しますが、ノードの実行を開始するとステータスを成功に設定します。 SKIP_UNCHOOSE(4)：ノードは一時的なワークフローで選択されていないノードです。このタイプのノードは一時的なワークフローにのみ存在します。スケジューリングシステムは、ノードの実行を開始するとステータスを成功に設定します。 SKIP_CYCLE(5)：ノードは週または月単位でスケジューリングされ、スケジューリング時間を待っているノードです。スケジューリングシステムは定期的にノードを実行しますが、ノードの実行を開始するとステータスを成功に設定します。 CONDITION_UNCHOOSE(6)：ノードは祖先ブランチノードによって選択されておらず、ドライランノードとして実行されます。 REALTIME_DEPRECATED(7)：ノードにはリアルタイムで生成されたが非推奨のインスタンスがあります。スケジューリングシステムはノードのステータスを成功に設定します。	NORMAL(0)
ParamValues	string	ノードに関連するパラメーター。	bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif
Connection	string	接続文字列。	odps_first
BaselineId	integer	ベースライン ID。	123123
DqcType	integer	インスタンスが Data Quality のモニタリングルールに関連付けられているかどうかを示します。有効な値： 0：インスタンスは Data Quality のモニタリングルールに関連付けられています。 1：インスタンスは Data Quality のモニタリングルールに関連付けられていません。	1
DagType	string	ワークフローのタイプ。有効な値： DAILY：ワークフローは自動トリガーノードの実行に使用されます。 MANUAL：ワークフローは手動トリガーノードの実行に使用されます。 SMOKE_TEST：ワークフローはスモークテストの実行に使用されます。 SUPPLY_DATA：ワークフローはデータのバックフィルに使用されます。	DAILY
BusinessId	integer	ワークフロー ID。	123
TaskRerunTime	integer	ノードを再実行できる回数。このパラメーターの値は、空または 0 以上の整数です。このパラメーターの値が空の場合、ノードを再実行できる回数は指定されません。このパラメーターの値が 0 の場合、ノードは再実行できません。このパラメーターの値が n などの正の整数の場合、ノードはさらに n 回再実行できます。たとえば、このパラメーターの値が 1 の場合、ノードはさらに 1 回再実行できます。このパラメーターの値が 2 の場合、ノードはさらに 2 回再実行できます。	0
PeriodNumber	integer	サイクルのシーケンス番号。このパラメーターは、当日のインスタンスのサイクルのシーケンス番号を示します。	1
ModifyTime	integer	インスタンスが最後に変更された時間。	1590416703313
Repeatability	boolean	インスタンスを生成するノードを再実行できるかどうかを示します。	true
RepeatInterval	integer	ノードの実行に失敗した後、ノードが再実行される間隔。単位：ミリ秒。	60000
InstanceId	integer	インスタンス ID。	11713307578
BeginWaitResTime	integer	インスタンスがリソースの待機を開始した時間。	1590416703313
RelatedFlowId	integer	ノードが属するワークフローの ID。	123123
Bizdate	integer	インスタンスのデータタイムスタンプ。ほとんどの場合、値はインスタンスが実行された時刻の 1 日前です。	1590336000000
NodeName	string	ノードの名前。	kzh
BeginWaitTimeTime	integer	インスタンスがスケジューリングされるのを待ち始めた時間。	1590416703313
DqcDescription	string	ノードに関連付けられている Data Quality のテーブルおよびパーティションフィルター式。	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
NodeId	integer	ノード ID。	33115
CreateUser	string	インスタンスの作成者。	111
Owner	string	インスタンスのオーナー。	111

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "test",
  "Success": true,
  "ErrorCode": "0",
  "Data": {
    "Status": "NOT_RUN",
    "CycTime": 1590422400000,
    "BeginRunningTime": 1590416703313,
    "FinishTime": 1590416703313,
    "CreateTime": 1590416703313,
    "DagId": 338450167,
    "Priority": 1,
    "TaskType": "NORMAL(0)",
    "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
    "Connection": "odps_first",
    "BaselineId": 123123,
    "DqcType": 1,
    "DagType": "DAILY",
    "BusinessId": 123,
    "TaskRerunTime": 0,
    "PeriodNumber": 1,
    "ModifyTime": 1590416703313,
    "Repeatability": true,
    "RepeatInterval": 60000,
    "InstanceId": 11713307578,
    "BeginWaitResTime": 1590416703313,
    "RelatedFlowId": 123123,
    "Bizdate": 1590336000000,
    "NodeName": "kzh",
    "BeginWaitTimeTime": 1590416703313,
    "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
    "NodeId": 33115,
    "CreateUser": "111",
    "Owner": "111"
  }
}

エラーコード

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

変更履歴

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