DescribeAuditRecords - - Centre de documentation Alibaba Cloud

Consulte les entrées du journal d'audit d'une instance MongoDB.

Description de l'opération

Lorsque vous appelez cette opération, assurez-vous que la fonctionnalité de journal d'audit de l'instance est activée. Sinon, l'opération renvoie un journal d'audit vide.
Cette opération s'applique uniquement aux instances à disque local à usage général et à disque local dédié.
Vous pouvez appeler cette opération jusqu'à 30 fois par minute. Pour appeler cette opération à une fréquence plus élevée, utilisez un Logstore. Pour plus d'informations, consultez Gérer un Logstore.

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:DescribeAuditRecords

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. Remarque Si vous définissez ce paramètre sur l'identifiant d'une instance de cluster fragmenté, vous devez également spécifier le paramètre NodeId.	dds-bp12c5b040dc****
NodeId	string	Non	L'identifiant d'un nœud Mongos ou d'un nœud de fragment dans l'instance de cluster fragmenté. Remarque Ce paramètre n'est disponible que lorsque DBInstanceId est défini sur l'identifiant d'une instance de cluster fragmenté.	d-bp128a003436****
StartTime	string	Oui	Le début de la plage horaire à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC.	2019-03-13T12:11:14Z
EndTime	string	Oui	La fin de la plage horaire à interroger. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Remarque La plage horaire entre l'heure de début et l'heure de fin ne peut pas dépasser 24 heures. Sinon, l'opération échoue.	2019-03-13T13:11:14Z
Database	string	Non	Le nom de la base de données. Par défaut, toutes les bases de données sont interrogées.	database****
User	string	Non	Le compte de la base de données. Par défaut, tous les comptes sont interrogés.	test
Form	string	Non	Le format des enregistrements d'audit renvoyés. Valeurs valides : File : déclenche la génération d'un fichier de journal d'audit. Si vous définissez ce paramètre sur File, seuls les paramètres communs sont renvoyés. Stream (par défaut) : renvoie un flux de données. Remarque Le paramètre File est obsolète.	Stream
QueryKeywords	string	Non	Les mots-clés pour la requête. Vous pouvez spécifier jusqu'à 10 mots-clés. Séparez les mots-clés multiples par des espaces.	slow
LogicalOperator	string	Non	L'opérateur logique pour la recherche par mots-clés. La valeur par défaut est and.	and
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 30 (par défaut), 50 et 100.	30
PageNumber	integer	Non	Le numéro de page à renvoyer. La valeur doit être supérieure à 0 et ne doit pas dépasser la valeur maximale du type de données entier. Valeur par défaut : 1.	1
OrderType	string	Non	L'ordre dans lequel trier les entrées du journal d'audit renvoyées par heure. Valeurs valides : asc : trie les entrées par ordre croissant. desc : trie les entrées par ordre décroissant.	asc

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalRecordCount	integer	Le nombre total d'entrées.	40
PageRecordCount	integer	Le nombre d'entrées sur la page actuelle.	30
RequestId	string	L'identifiant de la requête.	3278BEB8-503B-4E46-8F7E-D26E040C9769
PageNumber	integer	Le numéro de page.	1
Items	object
SQLRecord	array<object>	La liste des détails du journal d'audit.
	object	Les détails d'une entrée du journal d'audit.
HostAddress	string	The IP address of the client.	11.xxx.xxx.xxx
TableName	string	The name of the MongoDB collection.	C1
ReturnRowCounts	integer	The number of returned rows.	2
DBName	string	The database name.	test123
ExecuteTime	string	The time when the statement was executed. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2019-03-11T03:30:27Z
ThreadID	string	The thread ID.	140682188297984
TotalExecutionTimes	integer	The execution time, in microseconds.	700
Syntax	string	The executed statement.	{ \"atype\" : \"createCollection\", \"param\" : { \"ns\" : \"123.test1\" }, \"result\": \"OK\" }
AccountName	string	The name of the database account.	test

Exemples

JSON format

{
  "TotalRecordCount": 40,
  "PageRecordCount": 30,
  "RequestId": "3278BEB8-503B-4E46-8F7E-D26E040C9769",
  "PageNumber": 1,
  "Items": {
    "SQLRecord": [
      {
        "HostAddress": "11.xxx.xxx.xxx",
        "TableName": "C1",
        "ReturnRowCounts": 2,
        "DBName": "test123",
        "ExecuteTime": "2019-03-11T03:30:27Z",
        "ThreadID": "140682188297984",
        "TotalExecutionTimes": 700,
        "Syntax": "{ \\\"atype\\\" : \\\"createCollection\\\", \\\"param\\\" : { \\\"ns\\\" : \\\"123.test1\\\" }, \\\"result\\\": \\\"OK\\\" }",
        "AccountName": "test"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidStartTime.Format	Specified start time is not valid.	The specified start time is invalid.
400	InvalidEndTime.Format	Specified end time is not valid.
400	InvalidEndTime.Invalid	Specified end time is before this service active time.
400	InvalidParameterCombination	The end time must be greater than the start time.
400	InvalidQueryKeyword.Format	Specified Query Keyword is not valid.
400	InvalidDatabase.Format	Specified Database is not valid.
400	InvalidQueryTime.Format	Specified query time is not valid.
403	IncorrectSQLLogActiveStatus	Current DB instance SQL log active status does not support this operation.
403	LogApiFrequencyExceeded	Exceeding the allowed frequency of log api.
403	ConcurrentTaskExceeded	Concurrent task exceeding the allowed amount.

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

Notes de version

Consultez Notes de version pour la liste complète.