StopDtsJob - Data Transmission Service: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. A ferramenta também 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	StopDtsJob	Operação a ser executada. Defina o valor como StopDtsJob.
DtsJobId	String	Sim	l3m1213ye7l****	ID da tarefa de migração de dados, sincronização de dados ou rastreamento de alterações.
DtsInstanceId	String	Não	dtsl3m1213ye7l****	ID da instância de migração de dados, sincronização de dados ou rastreamento de alterações.
SynchronizationDirection	String	Não	Forward	Direção da sincronização. Valores válidos: Forward Reverse Nota Valor padrão: Forward. Defina este parâmetro como Reverse para interromper apenas a tarefa de sincronização reversa quando a topologia for bidirecional.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
DynamicCode	String	403	Código de erro dinâmico. Este parâmetro será removido futuramente.
DynamicMessage	String	DtsJobId	Mensagem de erro dinâmica usada para substituir %s no parâmetro ErrMessage. Nota Se o valor retornado do parâmetro ErrMessage for The Value of Input Parameter %s is not valid e o valor retornado do parâmetro DynamicMessage for DtsJobId, o parâmetro DtsJobId especificado é inválido.
ErrCode	String	InternalError	Código de erro retornado se a chamada falhar.
ErrMessage	String	The Value of Input Parameter %s is not valid.	Mensagem de erro retornada se a chamada falhar.
HttpStatusCode	Integer	200	Código de status HTTP.
RequestId	String	01B6F25-21E7-4484-99D5-3EF2625C****	ID da solicitação.
Success	Boolean	true	Indica se a chamada foi bem-sucedida.

Exemplos

Exemplos de solicitações

http(s)://dts.aliyuncs.com/?Action=StopDtsJob
&DtsJobId=l3m1213ye7l****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<StopDtsJobResponse>
      <RequestId>01B6F25-21E7-4484-99D5-3EF2625C****</RequestId>
      <HttpStatusCode>200</HttpStatusCode>
      <Success>true</Success>
</StopDtsJobResponse>

Formato JSON

{
    "RequestId":"01B6F25-21E7-4484-99D5-3EF2625C****",
    "HttpStatusCode":200,
    "Success":true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.