RegisterInstance - - Centre de documentation Alibaba Cloud

Enregistre une instance de base de données dans DMS.

Description de l'opération

Prérequis : vous devez disposer du rôle Administrateur ou Administrateur de base de données (DBA). Vous pouvez obtenir la RoleIdList en appelant l'API ListUsers ou GetUser.

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.

dms:RegisterInstance

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Vous pouvez appeler l'opération GetUserActiveTenant pour obtenir cet identifiant.	3***
InstanceType	string	Oui	Le type de base de données. Pour plus d'informations, consultez la description du paramètre DbType.	MySQL
InstanceSource	string	Oui	La source de l'instance de base de données. Valeurs valides : PUBLIC_OWN : une instance auto-gérée connectée via Internet. RDS : une instance ApsaraDB RDS. ECS_OWN : une instance auto-gérée déployée sur une instance Elastic Compute Service (ECS). VPC_IDC : une instance auto-gérée dans un centre de données connecté à un Virtual Private Cloud (VPC).	RDS
NetworkType	string	Oui	Le type de réseau. Valeurs valides : CLASSIC : réseau classique VPC : Virtual Private Cloud (VPC)	VPC
EnvType	string	Oui	Le type d'environnement. Valeurs valides : `product` : environnement de production `dev` : environnement de développement `pre` : environnement de pré-production `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 performance `stag` : environnement de préparation	product
EcsInstanceId	string	Non	L'identifiant de l'instance ECS. Remarque Ce paramètre est requis si `InstanceSource` est défini sur `ECS_OWN`.	i-2zei9gs1t7h8l7ac****
VpcId	string	Non	L'identifiant du VPC. Remarque Ce paramètre est requis si `InstanceSource` est défini sur `VPC_IDC`.	vpc-xxxxxxxxxxxxxxxxxxxxx
EcsRegion	string	Non	La région où se trouve l'instance. Remarque Ce paramètre est requis si `InstanceSource` est défini sur `RDS`, `ECS_OWN` ou `VPC_IDC`.	cn-hangzhou
Host	string	Oui	Le point de terminaison de l'instance de base de données.	172.XX.XXX.254
Port	integer	Oui	Le port de connexion de l'instance de base de données.	3306
Sid	string	Non	L'identifiant système (SID) de la base de données. Remarque Ce paramètre est requis si `InstanceType` est défini sur `ORACLE`.	XXX
DatabaseUser	string	Oui	Le nom d'utilisateur du compte de la base de données.	dmstest
DatabasePassword	string	Oui	Le mot de passe du compte de la base de données.	******
InstanceAlias	string	Oui	Un alias pour l'instance afin de vous aider à l'identifier rapidement.	Instance de test
DbaUid	integer	Oui	L'UID de l'utilisateur disposant du rôle d'Administrateur de base de données (DBA) pour l'instance. Vous pouvez appeler l'opération ListUsers ou GetInstance pour obtenir cet identifiant.	22275482072787****
SafeRule	string	Oui	Le nom de l'ensemble de règles de sécurité (GroupName) pour l'instance. Vous pouvez appeler l'opération ListStandardGroups ou GetInstance pour obtenir cette valeur.	Utilisation de test
QueryTimeout	integer	Oui	Le délai d'expiration de la requête, en secondes.	60
ExportTimeout	integer	Oui	Le délai d'expiration de l'exportation, en secondes.	600
DataLinkName	string	Non	Le nom de la liaison de données pour les requêtes inter-instances. Remarque Ce paramètre est requis si `UseDsql` est défini sur `1`. Le nom de la liaison de données ne peut contenir que des lettres minuscules et des traits de soulignement (_). Le nom de la liaison de données doit être unique au sein du locataire.	dblink_test
DdlOnline	integer	Non	La stratégie pour les modifications de schéma sans verrouillage. Valeurs valides : 0 : Désactivé. 1 : Prioriser les opérations natives sans verrouillage. Si une opération échoue, elle revient à Data Management (DMS) pour l'exécution. 2 : Utiliser Data Management (DMS) pour les modifications de schéma sans verrouillage. Remarque Types de bases de données pris en charge : ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB for MyBase (MySQL) et autres bases de données compatibles MySQL.	2
UseDsql	integer	Non	Indique si les requêtes inter-instances doivent être activées. Valeurs valides : 0 : Désactivé 1 : Activé Remarque Types de bases de données pris en charge : MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible Oracle) et Redis.	1
SkipTest	boolean	Non	Indique si le test de connectivité doit être ignoré. Valeurs valides : true : Ignorer le test. false : Effectuer le test.	true
EnableSellSitd	string	Non	Y : Activer la protection des données sensibles. NULL ou autres valeurs : Désactiver la protection des données sensibles.	Y
TemplateId	integer	Non	L'identifiant du modèle de classification de sensibilité. Vous pouvez appeler l'opération ListClassificationTemplates pour obtenir cet identifiant.	31***
TemplateType	string	Non	Le type du modèle de classification de sensibilité. Vous pouvez appeler l'opération ListClassificationTemplates pour obtenir cette valeur.	INNER
DbaUidByString	string	Non	Ce paramètre remplace `DbaUid` et prend en charge les UID non numériques, tels que les UID des rôles RAM.	22275482072787****
ResourceGroup	string	Non	L'identifiant du groupe de ressources.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
RequestId	string	L'identifiant de la requête.	F4E2A94B-604F-43FF-93E7-F4EE3DCF412E
ErrorCode	string	Le code d'erreur renvoyé en cas d'échec de la requête.	UnknownError
ErrorMessage	string	Le message d'erreur renvoyé en cas d'échec de la requête.	UnknownError
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : La requête a réussi. false : La requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.