すべてのプロダクト
Search
ドキュメントセンター

Data Management:StopTaskFlowInstance

最終更新日:Mar 21, 2026

タスクフローインスタンスを停止します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:StopTaskFlowInstance

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Tid

integer

任意

テナント ID です。

説明

テナント ID を確認するには、Data Management (DMS) コンソールにアクセスし、右上隅のプロフィール画像にポインターを合わせます。詳細については、「現在のテナントに関する情報の表示」をご参照ください。

3***

DagId

integer

必須

タスクフローの ID です。ListTaskFlow 操作または ListLhTaskFlowAndScenario 操作を呼び出して、タスクフロー ID をクエリできます。

7***

DagInstanceId

integer

必須

タスクフローの実行レコード ID です。ListTaskFlowInstance 操作を呼び出して、実行レコード ID をクエリできます。

47****

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーターです。

RequestId

string

リクエスト ID です。この ID を使用してログをクエリし、問題をトラブルシューティングできます。

028BF827-3801-5869-8548-F4A039256308

ErrorCode

string

リクエストが失敗した場合に返されるエラーコードです。

UnknownError

ErrorMessage

string

リクエストが失敗した場合に返されるエラーメッセージです。

UnknownError

Success

boolean

リクエストが成功したかどうかを示します。有効な値は次のとおりです。

  • true:リクエストが成功しました。

  • false:リクエストが失敗しました。

true

成功レスポンス

JSONJSON

{
  "RequestId": "028BF827-3801-5869-8548-F4A039256308",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

エラーコード

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

変更履歴

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