GetOnlineDDLProgress - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération via OpenAPI Explorer, qui 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	GetOnlineDDLProgress	Opération à effectuer. Définissez la valeur sur GetOnlineDDLProgress.
Tid	Long	No	3***	ID du locataire. Remarque Pour afficher l'ID 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 View information about the current tenant.
JobDetailId	Long	Yes	15***	ID des détails de la tâche SQL OnlineDDL. Appelez l'opération ListDBTaskSQLJobDetail pour obtenir cet ID.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	34E01EDD-6A16-4CF0-9541-C644D1BE01AA	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti. Valeurs possibles : true : La requête a abouti. false : Échec de la requête.
ErrorMessage	String	UnknownError	Message d'erreur renvoyé en cas d'échec de la requête.
ErrorCode	String	403	Code d'erreur renvoyé en cas d'échec de la requête.
OnlineDDLTaskDetail	Object		Détails de la tâche.
JobStatus	String	SUCCESS	État de la tâche. Valeurs possibles : INIT : Initialisation de la tâche en cours. SUCCESS : Tâche terminée. RUNNING : Exécution de la tâche en cours. WAITING_CUTOVER : Attente du basculement. RESTARTING : Redémarrage de la tâche en cours. PAUSE : Tâche suspendue. UNSUPPORTED : Tâche non prise en charge. CANCELED : Tâche annulée. FAIL : Échec de la tâche. INTERRUPT : Tâche interrompue.
StatusDesc	String	Success	Description de l'état de la tâche.
DelaySeconds	Long	0	Latence de relecture de DMS, en secondes. Il s'agit du temps nécessaire pour rejouer les journaux binaires de la table vers la table temporaire. Cette latence ne correspond pas à la latence de réplication entre la base de données principale et la base de données secondaire.
CopyTotal	Long	10	Nombre total estimé de lignes de données, obtenu à partir des statistiques de la base de données information_schema. Dans la plupart des cas, ce nombre est inférieur au nombre réel de lignes de la table.
CopyCount	Long	9	Quantité réelle de données répliquées depuis la table d'origine lors de l'opération de modification sans verrouillage.
ProgressRatio	String	90 %	Progression estimée de l'exécution. La progression réelle dépend de l'état de la tâche.
CutoverLockTimeSeconds	Long	2	Durée maximale de verrouillage de la table lors du basculement, en secondes.
CutoverFailRetryTimes	Long	3	Nombre de tentatives en cas d'échec du basculement.
CleanStrategy	String	DROP	Politique de nettoyage de la table d'origine après le basculement. Valeurs possibles : DROP : Suppression des tables d'origine invalides. MOVE : Déplacement des tables d'origine invalides vers la base de données de test. Vous pouvez les supprimer manuellement. NOTHING : Conservation des tables d'origine invalides dans la base de données d'origine. Vous pouvez les supprimer manuellement.
CopyChunkSize	Long	1000	Taille de chaque fragment utilisé pour la réplication des données. Une taille de fragment plus grande améliore l'efficacité de la réplication mais réduit les performances de l'application. Remarque Lors de la réplication complète, la table d'origine est divisée en N petits fragments, répliqués un par un vers la table temporaire. Par défaut, DMS ajuste dynamiquement la taille de chaque fragment.
CopyChunkMode	String	AUTO	Politique de réplication complète. Valeurs possibles : AUTO : DMS ajuste dynamiquement la taille du fragment selon les performances de la base de données. Le verrouillage des tables dure moins de 1,5 seconde par opération de réplication. RUNNING : DMS utilise la valeur spécifiée pour le paramètre CopyChunkSize (entre 1 et 60 000). Si vous définissez ce paramètre sur RUNNING, vous devez spécifier CopyChunkSize.
CutoverWindowStartTime	String	12:00:00	Début de la fenêtre temporelle du basculement. Valeur par défaut : 00:00:00. Ce paramètre définit la fenêtre temporelle autorisée pour le basculement. Celui-ci n'est effectué que si les conditions sont remplies et que l'heure actuelle se situe dans cette fenêtre. Sinon, l'opération est différée jusqu'au début de la fenêtre.
CutoverWindowEndTime	String	13:00:00	Fin de la fenêtre temporelle du basculement. Cette valeur doit être postérieure d'au moins 30 minutes à CutoverWindowStartTime. Valeur par défaut : 23:59:59.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=GetOnlineDDLProgress
&Tid=3***
&JobDetailId=15***
&Common request parameters

Exemple de réponse

Format XML

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

<GetOnlineDDLProgressResponse>
    <RequestId>34E01EDD-6A16-4CF0-9541-C644D1BE01AA</RequestId>
    <Success>true</Success>
    <OnlineDDLTaskDetail>
        <JobStatus>SUCCESS</JobStatus>
        <StatusDesc>Success</StatusDesc>
        <DelaySeconds>0</DelaySeconds>
        <CopyTotal>10</CopyTotal>
        <CopyCount>9</CopyCount>
        <ProgressRatio>90</ProgressRatio>
        <CutoverLockTimeSeconds>2</CutoverLockTimeSeconds>
        <CutoverFailRetryTimes>3</CutoverFailRetryTimes>
        <CleanStrategy>DROP</CleanStrategy>
        <CopyChunkSize>1000</CopyChunkSize>
        <CopyChunkMode>AUTO</CopyChunkMode>
        <CutoverWindowStartTime>12:00:00</CutoverWindowStartTime>
        <CutoverWindowEndTime>13:00:00</CutoverWindowEndTime>
    </OnlineDDLTaskDetail>
</GetOnlineDDLProgressResponse>

Format JSON

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

{
  "RequestId" : "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success" : true,
  "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

Pour une liste des codes d'erreur, consultez les Codes d'erreur du service.