Pausa de la replicación de datos: suspend

API de SOAP › API de gestión de escenarios › Pausa de la replicación de datos: suspend_replication()

Pausa de la replicación de datos: suspend_replication()

La API suspend_replication permite suspender las operaciones de replicación de un host.

Argumentos

La función de API suspend_replication incluye los argumentos descritos en la tabla siguiente:

Nombre	Tipo	Descripción
session_id	uint	El ID de sesión que se ha devuelto llamando a la API create_session.
scenario_id	uint	El ID de escenario que debe suspenderse.
replica_index	uint	El índice del host réplica en un escenario. Normalmente, el valor del índice de la réplica es 2.
execute_sync	bool	Regula si debe llamarse a esta API sincrónica o asincrónicamente. Cuando se establece este argumento como verdadero, la función de API no devolverá ningún valor hasta que la operación finalice. De lo contrario, la función devuelve un valor inmediatamente.
mensaje	out string	Contiene el motivo del error cuando se produce un error en esta API.

Valores de retorno

El tipo de valor de retorno es booleano. Cuando el valor de retorno es verdadero, la API finalizará correctamente. Cuando el valor de retorno es falso, la API no finaliza correctamente. Si el valor de retorno es falso, revise el mensaje para determinar el motivo por el cual la API es errónea.

Ejemplo

public bool suspend_replication_example()
        {
            try
            {
                uint scenario_id = _scenario_id;
                string message = "";
                bool execute_sync = true;
                uint replica_index = 2;
                return get_mng().suspend_replication(_session_id, scenario_id, replica_index, execute_sync, out message);
            }
            catch (Exception ex)
            {
                System.Windows.Forms.MessageBox.Show(ex.Message);
            }
            return false;
        }