非同期ポーリングによる DeleteFile API で DataStudio ファイルを削除 - DataWorks - Alibaba Cloud - DataWorks

DataStudio からファイルを削除します。ファイルがコミット済みの場合、スケジューリングシステムでファイルを削除するための非同期プロセスがトリガーされます。返された DeploymentId パラメーターの値は、GetDeployment 操作を呼び出して非同期プロセスのステータスをポーリングするために使用されます。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	任意	DataWorks ワークスペースの ID です。DataWorks コンソール（https://dataworks.console.alibabacloud.com/console）にログインし、[ワークスペース] ページから ID を確認できます。この操作を呼び出す際には、本パラメーターまたは ProjectIdentifier パラメーターのいずれかを指定して、DataWorks ワークスペースを特定する必要があります。	10000
ProjectIdentifier	string	任意	DataWorks ワークスペースの名前です。DataWorks コンソール（https://dataworks.console.alibabacloud.com/console）にログインし、[ワークスペース] ページから名前を確認できます。この操作を呼び出す際には、本パラメーターまたは ProjectId パラメーターのいずれかを指定して、DataWorks ワークスペースを特定する必要があります。	dw_project
FileId	integer	必須	ファイルの ID です。関連するフォルダー ID を取得するには、ListFiles 操作を呼び出します。	10000201

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果。
HttpStatusCode	integer	HTTP ステータスコード。	200
DeploymentId	integer	ファイルがすでにコミット済みの場合、DeleteFile 操作はスケジューリングシステムで非同期削除プロセスもトリガーします。トリガーされた非同期削除プロセスのステータスをポーリングするには、DeleteFile 操作によって返される DeploymentId を使用して GetDeployment を呼び出す必要があります。このフィールドが空の場合、ファイルは削除されており、それ以上のポーリングは不要です。	1000000001
RequestId	string	リクエスト ID。エラー発生時のトラブルシューティングに使用されます。	0000-ABCD-EFG****
ErrorMessage	string	エラーメッセージ。	The connection does not exist.
Success	boolean	呼び出しが成功したかどうかを示します。有効な値: true: 成功。 false: 失敗。	true
ErrorCode	string	エラーコード。	Invalid.Tenant.ConnectionNotExists

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "DeploymentId": 1000000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

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

変更履歴

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