DescribeTask - AWS DataSync
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeTask

Stellt Informationen zu einer Aufgabe bereit, die definiert, wo und wie Ihre Daten AWS DataSync übertragen werden.

Anforderungssyntax

{
   "TaskArn": "string"
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

TaskArn

Gibt den Amazon-Ressourcennamen (ARN) der Übertragungsaufgabe an, über die Sie Informationen benötigen.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^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}$

Erforderlich: Ja

Antwortsyntax

{
   "CloudWatchLogGroupArn": "string",
   "CreationTime": number,
   "CurrentTaskExecutionArn": "string",
   "DestinationLocationArn": "string",
   "DestinationNetworkInterfaceArns": [ "string" ],
   "ErrorCode": "string",
   "ErrorDetail": "string",
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "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",
      "Status": "string"
   },
   "ScheduleDetails": { 
      "DisabledBy": "string",
      "DisabledReason": "string",
      "StatusUpdateTime": number
   },
   "SourceLocationArn": "string",
   "SourceNetworkInterfaceArns": [ "string" ],
   "Status": "string",
   "TaskArn": "string",
   "TaskMode": "string",
   "TaskReportConfig": { 
      "Destination": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "S3BucketArn": "string",
            "Subdirectory": "string"
         }
      },
      "ObjectVersionIds": "string",
      "OutputType": "string",
      "Overrides": { 
         "Deleted": { 
            "ReportLevel": "string"
         },
         "Skipped": { 
            "ReportLevel": "string"
         },
         "Transferred": { 
            "ReportLevel": "string"
         },
         "Verified": { 
            "ReportLevel": "string"
         }
      },
      "ReportLevel": "string"
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

CloudWatchLogGroupArn

Der Amazon-Ressourcenname (ARN) einer CloudWatch Amazon-Protokollgruppe zur Überwachung Ihrer Aufgabe.

Weitere Informationen finden Sie unter Überwachen von Datenübertragungen mit CloudWatch Protokollen.

Typ: Zeichenfolge

Längenbeschränkungen: Die maximale Länge beträgt 562.

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

CreationTime

Der Zeitpunkt, zu dem die Aufgabe erstellt wurde.

Typ: Zeitstempel

CurrentTaskExecutionArn

Der ARN der letzten Aufgabenausführung.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^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

Der ARN des Zielorts Ihrer Übertragung.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^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

Die ARNs Netzwerkschnittstellen, die für Ihren Zielort DataSync erstellt wurden.

Typ: Zeichenfolgen-Array

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

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

ErrorCode

Wenn bei Ihrer Aufgabe ein Problem auftritt, können Sie den Fehlercode verwenden, um das Problem zu beheben. Weitere Informationen finden Sie unter Problembehandlung bei DataSync Übertragungen.

Typ: Zeichenfolge

ErrorDetail

Wenn bei Ihrer Aufgabe ein Problem auftritt, können Sie die Fehlerdetails verwenden, um das Problem zu beheben. Weitere Informationen finden Sie unter Problembehandlung bei DataSync Übertragungen.

Typ: Zeichenfolge

Excludes

Die Ausschlussfilter, die die Dateien, Objekte und Ordner an Ihrem Quellspeicherort definieren, die Sie nicht übertragen DataSync möchten. Weitere Informationen und Beispiele finden Sie unter Mithilfe von Filtern angeben, welche DataSync Übertragungen übertragen werden.

Typ: Array von FilterRule-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 1 Element.

Includes

Dazu gehören Filter, die die Dateien, Objekte und Ordner an Ihrem Quellspeicherort definieren, die Sie übertragen DataSync möchten. Weitere Informationen und Beispiele finden Sie unter Mithilfe von Filtern angeben, welche DataSync Übertragungen übertragen werden.

Typ: Array von FilterRule-Objekten

Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 1 Element.

ManifestConfig

Die Konfiguration des Manifests, das die Dateien oder Objekte auflistet, die Sie übertragen DataSync möchten. Weitere Informationen finden Sie unter Mithilfe eines Manifests angeben, welche DataSync Übertragungen übertragen werden.

Typ: ManifestConfig Objekt

Name

Der Name Ihrer Aufgabe.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 256 Zeichen.

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

Options

Die Einstellungen der Aufgabe. Beispielsweise, welche Dateimetadaten erhalten bleiben, wie die Datenintegrität am Ende der Übertragung überprüft wird, Bandbreitenbeschränkungen und andere Optionen.

Typ: Options Objekt

Schedule

Der Zeitplan, zu dem Ihre Aufgabe ausgeführt werden soll. Weitere Informationen finden Sie unter Aufgabenplanung.

Typ: TaskSchedule Objekt

ScheduleDetails

Die Details zu Ihrem Task-Zeitplan.

Typ: TaskScheduleDetails Objekt

SourceLocationArn

Der ARN des Quellorts Ihrer Übertragung.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^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

Die ARNs Netzwerkschnittstellen, die für Ihren Quellstandort DataSync erstellt wurden.

Typ: Zeichenfolgen-Array

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

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

Status

Der Status Ihrer Aufgabe. Informationen zur Bedeutung der einzelnen Status finden Sie unter Aufgabenstatus.

Typ: Zeichenfolge

Zulässige Werte: AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE

TaskArn

Der ARN Ihrer Aufgabe.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 128 Zeichen.

Pattern: ^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}$

TaskMode

Der Aufgabenmodus, den Sie verwenden. Weitere Informationen finden Sie unter Auswählen eines Aufgabenmodus für Ihre Datenübertragung.

Typ: Zeichenfolge

Zulässige Werte: BASIC | ENHANCED

TaskReportConfig

Die Konfiguration Ihres Aufgabenberichts, der detaillierte Informationen zu Ihrer DataSync Übertragung enthält. Weitere Informationen finden Sie unter Überwachen Ihrer DataSync Übertragungen mit Aufgabenberichten.

Typ: TaskReportConfig Objekt

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalException

Diese Ausnahme wird ausgelöst, wenn im AWS DataSync Dienst ein Fehler auftritt.

HTTP Status Code: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTP Status Code: 400

Beispiele

Beispielanforderung

Das folgende Beispiel gibt den ARN einer DataSync Aufgabe an, über die Informationen abgerufen werden sollen.

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

Beispielantwort

Das folgende Beispiel zeigt eine DescribeTask Antwort.

{
  "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026",
  "Name": "MyTask",
  "TaskMode": "BASIC",
  "Status": "RUNNING",
  "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3",
  "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2",
  "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f",
  "CreationTime": 1532660733.39,
  "Options": { 
    "Atime": "BEST_EFFORT",
    "BytesPerSecond": 1000,
    "Gid": "NONE",
    "Mtime": "PRESERVE",
    "PosixPermissions": "PRESERVE",
    "PreserveDevices": "NONE",
    "PreserveDeletedFiles": "PRESERVE",
    "Uid": "NONE",
    "VerifyMode": "POINT_IN_TIME_CONSISTENT"
  },
  "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*"
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden: