Compartilhar via

Path - List

  • Referência
Serviço:
Storage Services
Versão da API:
2023-08-03

Listar caminhos e suas propriedades no sistema de arquivos fornecido.

GET https://{accountName}.{dnsSuffix}/{filesystem}?recursive={recursive}&resource=filesystem
Com parâmetros opcionais: 
GET https://{accountName}.{dnsSuffix}/{filesystem}?directory={directory}&recursive={recursive}&continuation={continuation}&maxResults={maxResults}&upn={upn}&resource=filesystem&timeout={timeout}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
 path True

string

O nome da conta de Armazenamento do Azure.
dnsSuffix
 path True

string

O sufixo DNS para o ponto de extremidade do Azure Data Lake Storage.
filesystem
 path True

string

minLength: 3
maxLength: 63
pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$

O identificador do sistema de arquivos. O valor deve iniciar e terminar com uma letra ou número e deve conter apenas letras, números e o caractere traço (-). Traços consecutivos não são permitidos. Todas as letras devem ser minúsculas. O valor deve ter entre 3 e 63 caracteres.
recursive
 query True

boolean

Se "true", todos os caminhos serão listados; caso contrário, somente os caminhos na raiz do sistema de arquivos são listados. Se "diretório" for especificado, a lista incluirá apenas caminhos que compartilham a mesma raiz.
resource
 query True

FilesystemResourceType

O valor deve ser "filesystem" para todas as operações do sistema de arquivos.
continuation
 query

string

O número de caminhos retornados com cada invocação é limitado. Se o número de caminhos a serem retornados exceder esse limite, um token de continuação será retornado no cabeçalho de resposta x-ms-continuation. Quando um token de continuação é retornado na resposta, ele deve ser especificado em uma invocação subsequente da operação de lista para continuar listando os caminhos. Observe que o token de continuação retornado no cabeçalho de resposta x-ms-continuation deve ser codificado em URL antes de ser usado em uma invocação subsequente.
directory
 query

string

Filtra os resultados para caminhos dentro do diretório especificado. Ocorrerá um erro se o diretório não existir.
maxResults
 query

integer (int32)

minimum: 1

Um valor opcional que especifica o número máximo de itens a serem retornados. Se for omitida ou maior que 5.000, a resposta incluirá até 5.000 itens.
timeout
 query

integer (int32)

minimum: 1

Um valor de tempo limite de operação opcional em segundos. O período começa quando a solicitação é recebida pelo serviço. Se o valor do tempo limite for decorrido antes da conclusão da operação, a operação falhará.
upn
 query

boolean

Opcional. Válido somente quando o Namespace Hierárquico está habilitado para a conta. Se "true", os valores de identidade do usuário retornados nos campos proprietário e grupo de cada entrada de lista serão transformados de IDs de objeto do Azure Active Directory para nomes de entidade de segurança de usuário. Se "false", os valores serão retornados como IDs de objeto do Azure Active Directory. O valor padrão é false. Observe que as IDs de objeto de grupo e aplicativo não são traduzidas porque não têm nomes amigáveis exclusivos.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-request-id

string

pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$

Uma UUID registrada nos logs de análise para solução de problemas e correlação.
x-ms-date

string

Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Isso é necessário ao usar a autorização de chave compartilhada.
x-ms-version

string

Especifica a versão do protocolo REST usada para processar a solicitação. Isso é necessário ao usar a autorização de chave compartilhada.

Respostas

Nome Tipo Description
200 OK

PathList

Okey

Cabeçalhos

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-continuation: string
  • x-ms-encryption-scope: string
Other Status Codes

DataLakeStorageError

