Todos os produtos
Search
Central de documentação

:GetOnlineDDLProgress

Última atualização: Jul 09, 2026

Consulta os detalhes e o progresso de uma tarefa OnlineDDL.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim GetOnlineDDLProgress

Operação a ser executada. Defina o valor como GetOnlineDDLProgress.

Tid Long Não 3***

ID do locatário.

Nota Para visualizar o ID do locatário, acesse o console do Data Management (DMS) e passe o ponteiro do mouse sobre a foto de perfil no canto superior direito. Para mais informações, consulte Visualizar informações sobre o locatário atual.
JobDetailId Long Sim 15***

ID dos detalhes da tarefa SQL OnlineDDL. Chame a operação ListDBTaskSQLJobDetail para obter esse ID.

Parâmetros de resposta

Parâmetro Tipo Exemplo Descrição
RequestId String 34E01EDD-6A16-4CF0-9541-C644D1BE01AA

ID da solicitação.

Success Boolean true

Indica se a solicitação foi bem-sucedida. Valores válidos:

  • true: A solicitação foi bem-sucedida.
  • false: A solicitação falhou.
ErrorMessage String UnknownError

Mensagem de erro retornada caso a solicitação falhe.

ErrorCode String 403

Código de erro retornado caso a solicitação falhe.

OnlineDDLTaskDetail Object

Detalhes da tarefa.

JobStatus String SUCCESS

Status da tarefa. Valores válidos:

  • INIT: A tarefa está sendo inicializada.
  • SUCCESS: A tarefa foi concluída.
  • RUNNING: A tarefa está em execução.
  • WAITING_CUTOVER: A tarefa aguarda o cut-over.
  • RESTARTING: A tarefa está reiniciando.
  • PAUSE: A tarefa está suspensa.
  • UNSUPPORTED: Tarefa não suportada.
  • CANCELED: A tarefa foi cancelada.
  • FAIL: A tarefa falhou.
  • INTERRUPT: A tarefa foi interrompida.
StatusDesc String Success

Descrição do status da tarefa.

DelaySeconds Long 0

Latência de replay do DMS, em segundos. Corresponde ao tempo necessário para reproduzir os logs binários da tabela na tabela temporária. Esse valor não indica a latência de replicação entre bancos de dados primário e secundário.

CopyTotal Long 10

Número total estimado de linhas de dados, obtido das estatísticas do banco de dados information_schema. Geralmente, essa estimativa é menor que a contagem real de linhas da tabela.

CopyCount Long 9

Quantidade real de dados replicados da tabela original durante a operação de alteração sem bloqueio.

ProgressRatio String 90%

Progresso estimado da execução. O progresso real varia conforme o status da tarefa.

CutoverLockTimeSeconds Long 2

Tempo máximo de bloqueio da tabela durante o cut-over, em segundos.

CutoverFailRetryTimes Long 3

Número de novas tentativas em caso de falha no cut-over.

CleanStrategy String DROP

Política de limpeza da tabela original após o cut-over. Valores válidos:

  • DROP: Exclua as tabelas originais inválidas.
  • MOVE: Move as tabelas originais inválidas para o banco de dados de teste para exclusão manual.
  • NOTHING: Mantém as tabelas originais inválidas no banco de dados original para exclusão manual.
CopyChunkSize Long 1000

Tamanho de cada bloco usado na replicação de dados. Blocos maiores aumentam a eficiência da replicação, mas reduzem o desempenho da aplicação.

Nota Durante a replicação completa, a tabela original é dividida em N blocos menores, replicados individualmente para a tabela temporária. Por padrão, o DMS ajusta dinamicamente o tamanho desses blocos.
CopyChunkMode String AUTO

Política de replicação completa. Valores válidos:

  • AUTO: O DMS ajusta dinamicamente o tamanho do bloco conforme o desempenho do banco de dados. As tabelas ficam bloqueadas por menos de 1,5 segundo em cada operação de replicação.
  • RUNNING: O DMS usa o valor definido no parâmetro CopyChunkSize (intervalo válido: 1 a 60000). Ao selecionar RUNNING, especifique obrigatoriamente o parâmetro CopyChunkSize.
CutoverWindowStartTime String 12:00:00

Início da janela de tempo para a operação de cut-over. Valor padrão: 00:00:00. Este parâmetro controla a janela permitida para o cut-over. A operação ocorre apenas se as condições forem atendidas dentro do intervalo especificado. Fora desse período, o cut-over aguardará o início da próxima janela válida.

CutoverWindowEndTime String 13:00:00

Fim da janela de tempo para a operação de cut-over. Deve ser pelo menos 30 minutos posterior ao CutoverWindowStartTime. Valor padrão: 23:59:59.

Exemplos

Solicitações de exemplo

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

Respostas de exemplo

Formato 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>

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.