UpdateInstance - : Central de Documentação do Alibaba Cloud

Atualiza as informações de uma instância de banco de dados e verifica a conectividade da instância.

Antes de chamar esta operação, use GetInstance ou ListInstances para consultar as informações completas da instância.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta ferramenta para facilitar o processo. O OpenAPI Explorer também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	UpdateInstance	Operação a ser executada. Defina o valor como UpdateInstance.
Tid	Long	Sim	3***	ID do locatário. Use a operação GetUserActiveTenant para consultar esse ID.
InstanceType	String	Sim	mysql	Tipo do banco de dados. Para obter mais informações sobre os valores válidos, consulte Parâmetro DbType.
InstanceSource	String	Sim	ECS_OWN	Origem da instância de banco de dados. Valores válidos: PUBLIC_OWN: instância de banco de dados autogerenciada implantada na Internet. RDS: instância do ApsaraDB RDS. ECS_OWN: banco de dados autogerenciado implantado em uma instância do Elastic Compute Service (ECS). VPC_IDC: instância de banco de dados autogerenciada implantada em um data center conectado por meio de uma Virtual Private Cloud (VPC).
EnvType	String	Sim	product	Tipo de ambiente da instância de banco de dados. Valores válidos: product: ambiente de produção. dev: ambiente de desenvolvimento. pre: ambiente de staging. test: ambiente de teste. sit: ambiente de teste de integração de sistema (SIT). uat: ambiente de teste de aceitação do usuário (UAT). pet: ambiente de teste de estresse. stag: ambiente STAG.
EcsInstanceId	String	Não	i-2zei9gs1t7h8l7ac****	ID da instância ECS. Nota Especifique este parâmetro quando InstanceSource estiver definido como ECS_OWN.
VpcId	String	Não	vpc-xxx	ID da VPC. Nota Especifique este parâmetro quando InstanceSource estiver definido como VPC_IDC.
EcsRegion	String	Não	cn-hangzhou	ID da região onde a instância de banco de dados está localizada. Nota Especifique este parâmetro quando InstanceSource estiver definido como RDS, ECS_OWN ou VPC_IDC.
Host	String	Sim	192.XXX.0.56	Endereço do host usado para conectar-se à instância de banco de dados.
Port	Integer	Sim	3306	Número da porta usada para conectar-se à instância de banco de dados.
Sid	String	Não	XXX	ID do sistema (SID) da instância de banco de dados. Nota Especifique este parâmetro quando InstanceType estiver definido como ORACLE.
DatabaseUser	String	Sim	dbuser	Conta usada para fazer login no banco de dados.
DatabasePassword	String	Sim	******	Senha usada para fazer login no banco de dados.
InstanceAlias	String	Sim	instance_test	Alias da instância de banco de dados. Especifique um alias que facilite a identificação da instância no Data Management (DMS).
DbaId	String	Sim	27****	ID do usuário com a função de administrador de banco de dados (DBA) da instância. Use ListUsers ou GetInstance para consultar o ID do usuário.
SafeRuleId	String	Sim	3****	ID do conjunto de regras de segurança (GroupName) da instância de banco de dados. Use ListStandardGroups ou GetInstance para consultar o ID do conjunto de regras desejado.
QueryTimeout	Integer	Sim	60	Tempo limite para consulta de dados na instância de banco de dados.
ExportTimeout	Integer	Sim	600	Tempo limite para exportação de dados da instância de banco de dados.
DataLinkName	String	Não	datalink_test	Nome do link de banco de dados para consultas entre bancos. Nota Especifique este parâmetro quando UseDsql estiver definido como 1. O nome pode conter apenas letras minúsculas e sublinhados (_). O nome deve ser exclusivo dentro do locatário.
DdlOnline	Integer	Não	0	Define se a alteração de esquema sem bloqueio está ativada para a instância de banco de dados. Valores válidos: 0: desativa a alteração de esquema sem bloqueio. 1: prioriza o MySQL Native OnlineDDL. 2: prioriza o DMS OnlineDDL.
UseDsql	Integer	Não	0	Define se a consulta entre bancos de dados está ativada para a instância. Valores válidos: 0: desativa a consulta entre bancos de dados. 1: ativa a consulta entre bancos de dados. Nota Bancos de dados compatíveis: MySQL, SQL Server, PostgreSQL, PolarDB for Oracle e ApsaraDB for Redis.
InstanceId	String	Sim	126****	ID da instância de banco de dados. Use a operação GetInstance para consultar o ID da instância.
SkipTest	Boolean	Não	false	Define se o teste de conectividade será ignorado. Valores válidos: true: ignora o teste de conectividade. false: executa o teste de conectividade.
EnableSellSitd	String	Não	Y	Y: ativa o Sensitive Data Discovery and Protection (SDDP). N: desativa o SDDP. NULL ou outros valores: mantém o estado atual do SDDP (ativado ou desativado).
TemplateId	Long	Não	3***	ID do modelo de classificação de dados atualizado.
TemplateType	String	Não	INNER	Tipo do modelo de classificação de dados atualizado.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	E9BEBF41-4F69-4605-A5D5-A67955173941	ID da solicitação.
ErrorCode	String	UnknownError	Código de erro retornado se a solicitação falhar.
ErrorMessage	String	UnknownError	Mensagem de erro retornada se a solicitação falhar.
Success	Boolean	false	Indica se a solicitação foi bem-sucedida. Valores válidos: true: solicitação bem-sucedida. false: falha na solicitação.

Exemplos

Exemplo de solicitação

http(s)://dms-enterprise.aliyuncs.com/?Action=UpdateInstance
&<Common request parameters>

Exemplo de resposta de sucesso

Formato XML

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

<RequestId>E9BEBF41-4F69-4605-A5D5-A67955173941</RequestId>
<Success>true</Success>

Formato JSON

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

{
  "RequestId" : "E9BEBF41-4F69-4605-A5D5-A67955173941",
  "Success" : true
}

Códigos de erro

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