Path - Lease

  • Referência
Service:
Storage Services
API Version:
2023-08-03

Caminho de Concessão
Crie e gerencie uma concessão para restringir o acesso de gravação e exclusão ao caminho. Essa operação dá suporte a solicitações HTTP condicionais. Para obter mais informações, confira Como especificar cabeçalhos condicionais para operações de serviço Blob.

POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}
With optional parameters: 
POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}?timeout={timeout}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
 path True

string

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

string

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

string

O identificador do sistema de arquivos.

Regex pattern: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
path
 path True

string

O caminho do arquivo ou diretório.
timeout
 query

integer

int32

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 passar antes da conclusão da operação, a operação falhará.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-lease-action True

PathLeaseAction

Há cinco ações de concessão: "acquire", "break", "change", "renew" e "release". Use "acquire" e especifique "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Use "break" para interromper uma concessão existente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no arquivo. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Use "change" e especifique a ID de concessão atual em "x-ms-lease-id" e a nova ID de concessão em "x-ms-proposed-lease-id" para alterar a ID de concessão de uma concessão ativa. Use "renovar" e especifique o "x-ms-lease-id" para renovar uma concessão existente. Use "release" e especifique o "x-ms-lease-id" para liberar uma concessão.
x-ms-lease-duration

integer

int32

A duração da concessão é necessária para adquirir uma concessão e especifica a duração da concessão em segundos. A duração da concessão deve estar entre 15 e 60 segundos ou -1 para concessão infinita.
x-ms-lease-break-period

integer

int32

A duração do período de quebra de concessão é opcional para interromper uma concessão e especifica o período de interrupção da concessão em segundos. A duração da quebra de concessão deve estar entre 0 e 60 segundos.
x-ms-lease-id

string

Necessário quando "x-ms-lease-action" é "renew", "change" ou "release". Para as ações de renovação e liberação, isso deve corresponder à ID de concessão atual.

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-proposed-lease-id

string

Obrigatório quando "x-ms-lease-action" é "acquire" ou "change". Uma concessão será adquirida com essa ID de concessão se a operação for bem-sucedida.

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

string

Opcional. Um valor de ETag. Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado. A ETag deve ser especificada entre aspas.
If-None-Match

string

Opcional. Um valor ETag ou o valor curinga especial ("*"). Especifique esse cabeçalho para executar a operação somente se a ETag do recurso não corresponder ao valor especificado. A ETag deve ser especificada entre aspas.
If-Modified-Since

string

Opcional. Um valor de data e hora. Especifique esse cabeçalho para executar a operação somente se o recurso tiver sido modificado desde a data e hora especificadas.
If-Unmodified-Since

string

Opcional. Um valor de data e hora. Especifique esse cabeçalho para executar a operação somente se o recurso não tiver sido modificado desde a data e hora especificadas.
x-ms-client-request-id

string

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

Regex pattern: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
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

A ação "renovar", "alterar" ou "liberar" foi bem-sucedida.

Headers

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-id: string
201 Created

Uma nova concessão foi criada. A ação "adquirir" foi bem-sucedida.

Headers

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-id: string
202 Accepted

A ação de concessão "break" foi bem-sucedida.

Headers

  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-time: string
Other Status Codes

