Partilhar via

Path - Lease

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

Caminho de locação
Crie e gerencie uma concessão para restringir, gravar e excluir o acesso ao caminho. Esta operação suporta solicitações HTTP condicionais. Para obter mais informações, consulte Especificando cabeçalhos condicionais para operações de serviço de Blob.

POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}
Com parâmetros opcionais: 
POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}?timeout={timeout}

Parâmetros do URI

Name Em Necessá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 Armazenamento do Azure Data Lake.
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.
path
 path True

string

O caminho do arquivo ou diretório.
timeout
 query

integer (int32)

minimum: 1

Um valor de tempo limite de operação opcional em segundos. O prazo começa a correr quando o pedido é recebido pelo serviço. Se o valor de tempo limite decorrer antes da conclusão da operação, a operação falhará.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-lease-action True

PathLeaseAction

São cinco ações de locação: "adquirir", "quebrar", "alterar", "renovar" e "liberar". Use "acquire" e especifique "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Use "break" para quebrar uma locação existente. Quando uma locação é quebrada, o período de interrupção da locação é permitido, durante o qual nenhuma operação de locação, exceto quebra e liberação, pode ser executada no arquivo. Quando uma concessão é quebrada com sucesso, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Use "change" e especifique o ID de concessão atual em "x-ms-lease-id" e o novo ID de concessão em "x-ms-proposed-lease-id" para alterar o 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 locação e especifica a duração da concessão em segundos. A duração da locação deve ser entre 15 e 60 segundos ou -1 para locação infinita.
x-ms-lease-break-period

integer (int32)

A duração do período de interrupção da 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 pausa de concessão deve ser entre 0 e 60 segundos.
x-ms-lease-id

string

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

Necessário quando "x-ms-lease-action" é "renovar", "alterar" ou "liberar". Para as ações de renovação e liberação, isso deve corresponder ao ID de concessão atual.
x-ms-proposed-lease-id

string

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

Necessário quando "x-ms-lease-action" é "adquirir" ou "alterar". Uma locação será adquirida com este ID de locação se a operação for bem-sucedida.
If-Match

string

Opcional. Um valor ETag. Especifique esse cabeçalho para executar a operação somente se a ETag do recurso corresponder ao valor especificado. O ETag deve ser especificado 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. O ETag deve ser especificado 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

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

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

string

Especifica o Tempo Universal Coordenado (UTC) 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

Name Tipo Description
200 OK

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

Cabeçalhos

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

Foi criado um novo contrato de arrendamento. A ação de "aquisição" foi bem sucedida.

Cabeçalhos

  • 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 locação "break" foi bem-sucedida.

