描述 Amazon DocumentDB 集群参数组 - Amazon DocumentDB
描述集群参数组详情确定集群的参数组
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

描述 Amazon DocumentDB 集群参数组

当您在新区域创建第一个 Amazon DocumentDB 集群或使用新引擎时，default 集群参数组自动创建。在同一区域创建且具有相同引擎版本的后续集群将以 default 集群参数组创建。

描述 Amazon DocumentDB 集群参数组详情

要描述给定集群参数组的详情，请使用 Amazon Web Services Management Console 或 Amazon Command Line Interface (Amazon CLI) 完成以下步骤。

Using the Amazon Web Services Management Console

  1. 登录到 Amazon Web Services Management Console 并打开 Amazon DocumentDB 控制台，网址：https://console.aws.amazon.com/docdb。

  2. 在导航窗格中，选择参数组。

    提示

    如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 ()。

  3. 在集群参数组窗格中，选择要查看其详细信息的参数组的名称。

  4. 所得页面显示参数组的参数、最近活动和标签。

    • 在集群参数下，您可以看到该参数的名称、当前值、允许值、该参数是否可修改、其应用值、数据类型和描述。您可以修改各个参数，方法是：选择该参数，然后在集群参数部分，选择编辑。有关更多信息，请参阅修改 Amazon DocumentDB 集群参数。

    • 在近期事件下，您可以看到该参数组的最新事件。您可以使用本部分的搜索栏筛选这些事件。有关更多信息，请参阅管理 Amazon DocumentDB 事件。

    • 在 Tags (标签)下，您可以看到此集群参数组上的标签。您可以通过在标签部分选择编辑来添加或移除标签。有关更多信息，请参阅标记 Amazon DocumentDB 资源。

Using the Amazon CLI

您可以使用 describe-db-cluster-parameter-groupsAmazon CLI 命令来查看您对 Amazon DocumentDB 所拥有的单一集群参数组或所有集群参数组的Amazon 资源名称（ARN）、族、描述和名称。您还可以使用 describe-db-cluster-parameters Amazon CLI 命令来查看单一集群参数组中的参数及其详细信息。

  • --describe-db-cluster-parameter-groups — 查看所有集群参数组的列表及其详细信息。

    • --db-cluster-parameter-group-name — 可选。您想描述的集群参数组的名称。如果忽略此参数，则将描述所有集群参数组。

  • --describe-db-cluster-parameters — 列出参数组中的所有参数及其值。

    • --db-cluster-parameter-group name – 必需。您想描述的集群参数组的名称。

以下代码列出了最多 100 个集群参数组及其 ARN、族、描述和名称。

aws docdb describe-db-cluster-parameter-groups

此操作的输出将类似于下文（JSON 格式）。

{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:default.docdb4.0",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Default cluster parameter group for docdb4.0",
                  "DBClusterParameterGroupName": "default.docdb4.0"
              },
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:sample-parameter-group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}

以下代码列出了 sample-parameter-group 的 ARN、族、描述和名称。

对于 Linux、macOS 或 Unix：

aws docdb describe-db-cluster-parameter-groups \
          --db-cluster-parameter-group-name sample-parameter-group

对于 Windows：

aws docdb describe-db-cluster-parameter-groups ^
          --db-cluster-parameter-group-name sample-parameter-group

此操作的输出将类似于下文（JSON 格式）。

{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}

以下代码列出了 sample-parameter-group 中参数的值。

对于 Linux、macOS 或 Unix：


aws docdb describe-db-cluster-parameters \
    --db-cluster-parameter-group-name sample-parameter-group

对于 Windows：


aws docdb describe-db-cluster-parameters ^
    --db-cluster-parameter-group-name sample-parameter-group

此操作的输出将类似于下文（JSON 格式）。

{
   "Parameters": [
         {
            "ParameterName": "audit_logs",
            "ParameterValue": "disabled",
            "Description": "Enables auditing on cluster.",
            "Source": "system",
            "ApplyType": "dynamic",
            "DataType": "string",
            "AllowedValues": "enabled,disabled",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot"
         },
         {
            "ParameterName": "change_stream_log_retention_duration",
            "ParameterValue": "17777",
            "Description": "Duration of time in seconds that the change stream log is retained and can be consumed.",
            "Source": "user",
            "ApplyType": "dynamic",
            "DataType": "integer",
            "AllowedValues": "3600-86400",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot"
         }
   ]
}

确定 Amazon DocumentDB 集群的参数组

要确定哪个参数组与特定集群关联，请使用 Amazon Web Services Management Console 或 Amazon CLI 完成以下步骤。

Using the Amazon Web Services Management Console

  1. 登录到 Amazon Web Services Management Console 并打开 Amazon DocumentDB 控制台，网址：https://console.aws.amazon.com/docdb。

  2. 在左侧导航窗格中，选择集群。

  3. 从集群列表中，选择您感兴趣的集群的名称。

  4. 生成的页面将显示所选集群的详细信息。向下滚动到 Cluster details (集群详细信息)。在此部分的底部，在 Cluster parameter group (集群参数组) 的下方找到参数组的名称。

    屏幕截图：显示集群的参数组。
Using the Amazon CLI

以下 Amazon CLI 代码确定管理集群 sample-cluster 的参数组。

aws docdb describe-db-clusters \
      --db-cluster-identifier sample-cluster \
      --query 'DBClusters[*].[DBClusterIdentifier,DBClusterParameterGroup]'

此操作的输出将类似于下文（JSON 格式）。

[
       [
           "sample-cluster",
           "sample-parameter-group"
       ]
]