ModifyDtsJob - Data Transmission Service - Centre de documentation Alibaba Cloud

Remarque

Vous pouvez préconfigurer la tâche dans la console, puis prévisualiser les paramètres de requête OpenAPI afin de vous aider à renseigner les paramètres de requête.

Débogage

Vous pouvez exécuter cette opération dans OpenAPI Explorer, qui calcule automatiquement la valeur de signature. Après un appel réussi, OpenAPI Explorer génère des exemples de code SDK.

Paramètres de requête

Name	Type	Required	Example	Description
Action	String	Yes	ModifyDtsJob	Le paramètre défini par le système. Définissez la valeur sur `ModifyDtsJob`.
RegionId	String	No	cn-hangzhou	L'ID de région de l'instance. Pour plus d'informations, consultez la rubrique Régions prises en charge.
DtsInstanceId	String	Yes	dtsbi6e22ay243****	L'ID de l'instance de synchronisation.
SynchronizationDirection	String	No	Forward	La direction de synchronisation. Valeurs possibles : `Forward` : synchronisation avant. `Reverse` : synchronisation inverse. Remarque Valeur par défaut : `Forward`. Ce paramètre est requis uniquement lorsque l'instance de synchronisation des données utilise une topologie de synchronisation bidirectionnelle.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	Le jeton client qui garantit l'idempotence de la requête. Générez une valeur de paramètre unique depuis votre client pour différentes requêtes. ClientToken prend uniquement en charge les caractères ASCII et ne peut pas dépasser 64 caractères de longueur.
DbList	Map	No	{"dtstest":{"name":"dtstest","all":true}}	Les objets de synchronisation modifiés au format de chaîne JSON. Pour plus d'informations, consultez la rubrique Objets pour la migration, la synchronisation et l'abonnement. Important : La DbList existante sera écrasée par la nouvelle DbList. Assurez-vous que la nouvelle DbList contient tous les objets de synchronisation requis. Dans le cas contraire, des objets de synchronisation risquent d'être perdus. Modifiez avec prudence. Recommandation : Avant toute modification, appelez l'API DescribeDtsJobDetail pour interroger les objets de synchronisation actuels, puis saisissez les objets de synchronisation modifiés en fonction de vos besoins métier. Par exemple, si les objets actuels sont la table A et la table B et que vous devez ajouter la table C, vous devez inclure la table A, la table B et la table C dans ce paramètre. DbList prend en charge un maximum de 1 Mo de données. Si DbList contient des conditions de filtrage, la longueur totale de DbList (y compris les conditions de filtrage) prend en charge un maximum de 1 Mo. Pour les tâches distribuées (telles que les tâches de migration ou de synchronisation avec PolarDB-X 1.0 comme source), DbList est divisé selon les tables physiques et génère plusieurs sous-tâches. Le DbList de chaque sous-tâche prend en charge un maximum de 1 Mo de données.
EtlOperatorColumnReference	String	No	{ "configKeyMap": [ { "moduleCode": "03", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" }, { "moduleCode": "07", "etlOperatorColumnReference": "etlOperatorColumnReference", "etlOperatorSetting": "etlOperatorSetting" } ], "amp.increment.replicator.compare.all.columns.enable": false, "srcNetType": "VPC", "etlOperatorColumnReference": { "MODIFY_TIME": [ { "datasynchron.test_timing_user_000": "user_create_date" }, { "datasynchron.test_timing_user_001": "user_create_date" }, { "datasynchron.test_timing_user_002": "user_create_date" }, { "datasynchron.test_timing_user_003": "user_create_date" } ] }, "destNetType": "VPC", "originalSrcDbInst": "sg-sit-db2-primary.mysql.polardb.rds.aliyuncs.com", "etlOperatorSetting": "adb_time_travel", "sjobUseJobTask": "1", "srcVpcNetMappingInst": "172.19.XXX.XXX:4261", "destVpcNetMappingInst": "172.19.XXX.XXX:4260", "useJobTask": "1" }	Un opérateur lié à la fonctionnalité extract, transform and load (ETL) et spécifique aux activités T+1.
ModifyTypeEnum	String	No	UPDATE_RESERVED	Indique la méthode de modification de la tâche de synchronisation. Si ce paramètre n'est pas spécifié, les objets de synchronisation sont modifiés par défaut. Si ce paramètre est défini sur UPDATE_RESERVED, les paramètres réservés sont modifiés.
Reserved	String	No	{"definer": false,"syncArchitecture": "oneway","whitelist.dms.online.ddl.enable": false,"destSSL": "0","triggerMode": "manual","sqlparser.dms.original.ddl": true,"whitelist.ghost.online.ddl.enable": false,"privilegeMigration": false,"maxRetryTime": 43200,"srcSSL": "0","autoStartModulesAfterConfig": "none"}	Le paramètre réservé de DTS. La méthode de mise à jour consiste à ajouter plutôt qu'à écraser. Le format est une chaîne JSON MAP. Vous pouvez transmettre ce paramètre pour implémenter des exigences spéciales (par exemple, démarrer automatiquement la vérification préalable). La méthode d'utilisation est similaire au paramètre Reserve. Pour plus d'informations, consultez la rubrique Description du paramètre Reserve.
FileOssUrl	String	No	http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_1218543989_**	L'URL OSS du fichier de synchronisation.
FilterTableName	String	No	testtable	Le nom de la table à filtrer.
StructureInitialization	Boolean	No	true	Spécifie s'il faut effectuer une migration de schéma ou une synchronisation de schéma. Valeurs possibles : true : oui. false : non.
DataInitialization	Boolean	No	true	Spécifie s'il faut effectuer une migration complète des données ou une synchronisation complète des données. Valeurs possibles : true : oui. false : non.
DataSynchronization	Boolean	No	true	Spécifie s'il faut effectuer une migration incrémentielle des données ou une synchronisation incrémentielle des données. Valeurs possibles : false : non. true : oui.
DtsJobId	String	No	fpx1149rw7p***	L'ID de la tâche de synchronisation. Vous pouvez l'obtenir en appelant l'API DescribeDtsJobs.
ZeroEtlJob	Boolean	No	false	Spécifie s'il faut interroger uniquement les tâches d'intégration zero extract, transform, load (ETL). Valeurs possibles : true : oui. false : non.
ResourceGroupId	String	No	rg-acfmzawhxxc****	L'ID du groupe de ressources.

Paramètres de réponse

Name	Type	Example	Description
Status	String	200	Le code d'état.
RequestId	String	1D6ECADF-C5E9-4C96-8811-77602B31****	L'ID de la requête.
DtsJobId	String	bi6e22a****	L'ID de la tâche DTS.
ErrCode	String	InternalError	Le code d'erreur renvoyé en cas d'échec de la requête.
Success	Boolean	true	Indique si la requête a abouti.
ErrMessage	String	The request processing has failed due to some unknown error.	Le message d'erreur renvoyé en cas d'échec de la requête. Remarque Le type de données de ce paramètre doit être String, et la valeur d'exemple réelle est The request processing has failed due to some unknown error.

Exemples

Exemple de requête

http(s)://dts.aliyuncs.com/?Action=ModifyDtsJob
&DtsInstanceId=dtsbi6e22ay243****
&DbList={"dtstest":{"name":"dtstest","all":true}}
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<ModifyDtsJobResponse>
    <DtsJobId>bi6e22a****</DtsJobId>
    <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
    <Success>true</Success>
</ModifyDtsJobResponse>

JSON format

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

{
  "DtsJobId" : "bi6e22a****",
  "RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
  "Success" : true
}

Codes d'erreur

HttpCode	Error code	Error message	Description
403	OperationDenied.JobStatusModifying	jobs state is modifying, please wait sync subtask ends	La tâche est actuellement en cours de modification des objets de synchronisation (l'opération de modification précédente n'est pas encore terminée). Veuillez attendre la fin de cet état.
403	CheckStatus.InvalidInitStatus	Task has not been configured, please configure job first	La tâche n'a pas été configurée. Veuillez configurer la tâche avant de la modifier.
403	DTS.Msg.OperationDenied.JobStatusModifying	jobs state is modifying, please wait sync subtask ends	La tâche est actuellement en cours de modification des objets de synchronisation (l'opération de modification précédente n'est pas encore terminée). Veuillez attendre la fin de cet état.
403	DTS.Msg.CheckStatus.InvalidInitStatus	Task has not been configured, please configure job first	La tâche n'a pas été configurée. Veuillez configurer la tâche avant de la modifier.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	Le SecurityToken spécifié a expiré. Veuillez mettre à jour la signature.
400	Throttling.User	Request was denied due to user flow control.	La requête a été refusée car la fréquence des requêtes a atteint le seuil. Veuillez réessayer ultérieurement.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	La requête a échoué en raison d'un délai d'attente temporaire du serveur ou d'une indisponibilité. Veuillez réessayer. Si l'échec persiste après plusieurs tentatives, contactez le support technique.

Consultez le Centre d'erreurs pour obtenir plus de codes d'erreur.