DescribeTaskExecution - AWS DataSync
Sintaksis PermintaanParameter PermintaanSintaksis ResponsElemen ResponsKesalahanContohLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

DescribeTaskExecution

Memberikan informasi tentang pelaksanaan AWS DataSync tugas Anda. Anda dapat menggunakan operasi ini untuk membantu memantau kemajuan transfer yang sedang berlangsung atau memeriksa hasil transfer.

Sintaksis Permintaan

{
   "TaskExecutionArn": "string"
}

Parameter Permintaan

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

Permintaan menerima data berikut dalam JSON format.

TaskExecutionArn

Menentukan Amazon Resource Name (ARN) dari eksekusi tugas yang Anda inginkan informasi tentang.

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

Diperlukan: Ya

Sintaksis Respons

{
   "BytesCompressed": number,
   "BytesTransferred": number,
   "BytesWritten": number,
   "EstimatedBytesToTransfer": number,
   "EstimatedFilesToDelete": number,
   "EstimatedFilesToTransfer": number,
   "Excludes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "FilesDeleted": number,
   "FilesSkipped": number,
   "FilesTransferred": number,
   "FilesVerified": number,
   "Includes": [ 
      { 
         "FilterType": "string",
         "Value": "string"
      }
   ],
   "ManifestConfig": { 
      "Action": "string",
      "Format": "string",
      "Source": { 
         "S3": { 
            "BucketAccessRoleArn": "string",
            "ManifestObjectPath": "string",
            "ManifestObjectVersionId": "string",
            "S3BucketArn": "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"
   },
   "ReportResult": { 
      "ErrorCode": "string",
      "ErrorDetail": "string",
      "Status": "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",
   "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.

Data berikut dikembalikan dalam JSON format oleh layanan.

BytesCompressed

Jumlah fisik byte yang ditransfer melalui jaringan setelah kompresi diterapkan. Dalam kebanyakan kasus, jumlah ini kurang dari BytesTransferred kecuali data tidak dapat dimampatkan.

Tipe: Long

BytesTransferred

Jumlah total byte yang terlibat dalam transfer. Untuk jumlah byte yang dikirim melalui jaringan, lihatBytesCompressed.

Tipe: Long

BytesWritten

Jumlah byte logis yang ditulis ke lokasi tujuan.

Tipe: Long

EstimatedBytesToTransfer

Perkiraan jumlah fisik byte yang akan ditransfer melalui jaringan.

Tipe: Long

EstimatedFilesToDelete

Jumlah file, objek, dan direktori yang diharapkan DataSync akan dihapus di lokasi tujuan Anda. Jika Anda tidak mengonfigurasi tugas untuk menghapus data di tujuan yang tidak ada di sumber, nilainya selalu0.

Tipe: Long

EstimatedFilesToTransfer

Jumlah file, objek, dan direktori yang diharapkan yang DataSync akan ditransfer melalui jaringan. Nilai ini dihitung selama fase eksekusi tugas sebelum PREPARING TRANSFERRING fase. Perhitungan didasarkan pada membandingkan konten lokasi sumber dan tujuan dan menemukan perbedaan yang perlu ditransfer.

Tipe: Long

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.

FilesDeleted

Jumlah file, objek, dan direktori yang DataSync dihapus di lokasi tujuan Anda. Jika Anda tidak mengonfigurasi tugas untuk menghapus data di tujuan yang tidak ada di sumber, nilainya selalu0.

Tipe: Long

FilesSkipped

Jumlah file, objek, dan direktori yang DataSync dilewati selama transfer Anda.

Tipe: Long

FilesTransferred

Jumlah sebenarnya dari file, objek, dan direktori yang DataSync ditransfer melalui jaringan. Nilai ini diperbarui secara berkala selama TRANSFERRING fase eksekusi tugas ketika sesuatu dibaca dari sumber dan dikirim melalui jaringan.

Jika DataSync gagal mentransfer sesuatu, nilai ini bisa kurang dariEstimatedFilesToTransfer. Dalam beberapa kasus, nilai ini juga bisa lebih besar dariEstimatedFilesToTransfer. Elemen ini khusus implementasi untuk beberapa jenis lokasi, jadi jangan gunakan sebagai indikasi yang tepat tentang apa yang ditransfer atau untuk memantau pelaksanaan tugas Anda.

Tipe: Long

FilesVerified

Jumlah file, objek, dan direktori yang DataSync diverifikasi selama transfer Anda.

catatan

Ketika Anda mengonfigurasi tugas Anda untuk memverifikasi hanya data yang ditransfer, DataSync tidak memverifikasi direktori dalam beberapa situasi atau file yang gagal ditransfer.

Tipe: Long

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

Options

Menunjukkan bagaimana tugas transfer Anda dikonfigurasi. Opsi ini mencakup cara DataSync menangani file, objek, dan metadata terkait selama transfer Anda. Anda juga dapat menentukan cara memverifikasi integritas data, menetapkan batas bandwidth untuk tugas Anda, di antara opsi lainnya.

Setiap opsi memiliki nilai default. Kecuali Anda perlu, Anda tidak perlu mengonfigurasi opsi apa pun sebelum menelepon StartTaskExecution.

Anda juga dapat mengganti opsi tugas untuk setiap eksekusi tugas. Misalnya, Anda mungkin ingin LogLevel menyesuaikan eksekusi individual.

Tipe: Objek Options

ReportResult

Menunjukkan apakah DataSync menghasilkan laporan tugas lengkap untuk transfer Anda.

Tipe: Objek ReportResult

Result

Hasil eksekusi tugas.

Tipe: Objek TaskExecutionResultDetail

StartTime

Waktu ketika pelaksanaan tugas dimulai.

Tipe: Timestamp

Status

Status tugas.

Untuk informasi rinci tentang status eksekusi tugas, lihat Status eksekusi tugas.

Tipe: String

Nilai yang Valid: QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR

TaskExecutionArn

Eksekusi tugas yang Anda inginkan informasi tentang. ARN TaskExecutionArnbersifat hierarkis dan termasuk TaskArn untuk tugas yang dieksekusi.

Misalnya, TaskExecution nilai dengan ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b menjalankan tugas dengan ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

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

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 .

HTTPKode Status: 500

InvalidRequestException

Pengecualian ini dilontarkan ketika klien mengirimkan permintaan yang salah format.

HTTPKode Status: 400

Contoh

Permintaan Sampel

Contoh ini menggambarkan DescribeTaskExecution permintaan.

{
    "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1"
}

Contoh Respons

Contoh ini menggambarkan DescribeTaskExecution respons.

{
    "BytesCompressed": 3500,
    "BytesTransferred": 5000,
    "BytesWritten": 5000,
    "EstimatedBytesToTransfer": 5000,
    "EstimatedFilesToDelete": 10,
    "EstimatedFilesToTransfer": 100,
    "FilesDeleted": 10,
    "FilesSkipped": 0,
    "FilesTransferred": 100,
    "FilesVerified": 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-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1",
    "TaskReportConfig": {
        "Destination": {
            "S3": {
                "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-datasync-role",
                "S3BucketArn": "arn:aws:s3:::my-task-reports-bucket/*",
                "Subdirectory": "reports"
            }
        },
        "ObjectVersionIds": "INCLUDE",
        "OutputType": "STANDARD",
        "Overrides": {
            "Deleted": {
                "ReportLevel": "ERRORS_ONLY"
            },
            "Skipped": {
                "ReportLevel": "SUCCESSES_AND_ERRORS"
            },
            "Transferred": {
                "ReportLevel": "ERRORS_ONLY"
            },
            "Verified": {
                "ReportLevel": "ERRORS_ONLY"
            }
        },
        "ReportLevel": "ERRORS_ONLY"
    }
}

Lihat Juga

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