2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeTaskExecution
AWS DataSyncタスクの実行に関する情報を提供します。この操作を使用すると、進行中の転送の進行状況を監視したり、転送の結果を確認したりできます。
リクエストの構文
{
"TaskExecutionArn": "string
"
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- TaskExecutionArn
-
情報が必要なタスク実行の Amazon リソースネーム (ARN) を指定します。
型: 文字列
長さの制限: 最大長は 128 です。
パターン:
^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}$
必須: はい
レスポンスの構文
{
"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"
}
],
"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"
}
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- BytesCompressed
-
圧縮が適用された後にネットワーク上で転送された物理バイト数。ほとんどの場合、
BytesTransferred
データが圧縮可能でない限り、この数はそれよりも少なくなります。型: Long
- BytesTransferred
-
転送に関係するバイトの総数。ネットワーク経由で送信されたバイト数については、を参照してください
BytesCompressed
。型: Long
- BytesWritten
-
宛先の場所に書き込まれた論理バイト数。
型: Long
- EstimatedBytesToTransfer
-
ネットワーク上で転送される推定物理バイト数。
型: Long
- EstimatedFilesToDelete
-
DataSync 転送先の場所で削除されるファイル、オブジェクト、ディレクトリの予想数。ターゲットにあるデータのうち、ソースにないデータを削除するようにタスクを設定しない場合、
0
値は常にになります。型: Long
- EstimatedFilesToTransfer
-
DataSync ネットワーク経由で転送されるファイル、オブジェクト、ディレクトリの予想数。この値は、
PREPARING
TRANSFERRING
そのフェーズの前のタスク実行フェーズで計算されます。この計算は、転送元と転送先の場所のコンテンツを比較し、転送する必要がある差異を見つけることに基づいて行われます。型: Long
- Excludes
-
転送中に特定のデータを除外するフィルタルールのリスト。詳細と例については、「によって転送されたデータのフィルタリング」を参照してください DataSync。
型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
- FilesDeleted
-
DataSync 転送先の場所で削除されたファイル、オブジェクト、およびディレクトリの数。移行先にあるデータのうち、ソースにないデータを削除するようにタスクを設定しない場合、値は常にです
0
。型: Long
- FilesSkipped
-
DataSync 転送中にスキップされたファイル、オブジェクト、ディレクトリの数。
型: Long
- FilesTransferred
-
DataSyncネットワーク経由で転送されたファイル、オブジェクト、ディレクトリの実際の数。この値は、
TRANSFERRING
タスクの実行段階で、ソースから何かが読み込まれてネットワーク経由で送信されるときに定期的に更新されます。DataSync 何かを転送できなかった場合、この値はより小さくなる可能性があります
EstimatedFilesToTransfer
。場合によっては、この値がより大きくなることもありますEstimatedFilesToTransfer
。この要素は一部のロケーションタイプでは実装固有であるため、転送された内容の正確な指標として使用したり、タスクの実行を監視したりしないでください。型: Long
- FilesVerified
-
DataSync 転送中に検証されたファイル、オブジェクト、ディレクトリの数。
注記
DataSync 転送されたデータだけを検証するようにタスクを設定しても、状況によってはディレクトリや転送に失敗したファイルは検証されません。
型: Long
- Includes
-
転送中に特定のデータを含むフィルタルールのリスト。詳細と例については、「によって転送されるデータのフィルタリング」を参照してください DataSync。
型: FilterRule オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 1 項目です。
- Options
-
転送タスクがどのように構成されているかを示します。これらのオプションには、転送中のファイル、オブジェクト、 DataSync および関連するメタデータの処理方法が含まれます。また、データの整合性の検証方法や、タスクの帯域幅制限の設定方法なども指定できます。
各オプションにはデフォルト値があります。必要でない限り、タスクを開始する前にこれらのオプションを設定する必要はありません。
型: Options オブジェクト
- ReportResult
-
DataSync 転送に関する完全なタスクレポートを生成したかどうかを示します。
型: ReportResult オブジェクト
- Result
-
タスク実行の 結果。
型: TaskExecutionResultDetail オブジェクト
- StartTime
-
タスクの実行が開始された時刻。
タイプ: Timestamp
- Status
-
タスク実行のステータス。
タスク実行ステータスの詳細については、「タスク実行ステータス」を参照してください。
タイプ: 文字列
有効な値:
QUEUED | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR
- TaskExecutionArn
-
情報が必要なタスク実行の ARN。
TaskExecutionArn
階層型で、TaskArn
実行されたタスクに含まれます。たとえば、ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
でタスクを実行した ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
とTaskExecution
の値です。型: 文字列
長さの制限: 最大長は 128 です。
パターン:
^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
-
DataSync 転送に関する詳細情報を提供するタスクレポートの設定。
型: TaskReportConfig オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
リクエスト例
DescribeTaskExecution
この例はリクエストを示しています。
{ "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1" }
レスポンス例
DescribeTaskExecution
この例はレスポンスを示しています。
{ "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" } }
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。