DescribeSqlLogConfig - - Centre de documentation Alibaba Cloud

Consulte la configuration de DAS Enterprise Edition d'une instance de base de données.

Description de l'opération

Avant de commencer :

Utilisez la dernière version du SDK Alibaba Cloud ou DAS.
Lors de l'appel à DAS via le SDK, définissez la région sur cn-shanghai.

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.

hdm:DescribeSqlLogConfig

get

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance de base de données.	rm-2ze8g2am97624****

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	string	Le code d'état renvoyé.	200
Data	object	Les données renvoyées.
ColdEnable	boolean	Indique si le stockage des données froides est activé. Valeurs valides : true : Activé. false : Désactivé.	true
ColdRetention	integer	La durée de stockage des données froides. Unité : jours.	23
ColdStartTime	integer	L'heure de début du stockage des données froides. La valeur est un horodatage UNIX. Unité : millisecondes.	1683712800000
CollectorVersion	string	La version du collecteur. Valeurs valides : MYSQL_V0 : MySQL V0. MYSQL_V1 : MySQL V1. MYSQL_V2 : MySQL V2. MYSQL_V3 : MySQL V3. PG_V1 : PostgreSQL V1. rdspg_v1 : RDS PostgreSQL V1. polarpg_v1 : PolarDB for PostgreSQL V1.	MYSQL_V3
HotEnable	boolean	Indique si le stockage des données chaudes est activé. Valeurs valides : true : Activé. false : Désactivé.	true
HotRetention	integer	La durée de stockage des données chaudes. Unité : jours.	7
HotStartTime	integer	L'heure de début du stockage des données chaudes. La valeur est un horodatage UNIX. Unité : millisecondes.	1683712800000
LogFilter	string	Un paramètre réservé.	None
RequestEnable	boolean	Indique si SQL Explorer est activé. Valeurs valides : true : Activé. false : Désactivé.	true
RequestStartTime	integer	L'heure à laquelle SQL Explorer a été activé. La valeur est un horodatage UNIX. Unité : millisecondes.	1683712800000
RequestStopTime	integer	L'heure d'expiration de DAS Enterprise Edition V1. La valeur est un horodatage UNIX. Unité : millisecondes.	1715335200000
Retention	integer	La durée totale de stockage des données, qui correspond à la somme de HotRetention et ColdRetention. Unité : jours.	30
SqlLogEnable	boolean	Indique si DAS Enterprise Edition est activé. Valeurs valides : true : Activé. false : Désactivé.	true
Enable	boolean	Indique si SQL Explorer est activé. Ce paramètre est un alias de SqlLogEnable.
SqlLogSource	string	Un paramètre réservé.	None
SqlLogState	string	L'état de la migration des données. Valeurs valides : FINISH : La migration des données historiques est terminée. RUNNING : La migration des données historiques est en cours. FAILURE : La migration des données historiques a échoué.	FINISH
SqlLogVisibleTime	integer	L'heure à laquelle DAS Enterprise Edition a été activé. La valeur est un horodatage UNIX. Unité : millisecondes.	1683712800000
SupportMigration	boolean	Un paramètre réservé.	None
SupportVersion	string	La dernière version de DAS Enterprise Edition prise en charge par l'instance actuelle. Valeurs valides : SQL_LOG_V0 : Enterprise Edition V0. SQL_LOG_V1 : Enterprise Edition V1. SQL_LOG_V2 : Enterprise Edition V2. SQL_LOG_V3 : Enterprise Edition V3. SQL_LOG_NOT_ENABLE : Enterprise Edition n'est pas activée. SQL_LOG_NOT_SUPPORT : Enterprise Edition n'est pas prise en charge.	SQL_LOG_V3
SupportSecurityAudit	boolean	Indique si le moteur et la région de l'instance actuelle prennent en charge l'activation de l'audit de sécurité. Ce champ indique uniquement la capacité du produit et n'indique pas que l'audit de sécurité est déjà activé.
Version	string	La version actuelle de DAS Enterprise Edition qui est activée. Valeurs valides : SQL_LOG_V0 : Enterprise Edition V0. SQL_LOG_V1 : Enterprise Edition V1. SQL_LOG_V2 : Enterprise Edition V2. SQL_LOG_V3 : Enterprise Edition V3. SQL_LOG_NOT_ENABLE : Enterprise Edition n'est pas activée. SQL_LOG_NOT_SUPPORT : Enterprise Edition n'est pas prise en charge.	SQL_LOG_V3
Message	string	Le message renvoyé. Remarque Si la requête aboutit, Successful est renvoyé. Si la requête échoue, un message d'erreur est renvoyé, tel qu'un code d'erreur.	Successful
RequestId	string	L'identifiant de la requête.	0A74B755-98B7-59DB-8724-1321B394****
Success	string	Indique si la requête a abouti. Valeurs valides : true : La requête a abouti. false : La requête a échoué.	true

Pour SQL_LOG_V0 (Enterprise Edition V0) et SQL_LOG_V1 (Enterprise Edition V1), les données sont stockées dans CStore et sont considérées comme du stockage chaud. Pour les instances de base de données avec ces versions activées, la requête renvoie SqlLogEnable = HotEnable = true, Retention = HotRetention, ColdEnable = false, ColdRetention = 0.

Exemples

JSON format

{
  "Code": "200",
  "Data": {
    "ColdEnable": true,
    "ColdRetention": 23,
    "ColdStartTime": 1683712800000,
    "CollectorVersion": "MYSQL_V3",
    "HotEnable": true,
    "HotRetention": 7,
    "HotStartTime": 1683712800000,
    "LogFilter": "None",
    "RequestEnable": true,
    "RequestStartTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "Retention": 30,
    "SqlLogEnable": true,
    "Enable": false,
    "SqlLogSource": "None",
    "SqlLogState": "FINISH",
    "SqlLogVisibleTime": 1683712800000,
    "SupportMigration": true,
    "SupportVersion": "SQL_LOG_V3",
    "SupportSecurityAudit": false,
    "Version": "SQL_LOG_V3"
  },
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": "true"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParams	The request parameters are invalid.	Les paramètres de la requête sont invalides.
403	NoPermission	You are not authorized to do this action.	Vous ne disposez pas des autorisations nécessaires pour effectuer cette opération.
404	InstanceNotFound	The specified instance does not exist.	L'instance n'existe pas.

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

Notes de version

Consultez Notes de version pour la liste complète.