本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 描述 Amazon DocumentDB 叢集參數群組
當您在新區域中建立第一個 Amazon DocumentDB 叢集或使用新引擎時，系統會自動建立`default`叢集參數群組。在相同區域中建立且具有相同引擎版本的後續叢集會使用`default`叢集參數群組建立。
**Topics**
+ [描述叢集參數群組的詳細資訊](#cluster_parameter_groups-describe_details)
+ [判斷叢集的參數群組](#cluster_parameter_groups-determine)
+ [判斷與叢集參數群組相關聯的叢集和執行個體](#cluster_parameter_groups-count)
## 描述 Amazon DocumentDB 叢集參數群組的詳細資訊
若要描述指定叢集參數群組的詳細資訊，請使用 AWS 管理主控台 或 AWS Command Line Interface () 完成下列步驟AWS CLI。
------
#### [ Using the AWS 管理主控台 ]
****
1. 登入 AWS 管理主控台，並在 https：//[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) 開啟 Amazon DocumentDB 主控台。
1. 在導覽窗格中，選擇 **Parameter groups** (參數群組)。
**提示**
如果畫面左側沒有出現導覽窗格，請選擇頁面左上角的功能表圖示 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/zh_tw/documentdb/latest/developerguide/images/docdb-menu-icon.png))。
1. 在 **Cluster parameter groups (叢集參數群組)** 窗格中，選取您想要查看詳細資訊的參數群組名稱。
1. 產生的頁面會顯示參數群組的參數、最近的活動和標籤。
+ 在 **Cluster parameters (叢集參數)** 下，您可以看到參數名稱、目前值、允許值、參數是否可修改、套用類型、資料類型和說明。您可以選取 參數，然後在叢集參數區段中選擇**編輯**，以修改個別參數。 ****如需詳細資訊，請參閱[修改 Amazon DocumentDB 叢集參數](cluster_parameter_groups-parameters.md)。
+ 在 **Recent events (最近的事件)** 中，您可以查看此參數群組的最近事件。您可以使用本節中的搜尋列來篩選這些事件。如需詳細資訊，請參閱[管理 Amazon DocumentDB 事件](managing-events.md)。
+ 在 **Tags (標籤)**，您可以查看在此叢集參數群組上的標籤。您可以在標籤區段中選擇**編輯**來新增或移除**標籤**。如需詳細資訊，請參閱[標記 Amazon DocumentDB 資源](tagging.md)。
------
#### [ Using the AWS CLI ]
您可以使用 `describe-db-cluster-parameter-groups` AWS CLI 命令來檢視 Amazon DocumentDB 的單一叢集參數群組或所有叢集參數群組的 Amazon Resource Name (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** – 必要。您想要說明的叢集參數群組名稱。
**Example**
以下程式碼列出高達 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"
}
]
}
```
**Example**
以下程式碼列出 `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"
}
]
}
```
**Example**
以下程式碼列出 `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 叢集的參數群組
若要判斷哪些參數群組與特定叢集相關聯，請使用 AWS 管理主控台 或 完成下列步驟 AWS CLI。
------
#### [ Using the AWS 管理主控台 ]
1. 登入 AWS 管理主控台，並在 https：//[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) 開啟 Amazon DocumentDB 主控台。
1. 在左側導覽窗格中選擇**叢集**。
1. 在叢集的清單中，選取您有興趣之叢集的名稱。
1. 產生的頁面會顯示您所選取叢集的詳細資訊。向下捲動至 **Cluster details (叢集詳細資訊)**。在該區段底部的 **Cluster parameter group (叢集參數群組)** 下找到參數群組的名稱。
![\[螢幕擷取畫面：顯示叢集的參數群組。\]](http://docs.aws.amazon.com/zh_tw/documentdb/latest/developerguide/images/docdb-determine-parameter-group.png)
------
#### [ Using the AWS CLI ]
下列 AWS CLI 程式碼會決定管理叢集 的參數群組`sample-cluster`。
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,DBClusterParameterGroup]'
```
此操作的輸出將會如下所示 (JSON 格式)。
```
[
[
"sample-cluster",
"sample-parameter-group"
]
]
```
------
## 判斷與 Amazon DocumentDB 叢集參數群組相關聯的叢集和執行個體
若要判斷有多少叢集和執行個體與每個參數群組相關聯，請使用 完成以下步驟 AWS CLI。
------
#### [ Using the AWS CLI ]
下列 AWS CLI 程式碼會決定有多少叢集和執行個體與 相關聯`sample-parameter-group`。
針對 Linux、macOS 或 Unix：
```
aws docdb describe-db-clusters \
--query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' \
--output json | \
jq -r 'group_by(.[0]) | map({
parameter_group_name: .[0][0],
total_clusters: length,
total_instances: map(.[2] | length) | add // 0
}) | .[]'
```
針對 Windows：
```
aws docdb describe-db-clusters ^
--query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' ^
--output json | ^
jq -r 'group_by(.[0]) | map({
parameter_group_name: .[0][0],
total_clusters: length,
total_instances: map(.[2] | length) | add // 0
}) | .[]'
```
此操作的輸出將會如下所示 (JSON 格式)。
```
{
"parameter_group_name": "sample-parameter-group",
"total_clusters": 50,
"total_instances": 150
}
```
------