CreateSynchronizationJob - DTS API Reference - Data Transmission Service: Central de Documentação do Alibaba Cloud

Antes de chamar esta operação, consulte os métodos de faturamento e preços do DTS.

Após adquirir uma instância de sincronização, chame ConfigureSynchronizationJob para configure a tarefa de sincronização. A tarefa inicia automaticamente.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura e gera códigos de exemplo do SDK.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateSynchronizationJob	A operação a ser executada. Defina o valor como CreateSynchronizationJob.
DestRegion	String	Sim	cn-hangzhou	ID da região do banco de dados de destino. Para obter IDs de região válidos, consulte a Lista de regiões suportadas. Nota Se SourceRegion estiver definido como China (Hong Kong) ou uma região fora da China continental, defina DestRegion com o mesmo valor.
PayType	String	Sim	PostPaid	Método de faturamento da instância de sincronização. PrePaid: assinatura PostPaid (valor padrão): pagamento conforme o uso
SourceRegion	String	Sim	cn-hangzhou	ID da região do banco de dados de source. Para obter IDs de região válidos, consulte a Lista de regiões suportadas.
SynchronizationJobClass	String	Sim	small	Especificação da instância de sincronização. Valores válidos: micro, small, medium e large. Nota Para benchmarks de desempenho de cada especificação, consulte Especificações de instâncias de sincronização de dados.
RegionId	String	Não	cn-hangzhou	ID da região da instância de sincronização. Defina este valor igual a DestRegion.
Topology	String	Não	oneway	Topologia de sincronização. Valores válidos: oneway: sincronização unidirecional bidirectional: sincronização bidirecional Nota Valor padrão: oneway. O valor bidirectional é suportado apenas quando SourceEndpoint.InstanceType e DestinationEndpoint.InstanceType estão definidos como MySQL, PolarDB ou Redis.
Period	String	Não	Year	Ciclo de faturamento da instância por assinatura. Valores válidos: Year Month Nota Obrigatório apenas quando PayType está definido como PrePaid.
UsedTime	Integer	Não	1	Duração da assinatura. Se o ciclo de faturamento for Year, o intervalo de valores é de 1 a 5. Se o ciclo de faturamento for Month, o intervalo de valores é de 1 a 60. Nota Obrigatório apenas quando PayType está definido como PrePaid.
ClientToken	String	Não	0c593ea1-3bea-11e9-b96b-88e9fe63****	Token de cliente que garante a idempotência da solicitação. Utilize um valor exclusivo para cada solicitação. O valor de ClientToken pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.
SourceEndpoint.InstanceType	String	Não	MySQL	Tipo de instância do banco de dados de source. Valores válidos: MySQL: instância do ApsaraDB RDS for MySQL ou banco de dados MySQL autogerenciado PolarDB: cluster do PolarDB for MySQL ou cluster do PolarDB O Edition Redis: banco de dados Redis DRDS: instância do PolarDB-X V1.0 Nota Valor padrão: MySQL. Para bancos de dados de source e destino suportados, consulte Tipos de banco de dados, tipos de sincronização inicial e topologias de sincronização.
DestinationEndpoint.InstanceType	String	Não	MySQL	Tipo de instância do banco de dados de destino. Valores válidos: MySQL: instância do ApsaraDB RDS for MySQL ou banco de dados MySQL autogerenciado PolarDB: cluster do PolarDB for MySQL ou cluster do PolarDB O Edition Redis: banco de dados Redis MaxCompute: projeto do MaxCompute Nota Valor padrão: MySQL. Para bancos de dados de source e destino suportados, consulte Tipos de banco de dados, tipos de sincronização inicial e topologias de sincronização.
networkType	String	Não	Intranet	Tipo de rede. Valor válido: Intranet (VPC).
AccountId	String	Não	12323344****	ID da conta Alibaba Cloud. Este parâmetro foi descontinuado e será removido no futuro.
DBInstanceCount	Integer	Não	3	Obrigatório quando SourceEndpoint.InstanceType está definido como DRDS. Representa o número de instâncias RDS privadas anexadas à instância PolarDB-X de source. Valor padrão: 1.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
ErrCode	String	InternalError	Código de erro retornado quando a chamada falha.
ErrMessage	String	The request processing has failed due to some unknown error.	Mensagem de erro retornada quando a chamada falha.
RequestId	String	9056C8B0-5799-493A-9655-70F607B8****	ID da solicitação.
Success	String	true	Indica se a solicitação foi bem-sucedida.
SynchronizationJobId	String	dtshvj11k25255****	ID da instância de sincronização de dados.

Exemplos

Exemplos de solicitações

http(s)://dts.aliyuncs.com/?Action=CreateSynchronizationJob
&SourceRegion=cn-hangzhou
&DestRegion=cn-hangzhou
&SynchronizationJobClass=small
&PayType=PostPaid 
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<CreateSynchronizationJobResponse>
      <SynchronizationJobId>dtshvj11k25255****</SynchronizationJobId>
      <RequestId>9056C8B0-5799-493A-9655-70F607B8****</RequestId>
      <Success>true</Success>
</CreateSynchronizationJobResponse>

Formato JSON

{
    "SynchronizationJobId": "dtshvj11k25255****",
    "RequestId": "9056C8B0-5799-493A-9655-70F607B8****",
    "Success": true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite a Central de Erros da API.