Ocorreu um erro. Os possíveis status HTTP, código e cadeias de caracteres de mensagem estão listados abaixo:

  • 400 Solicitação Inválida, ContentLengthMustBeZero, "O cabeçalho da solicitação Content-Length deve ser zero".
  • 400 Solicitação Inválida, InvalidAuthenticationInfo, "As informações de autenticação não são fornecidas no formato correto. Verifique o valor do cabeçalho de autorização."
  • 400 Solicitação Inválida, InvalidFlushPosition: "Os dados carregados não são contíguos ou o valor do parâmetro de consulta de posição não é igual ao comprimento do arquivo depois de acrescentar os dados carregados."
  • 400 Solicitação Inválida, InvalidHeaderValue: "O valor de um dos cabeçalhos HTTP não está no formato correto."
  • 400 Solicitação Inválida, InvalidHttpVerb, "O verbo HTTP especificado é inválido - ele não é reconhecido pelo servidor".
  • 400 Solicitação Inválida, InvalidInput, "Uma das entradas de solicitação não é válida".
  • 400 Solicitação Inválida, InvalidPropertyName, "Um nome de propriedade não pode estar vazio".
  • 400 Solicitação Inválida, InvalidPropertyName, "O nome da propriedade contém caracteres inválidos".
  • 400 Solicitação Inválida, InvalidQueryParameterValue, "O valor de um dos parâmetros de consulta especificados no URI da solicitação é inválido."
  • 400 Solicitação Inválida, InvalidResourceName, "O nome do recurso especificado contém caracteres inválidos".
  • 400 Solicitação Inválida, InvalidSourceUri, "O URI de origem é inválido".
  • 400 Solicitação Inválida, InvalidUri, "O URI da solicitação é inválido".
  • 400 Solicitação Inválida, MissingRequiredHeader, "Um cabeçalho HTTP obrigatório para essa solicitação não é especificado."
  • 400 Solicitação Inválida, MissingRequiredQueryParameter, "Um parâmetro de consulta obrigatório para essa solicitação não é especificado."
  • 400 Solicitação Incorreta, MultipleConditionHeadersNotSupported, "Não há suporte para vários cabeçalhos de condição".
  • 400 Solicitação Incorreta, OutOfRangeInput, "Uma das entradas de solicitação está fora do intervalo".
  • 400 Solicitação Incorreta, OutOfRangeQueryParameterValue, "Um dos parâmetros de consulta especificados no URI da solicitação está fora do intervalo permitido".
  • 400 Solicitação Inválida, UnsupportedHeader, "Não há suporte para um dos cabeçalhos especificados na solicitação".
  • 400 Solicitação Inválida, UnsupportedQueryParameter, "Não há suporte para um dos parâmetros de consulta especificados no URI da solicitação".
  • 400 Solicitação Inválida, UnsupportedRestVersion, "A versão Rest especificada não tem suporte".
  • 403 Proibido, AccountIsDisabled, "A conta especificada está desabilitada".
  • 403 Proibido, AuthorizationFailure, "Esta solicitação não está autorizada a executar esta operação".
  • 403 Proibido, InsufficientAccountPermissions, "A conta que está sendo acessada não tem permissões suficientes para executar esta operação".
  • 404 Não Encontrado, FilesystemNotFound, "O sistema de arquivos especificado não existe".
  • 404 Não Encontrado, PathNotFound, "O caminho especificado não existe".
  • 404 Não Encontrado, RenameDestinationParentPathNotFound, "O diretório pai do caminho de destino não existe".
  • 404 Não Encontrado, ResourceNotFound, "O recurso especificado não existe".
  • 404 Não Encontrado, SourcePathNotFound, "O caminho de origem para uma operação de renomeação não existe".
  • Método 405 Não Permitido, UnsupportedHttpVerb, "O recurso não dá suporte ao verbo HTTP especificado".
  • 409 Conflict, DestinationPathIsBeingDeleted, "O caminho de destino especificado está marcado para ser excluído".
  • 409 Conflict, DirectoryNotEmpty, "O valor do parâmetro de consulta recursiva deve ser verdadeiro para excluir um diretório não vazio."
  • 409 Conflict, FilesystemAlreadyExists, "O sistema de arquivos especificado já existe".
  • Conflito 409, FilesystemBeingDeleted, "O sistema de arquivos especificado está sendo excluído".
  • 409 Conflict, InvalidDestinationPath, "O caminho especificado ou um elemento do caminho, existe e seu tipo de recurso é inválido para esta operação." * 409 Conflito, InvalidFlushOperation, "O recurso foi criado ou modificado pela API do Serviço blob e não pode ser gravado pela API do Serviço de Armazenamento do Data Lake."
  • Conflito 409, InvalidRenameSourcePath, "O diretório de origem não pode ser o mesmo que o diretório de destino, nem o destino pode ser um subdiretório do diretório de origem.".
  • Conflito 409, InvalidSourceOrDestinationResourceType, "O tipo de recurso de origem e destino deve ser idêntico".
  • Conflito 409, LeaseAlreadyPresent: "Já há uma concessão presente".
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "A ID de concessão especificada não correspondeu à ID de concessão do recurso com a operação de concessão especificada".
  • Conflito 409, LeaseIsAlreadyBroken: "A concessão já foi interrompida e não pode ser quebrada novamente."
  • Conflito 409, LeaseIsBreakingAndCannotBeAcquired, "A ID de concessão correspondeu, mas a concessão está atualmente em estado de quebra e não pode ser adquirida até que seja interrompida."
  • Conflito 409, LeaseIsBreakingAndCannotBeChanged, "A ID de concessão correspondeu, mas a concessão está atualmente em estado de interrupção e não pode ser alterada."
  • Conflito 409, LeaseIsBrokenAndCannotBeRenewed, "A ID de concessão correspondeu, mas a concessão foi interrompida explicitamente e não pode ser renovada."
  • 409 Conflict, LeaseNameMismatch, "O nome de concessão especificado não correspondeu ao nome de concessão existente".
  • Conflito 409, LeaseNotPresentWithLeaseOperation, "A ID de concessão não está presente com a operação de concessão especificada".
  • Conflito 409, PathAlreadyExists, "O caminho especificado já existe".
  • 409 Conflict, PathConflict, "O caminho especificado ou um elemento do caminho, existe e seu tipo de recurso é inválido para esta operação."
  • Conflito 409, SourcePathIsBeingDeleted, "O caminho de origem especificado está marcado para ser excluído".
  • 409 Conflict, ResourceTypeMismatch, "O tipo de recurso especificado na solicitação não corresponde ao tipo do recurso".
  • 412 Precondition Failed, ConditionNotMet, "A condição especificada usando cabeçalhos condicionais HTTP não é atendida."
  • 412 Precondition Failed, LeaseIdMismatch, "A ID de concessão especificada não correspondeu à ID de concessão do recurso."
  • 412 Precondition Failed, LeaseIdMissing, "No momento, há uma concessão no recurso e nenhuma ID de concessão foi especificada na solicitação."
  • 412 Precondition Failed, LeaseNotPresent, "No momento, não há nenhuma concessão no recurso".
  • 412 Precondition Failed, LeaseLost, "Uma ID de concessão foi especificada, mas a concessão do recurso expirou."
  • 412 Precondition Failed, SourceConditionNotMet, "A condição de origem especificada usando cabeçalhos condicionais HTTP não é atendida."
  • 413 Entidade de Solicitação Muito Grande, RequestBodyTooLarge: "O corpo da solicitação é muito grande e excede o limite máximo permitido".
  • 416 Intervalo Solicitado Não Satisfável, InvalidRange: "O intervalo especificado é inválido para o tamanho atual do recurso".
  • 500 Erro interno do servidor, InternalError, "O servidor encontrou um erro interno. Tente novamente a solicitação."
  • 500 Erro interno do servidor, OperationTimedOut, "A operação não pôde ser concluída dentro do tempo permitido".
  • Serviço 503 Indisponível, ServerBusy, "A saída está acima do limite da conta".
  • Serviço 503 Indisponível, ServerBusy, "A entrada está acima do limite da conta".
  • Serviço 503 Indisponível, ServerBusy, "As operações por segundo estão acima do limite da conta".
  • Serviço 503 Indisponível, ServerBusy: "No momento, o servidor não pode receber solicitações. Tente novamente sua solicitação."

