ExportJournalToS3 - Amazon Quantum 賬本數據庫（AmazonQLDB）
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

ExportJournalToS3

將日期和時間範圍內的日誌內容從分類帳匯出到指定的 Amazon Simple Storage Service (Amazon S3) 儲存貯體。日誌匯出任務可以使用 Amazon Ion 格式的文字或二進位表示法或 JSON 行文字格式來寫入資料物件。

如果具有給定的分類帳Name不存在，則拋出ResourceNotFoundException。

如果具有給定的分類帳處Name於CREATING狀態，則拋出ResourcePreconditionNotMetException。

您可以針對每個分類帳，啟動最多兩個並行分錄匯出請求。超出此限制時，會擲回日誌匯出要求LimitExceededException。

請求語法

POST /ledgers/name/journal-s3-exports HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "OutputFormat": "string",
   "RoleArn": "string",
   "S3ExportConfiguration": { 
      "Bucket": "string",
      "EncryptionConfiguration": { 
         "KmsKeyArn": "string",
         "ObjectEncryptionType": "string"
      },
      "Prefix": "string"
   }
}

URI 請求參數

請求會使用下列 URI 參數。

name

分類帳的名稱。

長度限制：長度下限為 1。長度上限為 32。

模式：(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

必要：是

請求主體

請求接受採用 JSON 格式的下列資料。

ExclusiveEndTime

要匯出之分錄內容範圍的專用結束日期與時間。

ExclusiveEndTime 必須採用 ISO 8601 日期和時間格式，並以國際標準時間 (UTC) 表示。例如：2019-06-13T21:36:34Z。

ExclusiveEndTime必須小於或等於目前的 UTC 日期和時間。

類型：Timestamp

必要：是

InclusiveStartTime

要匯出之分錄內容範圍的開始日期與時間 (含)。

InclusiveStartTime 必須採用 ISO 8601 日期和時間格式，並以國際標準時間 (UTC) 表示。例如：2019-06-13T21:36:34Z。

必InclusiveStartTime須在之前ExclusiveEndTime。

如果您提供的InclusiveStartTime是分類帳之前的CreationDateTime，Amazon QLDB 將其預設為分類帳。CreationDateTime

類型：Timestamp

必要：是

OutputFormat

匯出分錄資料的輸出格式。日誌匯出任務可以使用 Amazon Ion 格式的文字或二進位表示法或 JSON 行文字格式來寫入資料物件。

預設：ION_TEXT

在 JSON 行格式中，匯出資料物件中的每個日誌區塊都是以換行符分隔的有效 JSON 物件。您可以使用此格式將 JSON 匯出與 Amazon Athena 等分析工具直接整合， AWS Glue 因為這些服務可以自動剖析以換行符分隔的 JSON。

類型：字串

有效值:ION_BINARY | ION_TEXT | JSON

必要：否

RoleArn

IAM 角色的 Amazon 資源名稱 (ARN)，可授與日誌匯出任務的 QLDB 許可，以執行以下作業：

  • 將物件寫入您的 Amazon S3 儲存貯體。

  • (選擇性) 在 AWS Key Management Service (AWS KMS) 中使用您的客戶管理金鑰，對匯出的資料進行伺服器端加密。

若要在請求日誌匯出時將角色傳遞給 QLDB，您必須擁有對 IAM 角色資源執行iam:PassRole動作的權限。所有分錄匯出請求都需要此功能。

類型：字串

長度限制︰長度下限為 20。長度上限為 1600。

必要：是

S3ExportConfiguration

您的匯出請求之 Amazon S3 儲存貯體目的地的組態設定。

類型：S3ExportConfiguration 物件

必要：是

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "ExportId": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

ExportId

QLDB 指派給每個分錄匯出工作的 UUID (以 Base62 編碼的文字表示)。

要描述您的出口請求並檢查工作狀態，您可以使用撥ExportId打電話DescribeJournalS3Export。

類型：字串

長度約束：固定長度為 22。

模式：^[A-Za-z-0-9]+$

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

ResourceNotFoundException

指定的資源不存在。

HTTP 狀態碼：404

ResourcePreconditionNotMetException

作業失敗，因為未事先滿足條件。

HTTP 狀態碼：412

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：