ModifySqlLogConfig - - Centre de documentation Alibaba Cloud

Active ou configure DAS Enterprise Edition pour une instance de base de données.

Description de l'opération

Pour utiliser cette opération, les conditions préalables suivantes doivent être remplies :

Utilisez la dernière version du SDK Alibaba Cloud ou DAS.
Lors de l'appel au service DAS à l'aide du SDK, définissez la région sur cn-shanghai.
Par défaut, cette opération active la dernière version prise en charge. Pour connaître les bases de données et les régions prises en charge par chaque version de DAS Enterprise Edition, consultez Éditions de DAS et fonctionnalités prises en charge.

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

update

*All resources.

*

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.	rr-2ze770smbq3tp****
Enable	boolean	Non	Indique si DAS Enterprise Edition doit être activé. Valeurs valides : true : Oui. false : Non. Remarque Ce paramètre est requis lorsque vous activez DAS Enterprise Edition. Par défaut, la dernière version prise en charge est activée.	true
RequestEnable	boolean	Non	Indique si SQL Explorer doit être activé. Valeurs valides : true : Oui. false : Non. Remarque Ce paramètre est requis uniquement lorsque vous activez DAS Enterprise Edition V3.	true
Retention	integer	Non	La durée totale de stockage des données. Unité : jours. Valeurs valides : 7 30 180 365 Remarque Lorsque vous activez DAS Enterprise Edition V3, la valeur de ce paramètre doit être supérieure ou égale à 30.	30
HotRetention	integer	Non	La durée de stockage des données chaudes. Unité : jours. La valeur est un entier compris dans la plage [1, 7]. Remarque Ce paramètre est requis uniquement lorsque vous activez DAS Enterprise Edition V3.	1
Filters	array<object>	Non	Un paramètre réservé.
	object	Non	Un paramètre réservé.
Key	string	Non	Un paramètre réservé.	None
Value	string	Non	Un paramètre réservé.	None
EnableAudit	boolean	Non	Indique si l'audit de sécurité doit être activé.	true

DAS Enterprise Edition comporte quatre versions : V0, V1, V2 et V3. Par défaut, la dernière version prise en charge est activée.

Pour les instances de base de données qui ne prennent en charge que DAS Enterprise Edition V0, vous devez uniquement spécifier les paramètres Enable et Retention.
Pour les instances de base de données qui prennent en charge DAS Enterprise Edition V1, vous devez uniquement spécifier les paramètres Enable et Retention. Le système active automatiquement la fonctionnalité SQL Explorer (c'est-à-dire que les configurations par défaut définissent RequestEnable sur true).
Pour les instances de base de données qui prennent en charge DAS Enterprise Edition V2, vous devez uniquement spécifier les paramètres Enable et Retention. Le système active automatiquement la fonctionnalité SQL Explorer (c'est-à-dire que les configurations par défaut définissent RequestEnable sur true), définit la durée de stockage à chaud (HotRetention) sur 7 jours et définit la durée de stockage à froid sur Retention - 7 jours.

Éléments de réponse

Élément	Type	Description	Exemple
	object
Code	string	Le code d'état renvoyé.	200
Message	string	Le message renvoyé. Remarque Si la requête aboutit, Successful est renvoyé. Si la requête échoue, un message d'erreur tel qu'un code d'erreur est renvoyé.	Successful
RequestId	string	L'identifiant de la requête.	03C88D8E-1541-518E-8BFF-BEC6589B6334
Success	string	Indique si la requête a abouti. Valeurs valides : true : La requête a abouti. false : La requête a échoué.	false
Data	object	Les données renvoyées.
SqlLogVisibleTime	integer	L'heure à laquelle DAS Enterprise Edition a été activé. L'heure est au format d'horodatage UNIX. Unité : millisecondes.	1683712800000
RequestStopTime	integer	L'heure d'expiration de DAS Enterprise Edition V1. L'heure est au format d'horodatage UNIX. Unité : millisecondes.	1715335200000
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 : ApsaraDB RDS for PostgreSQL V1. polarpg_v1 : PolarDB for PostgreSQL V1.	MYSQL_V3
SupportVersion	string	La dernière version de DAS Enterprise Edition prise en charge. Valeurs valides : SQL_LOG_V0 : DAS Enterprise Edition V0. SQL_LOG_V1 : DAS Enterprise Edition V1. SQL_LOG_V2 : DAS Enterprise Edition V2. SQL_LOG_V3 : DAS Enterprise Edition V3. SQL_LOG_NOT_ENABLE : DAS Enterprise Edition n'est pas activé. SQL_LOG_NOT_SUPPORT : DAS Enterprise Edition n'est pas pris en charge.	SQL_LOG_V3
ColdRetention	integer	La durée de stockage des données froides. Unité : jours. La valeur est calculée à l'aide de la formule : Retention - HotRetention.	23
SqlLogEnable	boolean	Indique si DAS Enterprise Edition est activé. Valeurs valides : true : Oui. false : Non.	true
Retention	integer	La durée totale de stockage des données. Unité : jours.	30
HotRetention	integer	La durée de stockage des données chaudes. Unité : jours.	7
RequestEnable	boolean	Indique si SQL Explorer est activé. Valeurs valides : true : Oui. false : Non.	false
Version	string	La version de DAS Enterprise Edition activée. Valeurs valides : SQL_LOG_V0 : DAS Enterprise Edition V0. SQL_LOG_V1 : DAS Enterprise Edition V1. SQL_LOG_V2 : DAS Enterprise Edition V2. SQL_LOG_V3 : DAS Enterprise Edition V3. SQL_LOG_NOT_ENABLE : DAS Enterprise Edition n'est pas activé. SQL_LOG_NOT_SUPPORT : DAS Enterprise Edition n'est pas pris en charge.	SQL_LOG_V3
RequestStartTime	integer	L'heure à laquelle SQL Explorer a été activé. L'heure est au format d'horodatage UNIX. Unité : millisecondes.	1683712800000
HotEnable	boolean	Indique si le stockage des données chaudes est activé. Valeurs valides : true : Oui. false : Non.	true
HotStartTime	integer	L'heure de début du stockage des données chaudes. L'heure est au format d'horodatage UNIX. Unité : millisecondes.	1683712800000
ColdEnable	boolean	Indique si le stockage des données froides est activé. Valeurs valides : true : Oui. false : Non.	true
ColdStartTime	integer	L'heure de début du stockage des données froides. L'heure est au format d'horodatage UNIX. Unité : millisecondes.	1683712800000
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
LogFilter	string	Un paramètre réservé.	None
SqlLogSource	string	La source des journaux d'audit activés.	DSC:DAS_SIDE

Exemples

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "03C88D8E-1541-518E-8BFF-BEC6589B6334",
  "Success": "false",
  "Data": {
    "SqlLogVisibleTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "CollectorVersion": "MYSQL_V3",
    "SupportVersion": "SQL_LOG_V3",
    "ColdRetention": 23,
    "SqlLogEnable": true,
    "Retention": 30,
    "HotRetention": 7,
    "RequestEnable": false,
    "Version": "SQL_LOG_V3",
    "RequestStartTime": 1683712800000,
    "HotEnable": true,
    "HotStartTime": 1683712800000,
    "ColdEnable": true,
    "ColdStartTime": 1683712800000,
    "SqlLogState": "FINISH",
    "LogFilter": "None",
    "SqlLogSource": "DSC:DAS_SIDE"
  }
}

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 n'avez pas l'autorisation d'effectuer cette opération.

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

Notes de version

Consultez Notes de version pour la liste complète.