Cabeçalhos

  • x-ms-request-id: string
  • x-ms-version: string

Definições

Nome Description
DataLakeStorageError
Error

O objeto de resposta de erro de serviço.
FilesystemResourceType

O valor deve ser "filesystem" para todas as operações do sistema de arquivos.
Path
PathList

DataLakeStorageError

Objeto
Nome Tipo Description
error

Error

O objeto de resposta de erro de serviço.

Error

Objeto

O objeto de resposta de erro de serviço.

Nome Tipo Description
code

string

O código de erro do serviço.
message

string

A mensagem de erro do serviço.

FilesystemResourceType

Enumeração

O valor deve ser "filesystem" para todas as operações do sistema de arquivos.

Valor Description
filesystem

Path

Objeto
Nome Tipo Valor padrão Description
contentLength

integer (int64)

etag

string

group

string

isDirectory

boolean

False
lastModified

string

name

string

owner

string

permissions

string

x-ms-encryption-context

string

Se o valor da propriedade de contexto de criptografia for definido, ele retornará o valor definido. Válido somente quando o Namespace Hierárquico está habilitado para a conta.
x-ms-encryption-key-sha256

string

O servidor ecoará o SHA256 da chave de criptografia fornecida pelo cliente para validar a chave usada na operação.
x-ms-encryption-scope

string

Se a solicitação usou um escopo de criptografia, para que o cliente possa garantir que o conteúdo da solicitação seja criptografado com êxito usando o escopo de criptografia.
x-ms-server-encrypted: true/false

boolean

O valor desse cabeçalho será definido como true se o conteúdo da solicitação for criptografado com êxito usando o algoritmo especificado.

PathList

Objeto
Nome Tipo Description
paths

Path[]