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

Configure una tarea de seguimiento de cambios.

Nota

Cuando configure una tarea de seguimiento de cambios en la consola de Data Transmission Service (DTS), pase el puntero sobre Next: Save Task Settings and Precheck en el paso Advanced Settings y haga clic en Preview OpenAPI parameters para consultar los parámetros utilizados al llamar a las operaciones de la API.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ConfigureSubscription	La operación que desea ejecutar. Establezca el valor en ConfigureSubscription.
RegionId	String	Sí	cn-hangzhou	El ID de la región donde reside la instancia de DTS. Para obtener más información, consulte Supported regions.
DtsJobName	String	Sí	MySQL Change Tracking	El nombre de la tarea de seguimiento de cambios. Nota Se recomienda especificar un nombre descriptivo para facilitar su identificación. No es necesario que el nombre sea único.
DtsInstanceId	String	No	dtsy0zz3t13h7d****	El ID de la instancia de seguimiento de cambios. Puede llamar a la operación DescribeDtsJobs para consultar el ID de la instancia.
DtsJobId	String	No	y0zz3t13h7d****	El ID de la tarea de seguimiento de cambios. Puede llamar a la operación DescribeDtsJobs para consultar el ID de la tarea.
SourceEndpointEngineName	String	No	PostgreSQL	El motor de la base de datos de origen. Valores válidos: MySQL, PostgreSQL y Oracle. Nota Si la base de datos de origen es autoadministrada, debe especificar este parámetro.
SourceEndpointInstanceType	String	No	RDS	El tipo de la base de datos de origen. Valores válidos: RDS: instancia de ApsaraDB RDS for MySQL PolarDB: clúster de PolarDB for MySQL DRDS: instancia de PolarDB-X 1.0 LocalInstance: base de datos autoadministrada con dirección IP pública ECS: base de datos autoadministrada alojada en una instancia de Elastic Compute Service (ECS) Express: base de datos autoadministrada conectada mediante Express Connect CEN: base de datos autoadministrada conectada mediante Cloud Enterprise Network (CEN) dg: base de datos autoadministrada conectada mediante Database Gateway
SourceEndpointRegion	String	No	cn-hangzhou	El ID de la región donde reside la base de datos de origen. Para obtener más información, consulte Supported regions. Nota Si la base de datos de origen es autoadministrada y cuenta con una dirección IP pública, puede establecer el valor de este parámetro en cn-hangzhou o en el ID de la región más cercana a dicha base de datos.
SourceEndpointInstanceID	String	No	rm-bp1zc3iyqe3qw****	El ID de la instancia de origen. Nota Este parámetro solo surte efecto y es obligatorio cuando la base de datos de origen es una instancia de ApsaraDB RDS for MySQL, una instancia de PolarDB-X 1.0 o un clúster de PolarDB for MySQL.
SourceEndpointIP	String	No	172.16.8.**	La dirección IP de la base de datos de origen. Nota Este parámetro solo surte efecto y es obligatorio cuando la base de datos de origen es autoadministrada.
SourceEndpointPort	String	No	3306	El número de puerto de servicio de la base de datos de origen. Nota Este parámetro solo surte efecto y es obligatorio cuando la base de datos de origen es autoadministrada.
SourceEndpointOracleSID	String	No	testsid	El identificador del sistema (SID) de la base de datos Oracle. Nota Este parámetro solo surte efecto y es obligatorio cuando la base de datos de origen es una base de datos Oracle autoadministrada que no está desplegada en la arquitectura Real Application Clusters (RAC).
SourceEndpointDatabaseName	String	No	dtstestdata	El nombre de la base de datos de origen.
SourceEndpointUserName	String	No	dtstest	La cuenta de la base de datos de la instancia de origen. Nota Los permisos necesarios para la cuenta de la base de datos varían según el escenario de seguimiento de cambios. Para obtener más información, consulte Prepare the source database account for change tracking.
SourceEndpointPassword	String	No	Test123456	La contraseña de la cuenta utilizada para conectarse a la base de datos de origen.
SourceEndpointOwnerID	String	No	140692647406****	El ID de la cuenta de Alibaba Cloud a la que pertenece la base de datos de origen. Nota Este parámetro solo surte efecto y es obligatorio cuando se realiza el seguimiento de cambios de datos entre diferentes cuentas de Alibaba Cloud.
SourceEndpointRole	String	No	ram-for-dts	El rol de Resource Access Management (RAM) asignado para acceder a la base de datos de origen. Este parámetro es obligatorio si la base de datos de origen no pertenece a la cuenta de Alibaba Cloud que utiliza para configurar la tarea de seguimiento de cambios. En este caso, debe permitir que la cuenta de Alibaba Cloud usada para configurar la tarea acceda a la base de datos de origen. Nota Para obtener más información sobre los permisos necesarios para el rol de RAM y cómo otorgarlos, consulte Configure RAM authorization for cross-account data migration and synchronization.
DbList	String	Sí	{"dtstest":{"name":"dtstest","all":true}}	Los objetos cuyo seguimiento de cambios de datos desea realizar. El valor debe ser una cadena JSON. Para obtener más información, consulte Objects of DTS tasks.
Reserve	String	No	{ "srcInstanceId": "cen-9kqshqum***" }	El parámetro reservado de DTS. El valor debe ser una cadena JSON. Puede especificar este parámetro para agregar más configuraciones de la base de datos de origen o de destino a la tarea de DTS. Por ejemplo, puede especificar el formato de almacenamiento de datos de la base de datos Kafka de destino y el ID de la instancia de CEN. Para obtener más información, consulte Reserve parameter description.
Checkpoint	String	No	1616902385	La hora a la que comienza el seguimiento de cambios de datos. El valor es una marca de tiempo UNIX que representa el número de segundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC. Nota Puede utilizar un motor de búsqueda para encontrar un convertidor de marcas de tiempo UNIX.
SubscriptionInstanceNetworkType	String	Sí	vpc	El tipo de red de la tarea de seguimiento de cambios. Establezca el valor en vpc. Un valor de vpc indica el tipo de red Virtual Private Cloud (VPC). Nota Para usar la nueva versión de la función de seguimiento de cambios, debe especificar SubscriptionInstanceNetworkType. También debe especificar SubscriptionInstanceVPCId y SubscriptionInstanceVSwitchID. Si no especifica SubscriptionInstanceNetworkType, se utilizará la versión anterior de la función de seguimiento de cambios. La versión anterior de la función de seguimiento de cambios admite bases de datos MySQL autoadministradas, instancias de ApsaraDB RDS for MySQL e instancias de PolarDB-X 1.0. La nueva versión de la función de seguimiento de cambios admite bases de datos MySQL autoadministradas, instancias de ApsaraDB RDS for MySQL, clústeres de PolarDB for MySQL y bases de datos Oracle.
SubscriptionInstanceVPCId	String	No	vpc-bp1vwnn14rqpyiczj****	El ID de la VPC en la que se despliega la instancia de seguimiento de cambios. Nota Este parámetro solo surte efecto y es obligatorio cuando SubscriptionInstanceNetworkType se establece en vpc.
SubscriptionInstanceVSwitchId	String	No	vsw-bp10df3mxae6lpmku****	El ID del vSwitch en la VPC especificada. Nota Este parámetro solo surte efecto y es obligatorio cuando SubscriptionInstanceNetworkType se establece en vpc.
SubscriptionDataTypeDDL	Boolean	No	true	Especifica si se deben rastrear sentencias DDL. Valor predeterminado: true. Valores válidos: true: rastrea sentencias DDL. false: no rastrea sentencias DDL.
SubscriptionDataTypeDML	Boolean	No	true	Especifica si se deben rastrear sentencias DML. Valor predeterminado: true. Valores válidos: true: rastrea sentencias DML. false: no rastrea sentencias DML.
DelayPhone	String	No	1361234,1371234	Los números de celular a los que se envían alertas relacionadas con la latencia. Separe varios números de celular con comas (,). Nota Este parámetro solo está disponible para usuarios del sitio de China (aliyun.com). Solo se admiten números de celular de China continental. Puede especificar hasta 10 números de celular. Los usuarios del sitio internacional (alibabacloud.com) no pueden recibir alertas mediante números de celular, pero pueden configurar reglas de alerta para tareas de DTS en la consola de CloudMonitor. Para obtener más información, consulte Configure alert rules for DTS tasks in the CloudMonitor console.
DelayRuleTime	Long	No	10	El umbral para las alertas relacionadas con la latencia. Unidad: segundos. El valor debe ser un número entero. Puede establecer el umbral según sus requisitos empresariales. Para evitar fluctuaciones causadas por sobrecargas de red y de la base de datos, se recomienda establecer el umbral en más de 10 segundos. Nota Si DelayNotice se establece en true, este parámetro es obligatorio.
DelayNotice	Boolean	No	true	Especifica si se debe supervisar la latencia de la tarea. Valores válidos: true: supervisa la latencia de la tarea. false: no supervisa la latencia de la tarea.
ErrorPhone	String	No	1361234,1371234	Los números de celular a los que se envían alertas relacionadas con el estado. Separe varios números de celular con comas (,). Nota Este parámetro solo está disponible para usuarios del sitio de China (aliyun.com). Solo se admiten números de celular de China continental. Puede especificar hasta 10 números de celular. Los usuarios del sitio internacional (alibabacloud.com) no pueden recibir alertas mediante números de celular, pero pueden configurar reglas de alerta para tareas de DTS en la consola de CloudMonitor. Para obtener más información, consulte Configure alert rules for DTS tasks in the CloudMonitor console.
ErrorNotice	Boolean	No	true	Especifica si se debe supervisar el estado de la tarea. Valores válidos: true: supervisa el estado de la tarea. false: no supervisa el estado de la tarea.
DedicatedClusterId	String	No	dtscluster_atyl3b5214uk***	El ID del clúster dedicado de DTS en el que está programada la ejecución de la tarea de seguimiento de cambios.
DtsBisLabel	String	No	normal	La etiqueta de entorno de la instancia de DTS. Valores válidos: normal online

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	String	200	El código de estado HTTP.
RequestId	String	1D6ECADF-C5E9-4C96-8811-77602B31****	El ID de la solicitud.
ErrCode	String	InternalError	El código de error devuelto si la solicitud falló.
DtsJobId	String	y0zz3t13h7d****	El ID de la tarea de seguimiento de cambios.
Success	String	true	Indica si la solicitud se realizó correctamente.
DtsInstanceId	String	dtsy0zz3t13h7d****	El ID de la instancia de seguimiento de cambios.
ErrMessage	String	The request processing has failed due to some unknown error.	El mensaje de error devuelto si la solicitud falló.

