ListFolders を呼び出してフォルダをクエリする - DataWorks

ListFolders 操作を呼び出して、フォルダを照会します。

今すぐお試しください

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

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	任意	DataWorks ワークスペースの ID。DataWorks コンソールにログインし、[ワークスペース管理] ページに移動してワークスペース ID を取得します。この API 呼び出しでは、このパラメーターまたは ProjectIdentifier を設定して、DataWorks ワークスペースを指定する必要があります。	10000
ProjectIdentifier	string	任意	DataWorks ワークスペースの名前。DataWorks コンソールにログインし、[ワークスペース管理] ページに移動してワークスペース名を取得します。この API 呼び出しでは、このパラメーターまたは ProjectId を設定して、DataWorks ワークスペースを指定する必要があります。	dw_project
ParentFolderPath	string	必須	親フォルダのパス。	Business_process/my_first_business_process/MaxCompute
PageNumber	integer	必須	返すページ番号。このパラメーターはページネーションに使用されます。	1
PageSize	integer	必須	1ページあたりのエントリ数。デフォルト値は 10、最大値は 100 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object
HttpStatusCode	integer	HTTP ステータスコード。	200
ErrorMessage	string	エラーメッセージ。	The connection does not exist.
RequestId	string	リクエスト ID。この ID は、問題のトラブルシューティングに使用します。	0000-ABCD-****
ErrorCode	string	エラーコード。	Invalid.Tenant.ConnectionNotExists
Success	boolean	操作が成功したかどうかを示します。	true
Data	object	指定された条件を満たすフォルダのリスト。
PageNumber	integer	返されたページのページ番号。	1
PageSize	integer	返されたページのエントリ数。	10
TotalCount	integer	フィルター条件に一致するエントリの総数。	13
Folders	array<object>	フォルダのリスト。
	object
FolderPath	string	フォルダのパス。	Business_process/my_first_business_process/MaxCompute/ods_layer
FolderId	string	フォルダの ID。	2735c2****

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Folders": [
      {
        "FolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer",
        "FolderId": "2735c2****"
      }
    ]
  }
}

エラーコード

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.

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

変更履歴

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