描述 Amazon DocumentDB集群

您可以使用 Amazon DocumentDB 管理控制台或 AWS CLI 查看详细信息，例如与 Amazon DocumentDB 集群相关的连接终端节点、安全组、VPC 和参数组。

有关更多信息，请参阅下列内容：

使用 AWS 管理控制台

通过以下过程使用控制台查看指定 Amazon DocumentDB集群的详细信息。

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

  2. 在导航窗格中，选择 Clusters.

    提示

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

  3. 在集群列表中，选择要查看其详细信息的集群的名称。有关集群的信息分为以下几组：

    • Summary (摘要) — 有关集群的一般信息，包括引擎版本、集群状态、待定维护及其参数组的状态。

    • Connectivity & Security (连接和安全) —Connect (连接) 部分列出要使用 mongo shell 或应用程序连接到该集群的连接终端节点。Security Groups （安全组） 部分列出与此集群关联的安全组及其 VPC ID 和描述。

    • Configuration (配置) — Cluster details (集群详细信息) 部分列出有关集群的详细信息，包括集群的 Amazon 资源名称 (ARN)、终端节点和参数组。其中还列出集群的备份信息、维护详细信息以及安全和网络设置。Cluster instances （集群实例） 部分列出属于此集群的实例，其中包括每个实例的角色和集群参数组状态。

    • Monitoring (监控) — 该集群的 Amazon CloudWatch Logs 指标。有关更多信息，请参阅 使用 Amazon DocumentDB 监控 CloudWatch.

    • Events & tags (事件和标签) —Recent events (最近事件) 部分列出此集群的最近事件。Amazon DocumentDB 保留与集群、实例、快照、安全组和集群参数组相关的事件记录。此信息包括与每个事件关联的日期、时间和消息。Tags （标签） 部分列出附加到此集群的标签。

使用 AWS CLI

要使用 Amazon DocumentDB 查看 AWS CLI 集群的详细信息，请使用 describe-db-clusters 命令，如以下示例所示。有关更多信息，请参阅 资源管理 API 参考DescribeDBClusters 中的 。Amazon DocumentDB

注意

对于某些管理功能（如集群和实例周期管理），Amazon DocumentDB 利用与 Amazon RDS. 共享的操作技术。filterName=engine,Values=docdb 筛选器参数仅返回 Amazon DocumentDB 集群。

示例 1：列出所有 Amazon DocumentDB 集群

以下 AWS CLI 代码列出区域中所有 Amazon DocumentDB 集群的详细信息。

  1. aws docdb describe-db-clusters --filter Name=engine,Values=docdb

此操作的输出将类似于下文。

  1. {
  2.     "DBClusters": [
  3.         {
  4.             "AvailabilityZones": [
  5.                 "us-east-1c",
  6.                 "us-east-1b",
  7.                 "us-east-1a"
  8.             ],
  9.             "BackupRetentionPeriod": 1,
  10.             "DBClusterIdentifier": "sample-cluster-1",
  11.             "DBClusterParameterGroup": "sample-parameter-group",
  12.             "DBSubnetGroup": "default",
  13.             "Status": "available",
  14.             ...
  15.         },
  16.         {
  17.             "AvailabilityZones": [
  18.                 "us-east-1c",
  19.                 "us-east-1b",
  20.                 "us-east-1a"
  21.             ],
  22.             "BackupRetentionPeriod": 1,
  23.             "DBClusterIdentifier": "sample-cluster-2",
  24.             "DBClusterParameterGroup": "sample-parameter-group",
  25.             "DBSubnetGroup": "default",
  26.             "Status": "available",
  27.             ...
  28.         },
  29.         {
  30.             "AvailabilityZones": [
  31.                 "us-east-1c",
  32.                 "us-east-1b",
  33.                 "us-east-1a"
  34.             ],
  35.             "BackupRetentionPeriod": 1,
  36.             "DBClusterIdentifier": "sample-cluster-3",
  37.             "DBClusterParameterGroup": "sample-parameter-group",
  38.             "DBSubnetGroup": "default",
  39.             "Status": "available",
  40.             ...
  41.         }
  42.     ]
  43. }

示例 2：列出指定 Amazon DocumentDB 集群的所有详细信息

以下 AWS CLI 代码列出集群 sample-cluster. 的详细信息。

