DescribeTask - AWS DataSync

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

DescribeTask

Memberikan informasi tentang tugas, yang menentukan di mana dan bagaimana AWS DataSync mentransfer data Anda.

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 yang Anda inginkan informasi tentang.

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", "Status": "string" }, "ScheduleDetails": { "DisabledBy": "string", "DisabledReason": "string", "StatusUpdateTime": number }, "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 untuk memantau tugas Anda.

Untuk informasi selengkapnya, lihat Memantau DataSync dengan Amazon CloudWatch.

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

ARN dari eksekusi tugas terbaru.

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

ARN lokasi tujuan transfer Anda.

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

ARN dari antarmuka jaringan yang DataSync dibuat untuk lokasi tujuan Anda.

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

Jika ada masalah dengan tugas Anda, Anda dapat menggunakan kode kesalahan untuk membantu Anda memecahkan masalah. Untuk informasi selengkapnya, lihat Memecahkan masalah dengan DataSync transfer.

Jenis: String

ErrorDetail

Jika ada masalah dengan tugas Anda, Anda dapat menggunakan detail kesalahan untuk membantu Anda memecahkan masalah. Untuk informasi selengkapnya, lihat Memecahkan masalah dengan DataSync transfer.

Jenis: String

Excludes

Filter pengecualian yang menentukan file, objek, dan folder di lokasi sumber yang tidak DataSync ingin Anda transfer. Untuk informasi dan contoh selengkapnya, lihat Menentukan DataSync transfer apa yang menggunakan filter.

Tipe: Array objek FilterRule

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

Includes

Termasuk filter yang menentukan file, objek, dan folder di lokasi sumber Anda yang DataSync ingin Anda transfer. Untuk informasi dan contoh selengkapnya, lihat Menentukan DataSync transfer apa yang menggunakan filter.

Tipe: Array objek FilterRule

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

ManifestConfig

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

Tipe: Objek ManifestConfig

Name

Nama tugas Anda.

Jenis: String

Batasan Panjang: Panjang minimum 0. Panjang maksimum 256.

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

Options

Pengaturan tugas. Misalnya, metadata file apa yang dipertahankan, bagaimana integritas data diverifikasi di akhir transfer Anda, batas bandwidth, di antara opsi lainnya.

Tipe: Objek Options

Schedule

Jadwal kapan Anda ingin tugas Anda berjalan. Untuk informasi selengkapnya, lihat Menjadwalkan tugas Anda.

Tipe: Objek TaskSchedule

ScheduleDetails

Detail tentang jadwal tugas Anda.

Tipe: Objek TaskScheduleDetails

SourceLocationArn

ARN lokasi sumber transfer Anda.

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

ARN dari antarmuka jaringan yang DataSync dibuat untuk lokasi sumber Anda.

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 Anda. Untuk informasi tentang arti setiap status, lihat Status tugas.

Jenis: String

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

TaskArn

ARN tugas Anda.

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 rinci tentang DataSync transfer Anda. Untuk informasi selengkapnya, lihat Memantau DataSync transfer Anda dengan 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 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: