ConfigureSubscription - Data Transmission Service - Centre de documentation Alibaba Cloud

Remarque

Lorsque vous configurez une tâche de suivi des modifications dans la console Data Transmission Service (DTS), placez le pointeur sur Next: Save Task Settings and Precheck à l'étape Advanced Settings, puis cliquez sur Preview OpenAPI parameters pour afficher les paramètres utilisés pour appeler les opérations API.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ConfigureSubscription	Opération à effectuer. Définissez la valeur sur ConfigureSubscription.
RegionId	String	Yes	cn-hangzhou	ID de la région où réside l'instance DTS. Pour plus d'informations, consultez Régions prises en charge.
DtsJobName	String	Yes	MySQL Change Tracking	Nom de la tâche de suivi des modifications. Remarque Nous vous recommandons de spécifier un nom descriptif pour faciliter l'identification. Il n'est pas nécessaire d'utiliser un nom unique.
DtsInstanceId	String	No	dtsy0zz3t13h7d****	ID de l'instance de suivi des modifications. Appelez l'opération DescribeDtsJobs pour interroger l'ID de l'instance.
DtsJobId	String	No	y0zz3t13h7d****	ID de la tâche de suivi des modifications. Appelez l'opération DescribeDtsJobs pour interroger l'ID de la tâche.
SourceEndpointEngineName	String	No	PostgreSQL	Moteur de la base de données source. Valeurs valides : MySQL, PostgreSQL et Oracle. Remarque Si la base de données source est une base de données gérée par l'utilisateur, vous devez spécifier ce paramètre.
SourceEndpointInstanceType	String	No	RDS	Type de la base de données source. Valeurs valides : RDS : Instance ApsaraDB RDS for MySQL PolarDB : Cluster PolarDB for MySQL DRDS : Instance PolarDB-X 1,0 LocalInstance : Base de données gérée par l'utilisateur avec une adresse IP publique ECS : Base de données gérée par l'utilisateur hébergée sur une instance Elastic Compute Service (ECS) Express : Base de données gérée par l'utilisateur connectée via Express Connect CEN : Base de données gérée par l'utilisateur connectée via Cloud Enterprise Network (CEN) dg : Base de données gérée par l'utilisateur connectée via Database Gateway
SourceEndpointRegion	String	No	cn-hangzhou	ID de la région où réside la base de données source. Pour plus d'informations, consultez Régions prises en charge. Remarque Si la base de données source est une base de données gérée par l'utilisateur avec une adresse IP publique, définissez la valeur de ce paramètre sur cn-hangzhou ou sur l'ID de la région la plus proche de celle où réside la base de données gérée par l'utilisateur.
SourceEndpointInstanceID	String	No	rm-bp1zc3iyqe3qw****	ID de l'instance source. Remarque Ce paramètre prend effet et est requis uniquement lorsque la base de données source est une instance ApsaraDB RDS for MySQL, une instance PolarDB-X 1,0 ou un cluster PolarDB for MySQL.
SourceEndpointIP	String	No	172.16.8.**	Adresse IP de la base de données source. Remarque Ce paramètre prend effet et est requis uniquement lorsque la base de données source est une base de données gérée par l'utilisateur.
SourceEndpointPort	String	No	3306	Numéro de port de service de la base de données source. Remarque Ce paramètre prend effet et est requis uniquement lorsque la base de données source est une base de données gérée par l'utilisateur.
SourceEndpointOracleSID	String	No	testsid	ID système (SID) de la base de données Oracle. Remarque Ce paramètre prend effet et est requis uniquement lorsque la base de données source est une base de données Oracle gérée par l'utilisateur et n'est pas déployée dans l'architecture Real Application Clusters (RAC).
SourceEndpointDatabaseName	String	No	dtstestdata	Nom de la base de données source.
SourceEndpointUserName	String	No	dtstest	Compte de base de données de l'instance source. Remarque Les autorisations requises pour le compte de base de données varient selon le scénario de suivi des modifications. Pour plus d'informations, consultez Préparer le compte de la base de données source pour le suivi des modifications.
SourceEndpointPassword	String	No	Test123456	Mot de passe du compte utilisé pour se connecter à la base de données source.
SourceEndpointOwnerID	String	No	140692647406****	ID du compte Alibaba Cloud auquel appartient la base de données source. Remarque Ce paramètre prend effet et est requis uniquement lorsque vous suivez les modifications de données entre différents comptes Alibaba Cloud.
SourceEndpointRole	String	No	ram-for-dts	Rôle Resource Access Management (RAM) attribué pour accéder à la base de données source. Ce paramètre est requis si la base de données source n'appartient pas au compte Alibaba Cloud que vous utilisez pour configurer la tâche de suivi des modifications. Dans ce cas, vous devez autoriser le compte Alibaba Cloud utilisé pour configurer la tâche de suivi des modifications à accéder à la base de données source. Remarque Pour plus d'informations sur les autorisations requises pour le rôle RAM et sur la manière de les accorder, consultez Configurer l'autorisation RAM pour la migration et la synchronisation de données intercomptes.
DbList	String	Yes	{"dtstest":{"name":"dtstest","all":true}}	Objets pour lesquels vous souhaitez suivre les modifications de données. La valeur doit être une chaîne JSON. Pour plus d'informations, consultez Objets des tâches DTS.
Reserve	String	No	{ "srcInstanceId": "cen-9kqshqum*******" }	Paramètre réservé de DTS. La valeur doit être une chaîne JSON. Spécifiez ce paramètre pour ajouter davantage de configurations de la base de données source ou de destination à la tâche DTS. Par exemple, vous pouvez spécifier le format de stockage des données de la base de données Kafka de destination et l'ID de l'instance CEN. Pour plus d'informations, consultez Description du paramètre Reserve.
Checkpoint	String	No	1616902385	Heure à laquelle commence le suivi des modifications de données. La valeur est un horodatage UNIX représentant le nombre de secondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC. Remarque Utilisez un moteur de recherche pour trouver un convertisseur d'horodatage UNIX.
SubscriptionInstanceNetworkType	String	Yes	vpc	Type de réseau de la tâche de suivi des modifications. Définissez la valeur sur vpc. Une valeur de vpc indique le type de réseau Virtual Private Cloud (VPC). Remarque Pour utiliser la nouvelle version de la fonctionnalité de suivi des modifications, vous devez spécifier SubscriptionInstanceNetworkType. Vous devez également spécifier SubscriptionInstanceVPCId et SubscriptionInstanceVSwitchID. Si vous ne spécifiez pas SubscriptionInstanceNetworkType, la version précédente de la fonctionnalité de suivi des modifications est utilisée. La version précédente de la fonctionnalité de suivi des modifications prend en charge les bases de données MySQL gérées par l'utilisateur, les instances ApsaraDB RDS for MySQL et les instances PolarDB-X 1,0. La nouvelle version de la fonctionnalité de suivi des modifications prend en charge les bases de données MySQL gérées par l'utilisateur, les instances ApsaraDB RDS for MySQL, les clusters PolarDB for MySQL et les bases de données Oracle.
SubscriptionInstanceVPCId	String	No	vpc-bp1vwnn14rqpyiczj****	ID du VPC dans lequel l'instance de suivi des modifications est déployée. Remarque Ce paramètre prend effet et est requis uniquement lorsque SubscriptionInstanceNetworkType est défini sur vpc.
SubscriptionInstanceVSwitchId	String	No	vsw-bp10df3mxae6lpmku****	ID du vSwitch dans le VPC spécifié. Remarque Ce paramètre prend effet et est requis uniquement lorsque SubscriptionInstanceNetworkType est défini sur vpc.
SubscriptionDataTypeDDL	Boolean	No	true	Indique s'il faut suivre les instructions DDL. Valeur par défaut : true. Valeurs valides : true : suit les instructions DDL. false : ne suit pas les instructions DDL.
SubscriptionDataTypeDML	Boolean	No	true	Indique s'il faut suivre les instructions DML. Valeur par défaut : true. Valeurs valides : true : suit les instructions DML. false : ne suit pas les instructions DML.
DelayPhone	String	No	1361234**,1371234**	Numéros de téléphone mobile auxquels sont envoyées les alertes liées à la latence. Séparez plusieurs numéros de téléphone mobile par des virgules (,). Remarque Ce paramètre est disponible uniquement pour les utilisateurs du site Chine (aliyun.com). Seuls les numéros de téléphone mobile de Chine continentale sont pris en charge. Vous pouvez spécifier jusqu'à 10 numéros de téléphone mobile. Les utilisateurs du site international (alibabacloud.com) ne peuvent pas recevoir d'alertes via des numéros de téléphone mobile, mais peuvent configurer des règles d'alerte pour les tâches DTS dans la console CloudMonitor. Pour plus d'informations, consultez Configurer des règles d'alerte pour les tâches DTS dans la console CloudMonitor.
DelayRuleTime	Long	No	10	Seuil pour les alertes liées à la latence. Unité : secondes. La valeur doit être un entier. Définissez le seuil en fonction de vos besoins métier. Pour éviter les fluctuations causées par la surcharge du réseau et de la base de données, nous vous recommandons de définir le seuil sur plus de 10 secondes. Remarque Si DelayNotice est défini sur true, ce paramètre est requis.
DelayNotice	Boolean	No	true	Indique s'il faut surveiller la latence de la tâche. Valeurs valides : true : surveille la latence de la tâche. false : ne surveille pas la latence de la tâche.
ErrorPhone	String	No	1361234**,1371234**	Numéros de téléphone mobile auxquels sont envoyées les alertes liées à l'état. Séparez plusieurs numéros de téléphone mobile par des virgules (,). Remarque Ce paramètre est disponible uniquement pour les utilisateurs du site Chine (aliyun.com). Seuls les numéros de téléphone mobile de Chine continentale sont pris en charge. Vous pouvez spécifier jusqu'à 10 numéros de téléphone mobile. Les utilisateurs du site international (alibabacloud.com) ne peuvent pas recevoir d'alertes via des numéros de téléphone mobile, mais peuvent configurer des règles d'alerte pour les tâches DTS dans la console CloudMonitor. Pour plus d'informations, consultez Configurer des règles d'alerte pour les tâches DTS dans la console CloudMonitor.
ErrorNotice	Boolean	No	true	Indique s'il faut surveiller l'état de la tâche. Valeurs valides : true : surveille l'état de la tâche. false : ne surveille pas l'état de la tâche.
DedicatedClusterId	String	No	dtscluster_atyl3b5214uk***	ID du cluster dédié DTS sur lequel la tâche de suivi des modifications est planifiée pour s'exécuter.
DtsBisLabel	String	No	normal	Tag d'environnement de l'instance DTS. Valeurs valides : normal online

Paramètres de réponse

Parameter	Type	Example	Description
HttpStatusCode	String	200	Code d'état HTTP.
RequestId	String	1D6ECADF-C5E9-4C96-8811-77602B31****	ID de la requête.
ErrCode	String	InternalError	Code d'erreur renvoyé si la requête a échoué.
DtsJobId	String	y0zz3t13h7d****	ID de la tâche de suivi des modifications.
Success	String	true	Indique si la requête a réussi.
DtsInstanceId	String	dtsy0zz3t13h7d****	ID de l'instance de suivi des modifications.
ErrMessage	String	The request processing has failed due to some unknown error.	Message d'erreur renvoyé si la requête a échoué.

Exemples

Exemples de requêtes

http(s)://dts.aliyuncs.com/?Action=ConfigureSubscription
&DbList={"dtstest":{"name":"dtstest","all":true}}
&DtsJobName=MySQL Change Tracking
&SourceEndpointInstanceType=RDS
&SubscriptionInstanceNetworkType=vpc
&SourceEndpointInstanceID=rm-bp1zc3iyqe3qw****
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<ConfigureSubscriptionResponse>
    <DtsJobId>y0zz3t13h7d****</DtsJobId>
    <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <DtsInstanceId>dtsy0zz3t13h7d****</DtsInstanceId>
    <Success>true</Success>
</ConfigureSubscriptionResponse>

JSON format

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

{
  "DtsJobId" : "y0zz3t13h7d****",
  "RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
  "HttpStatusCode" : 200,
  "DtsInstanceId" : "dtsy0zz3t13h7d****",
  "Success" : true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
400	Throttling.User	Request was denied due to user flow control.	Le nombre de requêtes a atteint la limite supérieure et la requête a été rejetée. Réessayez ultérieurement.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	Le délai d'attente de la réponse du serveur a expiré ou le serveur était indisponible. Réessayez. Si l'erreur persiste, contactez le support technique.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	La signature a expiré. Utilisez une nouvelle signature.

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