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

RunSemanticJob または ListSemanticJobRuns によって返された ExecutorJobId を使用して、指定された実行を停止します。呼び出しが成功したことは、停止リクエストが受け入れられたことのみを示します。最終的なステータスは GetSemanticJobDetail を呼び出して照会してください。

操作説明

シナリオ

指定されたセマンティックジョブの実行に対して、エグゼキュータに停止リクエストを送信します。これは、タスクが長期間実行される場合、手動での終了が必要な場合、またはリソースの回収が必要な場合に適用されます。

手順

RunSemanticJob または ListSemanticJobRuns から ExecutorJobId を取得し、タスクの ProjectId を使用します。
オプションで RetryTimes を指定します。
呼び出し後、GetSemanticJobDetail を呼び出して最終的なステータスをポーリングします。必要に応じて、診断のために GetSemanticJobLog を呼び出します。

注意事項

正常なレスポンスは、停止リクエストが処理されたことのみを示します。タスクが望ましい状態に達したことを意味するものではありません。

今すぐお試しください

この 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:KillSemanticJob

update

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ExecutorJobId	string	必須	停止する実行のエグゼキュータタスク ID。RunSemanticJob の応答の Data.ExecutorJobId 値、または ListSemanticJobRuns の Record の ExecutorJobId 値を使用します。	exec-job-demo
ProjectId	integer	必須	タスクが属する DataWorks ワークスペースの ID。CreateSemanticJob の応答の ProjectId 値、または ListSemanticJobs のリスト項目を使用します。	100
RetryTimes	integer	任意	エグゼキュータに停止リクエストを送信する際のリトライ回数。このパラメーターは通常オプションです。指定する場合は、負でない整数を使用します。呼び出し後、GetSemanticJobDetail を呼び出して最終的なステータスを確認します。	1

各リクエストフィールドの説明に基づいてリクエストパラメーターを構築します。

レスポンスフィールド

フィールド	型	説明	例
	object	実行停止リクエストの標準的な応答です。Data フィールドはリクエストの処理結果のみを示し、タスクが望ましい状態に達したことを示すものではありません。
RequestId	string	リクエスト ID。ログの特定や問題のトラブルシューティングに使用します。	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	リクエストが成功したかどうかを示します。
Data	boolean	停止リクエストがエグゼキュータによって受け入れられたかどうかを示します。true が返された場合でも、GetSemanticJobDetail を呼び出して最終的なステータスをクエリしてください。

応答フィールドの平均値および後続の呼び出し関係については、各フィールドの説明を参照してください。

例

成功レスポンス

JSONJSON

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": false
}

エラーコード

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

変更履歴

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