DescribeTaskExecution - AWS DataSync
Sintaxe da solicitaçãoParâmetros de solicitaçãoSintaxe da respostaElementos de respostaErrosExemplosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DescribeTaskExecution

Retorna metadados detalhados sobre uma tarefa que está sendo executada.

Sintaxe da solicitação

{
   "TaskExecutionArn": "string"
}

Parâmetros de solicitação

Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

TaskExecutionArn

O nome de recurso da Amazon (ARN) da tarefa que está sendo executada.

Tipo: String

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Obrigatório: Sim

Sintaxe da resposta

{
   "BytesCompressed": number,
   "BytesTransferred": number,
   "BytesWritten": number,
   "EstimatedBytesToTransfer": number,
   "EstimatedFilesToTransfer": number,
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "FilesTransferred": number,
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Options": { 
      "Atime": "string",
      "BytesPerSecond": number,
      "Gid": "string",
      "LogLevel": "string",
      "Mtime": "string",
      "ObjectTags": "string",
      "OverwriteMode": "string",
      "PosixPermissions": "string",
      "PreserveDeletedFiles": "string",
      "PreserveDevices": "string",
      "SecurityDescriptorCopyFlags": "string",
      "TaskQueueing": "string",
      "TransferMode": "string",
      "Uid": "string",
      "VerifyMode": "string"
   },
   "Result": { 
      "ErrorCode": "string",
      "ErrorDetail": "string",
      "PrepareDuration": number,
      "PrepareStatus": "string",
      "TotalDuration": number,
      "TransferDuration": number,
      "TransferStatus": "string",
      "VerifyDuration": number,
      "VerifyStatus": "string"
   },
   "StartTime": number,
   "Status": "string",
   "TaskExecutionArn": "string"
}

Elementos de resposta

Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

BytesCompressed

O número físico de bytes transferidos pela rede após a aplicação da compactação. Na maioria dos casos, esse número é menor do que, BytesTransferred a menos que os dados não sejam compactáveis.

Type: longo

BytesTransferred

O número total de bytes envolvidos na transferência. Para o número de bytes enviados pela rede, consulteBytesCompressed.

Type: longo

BytesWritten

O número de bytes lógicos gravados no recurso de AWS armazenamento de destino.

Type: longo

EstimatedBytesToTransfer

O número físico estimado de bytes que devem ser transferidos pela rede.

Type: longo

EstimatedFilesToTransfer

O número esperado de arquivos a serem transferidos pela rede. Esse valor é calculado durante a PREPARING fase anterior à TRANSFERRING fase de execução da tarefa. Esse valor é o número esperado de arquivos a serem transferidos. É calculado com base na comparação do conteúdo dos locais de origem e destino e na descoberta do delta que precisa ser transferido.

Type: longo

Excludes

Uma lista de regras de filtro que excluem dados específicos durante a transferência. Para obter mais informações e exemplos, consulte Filtragem de dados transferidos por DataSync.

Tipo: matriz de objetos FilterRule

Membros da matriz: número mínimo de 0 itens. Número máximo de 1 item.

FilesTransferred

O número real de arquivos que foram transferidos pela rede. Esse valor é calculado e atualizado continuamente durante a TRANSFERRING fase de execução da tarefa. Ele é atualizado periodicamente quando cada arquivo é lido da fonte e enviado pela rede.

Se ocorrem falhas durante uma transferência, esse valor pode ser menor que EstimatedFilesToTransfer. Em alguns casos, esse valor também pode ser maior queEstimatedFilesToTransfer. Esse elemento é específico da implementação para alguns tipos de local e, portanto, não use-o como um indicador para um número de arquivo correto nem para monitorar a execução da tarefa.

Type: longo

Includes

Uma lista de regras de filtro que incluem dados específicos durante a transferência. Para obter mais informações e exemplos, consulte Filtragem de dados transferidos por DataSync.

Tipo: matriz de objetos FilterRule

Membros da matriz: número mínimo de 0 itens. Número máximo de 1 item.

Options

Define as configurações da sua AWS DataSync tarefa. Essas opções incluem como DataSync manipula arquivos, objetos e seus metadados associados. Você também pode especificar como DataSync verifica a integridade dos dados, define limites de largura de banda para sua tarefa, entre outras opções.

Cada configuração de tarefa tem um valor padrão. A menos que seja necessário, você não precisa configurar nenhum deles Options antes de iniciar sua tarefa.

Tipo: objeto Options

Result

O resultado da tarefa.

Tipo: objeto TaskExecutionResultDetail

StartTime

A hora em que a execução da tarefa foi iniciada.

Tipo: Timestamp

Status

O status da tarefa.

Para obter informações detalhadas sobre os status de execução da tarefa, consulte Compreendendo os status da tarefa.

Tipo: String

Valores válidos: QUEUED | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR

TaskExecutionArn

O nome de recurso da Amazon (ARN) da tarefa que a tarefa que foi executada. TaskExecutionArné hierárquico e inclui TaskArn a tarefa que foi executada.

Por exemplo, um TaskExecution valor com o ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executou a tarefa com o arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2 ARN.

Tipo: String

Restrições de tamanho: tamanho máximo de 128.

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$

Erros

Para obter informações sobre os erros comuns a todas as ações, consulteErros comuns.

InternalException

Essa exceção é lançada quando ocorre um erro no AWS DataSync serviço.

Código de status HTTP: 500

InvalidRequestException

Essa exceção é lançada quando o cliente envia uma solicitação malformada.

Código de status HTTP: 400

Exemplos

Exemplo de solicitação

Este exemplo ilustra uma DescribeTaskExecution solicitação.

{
  "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Exemplo de resposta

Esse exemplo ilustra uma DescribeTaskExecution resposta.

{
   "BytesCompressed": "3500",
   "BytesTransferred": "5000",
   "BytesWritten": "5000",
   "EstimatedBytesToTransfer": "5000",
   "EstimatedFilesToTransfer": "100",
   "FilesTransferred": "100",
   "Result": { 
      "ErrorCode": "??????",
      "ErrorDetail": "??????",
      "PrepareDuration": "100",
      "PrepareStatus": "SUCCESS",
      "TransferDuration": "60",
      "TransferStatus": "AVAILABLE",
      "VerifyDuration": "30",
      "VerifyStatus": "SUCCESS"
   },
   "StartTime": "1532660733.39",
   "Status": "SUCCESS",
   "OverrideOptions": { 
      "Atime": "BEST_EFFORT",
      "BytesPerSecond": "1000",
      "Gid": "NONE",
      "Mtime": "PRESERVE",
      "PosixPermissions": "PRESERVE",
      "PreserveDevices": "NONE",
      "PreserveDeletedFiles": "PRESERVE",
      "Uid": "NONE",
      "VerifyMode": "POINT_IN_TIME_CONSISTENT"
   },
   "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f"
}

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: