File - List From Compute Node
Lista todos os arquivos em diretórios de tarefa no Nó de Computação especificado.
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
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
batch
|
path | True |
string |
A URL base para todas as solicitações de serviço do Lote do Azure. |
node
|
path | True |
string |
A ID do Nó de Computação cujos arquivos você deseja listar. |
pool
|
path | True |
string |
A ID do pool que contém o Nó de Computação. |
api-version
|
query | True |
string |
Versão da API do cliente. |
$filter
|
query |
string |
Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. |
|
maxresults
|
query |
integer int32 |
O número máximo de itens a serem retornados na resposta. Um máximo de 1000 arquivos pode ser retornado. |
|
recursive
|
query |
boolean |
Se deseja listar filhos de um diretório. |
|
timeout
|
query |
integer int32 |
O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado. |
Cabeçalho da solicitação
Media Types: "application/json; odata=minimalmetadata"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
client-request-id |
string uuid |
A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. |
|
return-client-request-id |
boolean |
Se o servidor deve retornar a ID de solicitação do cliente na resposta. |
|
ocp-date |
string date-time-rfc1123 |
A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Uma resposta que contém a lista de arquivos. Cabeçalhos
|
|
Other Status Codes |
O erro do serviço do Lote. |
Segurança
azure_auth
Fluxo de código de autenticação do Microsoft Entra OAuth 2.0
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
user_impersonation | Representar sua conta de usuário |
Authorization
Tipo:
apiKey
Em:
header
Exemplos
File list from node
Solicitação de exemplo
GET account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z/files?recursive=False&api-version=2024-07-01.20.0
Resposta de exemplo
{
"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"
}
}
]
}
Definições
Nome | Description |
---|---|
Batch |
Uma resposta de erro recebida do serviço do Lote do Azure. |
Batch |
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure. |
Error |
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure. |
File |
As propriedades de um arquivo em um Nó de Computação. |
Node |
Informações sobre um arquivo ou diretório em um Nó de Computação. |
Node |
O resultado da listagem dos arquivos em um Nó de Computação ou os arquivos associados a uma Tarefa em um Nó de Computação. |
BatchError
Uma resposta de erro recebida do serviço do Lote do Azure.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente. |
message |
Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário. |
|
values |
Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro. |
BatchErrorDetail
Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
Nome | Tipo | Description |
---|---|---|
key |
string |
Um identificador que especifica o significado da propriedade Value. |
value |
string |
As informações adicionais incluídas na resposta de erro. |
ErrorMessage
Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
Nome | Tipo | Description |
---|---|---|
lang |
string |
O código de idioma da mensagem de erro |
value |
string |
O texto da mensagem. |
FileProperties
As propriedades de um arquivo em um Nó de Computação.
Nome | Tipo | Description |
---|---|---|
contentLength |
integer |
O comprimento do arquivo. |
contentType |
string |
O tipo de conteúdo do arquivo. |
creationTime |
string |
A hora de criação do arquivo. |
fileMode |
string |
O atributo de modo de arquivo no formato octal. |
lastModified |
string |
A hora em que o arquivo foi modificado pela última vez. |
NodeFile
Informações sobre um arquivo ou diretório em um Nó de Computação.
Nome | Tipo | Description |
---|---|---|
isDirectory |
boolean |
Se o objeto representa um diretório. |
name |
string |
O caminho do arquivo. |
properties |
As propriedades do arquivo. |
|
url |
string |
A URL do arquivo. |
NodeFileListResult
O resultado da listagem dos arquivos em um Nó de Computação ou os arquivos associados a uma Tarefa em um Nó de Computação.
Nome | Tipo | Description |
---|---|---|
odata.nextLink |
string |
A URL para obter o próximo conjunto de resultados. |
value |
Node |
A lista de arquivos. |