DescribeMongoDBLogConfig - - Centre de documentation Alibaba Cloud

Consulte la configuration du service de journalisation MongoDB.

Description de l'opération

Cette API s'applique aux instances à usage général et dédiées qui utilisent des disques locaux.

Vous pouvez activer la fonctionnalité de journal d'audit pour ApsaraDB for MongoDB selon vos besoins. Pour plus d'informations, consultez Activer les journaux d'audit.

Depuis le 6 janvier 2022, la version officielle de la fonctionnalité de journal d'audit est déployée dans toutes les régions. Les nouvelles demandes pour la version d'essai gratuite ne sont plus acceptées. Pour plus d'informations, consultez [Avis] ApsaraDB for MongoDB lance les journaux d'audit à la demande et met fin à l'essai gratuit.
La version officielle de la fonctionnalité de journal d'audit est facturée à la demande. Les frais sont basés sur l'utilisation du stockage et la période de rétention. Pour plus de détails sur les tarifs, consultez Tarification d'ApsaraDB for MongoDB.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

dds:DescribeMongoDBLogConfig

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Appelez DescribeDBInstances pour obtenir l'identifiant de l'instance.	dds-bp12c5b040dc****

Éléments de réponse

Élément	Type	Description	Exemple
	object	La configuration du journal d'audit.
UserProjectName	string	Le nom du projet Simple Log Service pour les journaux d'audit.	nosql-176498472570****-cn-hangzhou
RequestId	string	L'identifiant de la requête.	664ECE26-658A-47C5-88F6-870B0132E8D2
IsUserProjectLogstoreExist	integer	Indique si un projet Simple Log Service pour les journaux d'audit existe dans la région actuelle. Valeurs valides : 1 : Le projet existe. 0 ou null : Le projet n'existe pas.	1
IsEtlMetaExist	integer	Indique si une règle est créée pour transférer les journaux d'audit vers Logtail. Pour plus d'informations sur Logtail, consultez Qu'est-ce que Logtail ?. Valeurs valides : 1 : Une règle est créée. 0 ou null : Aucune règle n'est créée.	1
ServiceType	string	La version de la fonctionnalité de journal d'audit. Trial : Version d'essai gratuite. Standard : Version officielle. V2_Standard : Version DAS Enterprise Edition (compatible NoSQL).	Standard
EnableAudit	boolean	Indique si la fonctionnalité de journal d'audit est activée pour l'instance ApsaraDB for MongoDB. true : Activée. false : Désactivée.	true
TtlForTrail	integer	La période de rétention des journaux d'audit pour la version d'essai gratuite. Unité : jours.	1
UsedStorageForTrail	integer	La capacité de stockage utilisée par les journaux d'audit pour la version d'essai gratuite. Unité : octets.	12548178759
PreserveStorageForTrail	integer	La capacité de stockage maximale pour la version d'essai gratuite des journaux d'audit. Unité : octets. La valeur maximale est de 107374182400 octets.	107374182400
TtlForStandard	integer	La période de rétention des journaux d'audit pour la version officielle. La valeur est comprise entre 1 et 365. Unité : jours.	30
UsedStorageForStandard	integer	La capacité de stockage utilisée par les journaux d'audit pour la version officielle. Unité : octets.	20163
PreserveStorageForStandard	integer	La capacité de stockage maximale pour la version officielle des journaux d'audit. Une valeur de -1 indique qu'aucune limite supérieure n'est définie.	-1
HotTtlForV2Standard	integer	La période de rétention du stockage chaud pour la version V2_Standard (DAS Enterprise Edition (compatible NoSQL)) des journaux d'audit. Unité : jours.	7
TtlForV2Standard	integer	La période de rétention du stockage froid pour la version V2_Standard (DAS Enterprise Edition (compatible NoSQL)) des journaux d'audit. Unité : jours.	30

Exemples

JSON format

{
  "UserProjectName": "nosql-176498472570****-cn-hangzhou",
  "RequestId": "664ECE26-658A-47C5-88F6-870B0132E8D2",
  "IsUserProjectLogstoreExist": 1,
  "IsEtlMetaExist": 1,
  "ServiceType": "Standard",
  "EnableAudit": true,
  "TtlForTrail": 1,
  "UsedStorageForTrail": 12548178759,
  "PreserveStorageForTrail": 107374182400,
  "TtlForStandard": 30,
  "UsedStorageForStandard": 20163,
  "PreserveStorageForStandard": -1,
  "HotTtlForV2Standard": 7,
  "TtlForV2Standard": 30
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.