File - List From Compute Node

Služba:

Batch Service

Verze rozhraní API:

2024-07-01.20.0

Zobrazí seznam všech souborů v adresářích úloh na zadaném výpočetním uzlu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky služby Azure Batch.
nodeId	path	True	string	ID výpočetního uzlu, jehož soubory chcete vypsat.
poolId	path	True	string	ID fondu, který obsahuje výpočetní uzel.
api-version	query	True	string	Verze rozhraní API klienta.
$filter	query		string	Klauzule $filter OData. Další informace o vytváření tohoto filtru naleznete v tématu https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.
maxresults	query		integer int32	Maximální počet položek, které se mají vrátit v odpovědi. Může se vrátit maximálně 1 000 souborů.
recursive	query		boolean	Určuje, jestli se mají zobrazit podřízené položky adresáře.
timeout	query		integer int32	Maximální doba, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date		string date-time-rfc1123	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Odpovědi

Name	Typ	Description
200 OK	NodeFileListResult	Odpověď obsahující seznam souborů. Hlavičky client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Tok ověřovacího kódu Microsoft Entra OAuth 2.0

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Typ: apiKey
V: header

Příklady

File list from node

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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"
      }
    }
  ]
}

Definice

Name	Description
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
FileProperties	Vlastnosti souboru ve výpočetním uzlu
NodeFile	Informace o souboru nebo adresáři na výpočetním uzlu
NodeFileListResult	Výsledek výpisu souborů na výpočetním uzlu nebo souborů přidružených k úkolu na výpočetním uzlu.

BatchError

Odpověď na chybu přijatá ze služby Azure Batch

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou invariantní a mají být využity programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná pro zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

Name	Typ	Description
key	string	Identifikátor určující význam vlastnosti Value.
value	string	Další informace zahrnuté v odpovědi na chybu.

ErrorMessage

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy.

FileProperties

Vlastnosti souboru ve výpočetním uzlu

Name	Typ	Description
contentLength	integer	Délka souboru.
contentType	string	Typ obsahu souboru.
creationTime	string	Čas vytvoření souboru. Čas vytvoření se nevrátí pro soubory na výpočetních uzlech Linuxu.
fileMode	string	Atribut režimu souboru v osmičkovém formátu. Režim souborů se vrátí jenom pro soubory na výpočetních uzlech Linuxu.
lastModified	string	Čas poslední změny souboru.

NodeFile

Informace o souboru nebo adresáři na výpočetním uzlu

Name	Typ	Description
isDirectory	boolean	Určuje, zda objekt představuje adresář.
name	string	Cesta k souboru.
properties	FileProperties	Vlastnosti souboru.
url	string	Adresa URL souboru.

NodeFileListResult

Výsledek výpisu souborů na výpočetním uzlu nebo souborů přidružených k úkolu na výpočetním uzlu.

Name	Typ	Description
odata.nextLink	string	Adresa URL pro získání další sady výsledků.
value	NodeFile[]	Seznam souborů.