Décrire les clusters Amazon DocumentDB - Amazon DocumentDB

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Décrire les clusters Amazon DocumentDB

Vous pouvez utiliser la console de gestion Amazon DocumentDB ou le AWS CLI pour consulter des informations telles que les points de terminaison de connexion, les groupes de sécurité, les VPC et les groupes de paramètres relatifs à vos clusters Amazon DocumentDB.

Pour plus d’informations, consultez les ressources suivantes :

Using the AWS Management Console

Utilisez la procédure suivante pour afficher les détails d'un cluster Amazon DocumentDB spécifié à l'aide de la console.

  1. Connectez-vous à la AWS Management Console console Amazon DocumentDB et ouvrez-la à l'adresse https://console.aws.amazon.com/docdb.

  2. Dans le panneau de navigation, choisissez Clusters.

    Astuce

    Si vous ne voyez pas le volet de navigation sur le côté gauche de votre écran, choisissez l'icône de menu () dans le coin supérieur gauche de la page.

  3. Dans la liste des clusters, choisissez le nom du cluster dont vous voulez afficher les détails. Les informations sur le cluster sont organisées en six groupes :

    • Résumé : informations générales sur le cluster, notamment la version du moteur, l'état du cluster, la maintenance en attente et le statut de son groupe de paramètres.

    • Connectivité et sécurité : la section Connect répertorie les points de terminaison de connexion permettant de se connecter à ce cluster à l'aide du shell mongo ou d'une application. La section Security Groups (Groupes de sécurité) répertorie les groupes de sécurité associés à ce cluster ainsi que leur ID de VPC et leurs descriptions.

    • Configuration : la section Détails du cluster répertorie les informations relatives au cluster, notamment le nom de ressource Amazon (ARN), le point de terminaison et le groupe de paramètres du cluster. Elle répertorie également les informations de sauvegarde du cluster, les détails de maintenance ainsi que les paramètres de sécurité et de réseau. La section Cluster instances (Instances de cluster) répertorie toutes les instances appartenant à votre cluster avec l'état du rôle et du groupe de paramètres de cluster de chaque instance.

    • Surveillance — Les métriques Amazon CloudWatch Logs pour ce cluster. Pour plus d’informations, consultez Surveillance d'Amazon DocumentDB avec CloudWatch.

    • Événements et tags — La section Événements récents répertorie les événements récents pour ce cluster. Amazon DocumentDB conserve un enregistrement des événements liés à vos clusters, instances, instantanés, groupes de sécurité et groupes de paramètres de cluster. Ces informations comprennent la date, l'heure et le message associés à chaque événement. La section Tags (Balises) répertorie les balises attachées à ce cluster.

Using the AWS CLI

Pour afficher les détails de vos clusters Amazon DocumentDB à l'aide de AWS CLI, utilisez la describe-db-clusters commande comme indiqué dans les exemples ci-dessous. Pour plus d'informations, consultez le document DescribeDBClustersde référence de l'API de gestion des ressources Amazon DocumentDB.

Note

Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS. Le paramètre de filterName=engine,Values=docdb filtre renvoie uniquement les clusters Amazon DocumentDB.

Exemple 1 : répertorier tous les clusters Amazon DocumentDB

Le AWS CLI code suivant répertorie les détails de tous les clusters Amazon DocumentDB d'une région.

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

Le résultat de cette opération ressemble à ceci.

{ "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", ... } ] }

Exemple 2 : répertorier tous les détails d'un cluster Amazon DocumentDB spécifié

Le AWS CLI code suivant répertorie les détails du clustersample-cluster.

Pour Linux, macOS ou Unix :

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

Pour Windows :

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

Le résultat de cette opération ressemble à ceci.

{ "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" } ] }

Exemple 3 : Répertorier les informations spécifiques d'un cluster Amazon DocumentDB

Pour répertorier un sous-ensemble des détails des clusters à l'aide du AWS CLI, ajoutez un qui spécifie les membres du cluster --query que l'describe-db-clustersopération doit répertorier. Le paramètre --db-cluster-identifier est l'identifiant du cluster particulier dont vous souhaitez afficher les détails. Pour plus d'informations sur les requêtes, voir Comment filtrer la sortie avec l'--queryoption dans le guide de AWS Command Line Interface l'utilisateur.

L'exemple suivant répertorie les instances d'un cluster Amazon DocumentDB.

Pour Linux, macOS ou Unix :

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

Pour Windows :

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

Le résultat de cette opération ressemble à ceci.

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