File - List From Compute Node

リファレンス

サービス:: Batch Service

API バージョン:: 2024-07-01.20.0

指定したコンピューティングノードのタスクディレクトリ内のすべてのファイルを一覧表示します。

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?api-version=2024-07-01.20.0

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

GET {batchUrl}/pools/{poolId}/nodes/{nodeId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI パラメーター

名前	/	必須	型	説明
batchUrl	path	True	string	すべての Azure Batch サービス要求のベース URL。
nodeId	path	True	string	ファイルを一覧表示するコンピューティングノードの ID。
poolId	path	True	string	コンピューティングノードを含むプールの ID。
api-version	query	True	string	クライアント API のバージョン。
$filter	query		string	OData $filter 句。このフィルターの構築の詳細については、https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-filesを参照してください。
maxresults	query		integer int32	応答で返される項目の最大数。最大 1,000 個のファイルを返すことができます。
recursive	query		boolean	ディレクトリの子を一覧表示するかどうか。
timeout	query		integer int32	サーバーが要求の処理に費やすことができる最大時間 (秒単位)。既定値は 30 秒です。値が 30 より大きい場合は、代わりに既定値が使用されます。

要求ヘッダー

Media Types: "application/json; odata=minimalmetadata"

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

応答

名前	型	説明
200 OK	NodeFileListResult	ファイルの一覧を含む応答。ヘッダー client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch サービスからのエラー。

名前

型

説明

200 OK

NodeFileListResult

ファイルの一覧を含む応答。

ヘッダー

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

Other Status Codes

BatchError

Batch サービスからのエラー。

セキュリティ

azure_auth

Microsoft Entra OAuth 2.0 認証コードフロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

Authorization

型: apiKey
/: header

例

File list from node

要求のサンプル

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/files?recursive=False&api-version=2024-07-01.20.0

応答のサンプル

状態コード:: 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": "2014-09-19T21:56:17.679195Z",
        "lastModified": "2014-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": "2014-09-19T21:56:17.5590855Z",
        "lastModified": "2014-09-19T21:56:17.5590855Z",
        "contentLength": 0,
        "contentType": "application/octet-stream"
      }
    }
  ]
}

定義

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

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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

FileProperties

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

名前	型	説明
contentLength	integer	ファイルの長さ。
contentType	string	ファイルのコンテンツタイプ。
creationTime	string	ファイルの作成時刻。 Linux コンピューティングノード上のファイルの作成時間は返されません。
fileMode	string	8 進数形式のファイルモード属性。ファイルモードは、Linux コンピューティングノード上のファイルに対してのみ返されます。
lastModified	string	ファイルが最後に変更された時刻。

NodeFile

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

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

NodeFileListResult

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

名前	型	説明
odata.nextLink	string	次の結果セットを取得する URL。
value	NodeFile[]	ファイルの一覧。

次の方法で共有

File - List From Compute Node

URI パラメーター

要求ヘッダー

応答

セキュリティ

azure_auth

スコープ

Authorization

例

File list from node

要求のサンプル

応答のサンプル

定義

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

その他のリソース