GetOnlineDDLProgress - - Centre de documentation Alibaba Cloud

Consulte les détails et la progression d'une tâche OnlineDDL.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Remarque Pour afficher l'identifiant du locataire, accédez à la console Data Management (DMS) et placez le pointeur sur la photo de profil dans le coin supérieur droit. Pour plus d'informations, consultez la section « Afficher les informations sur le locataire actuel » de la rubrique Gérer les locataires DMS.	3***
JobDetailId	integer	Oui	L'identifiant des détails de la tâche SQL OnlineDDL. Vous pouvez appeler l'opération ListDBTaskSQLJobDetail pour obtenir l'identifiant des détails de la tâche.	15***

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
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
ErrorMessage	string	Le message d'erreur renvoyé si la requête a échoué.	UnknownError
ErrorCode	string	Le code d'erreur renvoyé si la requête a échoué.	403
OnlineDDLTaskDetail	object	Les détails de la tâche.
JobStatus	string	L'état de la tâche. Valeurs valides : INIT : la tâche est en cours d'initialisation. SUCCESS : la tâche est terminée. RUNNING : la tâche est en cours d'exécution. WAITING_CUTOVER : la tâche est en attente de basculement. RESTARTING : la tâche est en cours de redémarrage. PAUSE : la tâche est suspendue. UNSUPPORTED : la tâche n'est pas prise en charge. CANCELED : la tâche est annulée. FAIL : la tâche a échoué. INTERRUPT : la tâche est interrompue.	SUCCESS
StatusDesc	string	La description de l'état de la tâche.	Success
DelaySeconds	integer	La latence de relecture de DMS. Unité : secondes. La latence de relecture correspond au temps nécessaire pour relire les journaux binaires de la table vers la table temporaire. Cette latence n'indique pas la latence de migration des données entre une base de données principale et une base de données secondaire.	0
CopyTotal	integer	Le nombre total estimé de lignes de données. Cette valeur est obtenue à partir des données statistiques de la base de données information_schema. Dans la plupart des cas, le nombre total estimé de lignes est inférieur au nombre réel de lignes dans une table.	10
CopyCount	integer	La quantité réelle de données répliquées à partir de la table d'origine dans le cadre de l'opération de modification sans verrouillage.	9
ProgressRatio	string	La progression d'exécution estimée. La progression réelle dépend de l'état de la tâche.	90%
CutoverLockTimeSeconds	integer	La durée maximale pendant laquelle une table peut être verrouillée lors du basculement. Unité : secondes.	2
CutoverFailRetryTimes	integer	Le nombre de tentatives en cas d'échec du basculement.	3
CleanStrategy	string	La stratégie de nettoyage de la table d'origine après le basculement. Valeurs valides : DROP : les tables d'origine invalides sont supprimées. MOVE : les tables d'origine invalides sont déplacées vers la base de données de test. Vous pouvez supprimer les tables manuellement. NOTHING : les tables d'origine invalides sont conservées dans la base de données d'origine. Vous pouvez supprimer les tables manuellement.	DROP
CopyChunkSize	integer	La taille de chaque fragment utilisé pour répliquer les données. Ce paramètre permet de spécifier la taille de chaque fragment. Une taille de fragment plus grande augmente l'efficacité de la réplication et diminue les performances de l'application. Remarque Lors de la réplication complète, la table d'origine est divisée en N petits fragments et chaque fragment est répliqué un par un dans la table temporaire. Par défaut, DMS ajuste dynamiquement la taille de chaque fragment.	1000
CopyChunkMode	string	La stratégie de réplication complète. Valeurs valides : AUTO : DMS ajuste dynamiquement la taille des fragments en fonction des performances de la base de données. Les tables sont verrouillées pendant moins de 1,5 seconde lors d'une seule opération de réplication. RUNNING : DMS utilise la valeur spécifiée du paramètre CopyChunkSize. La valeur valide du paramètre CopyChunkSize est comprise entre 1 et 60 000. Si vous définissez ce paramètre sur RUNNING, vous devez spécifier le paramètre CopyChunkSize.	AUTO
CutoverWindowStartTime	string	Le début de la fenêtre temporelle de l'opération de basculement. Valeur par défaut : 00:00:00. Ce paramètre contrôle la fenêtre temporelle du basculement. Le basculement ne peut être effectué que lorsque les conditions de basculement sont remplies et que l'heure se situe dans la fenêtre temporelle spécifiée. Si l'heure ne se situe pas dans la fenêtre temporelle, l'opération de basculement n'est pas effectuée avant que l'heure n'atteigne le début de la fenêtre temporelle.	12:00:00
CutoverWindowEndTime	string	La fin de la fenêtre temporelle de l'opération de basculement. Cette valeur doit être postérieure d'au moins 30 minutes au paramètre CutoverWindowStartTime. Valeur par défaut : 23:59:59.	13:00:00

Exemples

JSON format

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "403",
  "OnlineDDLTaskDetail": {
    "JobStatus": "SUCCESS",
    "StatusDesc": "Success",
    "DelaySeconds": 0,
    "CopyTotal": 10,
    "CopyCount": 9,
    "ProgressRatio": "90%",
    "CutoverLockTimeSeconds": 2,
    "CutoverFailRetryTimes": 3,
    "CleanStrategy": "DROP",
    "CopyChunkSize": 1000,
    "CopyChunkMode": "AUTO",
    "CutoverWindowStartTime": "12:00:00",
    "CutoverWindowEndTime": "13:00:00"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.