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

Nota

Após a alteração do banco de dados, o DTS reverte o offset de gravação incremental em 10 segundos. Se os dados sincronizados ou migrados não possuírem chave primária, garanta que nenhuma gravação ocorra no banco de dados de origem durante a substituição do banco de dados de origem ou de destino. Caso contrário, podem surgir dados duplicados.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer, que gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ModifyDtsJobEndpoint	A operação a ser executada. Defina o valor como ModifyDtsJobEndpoint.
RegionId	String	Não	cn-hangzhou	O ID da região da instância do DTS.
DtsJobId	String	Não	m4312mab158****	O ID da tarefa de sincronização ou migração de dados. Chame a operação DescribeDtsJobs para consultar o ID da tarefa. Nota DtsInstanceId é obrigatório se este parâmetro for deixado vazio.
DtsInstanceId	String	Não	dtsaw012y2g15q****	O ID da instância de sincronização ou migração de dados. Nota DtsJobId é obrigatório se este parâmetro for deixado vazio.
SynchronizationDirection	String	Não	Forward	A direção da sincronização. Valores válidos: Forward (padrão): Os dados são sincronizados do banco de dados de origem para o banco de dados de destino. Reverse: Os dados são sincronizados do banco de dados de destino para o banco de dados de origem.
Endpoint	String	Sim	src	O banco de dados a ser alterado. Valores válidos: src: o banco de dados de origem. dest: o banco de dados de destino.
EndpointRegionId	String	Não	cn-hangzhou	A região onde o banco de dados reside.
EndpointInstanceType	String	Sim	rds	O tipo do banco de dados. Valores válidos: rds: Instância do ApsaraDB RDS for MySQL ou ApsaraDB RDS for PostgreSQL. polardb: Cluster do PolarDB for MySQL ou PolarDB for PostgreSQL. mongodb: Instâncias de conjunto de réplicas do ApsaraDB for MongoDB na origem e instâncias de conjunto de réplicas ou cluster fragmentado do ApsaraDB for MongoDB no destino. distributed_mongodb: Instâncias distribuídas de cluster fragmentado do ApsaraDB for MongoDB na origem. Nota Para tarefas de sincronização ou migração incremental de dados de instâncias distribuídas, use primeiro o oplog para registrar alterações de dados no banco de dados de origem. greenplum: Instância do AnalyticDB for PostgreSQL. kafka: Instância do ApsaraMQ for Kafka. ecs: Banco de dados autogerenciado hospedado em uma instância do Elastic Compute Service (ECS). express: Banco de dados conectado via Express Connect. other: Banco de dados conectado pela Internet. Nota Os seguintes tipos de bancos de dados são suportados: MySQL, PolarDB for MySQL, PostgreSQL, PolarDB for PostgreSQL, MongoDB, Kafka e AnalyticDB for PostgreSQL. Se o banco de dados a ser alterado for um banco de dados MongoDB com arquitetura de cluster fragmentado, o novo banco de dados MongoDB deverá ter o mesmo número de shards que o banco de dados MongoDB original. Caso o banco de dados a ser alterado seja um banco de dados PostgreSQL de origem, assegure-se de que a latência da instância do DTS seja inferior a 30 segundos e que nenhum dado seja gravado no banco de dados de origem durante a alteração. Do contrário, pode ocorrer inconsistência de dados. O valor deste parâmetro não diferencia maiúsculas de minúsculas.
EndpointInstanceId	String	Não	rm-bp10k50h8374w****	O ID do banco de dados.
EndpointIp	String	Não	172.168.XX.XXX	O endereço IP do banco de dados.
EndpointPort	String	Não	3306	O número da porta do banco de dados.
ModifyAccount	Boolean	Não	false	Define se a senha da conta do banco de dados deve ser alterada. Valores válidos: true: Sim. false (padrão): Não.
Username	String	Não	dtstest	A conta do banco de dados da instância. Nota Este parâmetro é válido apenas se ModifyAccount estiver definido como true.
Password	String	Não	DTStest****	A senha da conta do banco de dados. Nota Este parâmetro é válido apenas se ModifyAccount estiver definido como true.
Database	String	Não	admin	Se o tipo do banco de dados a ser alterado for PostgreSQL, PolarDB for PostgreSQL ou AnalyticDB for PostgreSQL, defina este parâmetro como o nome do banco de dados. Se o tipo do banco de dados a ser alterado for MongoDB, defina este parâmetro como o nome do banco de dados de autenticação. Nota Este parâmetro é válido e obrigatório apenas se o tipo de banco de dados for PostgreSQL, PolarDB for PostgreSQL, AnalyticDB for PostgreSQL ou MongoDB.
ShardUsername	String	Não	shard	O nome de usuário da conta usada para fazer login na instância de cluster fragmentado do ApsaraDB for MongoDB. Nota Este parâmetro é válido e obrigatório apenas se o banco de dados de origem for uma instância de cluster fragmentado do ApsaraDB for MongoDB. Este parâmetro é válido apenas se ModifyAccount estiver definido como true.
ShardPassword	String	Não	DTStest****	A senha da conta usada para fazer login na instância de cluster fragmentado do ApsaraDB for MongoDB. Nota Este parâmetro é válido e obrigatório apenas se o banco de dados de origem for uma instância de cluster fragmentado do ApsaraDB for MongoDB. Este parâmetro é válido apenas se ModifyAccount estiver definido como true.
RoleName	String	Não	ram-for-dts	O nome da função do Resource Access Management (RAM) especificada para acessar recursos entre contas da Alibaba Cloud. Nota Este parâmetro é obrigatório para sincronizar ou migrar dados entre contas da Alibaba Cloud. Para mais informações, consulte Configurar autorização RAM para tarefas DTS entre contas.
AliyunUid	String	Não	150780020300****	O ID da conta da Alibaba Cloud à qual a instância do banco de dados pertence. Nota Se você especificar este parâmetro, os dados serão sincronizados ou migrados entre contas da Alibaba Cloud. Também é necessário especificar RoleName.
DryRun	Boolean	Não	true	Define se apenas uma pré-verificação deve ser executada. Valores válidos: true: Sim. Após a aprovação na pré-verificação, o banco de dados não é alterado. false (padrão): Não. Após a aprovação na pré-verificação, o banco de dados é alterado e a tarefa do DTS é executada.
ResourceGroupId	String	Não	rg-acfmzawhxxc****	O ID do grupo de recursos.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	String	200	O código de status HTTP.
RequestId	String	3FA98DF2-2F81-51FF-8A38-AA5112DD****	O ID da solicitação.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos:
ErrCode	String	DTS.Msg.InvalidEndpoint	O código de erro retornado se a solicitação falhar.
ErrMessage	String	The endpoint is invalid.	A mensagem de erro retornada se a solicitação falhar.

