UpdateInstance - - Centre de documentation Alibaba Cloud

Met à jour les informations d'une instance de base de données et vérifie sa connectivité.

Avant d'appeler cette opération, appelez l'opération GetInstance ou ListInstances pour obtenir toutes les informations sur l'instance.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	UpdateInstance	Opération à effectuer. Définissez la valeur sur UpdateInstance.
Tid	Long	Oui	3***	ID du locataire (tenant). Appelez l'opération GetUserActiveTenant pour obtenir cet ID.
InstanceType	String	Oui	mysql	Type de base de données. Pour connaître les valeurs valides, consultez le paramètre DbType.
InstanceSource	String	Oui	ECS_OWN	Source de l'instance de base de données. Valeurs valides : PUBLIC_OWN : instance de base de données auto-gérée déployée sur Internet RDS : instance ApsaraDB RDS ECS_OWN : base de données auto-gérée déployée sur une instance Elastic Compute Service (ECS) VPC_IDC : instance de base de données auto-gérée déployée dans un centre de données connecté via un VPC
EnvType	String	Oui	product	Type d'environnement de l'instance de base de données. Valeurs valides : product : environnement de production dev : environnement de développement pre : environnement de préproduction (staging) test : environnement de test sit : environnement de test d'intégration système (SIT) uat : environnement de test d'acceptation utilisateur (UAT) pet : environnement de test de charge stag : environnement STAG
EcsInstanceId	String	Non	i-2zei9gs1t7h8l7ac****	ID de l'instance ECS. Remarque Obligatoire si le paramètre InstanceSource est défini sur ECS_OWN.
VpcId	String	Non	vpc-xxx	ID du VPC. Remarque Obligatoire si le paramètre InstanceSource est défini sur VPC_IDC.
EcsRegion	String	Non	cn-hangzhou	ID de la région où réside l'instance de base de données. Remarque Obligatoire si le paramètre InstanceSource est défini sur RDS, ECS_OWN ou VPC_IDC.
Host	String	Oui	192.XXX.0.56	Adresse hôte utilisée pour se connecter à l'instance de base de données.
Port	Integer	Oui	3306	Numéro de port utilisé pour se connecter à l'instance de base de données.
Sid	String	Non	XXX	Identifiant système (SID) de l'instance de base de données. Remarque Obligatoire si le paramètre InstanceType est défini sur ORACLE.
DatabaseUser	String	Oui	dbuser	Compte utilisé pour se connecter à la base de données.
DatabasePassword	String	Oui	******	Mot de passe utilisé pour se connecter à la base de données.
InstanceAlias	String	Oui	instance_test	Alias de l'instance de base de données. Spécifiez un alias permettant d'identifier l'instance dans Data Management (DMS).
DbaId	String	Oui	27****	ID de l'utilisateur assumant le rôle d'administrateur de base de données (DBA) de l'instance. Appelez l'opération ListUsers ou GetInstance pour obtenir cet ID.
SafeRuleId	String	Oui	3****	ID de l'ensemble de règles de sécurité (GroupName) de l'instance. Appelez l'opération ListStandardGroups ou GetInstance pour obtenir l'ID de l'ensemble de règles souhaité.
QueryTimeout	Integer	Oui	60	Délai d'expiration pour les requêtes de données dans l'instance de base de données.
ExportTimeout	Integer	Oui	600	Délai d'expiration pour l'exportation des données depuis l'instance de base de données.
DataLinkName	String	Non	datalink_test	Nom du lien de base de données pour les requêtes inter-bases. Remarque Obligatoire si le paramètre UseDsql est défini sur 1. Le nom ne peut contenir que des lettres minuscules et des traits de soulignement (_). Le nom doit être unique au sein d'un locataire.
DdlOnline	Integer	Non	0	Indique s'il faut activer la modification de schéma sans verrouillage pour l'instance. Valeurs valides : 0 : désactive la modification de schéma sans verrouillage. 1 : privilégie MySQL Native OnlineDDL. 2 : privilégie DMS OnlineDDL.
UseDsql	Integer	Non	0	Indique s'il faut activer les requêtes inter-bases pour l'instance. Valeurs valides : 0 : désactive les requêtes inter-bases. 1 : active les requêtes inter-bases. Remarque Types de bases de données pris en charge : MySQL, SQL Server, PostgreSQL, PolarDB for Oracle et ApsaraDB for Redis.
InstanceId	String	Oui	126****	ID de l'instance de base de données. Appelez l'opération GetInstance pour obtenir cet ID.
SkipTest	Boolean	Non	false	Indique s'il faut ignorer le test de connectivité. Valeurs valides : true : ignore le test de connectivité. false : n'ignore pas le test de connectivité.
EnableSellSitd	String	Non	Y	Y : active Sensitive Data Discovery and Protection (SDDP). N : désactive SDDP. NULL ou autres valeurs : l'état SDDP n'est pas mis à jour et conserve sa valeur actuelle (activé ou désactivé).
TemplateId	Long	Non	3***	ID du modèle de classification des données mis à jour.
TemplateType	String	Non	INNER	Type du modèle de classification des données mis à jour.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	E9BEBF41-4F69-4605-A5D5-A67955173941	ID de la requête.
ErrorCode	String	UnknownError	Code d'erreur renvoyé en cas d'échec de la requête.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé en cas d'échec de la requête.
Success	Boolean	false	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=UpdateInstance
&<Common request parameters>

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>E9BEBF41-4F69-4605-A5D5-A67955173941</RequestId>
<Success>true</Success>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E9BEBF41-4F69-4605-A5D5-A67955173941",
  "Success" : true
}

Codes d'erreur

Pour la liste des codes d'erreur, consultez les Codes d'erreur de service .