Todos os produtos
Search
Central de documentação

Data Transmission Service:Preview the request parameters of API operations

Última atualização: Sep 06, 2026

Visualize os parâmetros de solicitação OpenAPI de uma tarefa do Data Transmission service (DTS) diretamente no console do DTS. Use esses parâmetros como referência ao chamar as operações de API correspondentes programaticamente.

Nota

Pare na etapa de visualização. Não prossiga para a próxima ação se quiser apenas consultar os parâmetros. Caso contrário, as operações relacionadas serão executadas, o que pode gerar cobranças ou alterar configurações da instância.

Pré-requisitos

Antes de começar, verifique se você tem:

  • Uma tarefa do DTS em uma das seguintes categorias: sincronização de dados, migração de dados, rastreamento de alterações ou verificação de dados

  • Acesso ao console do DTS

Visualizar parâmetros de API

  1. Faça login no console do DTS.

  2. No painel de navegação à esquerda, clique em Data Synchronization, Data Migration, Change Tracking ou Data Verification, conforme o tipo da tarefa.

  3. Na barra de navegação superior, selecione a região onde a instância do DTS está localizada.

  4. Acesse a página de configuração da tarefa. Essa página fica disponível ao criar uma tarefa, modificar os objetos a serem sincronizados ou rastreados, ou criar uma tarefa semelhante a uma existente. Para mais detalhes, consulte Overview of data synchronization scenarios, Overview of data migration scenarios, Overview of change tracking scenarios, Configure a data verification task, Modify the objects to be synchronized, Change the objects for change tracking e Create a similar instance.

  5. Conclua a etapa Configure Task Objects até que o botão Next: Save Task Settings and Precheck ou Next: Precheck and Start Task apareça na parte inferior da página. Dependendo do tipo de tarefa e dos bancos de dados de source e destino, talvez seja necessário passar pelas fases Advanced Settings, Data Verification ou Configure Database and Table Fields antes de chegar a esse botão.

  6. Passe o mouse sobre o botão Next: Save Task Settings and Precheck ou Next: Precheck and Start Task e clique em Preview OpenAPI parameters.

  7. Na caixa de diálogo Preview API Request Parameters, clique na aba JSON ou Tree para visualizar os parâmetros.

    Na caixa de diálogo Preview API Request Parameters, o campo Action é ConfigureDtsJob, e a aba JSON exibe os seguintes parâmetros principais de solicitação OpenAPI:

    • jobType: SYNC

    • sourceEndpointEngineName e destinationEndpointEngineName: MSSQL

    • sourceEndpointInstanceType e destinationEndpointInstanceType: RDS

    • sourceEndpointRegion e destinationEndpointRegion: cn-hangzhou

    • dbList: a configuração de mapeamento de bancos de dados e tabelas, na qual srcSchema e destSchema são ambos dbo

    • structureInitialization, dataInitialization e dataSynchronization: true

    A parte inferior da caixa de diálogo oferece os botões Copy Parameters e Close. A parte superior disponibiliza os links Copy e API Documentation.

Limpe os parâmetros antes do uso

Os parâmetros exibidos na caixa de diálogo Preview API Request Parameters servem apenas como referência. Antes de usá-los em uma chamada real de API, limpe a saída:

  • Remova barras invertidas extras (\), quebras de linha e espaços desnecessários.

  • Corrija aspas duplas aninhadas ("). Se um valor de parâmetro contiver uma string entre aspas duplas dentro de outra string também entre aspas duplas, escape as aspas internas com barras invertidas (\) ou remova as aspas externas, caso o formato permita.

Próximos passos

Use os parâmetros visualizados com as seguintes operações de API: