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

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

DescribeLedger

傳回分類帳的相關資訊，包括其狀態、權限模式、靜態加密設定以及建立時間。

請求語法

GET /ledgers/name HTTP/1.1

URI 請求參數

請求會使用下列 URI 參數。

name

您要說明之分類帳的名稱。

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

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

必要：是

請求主體

請求沒有請求主體。

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "EncryptionDescription": { 
      "EncryptionStatus": "string",
      "InaccessibleKmsKeyDateTime": number,
      "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 以停用該功能。

類型：布林值

EncryptionDescription

有關分類帳中靜態數據加密的信息。這包括當前狀態， AWS KMS 密鑰以及密鑰無法訪問的時間（在發生錯誤的情況下）。如果未定義此參數，則分類帳會使用 AWS 擁有的 KMS 金鑰進行加密。

類型：LedgerEncryptionDescription 物件

Name

分類帳的名稱。

類型：字串

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

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

PermissionsMode

分類帳的權限模式。

類型：字串

有效值:ALLOW_ALL | STANDARD

State

分類帳的目前狀態。

類型：字串

有效值:CREATING | ACTIVE | DELETING | DELETED

錯誤

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

InvalidParameterException

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

HTTP 狀態碼：400

ResourceNotFoundException

指定的資源不存在。

HTTP 狀態碼：404

另請參閱

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