DataLakeStorageError

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

  • 400 Solicitação Incorreta, ContentLengthMustBeZero, "O cabeçalho de solicitação Content-Length deve ser zero".
  • 400 Solicitação Incorreta, 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 Incorreta, 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 Incorreta, InvalidHeaderValue, "O valor de um dos cabeçalhos HTTP não está no formato correto."
  • 400 Solicitação Incorreta, InvalidHttpVerb, "O verbo HTTP especificado é inválido - ele não é reconhecido pelo servidor."
  • 400 Solicitação Incorreta, InvalidInput, "Uma das entradas de solicitação não é válida".
  • 400 Solicitação Incorreta, 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 Incorreta, InvalidQueryParameterValue, "O valor de um dos parâmetros de consulta especificados no URI da solicitação é inválido."
  • 400 Solicitação Incorreta, InvalidResourceName, "O nome do recurso especificado contém caracteres inválidos".
  • 400 Solicitação Incorreta, InvalidSourceUri, "O URI de origem é inválido".
  • 400 Solicitação Incorreta, InvalidUri, "O URI da solicitação é inválido".
  • 400 Solicitação Incorreta, MissingRequiredHeader, "Um cabeçalho HTTP obrigatório para essa solicitação não é especificado."
  • 400 Solicitação Incorreta, 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 de solicitação está fora do intervalo permitido".
  • 400 Solicitação Incorreta, UnsupportedHeader, "Não há suporte para um dos cabeçalhos especificados na solicitação".
  • 400 Solicitação Incorreta, UnsupportedQueryParameter, "Não há suporte para um dos parâmetros de consulta especificados no URI de 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, Sem SuporteHttpVerb, "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 true para excluir um diretório não vazio."
  • 409 Conflict, FilesystemAlreadyExists, "O sistema de arquivos especificado já existe".
  • 409 Conflict, 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 Conflict, InvalidFlushOperation, "The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API."
  • 409 Conflict, 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."
  • 409 Conflict, InvalidSourceOrDestinationResourceType, "O tipo de recurso de origem e destino deve ser idêntico."
  • 409 Conflict, 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."
  • 409 Conflict, LeaseIsAlreadyBroken, "A concessão já foi quebrada e não pode ser quebrada novamente."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "The lease ID matched, but the lease is currently in breaking state and cannot be changed."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "The lease ID matched, but the lease has been broken explicitly and cannot be renewed."
  • 409 Conflict, LeaseNameMismatch, "O nome da concessão especificado não correspondeu ao nome de concessão existente".
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "A ID de concessão não está presente com a operação de concessão especificada".
  • 409 Conflict, 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: "Atualmente, 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 Satisfiá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. Repita a solicitação."
  • 500 Erro interno do servidor, OperationTimedOut, "A operação não pôde ser concluída dentro do tempo permitido".
  • 503 Serviço Indisponível, ServerBusy, "A saída está acima do limite da conta".
  • 503 Serviço Indisponível, ServerBusy, "A entrada está acima do limite da conta".
  • 503 Serviço Indisponível, ServerBusy, "As operações por segundo estão acima do limite da conta".
  • 503 Serviço Indisponível, ServerBusy, "No momento, o servidor não pode receber solicitações. Tente novamente a sua solicitação.”

Headers

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

Definições

Nome Description
DataLakeStorageError
Error

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

Há cinco ações de concessão: "acquire", "break", "change", "renew" e "release". Use "acquire" e especifique "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Use "break" para interromper uma concessão existente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no arquivo. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Use "change" e especifique a ID de concessão atual em "x-ms-lease-id" e a nova ID de concessão em "x-ms-proposed-lease-id" para alterar a ID de concessão de uma concessão ativa. Use "renovar" e especifique o "x-ms-lease-id" para renovar uma concessão existente. Use "release" e especifique o "x-ms-lease-id" para liberar uma concessão.

DataLakeStorageError

Nome Tipo Description
error

Error

O objeto de resposta de erro de serviço.

Error

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.

PathLeaseAction

Há cinco ações de concessão: "acquire", "break", "change", "renew" e "release". Use "acquire" e especifique "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Use "break" para interromper uma concessão existente. Quando uma concessão é interrompida, o período de interrupção de concessão tem permissão para decorrer, durante o qual nenhuma operação de concessão, exceto interrupção e liberação, pode ser executada no arquivo. Quando uma concessão é interrompida com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Use "change" e especifique a ID de concessão atual em "x-ms-lease-id" e a nova ID de concessão em "x-ms-proposed-lease-id" para alterar a ID de concessão de uma concessão ativa. Use "renovar" e especifique o "x-ms-lease-id" para renovar uma concessão existente. Use "release" e especifique o "x-ms-lease-id" para liberar uma concessão.

Nome Tipo Description
acquire

string

break

string

change

string

release

string

renew

string