对于 Linux、macOS 或 Unix:

  1. aws docdb describe-db-clusters \
  2.    --filter Name=engine,Values=docdb \
  3.    --db-cluster-identifier sample-cluster

对于 Windows:

  1. aws docdb describe-db-clusters ^
  2.    --filter Name=engine,Values=docdb ^
  3.    --db-cluster-identifier sample-cluster

此操作的输出将类似于下文。

  1. {
  2.     "DBClusters": [
  3.         {
  4.             "AvailabilityZones": [
  5.                 "us-east-1c",
  6.                 "us-east-1b",
  7.                 "us-east-1a"
  8.             ],
  9.             "BackupRetentionPeriod": 1,
  10.             "DBClusterIdentifier": "sample-cluster",
  11.             "DBClusterParameterGroup": "sample-parameter-group",
  12.             "DBSubnetGroup": "default",
  13.             "Status": "available",
  14.             "EarliestRestorableTime": "2020-03-09T00:04:26.844Z",
  15.             "Endpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
  16.             "ReaderEndpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
  17.             "MultiAZ": false,
  18.             "Engine": "docdb",
  19.             "EngineVersion": "4.0.0",
  20.             "LatestRestorableTime": "2020-03-10T20:38:17.456Z",
  21.             "Port": 27017,
  22.             "MasterUsername": "<user-name>",
  23.             "PreferredBackupWindow": "00:00-00:30",
  24.             "PreferredMaintenanceWindow": "tue:09:50-tue:10:20",
  25.             "DBClusterMembers": [
  26.                 {
  27.                     "DBInstanceIdentifier": "sample-instance-1",
  28.                     "IsClusterWriter": true,
  29.                     "DBClusterParameterGroupStatus": "in-sync",
  30.                     "PromotionTier": 1
  31.                 },
  32.                 {
  33.                     "DBInstanceIdentifier": "sample-instance-2",
  34.                     "IsClusterWriter": false,
  35.                     "DBClusterParameterGroupStatus": "in-sync",
  36.                     "PromotionTier": 1
  37.                 },
  38.             ],
  39.             "VpcSecurityGroups": [
  40.                 {                             
  41.                     "VpcSecurityGroupId": "sg-abcd0123",
  42.                     "Status": "active"
  43.                 }
  44.             ],
  45.             "HostedZoneId": "ABCDEFGHIJKLMN",
  46.             "StorageEncrypted": true,
  47.             "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  48.             "DbClusterResourceId": "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
  49.             "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
  50.             "AssociatedRoles": [],
  51.             "ClusterCreateTime": "2020-01-10T22:13:38.261Z",
  52.             "EnabledCloudwatchLogsExports": [
  53.                 "profiler"
  54.             ],
  55.             "DeletionProtection": true
  56.         }
  57.     ]
  58. }
  59.

示例 3：列出 Amazon DocumentDB 集群的特定详细信息

要使用 AWS CLI 列出集群的部分详细信息，请添加 --query，以指定 describe-db-clusters 操作要列出哪个集群成员。--db-cluster-identifier 参数是要显示其详细信息的特定集群的标识符。有关查询的更多信息，请参阅 中的--query如何使用 选项筛选输出。AWS Command Line Interface 用户指南

以下示例列出 Amazon DocumentDB 集群中的实例。

对于 Linux、macOS 或 Unix:

  1. aws docdb describe-db-clusters \
  2.     --filter Name=engine,Values=docdb \
  3.     --db-cluster-identifier sample-cluster \
  4.     --query 'DBClusters[*].[DBClusterMembers]'

对于 Windows:

  1. aws docdb describe-db-clusters ^
  2.     --filter Name=engine,Values=docdb ^
  3.     --db-cluster-identifier sample-cluster ^
  4.     --query 'DBClusters[*].[DBClusterMembers]'

此操作的输出将类似于下文。

  1. [
  2.     [
  3.         [
  4.             {
  5.                 "DBInstanceIdentifier": "sample-instance-1",
  6.                 "IsClusterWriter": true,
  7.                 "DBClusterParameterGroupStatus": "in-sync",
  8.                 "PromotionTier": 1
  9.             },
  10.             {
  11.                 "DBInstanceIdentifier": "sample-instance-2",
  12.                 "IsClusterWriter": false,
  13.                 "DBClusterParameterGroupStatus": "in-sync",
  14.                 "PromotionTier": 1
  15.             }
  16.         ]
  17.     ]
  18. ]
  19.