

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

# 描述 Amazon DocumentDB 叢集
<a name="db-cluster-view-details"></a>

您可以使用 Amazon DocumentDB 管理主控台或 AWS CLI 查看連線端點、安全群組、VPCs 和與 Amazon DocumentDB 叢集相關的參數群組等詳細資訊。

如需詳細資訊，請參閱下列內容：
+ [監控 Amazon DocumentDB 叢集的狀態](monitoring_docdb-cluster_status.md)
+ [尋找叢集的端點](db-cluster-endpoints-find.md)

------
#### [ Using the AWS 管理主控台 ]

使用下列程序，使用主控台檢視指定 Amazon DocumentDB 叢集的詳細資訊。

1. 登入 AWS 管理主控台，並在 https：//[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb) 開啟 Amazon DocumentDB 主控台。

1. 在導覽窗格中，選擇**叢集**。
**提示**  
如果畫面左側沒有出現導覽窗格，請選擇頁面左上角的功能表圖示 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/zh_tw/documentdb/latest/developerguide/images/docdb-menu-icon.png))。

1. 在叢集清單中，選擇想要檢視詳細資訊的叢集名稱。叢集的相關資訊分為下列群組：
   + **摘要** — 有關叢集的一般資訊，包括引擎版本、叢集狀態、待定維護及其參數群組的狀態。
   + **連線與安全性** — **Connect** 區段列出要使用 mongo shell 或 應用程式連線到此叢集的連線端點。**Seucirty Groups (安全群組)** 區段會列出與此叢集相關聯的安全群組，以及其 VPC ID 和描述。
   + **組態** — **叢集詳細資訊**區段會列出叢集的詳細資訊，包括叢集的 Amazon Resource Name (ARN)、端點和參數群組。它也會列出叢集的備份資訊、維護詳細資訊，以及安全性和網路設定。**Cluster instances (叢集執行個體)** 區段會列出屬於您此叢集的執行個體，當中每個執行個體的角色和叢集參數群組狀態。
   + **監控** — 此叢集的 Amazon CloudWatch Logs 指標。如需詳細資訊，請參閱[使用 CloudWatch 監控 Amazon DocumentDB](cloud_watch.md)。
   + **事件和標籤** — **最近事件**區段列出此叢集的最近事件。Amazon DocumentDB 會保留與叢集、執行個體、快照、安全群組和叢集參數群組相關的事件記錄。此資訊包括與每個事件相關聯的日期、時間和訊息。**Tags (標籤)** 區段會列出連接至此叢集的標籤。

------
#### [ Using the AWS CLI ]

若要使用 檢視 Amazon DocumentDB 叢集的詳細資訊 AWS CLI，請使用 `describe-db-clusters`命令，如以下範例所示。如需詳細資訊，請參閱《*Amazon DocumentDB Resource Management API 參考*[https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusters.html)》中的 。

**注意**  
對於特定管理功能，例如叢集和執行個體生命週期管理，Amazon DocumentDB 會利用與 Amazon RDS 共用的操作技術。`filterName=engine,Values=docdb` 篩選條件參數只會傳回 Amazon DocumentDB 叢集。

**Example**  
**範例 1：列出所有 Amazon DocumentDB 叢集 **  
下列 AWS CLI 程式碼列出區域中所有 Amazon DocumentDB 叢集的詳細資訊。  

```
aws docdb describe-db-clusters --filter Name=engine,Values=docdb
```
此操作的輸出將會如下所示。  

```
{
    "DBClusters": [
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-1",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        },
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-2",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        },
        {
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1b",
                "us-east-1a"
            ],
            "BackupRetentionPeriod": 1,
            "DBClusterIdentifier": "sample-cluster-3",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            ...
        }
    ]
}
```

**Example**  
**範例 2：列出指定 Amazon DocumentDB 叢集的所有詳細資訊**  
下列 AWS CLI 程式碼列出叢集 的詳細資訊`sample-cluster`。  
針對 Linux、macOS 或 Unix：  

```
aws docdb describe-db-clusters \
   --filter Name=engine,Values=docdb \
   --db-cluster-identifier sample-cluster
```
針對 Windows：  

