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

Nota

Ao configurar uma tarefa de rastreamento de alterações no console do Data Transmission Service (DTS), passe o ponteiro do mouse sobre Next: Save Task Settings and Precheck na etapa Advanced Settings e clique em Preview OpenAPI parameters para visualizar os parâmetros usados nas chamadas de API.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ConfigureSubscription	A operação que você deseja executar. Defina o valor como ConfigureSubscription.
RegionId	String	Sim	cn-hangzhou	O ID da região onde a instância do DTS está localizada. Para mais informações, consulte Regiões suportadas.
DtsJobName	String	Sim	MySQL Change Tracking	O nome da tarefa de rastreamento de alterações. Nota Recomendamos especificar um nome descritivo para facilitar a identificação. Não é necessário usar um nome exclusivo.
DtsInstanceId	String	Não	dtsy0zz3t13h7d****	O ID da instância de rastreamento de alterações. Chame a operação DescribeDtsJobs para consultar o ID da instância.
DtsJobId	String	Não	y0zz3t13h7d****	O ID da tarefa de rastreamento de alterações. Chame a operação DescribeDtsJobs para consultar o ID da tarefa.
SourceEndpointEngineName	String	Não	PostgreSQL	O mecanismo do banco de dados de origem. Valores válidos: MySQL, PostgreSQL e Oracle. Nota Se o banco de dados de origem for autogerenciado, especifique este parâmetro.
SourceEndpointInstanceType	String	Não	RDS	O tipo do banco de dados de origem. Valores válidos: RDS: instância do ApsaraDB RDS for MySQL PolarDB: cluster do PolarDB for MySQL DRDS: instância do PolarDB-X 1.0 LocalInstance: banco de dados autogerenciado com endereço IP público ECS: banco de dados autogerenciado hospedado em uma instância do Elastic Compute Service (ECS) Express: banco de dados autogerenciado conectado via Express Connect CEN: banco de dados autogerenciado conectado via Cloud Enterprise Network (CEN) dg: banco de dados autogerenciado conectado via Database Gateway
SourceEndpointRegion	String	Não	cn-hangzhou	O ID da região onde o banco de dados de origem está localizado. Para mais informações, consulte Regiões suportadas. Nota Se o banco de dados de origem for autogerenciado com endereço IP público, defina o valor deste parâmetro como cn-hangzhou ou o ID da região mais próxima daquela onde o banco de dados autogerenciado reside.
SourceEndpointInstanceID	String	Não	rm-bp1zc3iyqe3qw****	O ID da instância de origem. Nota Este parâmetro entra em vigor e é obrigatório apenas quando o banco de dados de origem é uma instância do ApsaraDB RDS for MySQL, uma instância do PolarDB-X 1.0 ou um cluster do PolarDB for MySQL.
SourceEndpointIP	String	Não	172.16.8.**	O endereço IP do banco de dados de origem. Nota Este parâmetro entra em vigor e é obrigatório apenas quando o banco de dados de origem é autogerenciado.
SourceEndpointPort	String	Não	3306	O número da porta de serviço do banco de dados de origem. Nota Este parâmetro entra em vigor e é obrigatório apenas quando o banco de dados de origem é autogerenciado.
SourceEndpointOracleSID	String	Não	testsid	O ID do sistema (SID) do banco de dados Oracle. Nota Este parâmetro entra em vigor e é obrigatório apenas quando o banco de dados de origem é um banco de dados Oracle autogerenciado e não está implantado na arquitetura Real Application Clusters (RAC).
SourceEndpointDatabaseName	String	Não	dtstestdata	O nome do banco de dados de origem.
SourceEndpointUserName	String	Não	dtstest	A conta do banco de dados da instância de origem. Nota As permissões necessárias para a conta do banco de dados variam conforme o cenário de rastreamento de alterações. Para mais informações, consulte Preparar a conta do banco de dados de origem para rastreamento de alterações.
SourceEndpointPassword	String	Não	Test123456	A senha da conta usada para conectar ao banco de dados de origem.
SourceEndpointOwnerID	String	Não	140692647406****	O ID da conta Alibaba Cloud à qual o banco de dados de origem pertence. Nota Este parâmetro entra em vigor e é obrigatório apenas ao rastrear alterações de dados entre diferentes contas Alibaba Cloud.
SourceEndpointRole	String	Não	ram-for-dts	A função do Resource Access Management (RAM) atribuída para acessar o banco de dados de origem. Este parâmetro é necessário se o banco de dados de origem não pertencer à conta Alibaba Cloud usada para configurar a tarefa de rastreamento de alterações. Nesse caso, permita que a conta Alibaba Cloud usada na configuração acesse o banco de dados de origem. Nota Para mais informações sobre as permissões necessárias para a função RAM e como concedê-las, consulte Configurar autorização RAM para migração e sincronização de dados entre contas.
DbList	String	Sim	{"dtstest":{"name":"dtstest","all":true}}	Os objetos cujas alterações de dados você deseja rastrear. O valor deve ser uma string JSON. Para mais informações, consulte Objetos de tarefas DTS.
Reserve	String	Não	{ "srcInstanceId": "cen-9kqshqum***" }	O parâmetro reservado do DTS. O valor deve ser uma string JSON. Especifique este parâmetro para adicionar mais configurações do banco de dados de origem ou de destino à tarefa DTS. Por exemplo, especifique o formato de armazenamento de dados do banco de dados Kafka de destino e o ID da instância CEN. Para mais informações, consulte Descrição do parâmetro Reserve.
Checkpoint	String	Não	1616902385	O momento em que o rastreamento de alterações de dados começa. O valor é um timestamp UNIX que representa o número de segundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Nota Use um mecanismo de busca para obter um conversor de timestamp UNIX.
SubscriptionInstanceNetworkType	String	Sim	vpc	O tipo de rede da tarefa de rastreamento de alterações. Defina o valor como vpc. O valor vpc indica o tipo de rede Virtual Private Cloud (VPC). Nota Para usar a nova versão do recurso de rastreamento de alterações, especifique SubscriptionInstanceNetworkType. Também especifique SubscriptionInstanceVPCId e SubscriptionInstanceVSwitchID. Se você não especificar SubscriptionInstanceNetworkType, a versão anterior do recurso de rastreamento de alterações será usada. A versão anterior do recurso de rastreamento de alterações suporta bancos de dados MySQL autogerenciados, instâncias do ApsaraDB RDS for MySQL e instâncias do PolarDB-X 1.0. A nova versão suporta bancos de dados MySQL autogerenciados, instâncias do ApsaraDB RDS for MySQL, clusters do PolarDB for MySQL e bancos de dados Oracle.
SubscriptionInstanceVPCId	String	Não	vpc-bp1vwnn14rqpyiczj****	O ID da VPC onde a instância de rastreamento de alterações está implantada. Nota Este parâmetro entra em vigor e é obrigatório apenas quando SubscriptionInstanceNetworkType está definido como vpc.
SubscriptionInstanceVSwitchId	String	Não	vsw-bp10df3mxae6lpmku****	O ID do vSwitch na VPC especificada. Nota Este parâmetro entra em vigor e é obrigatório apenas quando SubscriptionInstanceNetworkType está definido como vpc.
SubscriptionDataTypeDDL	Boolean	Não	true	Indica se deve rastrear instruções DDL. Valor padrão: true. Valores válidos: true: rastreia instruções DDL. false: não rastreia instruções DDL.
SubscriptionDataTypeDML	Boolean	Não	true	Indica se deve rastrear instruções DML. Valor padrão: true. Valores válidos: true: rastreia instruções DML. false: não rastreia instruções DML.
DelayPhone	String	Não	1361234,1371234	Os números de celular para os quais alertas relacionados à latência são enviados. Separe vários números de celular com vírgulas (,). Nota Este parâmetro está disponível apenas para usuários do site da China (aliyun.com). Apenas números de celular da China continental são suportados. É possível especificar até 10 números de celular. Usuários do site internacional (alibabacloud.com) não podem receber alertas por números de celular, mas podem configurar regras de alerta para tarefas DTS no console do CloudMonitor. Para mais informações, consulte Configurar regras de alerta para tarefas DTS no console do CloudMonitor.
DelayRuleTime	Long	Não	10	O limiar para alertas relacionados à latência. Unidade: segundos. O valor deve ser um número inteiro. Defina o limiar com base nos requisitos do seu negócio. Para evitar oscilações causadas por sobrecarga de rede e banco de dados, recomendamos definir o limiar acima de 10 segundos. Nota Se DelayNotice estiver definido como true, este parâmetro é obrigatório.
DelayNotice	Boolean	Não	true	Indica se deve monitorar a latência da tarefa. Valores válidos: true: monitora a latência da tarefa. false: não monitora a latência da tarefa.
ErrorPhone	String	Não	1361234,1371234	Os números de celular para os quais alertas relacionados ao status são enviados. Separe vários números de celular com vírgulas (,). Nota Este parâmetro está disponível apenas para usuários do site da China (aliyun.com). Apenas números de celular da China continental são suportados. É possível especificar até 10 números de celular. Usuários do site internacional (alibabacloud.com) não podem receber alertas por números de celular, mas podem configurar regras de alerta para tarefas DTS no console do CloudMonitor. Para mais informações, consulte Configurar regras de alerta para tarefas DTS no console do CloudMonitor.
ErrorNotice	Boolean	Não	true	Indica se deve monitorar o status da tarefa. Valores válidos: true: monitora o status da tarefa. false: não monitora o status da tarefa.
DedicatedClusterId	String	Não	dtscluster_atyl3b5214uk***	O ID do cluster dedicado do DTS onde a tarefa de rastreamento de alterações está agendada para execução.
DtsBisLabel	String	Não	normal	A tag de ambiente da instância DTS. Valores válidos: normal online

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	String	200	O código de status HTTP.
RequestId	String	1D6ECADF-C5E9-4C96-8811-77602B31****	O ID da solicitação.
ErrCode	String	InternalError	O código de erro retornado se a solicitação falhar.
DtsJobId	String	y0zz3t13h7d****	O ID da tarefa de rastreamento de alterações.
Success	String	true	Indica se a solicitação foi bem-sucedida.
DtsInstanceId	String	dtsy0zz3t13h7d****	O ID da instância de rastreamento de alterações.
ErrMessage	String	The request processing has failed due to some unknown error.	A mensagem de erro retornada se a solicitação falhar.

Exemplos

Exemplos de solicitações

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>

Exemplos de respostas de sucesso

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 erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	Throttling.User	Request was denied due to user flow control.	O número de solicitações atingiu o limite superior e a solicitação foi rejeitada. Tente novamente mais tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A resposta do servidor expirou ou o servidor estava indisponível. Tente novamente. Se o erro persistir, entre em contato com o suporte técnico.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	A assinatura expirou. Use uma nova assinatura.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.