CreateSynchronizationJob - Data Transmission Service - Centro de documentación de Alibaba Cloud

Adquiere una instancia de sincronización de datos. Después de la compra, llame a ConfigureSynchronizationJob para configurar e iniciar la tarea de sincronización.

Antes de llamar a esta operación, familiarícese con los métodos de facturación y precios de DTS.

Después de adquirir una instancia de sincronización, llame a ConfigureSynchronizationJob para configurar la tarea de sincronización. La tarea se inicia automáticamente.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma y genera código de ejemplo del SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateSynchronizationJob	La operación por ejecutar. Establezca el valor en CreateSynchronizationJob.
DestRegion	String	Sí	cn-hangzhou	El ID de región de la base de datos de destino. Para consultar los ID de región válidos, consulte la Lista de regiones compatibles. Nota Si SourceRegion está configurado como China (Hong Kong) o una región fuera de China continental, establezca DestRegion con el mismo valor.
PayType	String	Sí	PostPaid	El método de facturación de la instancia de sincronización. PrePaid: suscripción PostPaid (valor predeterminado): pay-as-you-go
SourceRegion	String	Sí	cn-hangzhou	El ID de región de la base de datos de origen. Para consultar los ID de región válidos, consulte la Lista de regiones compatibles.
SynchronizationJobClass	String	Sí	small	La especificación de la instancia de sincronización. Valores válidos: micro, small, medium y large. Nota Para consultar las pruebas de rendimiento de cada especificación, consulte Especificaciones de instancias de sincronización de datos.
RegionId	String	No	cn-hangzhou	El ID de región de la instancia de sincronización. Establezca este parámetro con el mismo valor que DestRegion.
Topology	String	No	oneway	La topología de sincronización. Valores válidos: oneway: sincronización unidireccional bidirectional: sincronización bidireccional Nota Valor predeterminado: oneway. El valor bidirectional solo es compatible cuando SourceEndpoint.InstanceType y DestinationEndpoint.InstanceType están configurados como MySQL, PolarDB o Redis.
Period	String	No	Year	El ciclo de facturación de la instancia de suscripción. Valores válidos: Year Month Nota Obligatorio solo cuando PayType está configurado como PrePaid.
UsedTime	Integer	No	1	La duración de la suscripción. Si el ciclo de facturación es Year, el rango de valores es de 1 a 5. Si el ciclo de facturación es Month, el rango de valores es de 1 a 60. Nota Obligatorio solo cuando PayType está configurado como PrePaid.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	El token de cliente que garantiza la idempotencia de la solicitud. Utilice un valor único para cada solicitud. El valor de ClientToken solo puede contener caracteres ASCII y no debe exceder los 64 caracteres de longitud.
SourceEndpoint.InstanceType	String	No	MySQL	El tipo de instancia de la base de datos de origen. Valores válidos: MySQL: instancia de ApsaraDB RDS for MySQL o base de datos MySQL autogestionada PolarDB: clúster de PolarDB for MySQL o clúster de PolarDB O Edition Redis: base de datos Redis DRDS: instancia de PolarDB-X V1.0 Nota Valor predeterminado: MySQL. Para consultar las bases de datos de origen y destino compatibles, consulte Tipos de bases de datos, tipos de sincronización inicial y topologías de sincronización.
DestinationEndpoint.InstanceType	String	No	MySQL	El tipo de instancia de la base de datos de destino. Valores válidos: MySQL: instancia de ApsaraDB RDS for MySQL o base de datos MySQL autogestionada PolarDB: clúster de PolarDB for MySQL o clúster de PolarDB O Edition Redis: base de datos Redis MaxCompute: proyecto de MaxCompute Nota Valor predeterminado: MySQL. Para consultar las bases de datos de origen y destino compatibles, consulte Tipos de bases de datos, tipos de sincronización inicial y topologías de sincronización.
networkType	String	No	Intranet	El tipo de red. Valor válido: Intranet (VPC).
AccountId	String	No	12323344****	El ID de la cuenta de Alibaba Cloud. Este parámetro está obsoleto y se eliminará en el futuro.
DBInstanceCount	Integer	No	3	Obligatorio cuando SourceEndpoint.InstanceType está configurado como DRDS. El número de instancias RDS privadas asociadas a la instancia de PolarDB-X de origen. Valor predeterminado: 1.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
ErrCode	String	InternalError	El código de error devuelto cuando la llamada falla.
ErrMessage	String	The request processing has failed due to some unknown error.	El mensaje de error devuelto cuando la llamada falla.
RequestId	String	9056C8B0-5799-493A-9655-70F607B8****	El ID de la solicitud.
Success	String	true	Indica si la solicitud se completó correctamente.
SynchronizationJobId	String	dtshvj11k25255****	El ID de la instancia de sincronización de datos.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

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 error

Para consultar la lista de códigos de error, visite el Centro de errores de API.