GetFolder API でフォルダ詳細を取得 - DataWorks

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	任意	DataWorks ワークスペースの ID です。ワークスペース ID は、DataWorks コンソールのワークスペース構成ページから取得できます。この API 呼び出しで対象とする DataWorks ワークスペースを特定するには、本パラメーターまたは ProjectIdentifier のいずれかを指定する必要があります。	1000011
ProjectIdentifier	string	任意	DataWorks ワークスペースの名前です。ワークスペース名は、DataWorks コンソールのワークスペース構成ページから取得できます。この API 呼び出しで対象とする DataWorks ワークスペースを特定するには、本パラメーターまたは ProjectId のいずれかを指定する必要があります。	dw_project
FolderId	string	任意	フォルダの ID です。本パラメーターまたは FolderPath のいずれかを指定する必要があります。フォルダ ID は、ListFolders 操作を呼び出すことで取得できます。	273****
FolderPath	string	任意	フォルダのパスです。本パラメーターまたは FolderId のいずれかを指定する必要があります。フォルダパスは、ListFolders 操作を呼び出すことで取得できます。	Business_process/my_first_business_process/MaxCompute/ods_layer

レスポンスフィールド

フィールド	型	説明	例
	object	応答内容です。
HttpStatusCode	integer	HTTP ステータスコードです。	200
ErrorMessage	string	エラーメッセージです。	The connection does not exist.
RequestId	string	リクエスト ID です。エラー発生時のトラブルシューティングに使用します。	0000-ABCD-EFG****
ErrorCode	string	エラーコードです。	Invalid.Tenant.ConnectionNotExists
Success	boolean	呼び出しが成功したかどうかを示します。 true false	true
Data	object	フォルダの詳細情報です。
FolderPath	string	フォルダのパスです。	Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string	フォルダの ID です。	2735****

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
    "FolderId": "2735****"
  }
}

エラーコード

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.

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

変更履歴

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