```
aws docdb describe-db-clusters ^
   --filter Name=engine,Values=docdb ^
   --db-cluster-identifier sample-cluster
```
此操作的輸出將會如下所示。  

```
{
    "DBClusters": [
        {
            "AllocatedStorage": 1,
            "AvailabilityZones": [
                "us-east-1c",
                "us-east-1a",
                "us-east-1d"
            ],
            "BackupRetentionPeriod": 2,
            "DBClusterIdentifier": "sample-cluster",
            "DBClusterParameterGroup": "sample-parameter-group",
            "DBSubnetGroup": "default",
            "Status": "available",
            "EarliestRestorableTime": "2023-11-07T22:34:08.148000+00:00",
            "Endpoint": "sample-cluster.node.us-east-1.amazon.com",
            "ReaderEndpoint": "sample-cluster.node.us-east-1.amazon.com",
            "MultiAZ": false,
            "Engine": "docdb",
            "EngineVersion": "5.0.0",
            "LatestRestorableTime": "2023-11-10T07:21:16.772000+00:00",
            "Port": 27017,
            "MasterUsername": "chimeraAdmin",
            "PreferredBackupWindow": "22:22-22:52",
            "PreferredMaintenanceWindow": "sun:03:01-sun:03:31",
            "ReadReplicaIdentifiers": [],
            "DBClusterMembers": [
                {
                    "DBInstanceIdentifier": "sample-instance-1",
                    "IsClusterWriter": true,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                {
                    "DBInstanceIdentifier": "sample-instance-2",
                    "IsClusterWriter": true,
                    "DBClusterParameterGroupStatus": "in-sync",
                    "PromotionTier": 1
                },
                
            ],
            "VpcSecurityGroups": [
                {
                    "VpcSecurityGroupId": "sg-9084c2ec",
                    "Status": "active"
                }
            ],
            "HostedZoneId": "Z06853723JYKYBXTJ49RB",
            "StorageEncrypted": false,
            "DbClusterResourceId": "cluster-T4LGLANHVAPGQYYULWUDKLVQL4",
            "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
            "AssociatedRoles": [],
            "IAMDatabaseAuthenticationEnabled": false,
            "ClusterCreateTime": "2023-11-06T18:05:41.568000+00:00",
            "EngineMode": "provisioned",
            "DeletionProtection": false,
            "HttpEndpointEnabled": false,
            "CopyTagsToSnapshot": false,
            "CrossAccountClone": false,
            "DomainMemberships": [],
            "TagList": [],
            "StorageType": "iopt1",
            "AutoMinorVersionUpgrade": false,
            "NetworkType": "IPV4",
            "IOOptimizedNextAllowedModificationTime": "2023-12-07T18:05:41.580000+00:00"
        }
    ]
}
```

**Example**  
**範例 3：列出 Amazon DocumentDB 叢集的特定詳細資訊**  
若要使用 列出叢集詳細資訊的子集 AWS CLI，請新增 `--query`，指定要列出`describe-db-clusters`操作的叢集成員。`--db-cluster-identifier` 參數是您想要顯示詳細資訊之特定叢集的識別碼。如需查詢的詳細資訊，請參閱*AWS Command Line Interface 《 使用者指南*》中的[如何使用 `--query`選項篩選輸出](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-output.html#controlling-output-filter)。  
下列範例列出 Amazon DocumentDB 叢集中的執行個體。  
針對 Linux、macOS 或 Unix：  

```
aws docdb describe-db-clusters \
    --filter Name=engine,Values=docdb \
    --db-cluster-identifier sample-cluster \
    --query 'DBClusters[*].[DBClusterMembers]'
```
針對 Windows：  

```
aws docdb describe-db-clusters ^
    --filter Name=engine,Values=docdb ^
    --db-cluster-identifier sample-cluster ^
    --query 'DBClusters[*].[DBClusterMembers]'
```
此操作的輸出將會如下所示。  

```
[
    [
        [
            {
                "DBInstanceIdentifier": "sample-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            },
            {
                "DBInstanceIdentifier": "sample-instance-2",
                "IsClusterWriter": false,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ]
    ]
]
```

------