Cabeçalhos

  • 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. O possível status HTTP, código e cadeias de caracteres de mensagem estão listados abaixo:

  • 400 Solicitação incorreta, ContentLengthMustBeZero, "O cabeçalho da solicitação Content-Length deve ser zero."
  • 400 Bad Request, InvalidAuthenticationInfo, "As informações de autenticação não são fornecidas no formato correto. Verifique o valor do cabeçalho Autorização."
  • 400 Bad Request, 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 anexar os dados carregados."
  • 400 Bad Request, InvalidHeaderValue, "O valor de um dos cabeçalhos HTTP não está no formato correto."
  • 400 Bad Request, InvalidHttpVerb, "O verbo HTTP especificado é inválido - não é reconhecido pelo servidor."
  • 400 Bad Request, InvalidInput, "Uma das entradas de solicitação não é válida."
  • 400 Bad Request, InvalidPropertyName, "Um nome de propriedade não pode estar vazio."
  • 400 Bad Request, InvalidPropertyName, "O nome da propriedade contém caracteres inválidos."
  • 400 Bad Request, InvalidQueryParameterValue, "O valor de um dos parâmetros de consulta especificados no URI da solicitação é inválido."
  • 400 Bad Request, InvalidResourceName, "O nome do recurso especificado contém caracteres inválidos."
  • 400 Bad Request, InvalidSourceUri, "O URI de origem é inválido."
  • 400 Bad Request, InvalidUri, "O URI da solicitação é inválido."
  • 400 Bad Request, MissingRequiredHeader, "Um cabeçalho HTTP obrigatório para esta solicitação não é especificado."
  • 400 Bad Request, MissingRequiredQueryParameter, "Um parâmetro de consulta obrigatório para esta solicitação não é especificado."
  • 400 Solicitação incorreta, MultipleConditionHeadersNotSupported, "Vários cabeçalhos de condição não são suportados."
  • 400 Bad Request, OutOfRangeInput, "Uma das entradas de solicitação está fora do intervalo."
  • 400 Bad Request, OutOfRangeQueryParameterValue, "Um dos parâmetros de consulta especificados no URI da solicitação está fora do intervalo permitido."
  • 400 Bad Request, UnsupportedHeader, "Um dos cabeçalhos especificados na solicitação não é suportado."
  • 400 Bad Request, UnsupportedQueryParameter, "Um dos parâmetros de consulta especificados no URI da solicitação não é suportado."
  • 400 Bad Request, UnsupportedRestVersion, "A versão rest especificada não é suportada."
  • 403 Proibido, AccountIsDisabled, "A conta especificada está desativada."
  • 403 Proibido, AuthorizationFailure, "Esta solicitação não está autorizada a executar esta operação."
  • 403 Forbidden, InsufficientAccountPermissions, "A conta que está sendo acessada não tem permissões suficientes para executar esta operação."
  • 404 Not Found, FilesystemNotFound, "O sistema de arquivos especificado não existe."
  • 404 Not Found, PathNotFound, "O caminho especificado não existe."
  • 404 Not Found, RenameDestinationParentPathNotFound, "O diretório pai do caminho de destino não existe."
  • 404 Not Found, ResourceNotFound, "O recurso especificado não existe."
  • 404 Not Found, SourcePathNotFound, "O caminho de origem para uma operação de renomeação não existe."
  • 405 Method Not Allowed, UnsupportedHttpVerb, "O recurso não suporta o 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, "O recurso foi criado ou modificado pela API do Serviço de Blob e não pode ser gravado pela API do Serviço de Armazenamento Data Lake."
  • 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 Conflito, LeaseAlreadyPresent, "Já existe um contrato de arrendamento presente."
  • 409 Conflict, LeaseIdMismatchWithLeaseOperation, "O ID de concessão especificado não correspondia ao ID de concessão do recurso com a operação de concessão especificada."
  • 409 Conflito, LeaseIsAlreadyBroken, "O contrato de arrendamento já foi quebrado e não pode ser quebrado novamente."
  • 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, "O ID do contrato correspondeu, mas o contrato está atualmente em estado de quebra e não pode ser adquirido até que seja quebrado."
  • 409 Conflict, LeaseIsBreakingAndCannotBeChanged, "O ID da concessão correspondeu, mas a concessão está atualmente em estado de quebra e não pode ser alterada."
  • 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, "O ID do contrato correspondeu, mas o contrato foi quebrado explicitamente e não pode ser renovado."
  • 409 Conflict, LeaseNameMismatch, "O nome da concessão especificado não correspondia ao nome da concessão existente."
  • 409 Conflict, LeaseNotPresentWithLeaseOperation, "O ID da 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."
  • 409 Conflict, 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çalho(s) condicional(is) HTTP não é atendida."
  • 412 Precondition Failed, LeaseIdMismatch, "O ID de concessão especificado não correspondeu ao ID de concessão do recurso."
  • 412 Precondition Failed, LeaseIdMissing, "Existe atualmente uma concessão no recurso e nenhuma ID de concessão foi especificada na solicitação."
  • 412 Precondition Failed, LeaseNotPresent, "Não há atualmente nenhuma concessão no recurso."
  • 412 Precondition Failed, LeaseLost, "Um ID de concessão foi especificado, mas a concessão para o recurso expirou."
  • 412 Precondition Failed, SourceConditionNotMet, "A condição de origem especificada usando cabeçalho(s) condicional(is) 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 satisfatório, InvalidRange, "O intervalo especificado é inválido para o tamanho atual do recurso."
  • 500 Internal Server Error, InternalError, "O servidor encontrou um erro interno. Por favor, tente novamente o pedido."
  • 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 Service Unavailable, ServerBusy, "O servidor não consegue receber solicitações no momento. Por favor, tente novamente o seu pedido."

Cabeçalhos

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

Definições

Name Description
DataLakeStorageError
Error

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

São cinco ações de locação: "adquirir", "quebrar", "alterar", "renovar" e "liberar". Use "acquire" e especifique "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Use "break" para quebrar uma locação existente. Quando uma locação é quebrada, o período de interrupção da locação é permitido, durante o qual nenhuma operação de locação, exceto quebra e liberação, pode ser executada no arquivo. Quando uma concessão é quebrada com sucesso, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Use "change" e especifique o ID de concessão atual em "x-ms-lease-id" e o novo ID de concessão em "x-ms-proposed-lease-id" para alterar o 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

Object
Name Tipo Description
error

Error

O objeto de resposta de erro de serviço.

Error

Object

O objeto de resposta de erro de serviço.

Name Tipo Description
code

string

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

string

A mensagem de erro do serviço.

PathLeaseAction

Enumeração

São cinco ações de locação: "adquirir", "quebrar", "alterar", "renovar" e "liberar". Use "acquire" e especifique "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Use "break" para quebrar uma locação existente. Quando uma locação é quebrada, o período de interrupção da locação é permitido, durante o qual nenhuma operação de locação, exceto quebra e liberação, pode ser executada no arquivo. Quando uma concessão é quebrada com sucesso, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Use "change" e especifique o ID de concessão atual em "x-ms-lease-id" e o novo ID de concessão em "x-ms-proposed-lease-id" para alterar o 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.

Valor Description
acquire
break
change
release
renew