描述 Amazon DocumentDB 集群参数组

在创建 Amazon DocumentDB 集群时，将自动为该集群创建 default.docdb4.0 集群参数组。您可以查看此默认集群参数组或您拥有的任何其他集群参数组的详细信息。您还可以确定与特定集群关联的参数组。

描述 Amazon DocumentDB 集群参数组的详细信息

要描述给定集群参数组的详细信息，请使用 AWS 管理控制台或 AWS Command Line Interface （AWS CLI） 完成以下步骤。

  1. 通过以下网址登录 AWS 管理控制台并打开 Amazon DocumentDB 控制台：https://console.aws.amazon.com/docdb。

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

    提示

    如果您在屏幕左侧没有看到导航窗格，请在页面左上角选择菜单图标 (描述集群参数组 - 图1)。

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

  4. 生成的页面将显示参数组的参数、近期活动和标签。

    • 在 Cluster parameters （集群参数） 下，您可以查看参数的名称、当前值、允许值、参数是否可修改、其应用类型、数据类型和描述。您可以通过选择参数，然后选择 Cluster parameters （集群参数） 部分中的 Edit （编辑） 来修改各个参数。有关更多信息，请参阅修改 Amazon DocumentDB 集群参数。

    • 在 Recent events （近期事件） 下，您可以查看此参数组的最新事件。您可以使用本节中的搜索栏筛选这些事件。有关更多信息，请参阅管理 Amazon DocumentDB 事件。

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

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

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

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

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

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

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

  1. aws docdb describe-db-cluster-parameter-groups

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

  1. {
  2.           "DBClusterParameterGroups": [
  3.               {
  4.                   "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:default.docdb4.0",
  5.                   "DBParameterGroupFamily": "docdb4.0",
  6.                   "Description": "Default cluster parameter group for docdb4.0",
  7.                   "DBClusterParameterGroupName": "default.docdb4.0"
  8.               },
  9.               {
  10.                   "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:sample-parameter-group",
  11.                   "DBParameterGroupFamily": "docdb4.0",
  12.                   "Description": "Custom docdb4.0 parameter group",
  13.                   "DBClusterParameterGroupName": "sample-parameter-group"
  14.               }
  15.           ]
  16. }

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

对于 Linux、macOS 或 Unix:

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

对于 Windows:

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

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

  1. {
  2.           "DBClusterParameterGroups": [
  3.               {
  4.                   "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group",
  5.                   "Description": "Custom docdb4.0 parameter group",
  6.                   "DBParameterGroupFamily": "docdb4.0",
  7.                   "DBClusterParameterGroupName": "sample-parameter-group"
  8.               }
  9.           ]
  10. }

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

对于 Linux、macOS 或 Unix:

  2. aws docdb describe-db-cluster-parameters \
  3.     --db-cluster-parameter-group-name sample-parameter-group
  4.

对于 Windows:

  2. aws docdb describe-db-cluster-parameters ^
  3.     --db-cluster-parameter-group-name sample-parameter-group
  4.

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

  1. {
  2.    "Parameters": [
  3.          {
  4.             "ParameterName": "audit_logs",
  5.             "ParameterValue": "disabled",
  6.             "Description": "Enables auditing on cluster.",
  7.             "Source": "system",
  8.             "ApplyType": "dynamic",
  9.             "DataType": "string",
  10.             "AllowedValues": "enabled,disabled",
  11.             "IsModifiable": true,
  12.             "ApplyMethod": "pending-reboot"
  13.          },
  14.          {
  15.             "ParameterName": "change_stream_log_retention_duration",
  16.             "ParameterValue": "17777",
  17.             "Description": "Duration of time in seconds that the change stream log is retained and can be consumed.",
  18.             "Source": "user",
  19.             "ApplyType": "dynamic",
  20.             "DataType": "integer",
  21.             "AllowedValues": "3600-86400",
  22.             "IsModifiable": true,
  23.             "ApplyMethod": "pending-reboot"
  24.          }
  25.    ]
  26. }

确定 Amazon DocumentDB 集群的参数组

要确定与特定集群关联的参数组，请使用 AWS 管理控制台或 AWS CLI 完成以下步骤。

  1. 通过以下网址登录 AWS 管理控制台并打开 Amazon DocumentDB 控制台：https://console.aws.amazon.com/docdb。

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

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

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

    ![

    1.                        屏幕截图：显示集群的参数组。
    2.                     ](/projects/DocumentDB-20201111-zh/99026e5a0e5b17146450ae334e57bd77.png)

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

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

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

  1. [
  2.        [
  3.            "sample-cluster",
  4.            "sample-parameter-group"
  5.        ]
  6. ]