Nodes - List Node Files

サービス:: Batch Service

API バージョン:: 2025-06-01

指定されたCompute Node上のタスクディレクトリ内のすべてのファイルを一覧にします。

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/files?api-version=2025-06-01

省略可能なパラメーターを含む:

GET {endpoint}/pools/{poolId}/nodes/{nodeId}/files?api-version=2025-06-01&timeOut={timeOut}&maxresults={maxresults}&$filter={$filter}&recursive={recursive}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	Batch アカウントエンドポイント (例: https://batchaccount.eastus2.batch.azure.com)。
nodeId	path	True	string	リストしたいファイルのCompute NodeのIDです。
poolId	path	True	string	コンピューティングノードを含むプールの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	OData $filter 句。このフィルターの構築についての詳細は https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-filesを参照してください。
maxresults	query		integer (int32) minimum: 1 maximum: 1000	応答で返される項目の最大数。最大1000件の申請書を返送できます。
recursive	query		boolean	ディレクトリの子どもをリストアップするかどうか。
timeOut	query		integer (int32)	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が30より大きい場合は、デフォルトが使われます。」

要求ヘッダー

名前	型	説明
client-request-id	string	呼び出し元によって生成された要求 ID。中かっこなどの装飾のない GUID の形式 (例: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0)。
return-client-request-id	boolean	サーバーが応答で client-request-id を返す必要があるかどうか。
ocp-date	string (date-time-rfc7231)	要求が発行された時刻。通常、クライアントライブラリはこれを現在のシステムクロック時間に設定します。REST API を直接呼び出す場合は、明示的に設定します。

応答

名前	型	説明
200 OK	BatchNodeFileListResult	要求は成功しました。ヘッダー ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	予期しないエラー応答。

名前

型

説明

200 OK

BatchNodeFileListResult

要求は成功しました。

ヘッダー

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://batch.core.windows.net//.default

例

File list from node

要求のサンプル

HTTP

GET {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/files?api-version=2025-06-01&recursive=False

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "name": "shared",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared",
      "isDirectory": true
    },
    {
      "name": "startup\\ProcessEnv.cmd",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup/ProcessEnv.cmd",
      "isDirectory": false,
      "properties": {
        "creationTime": "2025-09-19T21:56:17.679195Z",
        "lastModified": "2025-09-19T21:56:17.679195Z",
        "contentLength": "1813",
        "contentType": "application/octet-stream"
      }
    },
    {
      "name": "startup\\stderr.txt",
      "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup/stderr.txt",
      "isDirectory": false,
      "properties": {
        "creationTime": "2025-09-19T21:56:17.5590855Z",
        "lastModified": "2025-09-19T21:56:17.5590855Z",
        "contentLength": "0",
        "contentType": "application/octet-stream"
      }
    }
  ]
}

定義

名前	説明
BatchError	Azure Batch サービスから受信したエラー応答。
BatchErrorDetail	Azure Batch エラー応答に含まれる追加情報の項目。
BatchErrorMessage	Azure Batch エラー応答で受信したエラーメッセージ。
BatchNodeFile	コンピューティングノード上のファイルまたはディレクトリに関する情報。
BatchNodeFileListResult	コンピューティングノード上のファイル、またはコンピューティングノード上のタスクに関連付けられているファイルを一覧表示した結果。
FileProperties	コンピューティングノード上のファイルのプロパティ。

BatchError

Object

Azure Batch サービスから受信したエラー応答。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムで使用することを目的としています。
message	BatchErrorMessage	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。
values	BatchErrorDetail[]	エラーに関する追加の詳細を含むキーと値のペアのコレクション。

BatchErrorDetail

Object

Azure Batch エラー応答に含まれる追加情報の項目。

名前	型	説明
key	string	Value プロパティの意味を指定する識別子。
value	string	エラー応答に含まれる追加情報。

BatchErrorMessage

Object

Azure Batch エラー応答で受信したエラーメッセージ。

名前	型	説明
lang	string	エラーメッセージの言語コード。
value	string	メッセージのテキスト。

BatchNodeFile

Object

コンピューティングノード上のファイルまたはディレクトリに関する情報。

名前	型	説明
isDirectory	boolean	オブジェクトがディレクトリを表すかどうか。
name	string	ファイルパス。
properties	FileProperties	ファイルのプロパティです。
url	string (uri)	ファイルの URL。

BatchNodeFileListResult

Object

コンピューティングノード上のファイル、またはコンピューティングノード上のタスクに関連付けられているファイルを一覧表示した結果。

名前	型	説明
odata.nextLink	string (uri)	次の結果セットを取得するための URL。
value	BatchNodeFile[]	ファイルのリスト。

FileProperties

Object

コンピューティングノード上のファイルのプロパティ。

名前	型	説明
contentLength	string (int64)	ファイルの長さ。
contentType	string	ファイルのコンテンツタイプ。
creationTime	string (date-time)	ファイル作成の時間。 Linux Compute Node上のファイルの作成時間は返されません。
fileMode	string	ファイルモード属性は八進形式です。ファイルモードはLinuxのCompute Node上のファイルにのみ返されます。
lastModified	string (date-time)	ファイルが最後に修正された時刻。