GetOnlineDDLProgress - Data Management - Centro de documentación de Alibaba Cloud

Consulta los detalles y el progreso de una tarea OnlineDDL.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:GetOnlineDDLProgress

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, vaya a la consola de Data Management (DMS) y pase el puntero sobre la foto de perfil en la esquina superior derecha. Para obtener más información, consulte la sección "Ver información sobre el inquilino actual" del tema Administrar inquilinos de DMS.	3***
JobDetailId	integer	Sí	El ID de los detalles de la tarea SQL de OnlineDDL. Puede llamar a la operación ListDBTaskSQLJobDetail para obtener el ID de detalle de la tarea.	15***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
ErrorCode	string	El código de error devuelto si la solicitud falló.	403
OnlineDDLTaskDetail	object	Los detalles de la tarea.
JobStatus	string	El estado de la tarea. Valores válidos: INIT: La tarea se está inicializando. SUCCESS: La tarea está completada. RUNNING: La tarea se está ejecutando. WAITING_CUTOVER: La tarea está en espera de cut-over. RESTARTING: La tarea se está reiniciando. PAUSE: La tarea está suspendida. UNSUPPORTED: La tarea no es compatible. CANCELED: La tarea está cancelada. FAIL: La tarea falló. INTERRUPT: La tarea está interrumpida.	SUCCESS
StatusDesc	string	La descripción del estado de la tarea.	Success
DelaySeconds	integer	La latencia de reproducción de DMS. Unidad: segundos. La latencia de reproducción es el período de tiempo que toma reproducir los registros binarios de la tabla en la tabla temporal. La latencia no indica la latencia de migración de datos entre una base de datos principal y una secundaria.	0
CopyTotal	integer	El número total estimado de filas de los datos. El valor se obtiene de los datos estadísticos en la base de datos information_schema. En la mayoría de los casos, el número total estimado de filas es menor que el número real de filas en una tabla.	10
CopyCount	integer	La cantidad real de datos replicados desde la tabla original en la operación de cambio sin bloqueo.	9
ProgressRatio	string	El progreso de ejecución estimado. El progreso real está sujeto al estado de la tarea.	90%
CutoverLockTimeSeconds	integer	El período máximo de tiempo que una tabla puede estar bloqueada durante el cut-over. Unidad: segundos.	2
CutoverFailRetryTimes	integer	El número de reintentos cuando falla el cut-over.	3
CleanStrategy	string	La política de limpieza de la tabla original después del cut-over. Valores válidos: DROP: Las tablas originales no válidas se eliminan. MOVE: Las tablas originales no válidas se mueven a la base de datos de prueba. Puede eliminar las tablas manualmente. NOTHING: Las tablas originales no válidas se conservan en la base de datos original. Puede eliminar las tablas manualmente.	DROP
CopyChunkSize	integer	El tamaño de cada fragmento que se utiliza para replicar datos. Este parámetro se utiliza para especificar el tamaño de cada fragmento. Un tamaño de fragmento mayor aumenta la eficiencia de replicación y disminuye el rendimiento del negocio. Nota Durante la replicación completa, la tabla original se divide en N fragmentos pequeños y cada fragmento se replica en la tabla temporal uno por uno. De forma predeterminada, DMS ajusta dinámicamente el tamaño de cada fragmento.	1000
CopyChunkMode	string	La política de replicación completa. Valores válidos: AUTO: DMS ajusta dinámicamente el tamaño del fragmento según el rendimiento de la base de datos. Las tablas se bloquean durante menos de 1.5 segundos en una sola operación de replicación. RUNNING: DMS utiliza el valor especificado del parámetro CopyChunkSize. El valor válido del parámetro CopyChunkSize oscila entre 1 y 60000. Si establece este parámetro en RUNNING, debe especificar el parámetro CopyChunkSize.	AUTO
CutoverWindowStartTime	string	El inicio de la ventana de tiempo de la operación de cut-over. Valor predeterminado: 00:00:00. Este parámetro controla la ventana de tiempo del cut-over. El cut-over solo se puede realizar cuando se cumplen las condiciones de cut-over y la hora se encuentra dentro de la ventana de tiempo especificada. Si la hora no se encuentra dentro de la ventana de tiempo, la operación de cut-over no se realiza hasta que la hora alcance el inicio de la ventana de tiempo.	12:00:00
CutoverWindowEndTime	string	El final de la ventana de tiempo de la operación de cut-over. Este valor debe ser al menos 30 minutos posterior al parámetro CutoverWindowStartTime. Valor predeterminado: 23:59:59	13:00:00

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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"
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.