本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 操作 **重要** 终止支持通知：现有客户将能够使用 Amazon QLDB，直到 2025 年 7 月 31 日终止支持。有关更多详细信息，请参阅[将亚马逊 QLDB 账本迁移到亚马逊 Aurora PostgreSQL](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/)。 Amazon QLDB 支持以下操作： + [CancelJournalKinesisStream](API_CancelJournalKinesisStream.md) + [CreateLedger](API_CreateLedger.md) + [DeleteLedger](API_DeleteLedger.md) + [DescribeJournalKinesisStream](API_DescribeJournalKinesisStream.md) + [DescribeJournalS3Export](API_DescribeJournalS3Export.md) + [DescribeLedger](API_DescribeLedger.md) + [ExportJournalToS3](API_ExportJournalToS3.md) + [GetBlock](API_GetBlock.md) + [GetDigest](API_GetDigest.md) + [GetRevision](API_GetRevision.md) + [ListJournalKinesisStreamsForLedger](API_ListJournalKinesisStreamsForLedger.md) + [ListJournalS3Exports](API_ListJournalS3Exports.md) + [ListJournalS3ExportsForLedger](API_ListJournalS3ExportsForLedger.md) + [ListLedgers](API_ListLedgers.md) + [ListTagsForResource](API_ListTagsForResource.md) + [StreamJournalToKinesis](API_StreamJournalToKinesis.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateLedger](API_UpdateLedger.md) + [UpdateLedgerPermissionsMode](API_UpdateLedgerPermissionsMode.md) Amazon QLDB 会话支持以下操作： + [SendCommand](API_QLDB-Session_SendCommand.md) # Amazon QLDB **重要** 终止支持通知：现有客户将能够使用 Amazon QLDB，直到 2025 年 7 月 31 日终止支持。有关更多详细信息，请参阅[将亚马逊 QLDB 账本迁移到亚马逊 Aurora PostgreSQL](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/)。 Amazon QLDB 支持以下操作： + [CancelJournalKinesisStream](API_CancelJournalKinesisStream.md) + [CreateLedger](API_CreateLedger.md) + [DeleteLedger](API_DeleteLedger.md) + [DescribeJournalKinesisStream](API_DescribeJournalKinesisStream.md) + [DescribeJournalS3Export](API_DescribeJournalS3Export.md) + [DescribeLedger](API_DescribeLedger.md) + [ExportJournalToS3](API_ExportJournalToS3.md) + [GetBlock](API_GetBlock.md) + [GetDigest](API_GetDigest.md) + [GetRevision](API_GetRevision.md) + [ListJournalKinesisStreamsForLedger](API_ListJournalKinesisStreamsForLedger.md) + [ListJournalS3Exports](API_ListJournalS3Exports.md) + [ListJournalS3ExportsForLedger](API_ListJournalS3ExportsForLedger.md) + [ListLedgers](API_ListLedgers.md) + [ListTagsForResource](API_ListTagsForResource.md) + [StreamJournalToKinesis](API_StreamJournalToKinesis.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateLedger](API_UpdateLedger.md) + [UpdateLedgerPermissionsMode](API_UpdateLedgerPermissionsMode.md) # CancelJournalKinesisStream 结束指定 Amazon QLDB 日记账流。在取消流式传输前，当前状态必须为`ACTIVE`。取消流后，您无法重新启动流。已取消的 QLDB 数据流资源有 7 天的保留期，因此在此限制到期后它们会被自动删除。 ## 请求语法 ``` DELETE /ledgers/name/journal-kinesis-streams/streamId HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_CancelJournalKinesisStream_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ** [streamId](#API_CancelJournalKinesisStream_RequestSyntax) ** 要取消的 QLDB 日记账流的 UUID（以 Base62 编码的文本表示）。长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` 必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "StreamId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [StreamId](#API_CancelJournalKinesisStream_ResponseSyntax) ** 取消的 QLDB 日记账流的 UUID（以 Base62 编码的文本表示）。类型：字符串长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/CancelJournalKinesisStream) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/CancelJournalKinesisStream) # 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](#API_CreateLedger_RequestSyntax) ** 指定是否保护分类账不被任何用户删除。如果创建分类账期间未定义，则默认情况下启用该功能（`true`）。如果启用了删除保护，您必须先禁用它，然后才能删除分类账。您可以通过调用 `UpdateLedger` 操作将此参数设置为 `false` 来禁用该功能。类型：布尔值必需：否 ** [KmsKey](#API_CreateLedger_RequestSyntax) ** AWS Key Management Service (AWS KMS) 中的密钥，用于加密账本中的静态数据。有关更多信息，请参阅《Amazon QLDB 开发人员指南》中的[静态加密](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html)。使用以下选项之一指定此参数： + `AWS_OWNED_KMS_KEY`：使用由您代表自己拥有和管理 AWS 的 AWS KMS 密钥。 + **未定义**：默认情况下，使用 AWS 拥有的 KMS 密钥。 + **A valid symmetric customer managed KMS key**（有效的对称客户托管 KMS 密钥）：在您创建、拥有和管理的账户中使用指定的对称加密 KMS 密钥。 Amazon QLDB 不支持非对称密钥。有关更多信息，请参阅《* AWS Key Management Service 开发人员*指南》中的[使用对称和非对称密钥](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)。要指定客户托管的 KMS 密钥，您可以使用其密钥 ID、Amazon 资源名称（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)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)。类型：字符串长度限制：最大长度为 1600。必需：否 ** [Name](#API_CreateLedger_RequestSyntax) ** 您要创建的分类帐的名称。该名称在您 AWS 账户当前区域的所有账本中必须是唯一的。分类账名称的命名约束在《Amazon QLDB 开发人员指南》的 [Amazon QLDB 中的配额](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming)中定义。类型：字符串长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ** [PermissionsMode](#API_CreateLedger_RequestSyntax) ** 要分配给您想创建的分类帐的权限模式。此参数可能具有下列值之一： + `ALLOW_ALL`：一种旧式权限模式，支持对分类账进行 API 级别粒度的访问控制。此模式允许拥有此分类账的 `SendCommand` API 权限的用户在指定分类账中的任何表上运行所有 PartiQL 命令（因此，`ALLOW_ALL`）。此模式忽略您为分类账创建的任何表级或命令级 IAM 权限策略。 + `STANDARD`：（*推荐*）一种权限模式，可以对分类账、表格和 PartiQL 命令进行更精细粒度的访问控制。默认情况下，此模式拒绝所有用户请求在此分类账中的任何表上运行任何 PartiQL 命令。要允许 PartiQL 命令运行，除了分类账的 `SendCommand` API 权限外，您还必须为特定表资源和 PartiQL 操作创建 IAM 权限策略。有关信息，请参阅《Amazon QLDB 开发人员指南》中的[标准权限模式入门](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html)。我们强烈建议使用 `STANDARD` 权限模式来最大限度地提高分类账数据的安全性。类型：字符串有效值：`ALLOW_ALL | STANDARD` 必需：是 ** [Tags](#API_CreateLedger_RequestSyntax) ** 要作为标签添加到待创建的分类账中的键值对。标签键区分大小写。标签值区分大小写，可以为空值。类型：字符串到字符串映射映射条目：最低 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](#API_CreateLedger_ResponseSyntax) ** 分类账的 Amazon 资源名称（ARN）。类型：字符串长度约束：最小长度为 20。长度上限为 1600。 ** [CreationDateTime](#API_CreateLedger_ResponseSyntax) ** 创建分类账时，日期和时间采用世界标准纪元时间格式）。（纪元时间格式为自 1970 年 1 月 1 日午夜 12:00:00 UTC 以来的秒数。）类型：时间戳 ** [DeletionProtection](#API_CreateLedger_ResponseSyntax) ** 指定是否保护分类账不被任何用户删除。如果创建分类账期间未定义，则默认情况下启用该功能（`true`）。如果启用了删除保护，您必须先禁用它，然后才能删除分类账。您可以通过调用 `UpdateLedger` 操作将此参数设置为 `false` 来禁用该功能。类型：布尔值 ** [KmsKeyArn](#API_CreateLedger_ResponseSyntax) ** 分类账用于静态加密的、客户托管 KMS 密钥。如果未定义此参数，则账本使用 AWS 拥有的 KMS 密钥进行加密。类型：字符串长度约束：最小长度为 20。长度上限为 1600。 ** [Name](#API_CreateLedger_ResponseSyntax) ** 分类账的名称。类型：字符串长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` ** [PermissionsMode](#API_CreateLedger_ResponseSyntax) ** 您想创建的分类帐的权限模式。类型：字符串有效值：`ALLOW_ALL | STANDARD` ** [State](#API_CreateLedger_ResponseSyntax) ** 分类账的当前状态。类型：字符串有效值：`CREATING | ACTIVE | DELETING | DELETED` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** LimitExceededException ** 您已达到允许的最大资源数量上限。 HTTP 状态代码：400 ** ResourceAlreadyExistsException ** 指定资源已经存在。 HTTP 状态代码：409 ** ResourceInUseException ** 此时无法修改指定资源。 HTTP 状态代码：409 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/CreateLedger) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/CreateLedger) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/CreateLedger) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/CreateLedger) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/CreateLedger) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/CreateLedger) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/CreateLedger) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/CreateLedger) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/CreateLedger) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/CreateLedger) # DeleteLedger 删除分类账及其所有内容。此操作不可逆。如果启用了删除保护，您必须先禁用它，然后才能删除分类账。您可以通过调用 `UpdateLedger` 操作将此参数设置为 `false` 来禁用该功能。 ## 请求语法 ``` DELETE /ledgers/name HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_DeleteLedger_RequestSyntax) ** 您要删除的日记账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceInUseException ** 此时无法修改指定资源。 HTTP 状态代码：409 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DeleteLedger) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DeleteLedger) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DeleteLedger) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DeleteLedger) # DescribeJournalKinesisStream 返回有关给定 Amazon QLDB 日记账流的详细信息。输出包括 Amazon 资源名称（ARN）、流名称、当前状态、创建时间和原始流创建请求参数。此操作不会返回任何过期的日志流。有关更多信息，请参阅 *《Amazon QLDB 开发人员指南》* 中的 [终端流过期](https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration)。 ## 请求语法 ``` GET /ledgers/name/journal-kinesis-streams/streamId HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_DescribeJournalKinesisStream_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ** [streamId](#API_DescribeJournalKinesisStream_RequestSyntax) ** QLDB 日记账流描述的 UUID（以 Base62 编码的文本表示）。长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` 必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Stream": { "Arn": "string", "CreationTime": number, "ErrorCause": "string", "ExclusiveEndTime": number, "InclusiveStartTime": number, "KinesisConfiguration": { "AggregationEnabled": boolean, "StreamArn": "string" }, "LedgerName": "string", "RoleArn": "string", "Status": "string", "StreamId": "string", "StreamName": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Stream](#API_DescribeJournalKinesisStream_ResponseSyntax) ** `DescribeJournalS3Export` 请求返回的 QLDB 日记账流信息。类型：[JournalKinesisStreamDescription](API_JournalKinesisStreamDescription.md) 对象 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeJournalKinesisStream) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeJournalKinesisStream) # DescribeJournalS3Export 有关日记账导出任务的返回信息，包括分类账名称、导出 ID、创建时间、当前状态和原始导出创建请求的参数。此操作不会返回任何过期导出作业。有关更多信息，请参阅*《Amazon QLDB 开发者指南》*中的[过期导出作业](https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration)。如果给定的导出任务`ExportId`不存在，则抛出`ResourceNotFoundException`。如果给定`Name`分类账不存在，则抛出`ResourceNotFoundException`。 ## 请求语法 ``` GET /ledgers/name/journal-s3-exports/exportId HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [exportId](#API_DescribeJournalS3Export_RequestSyntax) ** 描述的 QLDB 日记账导出作业的 UUID（以 Base62 编码的文本表示）。长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` 必需：是 ** [name](#API_DescribeJournalS3Export_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "ExportDescription": { "ExclusiveEndTime": number, "ExportCreationTime": number, "ExportId": "string", "InclusiveStartTime": number, "LedgerName": "string", "OutputFormat": "string", "RoleArn": "string", "S3ExportConfiguration": { "Bucket": "string", "EncryptionConfiguration": { "KmsKeyArn": "string", "ObjectEncryptionType": "string" }, "Prefix": "string" }, "Status": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ExportDescription](#API_DescribeJournalS3Export_ResponseSyntax) ** `DescribeJournalS3Export` 请求返回的日记账导出作业信息。类型：[JournalS3ExportDescription](API_JournalS3ExportDescription.md) 对象 ## 错误有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeJournalS3Export) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeJournalS3Export) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeJournalS3Export) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeJournalS3Export) # DescribeLedger 返回有关分类账的信息，包括分类账状态、权限模式、静态加密设置以及创建时间。 ## 请求语法 ``` GET /ledgers/name HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_DescribeLedger_RequestSyntax) ** 您要描述的分类帐的名称。长度限制：长度下限为 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](#API_DescribeLedger_ResponseSyntax) ** 分类账的 Amazon 资源名称（ARN）。类型：字符串长度约束：最小长度为 20。长度上限为 1600。 ** [CreationDateTime](#API_DescribeLedger_ResponseSyntax) ** 创建分类账时，日期和时间采用世界标准纪元时间格式）。（纪元时间格式为自 1970 年 1 月 1 日午夜 12:00:00 UTC 以来的秒数。）类型：时间戳 ** [DeletionProtection](#API_DescribeLedger_ResponseSyntax) ** 指定是否保护分类账不被任何用户删除。如果创建分类账期间未定义，则默认情况下启用该功能（`true`）。如果启用了删除保护，您必须先禁用它，然后才能删除分类账。您可以通过调用 `UpdateLedger` 操作将此参数设置为 `false` 来禁用该功能。类型：布尔值 ** [EncryptionDescription](#API_DescribeLedger_ResponseSyntax) ** 有关分类账中静态数据加密的信息。这包括当前状态、 AWS KMS 密钥以及何时无法访问密钥（如果出现错误）。如果未定义此参数，则账本使用 AWS 拥有的 KMS 密钥进行加密。类型：[LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) 对象 ** [Name](#API_DescribeLedger_ResponseSyntax) ** 分类账的名称。类型：字符串长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` ** [PermissionsMode](#API_DescribeLedger_ResponseSyntax) ** 分类账的权限模式。类型：字符串有效值：`ALLOW_ALL | STANDARD` ** [State](#API_DescribeLedger_ResponseSyntax) ** 分类账的当前状态。类型：字符串有效值：`CREATING | ACTIVE | DELETING | DELETED` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeLedger) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeLedger) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeLedger) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeLedger) # 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](#API_ExportJournalToS3_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [ExclusiveEndTime](#API_ExportJournalToS3_RequestSyntax) ** 要导出的日记账内容范围的唯一结束日期和时间。 `ExclusiveEndTime` 必须采用 `ISO 8601` 日期和时间格式以及通用协调时间（UTC）。例如：`2019-06-13T21:36:34Z`。 `ExclusiveEndTime` 必须小于或等于当前的 UTC 日期和时间。类型：时间戳必需：是 ** [InclusiveStartTime](#API_ExportJournalToS3_RequestSyntax) ** 要导出的日记账内容范围的全部起始日期和时间。 `InclusiveStartTime` 必须采用 `ISO 8601` 日期和时间格式以及通用协调时间（UTC）。例如：`2019-06-13T21:36:34Z`。 `InclusiveStartTime`必须在`ExclusiveEndTime`之前。如果您提供的 `InclusiveStartTime` 是在分类账的 `CreationDateTime` 之前，则 Amazon QLDB 有效地将其默认视为分类账的 `CreationDateTime`。类型：时间戳必需：是 ** [OutputFormat](#API_ExportJournalToS3_RequestSyntax) ** 导出的日记账数据的输出格式。日记账导出作业可以以 [Amazon Ion](https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html) 格式的文本或二进制形式或 [JSON 行](https://jsonlines.org/)文本格式写入数据对象。默认值：`ION_TEXT` 在 JSON 行格式中，导出的数据对象中的每个日记账数据块都是由换行符分隔的有效 JSON 对象。您可以使用这种格式将 JSON 导出与 Amazon Athena 和 AWS Glue 等分析工具直接集成，因为这些服务可以自动解析以换行符分隔的 JSON。类型：字符串有效值：`ION_BINARY | ION_TEXT | JSON` 必需：否 ** [RoleArn](#API_ExportJournalToS3_RequestSyntax) ** IAM 角色的 Amazon 资源名称（ARN），该名称授予日记账导出任务的 QLDB 权限： + 将对象写入 Amazon S3 存储桶。 + （可选）使用 AWS Key Management Service (AWS KMS) 中的客户托管密钥对导出的数据进行服务器端加密。要在请求日记账导出时将角色传递给 QLDB，您必须具有对 IAM 角色资源执行 `iam:PassRole` 操作的权限。这是所有日记账流请求所必需的。类型：字符串长度约束：最小长度为 20。长度上限为 1600。必需：是 ** [S3ExportConfiguration](#API_ExportJournalToS3_RequestSyntax) ** 导出请求 Amazon S3 存储桶目标的配置设置。类型：[S3ExportConfiguration](API_S3ExportConfiguration.md) 对象必需：是 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "ExportId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [ExportId](#API_ExportJournalToS3_ResponseSyntax) ** QLDB 分配到每个日记账流导出作业的 UUID（以 Base62 编码的文本表示）。要描述您的导出请求并检查任务状态，您可以使用`ExportId`致电`DescribeJournalS3Export`。类型：字符串长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` ## 错误有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ExportJournalToS3) + [AWS JavaScript V3 版 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ExportJournalToS3) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ExportJournalToS3) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ExportJournalToS3) # GetBlock 返回日志中指定地址的数据块对象。如果 `DigestTipAddress` 已提供，还会返回指定数据块的证明以供验证。有关区块中数据内容的信息，请参阅 *Amazon QLDB 开发人员指南*中的[日志内容](https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html)。如果指定的分类账不存在或处于`DELETING`状态，则抛出`ResourceNotFoundException`。如果指定的分类账处于`CREATING`状态，则抛出`ResourcePreconditionNotMetException`。如果不存在具有指定地址的数据块，则抛出`InvalidParameterException`。 ## 请求语法 ``` POST /ledgers/name/block HTTP/1.1 Content-type: application/json { "BlockAddress": { "IonText": "string" }, "DigestTipAddress": { "IonText": "string" } } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_GetBlock_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [BlockAddress](#API_GetBlock_RequestSyntax) ** 您要请求的数据块的位置。地址是一种包含两个字段的 Amazon Ion 结构：即 `strandId` 和 `sequenceNo`。例如：`{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}`。类型：[ValueHolder](API_ValueHolder.md) 对象必需：是 ** [DigestTipAddress](#API_GetBlock_RequestSyntax) ** 摘要中要求提供证据的最新数据块位置。地址是一种包含两个字段的 `strandId`Amazon Ion 结构：即和 `sequenceNo`。例如：`{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}`。类型：[ValueHolder](API_ValueHolder.md) 对象必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Block": { "IonText": "string" }, "Proof": { "IonText": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Block](#API_GetBlock_ResponseSyntax) ** Amazon Ion 格式的区块数据对象。类型：[ValueHolder](API_ValueHolder.md) 对象 ** [Proof](#API_GetBlock_ResponseSyntax) ** `GetBlock` 请求返回的 Amazon Ion 格式的证明对象。证明包含使用默克尔树重新计算指定摘要所需哈希值列表，从指定的区块开始。类型：[ValueHolder](API_ValueHolder.md) 对象 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/GetBlock) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/GetBlock) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/GetBlock) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/GetBlock) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/GetBlock) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/GetBlock) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/GetBlock) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/GetBlock) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/GetBlock) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/GetBlock) # GetDigest 返回日记账中最新提交块的分类账摘要。响应包括一个 256 位的哈希值和一个块地址。 ## 请求语法 ``` POST /ledgers/name/digest HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_GetDigest_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Digest": blob, "DigestTipAddress": { "IonText": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Digest](#API_GetDigest_ResponseSyntax) ** 由 `GetDigest` 代表请求返回的摘要的 256 位哈希值。类型：Base64 编码的二进制数据对象长度限制：固定长度为 32。 ** [DigestTipAddress](#API_GetDigest_ResponseSyntax) ** 摘要中要求提供证据的最新数据块位置。地址是一种包含两个字段的 `strandId`Amazon Ion 结构：即和 `sequenceNo`。类型：[ValueHolder](API_ValueHolder.md) 对象 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/GetDigest) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/GetDigest) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/GetDigest) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/GetDigest) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/GetDigest) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/GetDigest) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/GetDigest) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/GetDigest) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/GetDigest) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/GetDigest) # GetRevision 返回指定文档 ID 和块地址的修订数据对象。如果 `DigestTipAddress` 已提供，还会返回指定修订版的证明以供验证。 ## 请求语法 ``` POST /ledgers/name/revision HTTP/1.1 Content-type: application/json { "BlockAddress": { "IonText": "string" }, "DigestTipAddress": { "IonText": "string" }, "DocumentId": "string" } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_GetRevision_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [BlockAddress](#API_GetRevision_RequestSyntax) ** 要验证的文档修订版的数据块位置。地址是一种包含两个字段的 `strandId`Amazon Ion 结构：即和 `sequenceNo`。例如：`{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}`。类型：[ValueHolder](API_ValueHolder.md) 对象必需：是 ** [DigestTipAddress](#API_GetRevision_RequestSyntax) ** 摘要中要求提供证据的最新数据块位置。地址是一种包含两个字段的 `strandId`Amazon Ion 结构：即和 `sequenceNo`。例如：`{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}`。类型：[ValueHolder](API_ValueHolder.md) 对象必需：否 ** [DocumentId](#API_GetRevision_RequestSyntax) ** 要验证的文档的 UUID（以 Base62 编码的文本表示）。类型：字符串长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` 必需：是 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Proof": { "IonText": "string" }, "Revision": { "IonText": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Proof](#API_GetRevision_ResponseSyntax) ** `GetRevision` 请求返回的 Amazon Ion 格式的证明对象。证明包含使用默克尔树重新计算指定摘要所需哈希值列表，从指定的文档修订版开始。类型：[ValueHolder](API_ValueHolder.md) 对象 ** [Revision](#API_GetRevision_ResponseSyntax) ** Amazon Ion 格式的文档修订数据对象。类型：[ValueHolder](API_ValueHolder.md) 对象 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/GetRevision) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/GetRevision) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/GetRevision) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/GetRevision) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/GetRevision) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/GetRevision) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/GetRevision) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/GetRevision) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/GetRevision) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/GetRevision) # ListJournalKinesisStreamsForLedger 返回给定分类账的所有 Amazon QLDB 日记账流。此操作不会返回任何过期的日记账流。有关更多信息，请参阅 *《Amazon QLDB 开发人员指南》* 中的 [终端流过期](https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration)。此操作返回最多 `MaxResults` 个项目。它是分页的，因此您可以通过 `ListJournalKinesisStreamsForLedger` 多次调用来检索所有项目。 ## 请求语法 ``` GET /ledgers/name/journal-kinesis-streams?max_results=MaxResults&next_token=NextToken HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_ListJournalKinesisStreamsForLedger_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ** [MaxResults](#API_ListJournalKinesisStreamsForLedger_RequestSyntax) ** 在单个 `ListJournalKinesisStreamsForLedger` 请求中要返回的最大结果数。（返回的实际结果数可能会更少。）有效范围：最小值为 1。最大值为 100。 ** [NextToken](#API_ListJournalKinesisStreamsForLedger_RequestSyntax) ** 分页令牌表示您要检索下一页结果。如果您在上次`ListJournalKinesisStreamsForLedger`调用的响应中收到了 `NextToken` 的值，则应使用值作为此处的输入。长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 请求正文该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Streams": [ { "Arn": "string", "CreationTime": number, "ErrorCause": "string", "ExclusiveEndTime": number, "InclusiveStartTime": number, "KinesisConfiguration": { "AggregationEnabled": boolean, "StreamArn": "string" }, "LedgerName": "string", "RoleArn": "string", "Status": "string", "StreamId": "string", "StreamName": "string" } ] } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [NextToken](#API_ListJournalKinesisStreamsForLedger_ResponseSyntax) ** + 如果 `NextToken` 为空，则表示最后一页结果已处理完毕，没有检索到其他结果。 + 如果`NextToken` *不* 为空，则表示有更多结果可用。若要检索下一页结果，请在后续 `ListJournalKinesisStreamsForLedger` 调用中使用`NextToken`值。类型：字符串长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ** [Streams](#API_ListJournalKinesisStreamsForLedger_ResponseSyntax) ** 当前与给定分类账关联的 QLDB 日记账流。类型：[JournalKinesisStreamDescription](API_JournalKinesisStreamDescription.md) 对象数组 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) # ListJournalS3Exports 返回与当前 AWS 账户和区域关联的所有分类账的所有日记账导出任务。此操作最多返回 `MaxResults` 个项目，并且会进行分页，以便您可以通过 `ListJournalS3Exports` 个多次调用来检索所有项目。此操作不会返回任何过期导出作业。有关更多信息，请参阅 *《Amazon QLDB 开发者指南》* 中的 [导出作业到期](https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration)。 ## 请求语法 ``` GET /journal-s3-exports?max_results=MaxResults&next_token=NextToken HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [MaxResults](#API_ListJournalS3Exports_RequestSyntax) ** 在单个 `ListJournalS3Exports` 请求中要返回的最大结果数。（返回的实际结果数可能会更少。）有效范围：最小值为 1。最大值为 100。 ** [NextToken](#API_ListJournalS3Exports_RequestSyntax) ** 分页令牌表示您要检索下一页结果。如果您在上次 `ListJournalS3Exports` 调用的响应中收到了 `NextToken` 的值，则应使用该值作为此处的输入。长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 请求正文该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "JournalS3Exports": [ { "ExclusiveEndTime": number, "ExportCreationTime": number, "ExportId": "string", "InclusiveStartTime": number, "LedgerName": "string", "OutputFormat": "string", "RoleArn": "string", "S3ExportConfiguration": { "Bucket": "string", "EncryptionConfiguration": { "KmsKeyArn": "string", "ObjectEncryptionType": "string" }, "Prefix": "string" }, "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [JournalS3Exports](#API_ListJournalS3Exports_ResponseSyntax) ** 返回与当前 AWS 账户和区域关联的所有分类账的日记账导出作业。类型：[JournalS3ExportDescription](API_JournalS3ExportDescription.md) 对象数组 ** [NextToken](#API_ListJournalS3Exports_ResponseSyntax) ** + 如果 `NextToken` 为空，则表示最后一页结果已处理完毕，没有其他结果。 + 如果`NextToken` *不* 为空，则表示有更多结果可用。若要检索下一页结果，请在后续 `ListJournalS3Exports` 调用中使用`NextToken`值。类型：字符串长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 错误有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListJournalS3Exports) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListJournalS3Exports) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListJournalS3Exports) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListJournalS3Exports) # ListJournalS3ExportsForLedger 返回指定分类账的所有日记账导出作业。此操作最多返回 `MaxResults` 个项目，并且会进行分页，以便您可以通过 `ListJournalS3ExportsForLedger` 个多次调用来检索所有项目。此操作不会返回任何过期导出作业。有关更多信息，请参阅 *《Amazon QLDB 开发者指南》* 中的 [导出作业到期](https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration)。 ## 请求语法 ``` GET /ledgers/name/journal-s3-exports?max_results=MaxResults&next_token=NextToken HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [MaxResults](#API_ListJournalS3ExportsForLedger_RequestSyntax) ** 在单个 `ListJournalS3ExportsForLedger` 请求中要返回的最大结果数。（返回的实际结果数可能会更少。）有效范围：最小值为 1。最大值为 100。 ** [name](#API_ListJournalS3ExportsForLedger_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ** [NextToken](#API_ListJournalS3ExportsForLedger_RequestSyntax) ** 分页令牌表示您要检索下一页结果。如果您在上次 `ListJournalS3ExportsForLedger` 调用的响应中收到了 `NextToken` 的值，则应使用该值作为此处的输入。长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 请求正文该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "JournalS3Exports": [ { "ExclusiveEndTime": number, "ExportCreationTime": number, "ExportId": "string", "InclusiveStartTime": number, "LedgerName": "string", "OutputFormat": "string", "RoleArn": "string", "S3ExportConfiguration": { "Bucket": "string", "EncryptionConfiguration": { "KmsKeyArn": "string", "ObjectEncryptionType": "string" }, "Prefix": "string" }, "Status": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [JournalS3Exports](#API_ListJournalS3ExportsForLedger_ResponseSyntax) ** 当前与指定分类账关联的日记账导出任务。类型：[JournalS3ExportDescription](API_JournalS3ExportDescription.md) 对象数组 ** [NextToken](#API_ListJournalS3ExportsForLedger_ResponseSyntax) ** + 如果 `NextToken` 为空，则表示最后一页结果已处理完毕，没有其他结果。 + 如果`NextToken` *不* 为空，则表示有更多结果可用。若要检索下一页结果，请在后续 `ListJournalS3ExportsForLedger` 调用中使用`NextToken`值。类型：字符串长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 错误有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListJournalS3ExportsForLedger) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) # ListLedgers 返回与当前 AWS 账户和区域关联的所有分类账。此操作最多返回 `MaxResults` 个项目，并且会进行分页，以便您可以通过 `ListLedgers` 个多次调用来检索所有项目。 ## 请求语法 ``` GET /ledgers?max_results=MaxResults&next_token=NextToken HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [MaxResults](#API_ListLedgers_RequestSyntax) ** 在单个 `ListLedgers` 请求中要返回的最大结果数。（返回的实际结果数可能会更少。）有效范围：最小值为 1。最大值为 100。 ** [NextToken](#API_ListLedgers_RequestSyntax) ** 分页令牌表示您要检索下一页结果。如果您在上次 `ListLedgers` 调用的响应中收到了 `NextToken` 的值，则应使用该值作为此处的输入。长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 请求正文该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Ledgers": [ { "CreationDateTime": number, "Name": "string", "State": "string" } ], "NextToken": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Ledgers](#API_ListLedgers_ResponseSyntax) ** 与当前 AWS 账户和地区关联的分类账。类型：[LedgerSummary](API_LedgerSummary.md) 对象数组 ** [NextToken](#API_ListLedgers_ResponseSyntax) ** 分页标记，表示是否还有更多结果可用： + 如果 `NextToken` 为空，则表示最后一页结果已处理完毕，不需要检索其他结果。 + 如果`NextToken` *不* 为空，则表示有更多结果可用。若要检索下一页结果，请在后续 `ListLedgers` 调用中使用`NextToken`值。类型：字符串长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` ## 错误有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListLedgers) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListLedgers) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListLedgers) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListLedgers) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListLedgers) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListLedgers) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListLedgers) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListLedgers) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListLedgers) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListLedgers) # ListTagsForResource 为指定的 Amazon QLDB 资源返回所有标签。 ## 请求语法 ``` GET /tags/resourceArn HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** 要列出其标签的Amazon 资源名称（ARN）。例如： `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger` 长度约束：最小长度为 20。长度上限为 1600。必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** 当前与指定的 Amazon QLDB 资源关联的标签。类型：字符串到字符串映射映射条目：最低 0 项。最多 200 项。密钥长度限制：最小长度为 1。最大长度为 128。值长度限制：最小长度为 0。最大长度为 256。 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListTagsForResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListTagsForResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListTagsForResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListTagsForResource) # StreamJournalToKinesis 为给定的 Amazon QLDB 分类账创建日记账流。流捕获提交到分类账的日志的每个文档修订版本，并将数据传送到指定的 Amazon Kinesis Data Streams 资源。 ## 请求语法 ``` POST /ledgers/name/journal-kinesis-streams HTTP/1.1 Content-type: application/json { "ExclusiveEndTime": number, "InclusiveStartTime": number, "KinesisConfiguration": { "AggregationEnabled": boolean, "StreamArn": "string" }, "RoleArn": "string", "StreamName": "string", "Tags": { "string" : "string" } } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_StreamJournalToKinesis_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [ExclusiveEndTime](#API_StreamJournalToKinesis_RequestSyntax) ** 指定流结束时间的日期和时间（不内含）。如果不定义此参数，则流将无限期运行，直到您取消它。 `ExclusiveEndTime` 必须采用 `ISO 8601` 日期和时间格式以及通用协调时间（UTC）。例如：`2019-06-13T21:36:34Z`。类型：时间戳必需：否 ** [InclusiveStartTime](#API_StreamJournalToKinesis_RequestSyntax) ** 开始流式传输日记账数据的开始日期和时间（内含）。此参数必须采用 `ISO 8601` 日期和时间格式以及通用协调时间 (UTC)。例如：`2019-06-13T21:36:34Z`。 `InclusiveStartTime` 不能是未来时间，必须在 `ExclusiveEndTime` 之前。如果您提供的 `InclusiveStartTime` 是在分类账的 `CreationDateTime` 之前，则 QLDB 有效地将其默认视为分类账的 `CreationDateTime`。类型：时间戳必需：是 ** [KinesisConfiguration](#API_StreamJournalToKinesis_RequestSyntax) ** 流请求的 Kinesis 数据流目标的配置设置。类型：[KinesisConfiguration](API_KinesisConfiguration.md) 对象必需：是 ** [RoleArn](#API_StreamJournalToKinesis_RequestSyntax) ** IAM 角色的 Amazon 资源名称（ARN），该角色授予日记账流将数据记录写入 Kinesis 数据流资源的 QLDB 权限。要在请求日志流时将角色传递给 QLDB，您必须具有对 IAM 角色资源执行 `iam:PassRole` 操作的权限。这是所有日志流请求所必需的。类型：字符串长度约束：最小长度为 20。长度上限为 1600。必需：是 ** [StreamName](#API_StreamJournalToKinesis_RequestSyntax) ** 要分配给 QLDB 日记账流的名称。用户定义的名称有助于识别和指示流的用途。您的流名称在给定分类账的其他*活动的* 流中必须是唯一的。流名称与分类账名称具有相同的命名约束，如在《Amazon QLDB 开发人员指南》的 [Amazon QLDB 中的配额](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming)中所定义。类型：字符串长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ** [Tags](#API_StreamJournalToKinesis_RequestSyntax) ** 要作为标签添加到待创建的流中的键值对。标签键区分大小写。标签值区分大小写，可以为空值。类型：字符串到字符串映射映射条目：最低 0 项。最多 200 项。密钥长度限制：最小长度为 1。最大长度为 128。值长度限制：最小长度为 0。长度上限为 256。必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "StreamId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [StreamId](#API_StreamJournalToKinesis_ResponseSyntax) ** QLDB 分配到每个 QLDB 日记账流的 UUID（以 Base62 编码的文本表示）。类型：字符串长度限制：固定长度为 22。模式：`^[A-Za-z-0-9]+$` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ** ResourcePreconditionNotMetException ** 由于未提前满足条件，操作失败。 HTTP 状态代码：412 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/StreamJournalToKinesis) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/StreamJournalToKinesis) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/StreamJournalToKinesis) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/StreamJournalToKinesis) # TagResource 将一个或多个标签添加到指定的 Amazon QLDB 资源。资源最多可以包含 50 个标签。如果尝试为资源创建超过 50 个标签，则请求将失败并返回错误。 ## 请求语法 ``` POST /tags/resourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [resourceArn](#API_TagResource_RequestSyntax) ** 您希望为其添加标签的 Amazon 资源名称（ARN）。例如： `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger` 长度约束：最小长度为 20。长度上限为 1600。必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [Tags](#API_TagResource_RequestSyntax) ** 要添加为标签的键值对将以标签形式添加到指定 QLDB 资源。标签键区分大小写。如果为资源指定的密钥已经存在，则请求将失败并返回错误。标签值区分大小写，可以为空值。类型：字符串到字符串映射映射条目：最低 0 项。最多 200 项。密钥长度限制：最小长度为 1。最大长度为 128。值长度限制：最小长度为 0。最大长度为 256。必需：是 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/TagResource) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/TagResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/TagResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/TagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/TagResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/TagResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/TagResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/TagResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/TagResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/TagResource) # UntagResource 删除指定 Amazon QLDB 资源的一个或多个标签。您最多可指定 50 个要删除的标签键。 ## 请求语法 ``` DELETE /tags/resourceArn?tagKeys=TagKeys HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [resourceArn](#API_UntagResource_RequestSyntax) ** 要从中删除标签的 Amazon 资源名称（ARN）。例如： `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger` 长度约束：最小长度为 20。长度上限为 1600。必需：是 ** [TagKeys](#API_UntagResource_RequestSyntax) ** 要删除的标签键列表。数组成员：最少 0 个物品。最多 200 项。长度限制：长度下限为 1。最大长度为 128。必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` HTTP/1.1 200 ``` ## 响应元素如果此操作成功，则该服务会发送回带有空 HTTP 正文的 HTTP 200 响应。 ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UntagResource) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UntagResource) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UntagResource) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UntagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UntagResource) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UntagResource) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UntagResource) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UntagResource) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UntagResource) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UntagResource) # UpdateLedger 更新分类账上的属性。 ## 请求语法 ``` PATCH /ledgers/name HTTP/1.1 Content-type: application/json { "DeletionProtection": boolean, "KmsKey": "string" } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_UpdateLedger_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) ** 指定是否保护分类账不被任何用户删除。如果创建分类账期间未定义，则默认情况下启用该功能（`true`）。如果启用了删除保护，您必须先禁用它，然后才能删除分类账。您可以通过调用 `UpdateLedger` 操作将此参数设置为 `false` 来禁用该功能。类型：布尔值必需：否 ** [KmsKey](#API_UpdateLedger_RequestSyntax) ** AWS Key Management Service (AWS KMS) 中的密钥，用于加密账本中的静态数据。有关更多信息，请参阅《Amazon QLDB 开发人员指南》中的[静态加密](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html)。使用以下选项之一指定此参数： + `AWS_OWNED_KMS_KEY`：使用由您代表自己拥有和管理 AWS 的 AWS KMS 密钥。 + **未定义**：不对分类账的 KMS 密钥进行任何更改。 + **A valid symmetric customer managed KMS key**（有效的对称客户托管 KMS 密钥）：在您创建、拥有和管理的账户中使用指定的对称加密 KMS 密钥。 Amazon QLDB 不支持非对称密钥。有关更多信息，请参阅《* AWS Key Management Service 开发人员*指南》中的[使用对称和非对称密钥](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)。要指定客户托管的 KMS 密钥，您可以使用其密钥 ID、Amazon 资源名称（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)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)。类型：字符串长度限制：最大长度为 1600。必需：否 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationDateTime": number, "DeletionProtection": boolean, "EncryptionDescription": { "EncryptionStatus": "string", "InaccessibleKmsKeyDateTime": number, "KmsKeyArn": "string" }, "Name": "string", "State": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Arn](#API_UpdateLedger_ResponseSyntax) ** 分类账的 Amazon 资源名称（ARN）。类型：字符串长度约束：最小长度为 20。长度上限为 1600。 ** [CreationDateTime](#API_UpdateLedger_ResponseSyntax) ** 创建分类账时，日期和时间采用世界标准纪元时间格式）。（纪元时间格式为自 1970 年 1 月 1 日午夜 12:00:00 UTC 以来的秒数。）类型：时间戳 ** [DeletionProtection](#API_UpdateLedger_ResponseSyntax) ** 指定是否保护分类账不被任何用户删除。如果创建分类账期间未定义，则默认情况下启用该功能（`true`）。如果启用了删除保护，您必须先禁用它，然后才能删除分类账。您可以通过调用 `UpdateLedger` 操作将此参数设置为 `false` 来禁用该功能。类型：布尔值 ** [EncryptionDescription](#API_UpdateLedger_ResponseSyntax) ** 有关分类账中静态数据加密的信息。这包括当前状态、 AWS KMS 密钥以及何时无法访问密钥（如果出现错误）。类型：[LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) 对象 ** [Name](#API_UpdateLedger_ResponseSyntax) ** 分类账的名称。类型：字符串长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` ** [State](#API_UpdateLedger_ResponseSyntax) ** 分类账的当前状态。类型：字符串有效值：`CREATING | ACTIVE | DELETING | DELETED` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedger) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedger) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedger) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedger) # UpdateLedgerPermissionsMode 更新分类账的权限模式。 **重要** 在切换至 `STANDARD` 权限模式前，必须先创建所有必需的 IAM 策略和表标签，以避免对用户造成干扰。要了解更多信息，请参阅 *Amazon QLDB 开发人员指南*中的[迁移到标准权限模式](https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating)。 ## 请求语法 ``` PATCH /ledgers/name/permissions-mode HTTP/1.1 Content-type: application/json { "PermissionsMode": "string" } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_UpdateLedgerPermissionsMode_RequestSyntax) ** 分类账的名称。长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 必需：是 ## 请求体请求接受采用 JSON 格式的以下数据。 ** [PermissionsMode](#API_UpdateLedgerPermissionsMode_RequestSyntax) ** 为您的分类账分配权限的模式。此参数可能具有下列值之一： + `ALLOW_ALL`：一种旧式权限模式，支持对分类账进行 API 级别粒度的访问控制。此模式允许拥有此分类账的 `SendCommand` API 权限的用户在指定分类账中的任何表上运行所有 PartiQL 命令（因此，`ALLOW_ALL`）。此模式忽略您为分类账创建的任何表级或命令级 IAM 权限策略。 + `STANDARD`：（*推荐*）一种权限模式，可以对分类账、表格和 PartiQL 命令进行更精细粒度的访问控制。默认情况下，此模式拒绝所有用户请求在此分类账中的任何表上运行任何 PartiQL 命令。要允许 PartiQL 命令运行，除了分类账的 `SendCommand` API 权限外，您还必须为特定表资源和 PartiQL 操作创建 IAM 权限策略。有关信息，请参阅《Amazon QLDB 开发人员指南》中的[标准权限模式入门](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html)。我们强烈建议使用 `STANDARD` 权限模式来最大限度地提高分类账数据的安全性。类型：字符串有效值：`ALLOW_ALL | STANDARD` 必需：是 ## 响应语法 ``` HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Name": "string", "PermissionsMode": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [Arn](#API_UpdateLedgerPermissionsMode_ResponseSyntax) ** 分类账的 Amazon 资源名称（ARN）。类型：字符串长度约束：最小长度为 20。长度上限为 1600。 ** [Name](#API_UpdateLedgerPermissionsMode_ResponseSyntax) ** 分类账的名称。类型：字符串长度限制：长度下限为 1。最大长度为 32。模式：`(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` ** [PermissionsMode](#API_UpdateLedgerPermissionsMode_ResponseSyntax) ** 分类账的当前权限模式。类型：字符串有效值：`ALLOW_ALL | STANDARD` ## 错误有关所有操作返回的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** InvalidParameterException ** 请求中的一项或多项参数无效。 HTTP 状态代码：400 ** ResourceNotFoundException ** 指定的资源不存在。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedgerPermissionsMode) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) # Amazon QLDB 会话 **重要** 终止支持通知：现有客户将能够使用 Amazon QLDB，直到 2025 年 7 月 31 日终止支持。有关更多详细信息，请参阅[将亚马逊 QLDB 账本迁移到亚马逊 Aurora PostgreSQL](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/)。 Amazon QLDB 会话支持以下操作： + [SendCommand](API_QLDB-Session_SendCommand.md) # SendCommand 向 Amazon QLDB 分类账发送命令。 **注意** 我们建议使用 QLDB 驱动程序或 QLDB Shell 在分类账上运行数据事务，而不是直接与此 API 交互。如果您使用的是 AWS 软件开发工具包，请使用 QLDB 驱动程序。该驱动程序在 *QLDB 会话*数据 API 之上提供了一个高级抽象层，并为您管理`SendCommand`操作。有关信息和支持的编程语言列表，请参阅 *Amazon QLDB 开发者指南*中的[驱动程序入门](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html)。如果您正在使用 AWS Command Line Interface (AWS CLI)，请使用 QLDB 外壳。Shell 是一个命令行接口，它使用 QLDB 驱动程序与分类账进行交互。有关信息，请参阅[使用 QLDB Shell 访问 Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html)。 ## 请求语法 ``` { "AbortTransaction": { }, "CommitTransaction": { "CommitDigest": blob, "TransactionId": "string" }, "EndSession": { }, "ExecuteStatement": { "Parameters": [ { "IonBinary": blob, "IonText": "string" } ], "Statement": "string", "TransactionId": "string" }, "FetchPage": { "NextPageToken": "string", "TransactionId": "string" }, "SessionToken": "string", "StartSession": { "LedgerName": "string" }, "StartTransaction": { } } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AbortTransaction](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令中止当前事务。类型：[AbortTransactionRequest](API_QLDB-Session_AbortTransactionRequest.md) 对象必需：否 ** [CommitTransaction](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令提交指定的事务。类型：[CommitTransactionRequest](API_QLDB-Session_CommitTransactionRequest.md) 对象必需：否 ** [EndSession](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令结束当前会话。类型：[EndSessionRequest](API_QLDB-Session_EndSessionRequest.md) 对象必需：否 ** [ExecuteStatement](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令在指定事务中执行语句。类型：[ExecuteStatementRequest](API_QLDB-Session_ExecuteStatementRequest.md) 对象必需：否 ** [FetchPage](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令获取页面。类型：[FetchPageRequest](API_QLDB-Session_FetchPageRequest.md) 对象必需：否 ** [SessionToken](#API_QLDB-Session_SendCommand_RequestSyntax) ** 指定当前命令的会话令牌。会话令牌在会话的整个生命周期中都是恒定的。要获取会话令牌，请运行 `StartSession` 命令。这个 `SessionToken` 对于当前会话期间发出的每个后续命令都是必需的。类型：字符串长度限制：最小长度为 4。长度上限为 1024。模式：`^[A-Za-z-0-9+/=]+$` 必需：否 ** [StartSession](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令启动新会话。作为响应的一部分获得会话令牌。类型：[StartSessionRequest](API_QLDB-Session_StartSessionRequest.md) 对象必需：否 ** [StartTransaction](#API_QLDB-Session_SendCommand_RequestSyntax) ** 命令启动新事务。类型：[StartTransactionRequest](API_QLDB-Session_StartTransactionRequest.md) 对象必需：否 ## 响应语法 ``` { "AbortTransaction": { "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "CommitTransaction": { "CommitDigest": blob, "ConsumedIOs": { "ReadIOs": number, "WriteIOs": number }, "TimingInformation": { "ProcessingTimeMilliseconds": number }, "TransactionId": "string" }, "EndSession": { "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "ExecuteStatement": { "ConsumedIOs": { "ReadIOs": number, "WriteIOs": number }, "FirstPage": { "NextPageToken": "string", "Values": [ { "IonBinary": blob, "IonText": "string" } ] }, "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "FetchPage": { "ConsumedIOs": { "ReadIOs": number, "WriteIOs": number }, "Page": { "NextPageToken": "string", "Values": [ { "IonBinary": blob, "IonText": "string" } ] }, "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "StartSession": { "SessionToken": "string", "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "StartTransaction": { "TimingInformation": { "ProcessingTimeMilliseconds": number }, "TransactionId": "string" } } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 200 响应。服务以 JSON 格式返回以下数据。 ** [AbortTransaction](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含已中止事务的详细信息。类型：[AbortTransactionResult](API_QLDB-Session_AbortTransactionResult.md) 对象 ** [CommitTransaction](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含已提交事务的详细信息。类型：[CommitTransactionResult](API_QLDB-Session_CommitTransactionResult.md) 对象 ** [EndSession](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含已结束会话的详细信息。类型：[EndSessionResult](API_QLDB-Session_EndSessionResult.md) 对象 ** [ExecuteStatement](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含已执行语句的详细信息。类型：[ExecuteStatementResult](API_QLDB-Session_ExecuteStatementResult.md) 对象 ** [FetchPage](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含获取的页面的详细信息。类型：[FetchPageResult](API_QLDB-Session_FetchPageResult.md) 对象 ** [StartSession](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含已启动会话的详细信息，其中包括会话令牌。这个 `SessionToken` 对于当前会话期间发出的每个后续命令都是必需的。类型：[StartSessionResult](API_QLDB-Session_StartSessionResult.md) 对象 ** [StartTransaction](#API_QLDB-Session_SendCommand_ResponseSyntax) ** 包含已启动事务的详细信息。类型：[StartTransactionResult](API_QLDB-Session_StartTransactionResult.md) 对象 ## 错误有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。 ** BadRequestException ** 如果请求格式错误或包含错误（例如参数值无效或缺少必填参数），则返回。 HTTP 状态代码：400 ** CapacityExceededException ** 当请求超出分类账的处理能力时返回。 HTTP 状态代码：400 ** InvalidSessionException ** 如果会话因超时或过期而不再存在，则返回。 HTTP 状态代码：400 ** LimitExceededException ** 如果超过资源限制（例如活动会话数），则返回。 HTTP 状态代码：400 ** OccConflictException ** OccConflictException – 当由于*乐观并发控制*（OCC）的验证阶段失败而导致事务无法写入日记账时返回。 HTTP 状态代码：400 ** RateExceededException ** 请求速率超出允许吞吐量时返回。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 .NET 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/SendCommand) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-session-2019-07-11/SendCommand) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/qldb-session-2019-07-11/SendCommand) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/SendCommand)