DescribeTask - AWS DataSync

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á.

DescribeTask

Retorna metadados sobre uma tarefa.

Sintaxe da solicitação

{ "TaskArn": "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.

TaskArn

O nome do recurso da Amazon (ARN) da tarefa a ser descrita.

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}$

Obrigatório: Sim

Sintaxe da resposta

{ "CloudWatchLogGroupArn": "string", "CreationTime": number, "CurrentTaskExecutionArn": "string", "DestinationLocationArn": "string", "DestinationNetworkInterfaceArns": [ "string" ], "ErrorCode": "string", "ErrorDetail": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "Name": "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" }, "Schedule": { "ScheduleExpression": "string" }, "SourceLocationArn": "string", "SourceNetworkInterfaceArns": [ "string" ], "Status": "string", "TaskArn": "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.

CloudWatchLogGroupArn

O nome de recurso da Amazon (ARN) do grupo de CloudWatch log da Amazon usado para monitorar e registrar eventos na tarefa.

Para obter mais informações sobre esses grupos, consulte Trabalhando com grupos de log e fluxos de log no Guia do CloudWatch usuário da Amazon.

Tipo: String

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

Padrão: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$

CreationTime

O horário em que a tarefa foi criada.

Tipo: Timestamp

CurrentTaskExecutionArn

O nome do recurso da Amazon (ARN) da execução da tarefa que está transferindo arquivos.

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}$

DestinationLocationArn

O nome do recurso da Amazon (ARN) da localização do recurso AWS de armazenamento da.

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}:location/loc-[0-9a-z]{17}$

DestinationNetworkInterfaceArns

Os nomes de recursos da Amazon (ARNs) das interfaces de rede criadas para o local de destino da. Para obter mais informações, consulte Requisitos da interface de rede da

Tipo: matriz de strings

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

Padrão: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$

ErrorCode

Erros AWS DataSync encontrados durante a execução da tarefa. Você pode usar esse código de erro para ajudar a solucionar problemas.

Tipo: String

ErrorDetail

Descrição detalhada de um erro encontrado durante a execução da tarefa. Você pode usar essas informações para ajudar a solucionar problemas.

Tipo: String

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.

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.

Name

O nome da tarefa que foi descrita.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.

Padrão: ^[a-zA-Z0-9\s+=._:@/-]+$

Options

As opções de configuração que controlam o comportamento da StartTaskExecution operação. Algumas opções incluem preservar metadados de arquivos ou de objetos e verificar a integridade dos dados.

Você pode substituir essas opções para cada execução de tarefa. Para obter mais informações, consulte StartTaskExecution.

Tipo: objeto Options

Schedule

O agendamento usado para transferir periodicamente arquivos de uma origem para um local de destino.

Tipo: objeto TaskSchedule

SourceLocationArn

O nome do recurso da Amazon (ARN) da localização do sistema de arquivo de origem.

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}:location/loc-[0-9a-z]{17}$

SourceNetworkInterfaceArns

Os nomes de recursos da Amazon (ARNs) das interfaces de rede criadas para o local de origem da. Para obter mais informações, consulte Requisitos da interface de rede da

Tipo: matriz de strings

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

Padrão: ^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$

Status

O status da tarefa que foi descrita.

Para obter informações detalhadas sobre os status de execução de tarefas, consulte Compreendendo os status das tarefas no Guia do AWS DataSyncusuário.

Tipo: String

Valores válidos: AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE

TaskArn

O nome do recurso da Amazon (ARN) da tarefa que foi descrita.

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}$

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

O exemplo a seguir retorna informações sobre a tarefa especificada na solicitação de amostra.

Exemplo de solicitação

{ "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" }

Exemplo

Este exemplo ilustra um uso de. DescribeTask

Exemplo de resposta

{ "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group" "CreationTime": 1532660733.39, "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb", "ErrorCode": "???????", "ErrorDetail": "??????", "Name": "MyTask", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa", "Status": "CREATING", "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" }

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: