DescribeTask

Memberikan informasi tentang tugas AWS DataSync transfer.

Sintaksis Permintaan

{
   "TaskArn": "string"
}

Parameter Permintaan

Untuk informasi tentang parameter yang umum untuk semua tindakan, lihat Parameter Umum.

Permintaan menerima data berikut dalam format JSON.

TaskArn

Menentukan Nama Sumber Daya Amazon (ARN) dari tugas transfer.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

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

Diperlukan: Ya

Sintaksis Respons

{
   "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"
   },
   "SourceLocationArn": "string",
   "SourceNetworkInterfaceArns": [ "string" ],
   "Status": "string",
   "TaskArn": "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"
   }
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

CloudWatchLogGroupArn

Nama Sumber Daya Amazon (ARN) dari grup CloudWatch log Amazon yang digunakan untuk memantau dan mencatat peristiwa dalam tugas.

Untuk informasi selengkapnya tentang grup ini, lihat Bekerja dengan Grup Log dan Aliran Log di Panduan CloudWatch Pengguna Amazon.

Jenis: String

Batasan Panjang: Panjang maksimum 562.

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

CreationTime

Waktu tugas dibuat.

Tipe: Timestamp

CurrentTaskExecutionArn

Nama Sumber Daya Amazon (ARN) dari eksekusi tugas yang mentransfer file.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

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

Nama Sumber Daya Amazon (ARN) dari lokasi sumber daya AWS penyimpanan.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

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

Nama Sumber Daya Amazon (ARN) dari antarmuka jaringan yang dibuat untuk lokasi tujuan Anda. Untuk informasi selengkapnya, lihat Persyaratan antarmuka jaringan.

Tipe: Array string

Batasan Panjang: Panjang maksimum 128.

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

ErrorCode

Kesalahan yang AWS DataSync ditemui selama pelaksanaan tugas. Anda dapat menggunakan kode kesalahan ini untuk membantu memecahkan masalah.

Jenis: String

ErrorDetail

Penjelasan detail tentang kesalahan yang ditemui selama eksekusi tugas. Anda dapat menggunakan informasi ini untuk membantu memecahkan masalah.

Jenis: String

Excludes

Daftar aturan filter yang mengecualikan data tertentu selama transfer Anda. Untuk informasi dan contoh selengkapnya, lihat Memfilter data yang ditransfer oleh DataSync.

Tipe: Array objek FilterRule

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 1 item.

Includes

Daftar aturan filter yang menyertakan data spesifik selama transfer Anda. Untuk informasi dan contoh selengkapnya, lihat Memfilter data yang ditransfer oleh DataSync.

Tipe: Array objek FilterRule

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 1 item.

ManifestConfig

Konfigurasi manifes yang mencantumkan file atau objek yang akan ditransfer. Untuk informasi selengkapnya, lihat Menentukan DataSync transfer apa yang menggunakan manifes.

Tipe: Objek ManifestConfig

Name

Nama tugas yang telah dideskripsikan.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 256.

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

Options

Opsi konfigurasi yang mengontrol perilaku StartTaskExecution operasi. Beberapa opsi termasuk melestarikan file atau objek metadata dan memverifikasi integritas data.

Anda dapat mengganti opsi ini untuk setiap eksekusi tugas. Untuk informasi lebih lanjut, lihat StartTaskExecution.

Tipe: Objek Options

Schedule

Jadwal yang digunakan untuk mentransfer file secara berkala dari sumber ke lokasi tujuan.

Tipe: Objek TaskSchedule

SourceLocationArn

Amazon Resource Name (ARN) dari lokasi sistem file sumber.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

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

Nama Sumber Daya Amazon (ARN) dari antarmuka jaringan yang dibuat untuk lokasi sumber Anda. Untuk informasi selengkapnya, lihat Persyaratan antarmuka jaringan.

Tipe: Array string

Batasan Panjang: Panjang maksimum 128.

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

Status

Status tugas yang telah dideskripsikan.

Untuk informasi rinci tentang status eksekusi tugas, lihat Memahami Status Tugas di AWS DataSync Panduan Pengguna.

Jenis: String

Nilai yang Valid: AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE

TaskArn

Amazon Resource Name (ARN) dari tugas yang telah dideskripsikan.

Jenis: String

Batasan Panjang: Panjang maksimum 128.

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

TaskReportConfig

Konfigurasi laporan tugas Anda, yang memberikan informasi terperinci tentang DataSync transfer Anda. Untuk informasi selengkapnya, lihat Membuat laporan tugas.

Tipe: Objek TaskReportConfig

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InternalException

Pengecualian ini dilontarkan ketika terjadi kesalahan dalam layanan AWS DataSync .

Kode Status HTTP: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

Kode Status HTTP: 400

Contoh-contoh

Contoh

Contoh berikut mengembalikan informasi tentang tugas yang ditentukan dalam contoh permintaan.

Contoh Permintaan

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

Contoh

Contoh ini menggambarkan salah satu penggunaan. DescribeTask

Contoh Respons

{
   "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"
}

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:

• AWS Antarmuka Baris Perintah

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3