Ejemplos

Solicitudes de ejemplo

http(s)://dts.aliyuncs.com/?Action=ConfigureSubscription
&DbList={"dtstest":{"name":"dtstest","all":true}}
&DtsJobName=MySQL Change Tracking
&SourceEndpointInstanceType=RDS
&SubscriptionInstanceNetworkType=vpc
&SourceEndpointInstanceID=rm-bp1zc3iyqe3qw****
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ConfigureSubscriptionResponse>
    <DtsJobId>y0zz3t13h7d****</DtsJobId>
    <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <DtsInstanceId>dtsy0zz3t13h7d****</DtsInstanceId>
    <Success>true</Success>
</ConfigureSubscriptionResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DtsJobId" : "y0zz3t13h7d****",
  "RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
  "HttpStatusCode" : 200,
  "DtsInstanceId" : "dtsy0zz3t13h7d****",
  "Success" : true
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	Throttling.User	Request was denied due to user flow control.	Se alcanzó el límite máximo de solicitudes y la solicitud fue rechazada. Inténtelo de nuevo más tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	La respuesta del servidor agotó el tiempo de espera o el servidor no estaba disponible. Inténtelo de nuevo. Si el error persiste, póngase en contacto con el soporte técnico.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	La firma ha caducado. Utilice una nueva firma.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.