Exemplos

Exemplos de solicitações

http(s)://dts.aliyuncs.com/?Action=ModifyDtsJobEndpoint
&RegionId=cn-hangzhou
&DtsInstanceId=dtsaw012y2g15q****
&SynchronizationDirection=Forward
&Endpoint=src
&EndpointInstanceType=rds
&EndpointInstanceId=rm-bp10k50h8374w****
&Username=dtstest
&Password=DTStest****
&DryRun=true
& Common request parameters

Exemplos de respostas de sucesso

Formato XML

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

<ModifyDtsJobEndpointResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>3FA98DF2-2F81-51FF-8A38-AA5112DD****</RequestId>
    <Success>true</Success>
</ModifyDtsJobEndpointResponse>

Formato JSON

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

{
  "HttpStatusCode" : "200",
  "RequestId" : "3FA98DF2-2F81-51FF-8A38-AA5112DD****",
  "Success" : true
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.TagKey	The Tag.N.Key parameter is invalid.	A chave de tag especificada é inválida. Insira uma chave de tag válida.
400	InvalidParameter.TagValue	The Tag.N.Value parameter is invalid.	O valor de tag especificado é inválido. Insira um valor de tag válido.
400	InvalidParameter.Tags	The specified value of parameter Tags is not valid.	A chave de tag ou o valor de tag especificado é inválido. Insira uma chave de tag ou um valor de tag válido.
400	Missing.TagKey	You must specify the key for value %s in Tag.N.Key.	A chave de tag não foi especificada.
400	MissingParameter.TagOrResourceId	Either Tags or ResourceIds must be specified.	A tag ou o ID da instância não foi especificado.
400	NumberExceed.Tags	The maximum number of Tags is exceeded. The maximum value is 20.	O número máximo de tags foi atingido, que é 20. Exclua as tags desnecessárias.
400	NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded. The maximum value is 50.	O número máximo de IDs de instância foi atingido, que é 20. Exclua os IDs de instância desnecessários.
400	InvalidParameter.Category	The specified Category is invalid. Valid values are Custom and System.	O valor de Category é inválido. Valores válidos: Custom e System.
400	InvalidParameter.NextToken	The parameter NextToken is invalid.	O valor de NextToken é inválido. Insira um token válido.
400	InvalidParameter.ResourceType	The ResourceType parameter is invalid.	O valor de ResourceType é inválido. Defina o valor como ALIYUN::DTS::INSTANCE.
400	InvalidParameter.Scope	The specified Scope is invalid. Valid value: public, private.	O escopo especificado para visualização da tag é inválido. Valores válidos: public e private.
400	Throttling.User	Request was denied due to user flow control.	O número de solicitações atingiu o limite e a solicitação foi rejeitada. Tente novamente mais tarde.
403	Duplicate.TagKey	The Tag.N.Key contains duplicate keys.	A chave de tag especificada já existe. Exclua a chave de tag redundante.
403	NoPermission.SystemTag	You are not authorized to operate system tag because the product code is invalid.	Você não tem autorização para executar operações em valores de tag devido a um código inválido.
403	QuotaExceed.TagsPerResource	The maximum number of tags for each resource is exceeded.	O número máximo de tags foi atingido. Exclua as tags desnecessárias.
403	NoPermission.Operator	The user is not authorized to operate on the specified resource.	Você não tem autorização para executar operações no recurso especificado.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	A assinatura expirou. Use uma nova assinatura.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A resposta do servidor atingiu o tempo limite ou o servidor estava indisponível. Tente novamente. Se o erro persistir, entre em contato com o suporte técnico.

Para obter uma lista de códigos de erro, consulte Códigos de Erro.