AddInstance - - Centre de documentation Alibaba Cloud

Enregistre une instance de base de données dans Data Management Service (DMS) et active l'hébergement sécurisé pour l'instance.

Description de l'opération

Votre rôle système doit être DBA ou administrateur. Pour consulter votre rôle système, reportez-vous à Consulter mon rôle système.

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

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Remarque Vous pouvez trouver l'identifiant du locataire en survolant l'icône de profil dans le coin supérieur droit de la console DMS.	23****
InstanceType	string	Oui	Le type de base de données. Pour les valeurs valides, reportez-vous à Description du paramètre DbType.	MySQL
InstanceSource	string	Oui	La source de l'instance. 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 sur une instance ECS. VPC_IDC : une instance auto-gérée dans un IDC connecté à un VPC. GATEWAY : une instance Database Gateway.	RDS
NetworkType	string	Oui	Le type de réseau. Valeurs valides : CLASSIC : réseau classique. VPC : réseau 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 SIT. uat : environnement UAT. pet : environnement de test de charge. stag : environnement STAG.	product
EcsInstanceId	string	Non	L'identifiant de l'instance. Par exemple, si votre instance est une instance Database Gateway, saisissez l'identifiant de la passerelle. Remarque Ce paramètre est requis si InstanceSource est défini sur ECS_OWN ou GATEWAY.	i-2zei9gs1t7h8l7ac****
VpcId	string	Non	L'identifiant de l'instance du VPC. Remarque Ce paramètre est requis si InstanceSource est défini sur VPC_IDC.	vpc-2zef4o1hu7ljd****
EcsRegion	string	Non	La région dans laquelle l'instance réside. Remarque Ce paramètre est requis si InstanceSource est défini sur RDS, ECS_OWN, GATEWAY ou VPC_IDC.	cn-hangzhou
Host	string	Oui	L'adresse de connexion à la base de données.	rm-bp1g3tf90******.sqlserver.rds.aliyuncs.com
Port	integer	Oui	Le port de connexion à la base de données.	3306
Sid	string	Non	Le SID de l'instance. Remarque Ce paramètre est requis si InstanceType est défini sur ORACLE.	testSid
DatabaseUser	string	Non	Le compte de la base de données.	testsdb
DatabasePassword	string	Non	Le mot de passe de la base de données.	test***
InstanceAlias	string	Oui	L'alias de l'instance, qui vous aide à identifier rapidement l'instance.	Instance de test
DbaId	integer	Oui	L'identifiant de l'utilisateur DBA pour l'instance. Vous pouvez appeler l'opération ListUsers ou GetInstance pour obtenir cette valeur.	27****
QueryTimeout	integer	Oui	Le délai d'expiration de la requête. Unité : secondes.	7200
ExportTimeout	integer	Oui	Le délai d'expiration de l'exportation. Unité : secondes.	86400
EnableSellTrust	string	Oui	Indique si l'hébergement sécurisé doit être activé pour l'instance. Valeurs valides : Y : activer le mode d'hébergement sécurisé. N : ne pas activer le mode d'hébergement sécurisé.	Y
EnableSellStable	string	Non	Indique si la fonctionnalité de modification stable doit être activée pour l'instance. Valeurs valides : Y : activer. N : ne pas activer.	N
EnableSellCommon	string	Non	Indique si la fonctionnalité de collaboration sécurisée doit être activée pour l'instance. Valeurs valides : Y : activer. N : ne pas activer.	Y
SafeRule	string	Non	Si vous souhaitez activer la fonctionnalité de collaboration sécurisée, vous devez spécifier le jeu de règles de sécurité (GroupName) pour l'instance. Vous pouvez appeler l'opération ListStandardGroups ou GetInstance pour obtenir cette valeur.	Finance-Production
EnableSellSitd	string	Non	Indique si la fonctionnalité de protection des données sensibles doit être activée pour l'instance. Valeurs valides : Y : activer. N : ne pas activer.	Y
DataLinkName	string	Non	Le nom du lien de données de requête inter-bases de données. Remarque Ce paramètre est requis si UseDsql est défini sur 1. Le nom du DBLink ne peut contenir que des lettres minuscules et des traits de soulignement (_). Le nom du DBLink doit être globalement unique au sein du locataire.	dblink_test
DdlOnline	integer	Non	Indique si la modification de structure DMS est prioritaire. Valeurs valides : 0 : ne pas utiliser. 1 : le DDL en ligne natif est prioritaire. 2 : la modification de structure sans verrouillage DMS est prioritaire. Remarque Types de bases de données pris en charge : ApsaraDB RDS for MySQL, PolarDB for MySQL, MyBase for MySQL et autres sources MySQL.	2
UseDsql	integer	Non	Indique si la requête inter-instances doit être activée. Valeurs valides : 0 : désactiver. 1 : activer. 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é pour l'instance doit être ignoré. Valeurs valides : true : ignorer. false : ne pas ignorer.	false
TemplateId	integer	Non	L'identifiant du modèle de classification des données. Vous pouvez appeler l'opération ListClassificationTemplates pour obtenir cette valeur.	31***
TemplateType	string	Non	Le type de modèle de catégorisation. Vous pouvez appeler l'opération ListClassificationTemplates pour obtenir cette valeur.	INNER
UseSsl	integer	Non	Indique si la connexion SSL doit être activée. Une fois le SSL activé, DMS se connecte à la base de données via SSL. La base de données doit avoir le SSL activé avant d'utiliser ce paramètre. Valeurs valides : 0 : valeur par défaut (DMS et le service de base de données négocient automatiquement l'activation du SSL). Le système identifie automatiquement si le SSL est activé sur la base de données cible. Si le SSL est activé, DMS se connecte à la base de données via SSL. Sinon, DMS se connecte via une méthode standard. 1 : activer la connexion SSL. Si le SSL n'est pas activé sur la base de données, ce paramètre ne prend pas effet. -1 : désactiver la connexion SSL. Remarque Cet élément de configuration n'est disponible que lorsque le type de base de données est MySQL ou Redis. Le SSL (Secure Sockets Layer) chiffre les connexions réseau au niveau de la couche de transport, améliorant ainsi la sécurité et l'intégrité des données de communication, mais augmente le temps de réponse de la connexion réseau.	0
RoleArn	string	Non	L'ARN du rôle autorisé dans le compte cible, utilisé pour l'enregistrement inter-locataires.	acs:ram::1760865*********:role/dms-role-arn
LoginType	integer	Non	0 : connexion par nom d'utilisateur et mot de passe. 1 : mot de passe uniquement (Redis). 2 : connexion sans mot de passe (Redis).	0

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête. Vous pouvez utiliser cet identifiant pour localiser les journaux et résoudre les problèmes.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	Le code d'erreur.	UnknownError
ErrorMessage	string	Le message d'erreur.	UnknownError
Success	boolean	Indique si la requête a abouti. Valeurs valides : true : la requête a abouti. false : la requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "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.