CreateLedger - Amazon Quantum Ledger 資料庫 （Amazon QLDB）
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

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

CreateLedger

在目前區域 AWS 帳戶 中建立新分類帳。

請求語法

POST /ledgers HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI 請求參數

請求不會使用任何 URI 參數。

請求主體

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

DeletionProtection

指定是否要保護分類帳，不讓任何使用者刪除。如果在建立分類帳時未定義，則預設會啟用此功能 (true)。

如果已啟用刪除保護，則必須先停用該功能才能刪除分類帳。您可以呼叫 UpdateLedger 操作將此參數設定為 false 以停用該功能。

類型：布林值

必要：否

KmsKey

AWS Key Management Service (AWS KMS) 中的密鑰用於分類帳中靜態數據的加密。如需詳細資訊，請參閱《Amazon QLDB 開發人員指南》中的靜態加密。

使用以下其中一個選項來指定此參數：

  • AWS_OWNED_KMS_KEY：使用代表您擁有和管理 AWS 的 AWS KMS 密鑰。

  • 未定義：依預設，使用 AWS 擁有的 KMS 金鑰。

  • 有效的對稱客戶受管 KMS 金鑰：使用在您帳戶中建立、擁有和管理的指定對稱加密 KMS 金鑰。

    Amazon QLDB 不支援非對稱金鑰。如需詳細資訊，請參閱 AWS Key Management Service 開發人員指南中的使用對稱和非對稱金鑰。

若要指定客戶受管 KMS 金鑰，您可使用其金鑰 ID、Amazon Resource Name (ARN)、別名名稱或別名 ARN。使用別名名稱時，請加上 "alias/" 字首。若要指定不同的索引鍵 AWS 帳戶，您必須使用金鑰 ARN 或別名 ARN。

例如：

  • 金鑰 ID：1234abcd-12ab-34cd-56ef-1234567890ab

  • 金鑰 ARN：arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • 別名名稱：alias/ExampleAlias

  • 別名 ARN：arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

如需詳細資訊，請參閱 AWS Key Management Service 開發人員指南中的金鑰識別碼 (KeyId)。

類型：字串

長度限制：最大長度為 1600。

必要：否

Name

您要建立分類帳的名稱。在您目前「區域」中的所有分類帳 AWS 帳戶 中，此名稱必須是唯一的。

分類帳名稱的命名限制定義於《Amazon QLDB 開發人員指南》中的 Amazon QLDB 中的配額。

類型：字串

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

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

必要：是

PermissionsMode

要指派給您希望建立分類帳的許可模式。此參數可以有下列其中一個值：

  • ALLOW_ALL：一種舊版許可模式，可使用 API 層級精細程度啟用對分類帳的存取控制。

    此模式允許具有指定分類帳 SendCommand API 許可的使用者 (因此為 ALLOW_ALL)，在此分類帳中的任何資料表上執行所有 PartiQL 命令。此模式會忽略您為分類帳建立之任何資料表層級或命令層級 IAM 許可政策。

  • STANDARD：(建議) 一種許可模式，可使用更細的層級啟用對分類帳、資料表和 PartiQL 命令的存取控制。

    根據預設，此模式會拒絕所有使用者在此分類帳中任何資料表上執行任何 PartiQL 命令的請求。若要允許執行 PartiQL 命令，除了分類帳的 SendCommand API 許可之外，您還必須為特定資料表資源和 PartiQL 動作建立 IAM 許可政策。如需相關資訊，請參閱《Amazon QLDB 開發人員指南》中的開始使用標準許可模式。

注意

強烈建議您使用 STANDARD 許可模式來最大化分類帳資料的安全性。

類型：字串

有效值:ALLOW_ALL | STANDARD

必要：是

Tags

要新增為標記至您要建立之分類帳的索引鍵值配對。標籤鍵會區分大小寫。標籤值區分大小寫，並且可以為 null。

類型：字串到字串映射

地圖項目：0 個項目的最小數目。項目數上限為 200。

索引鍵長度限制：長度下限為 1。長度上限為 128。

值長度限制：最小長度為 0。長度上限為 256。

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "State": "string"
}

回應元素

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

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

Arn

分類帳的 Amazon 資源名稱（ARN）。

類型：字串

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

CreationDateTime

建立分類帳時的日期和時間 (以紀元時間格式表示)。（紀元時間格式是自世界標準時間 1970 年 1 月 1 日上午 12:00:00 以來經過的秒數。）

類型：Timestamp

DeletionProtection

指定是否要保護分類帳，不讓任何使用者刪除。如果在建立分類帳時未定義，則預設會啟用此功能 (true)。

如果已啟用刪除保護，則必須先停用該功能才能刪除分類帳。您可以呼叫 UpdateLedger 操作將此參數設定為 false 以停用該功能。

類型：布林值

KmsKeyArn

客戶的 ARN 管理 KMS 金鑰，分類帳用於靜態加密。如果未定義此參數，則分類帳會使用 AWS 擁有的 KMS 金鑰進行加密。

類型：字串

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

Name

分類帳的名稱。

類型：字串

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

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

PermissionsMode

您所建立之分類帳的權限模式。

類型：字串

有效值:ALLOW_ALL | STANDARD

State

分類帳的目前狀態。

類型：字串

有效值:CREATING | ACTIVE | DELETING | DELETED

錯誤

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

InvalidParameterException

請求中的一個或多個參數無效。

HTTP 狀態碼：400

LimitExceededException

您已達到允許的最大資源數量上限。

HTTP 狀態碼：400

ResourceAlreadyExistsException

指定的資源已存在。

HTTP 狀態碼：409

ResourceInUseException

目前無法修改指定的資源。

HTTP 狀態碼：409

另請參閱

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