UpdateInstance - Data Management - Centro de documentación de Alibaba Cloud

Actualiza la información de una instancia de base de datos y verifica la conectividad de la instancia de base de datos.

Descripción de la operación

Antes de llamar a la operación UpdateInstance, llame a la operación GetInstance o ListInstances para obtener la información completa sobre la instancia.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:UpdateInstance

update

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant para consultar el ID del inquilino.	3***
InstanceType	string	Sí	El tipo de base de datos. Para obtener más información sobre los valores válidos de este parámetro, consulte Parámetro DbType.	mysql
InstanceSource	string	Sí	El origen de la instancia de base de datos. Valores válidos: PUBLIC_OWN: una instancia de base de datos autogestionada que está desplegada en Internet RDS: una instancia de ApsaraDB RDS ECS_OWN: una base de datos autogestionada que está desplegada en una instancia de Elastic Compute Service (ECS) VPC_IDC: una instancia de base de datos autogestionada que está desplegada en un centro de datos conectado a través de una nube privada virtual (VPC)	ECS_OWN
EnvType	string	Sí	El tipo de entorno en el que está desplegada la instancia de base de datos. Valores válidos: product: entorno de producción dev: entorno de desarrollo pre: entorno de prelanzamiento test: entorno de pruebas sit: entorno de prueba de integración del sistema (SIT) uat: entorno de prueba de aceptación del usuario (UAT) pet: entorno de prueba de estrés stag: entorno de preparación Valores válidos: product : product. pre : pre. dev : dev. test : test.	product
EcsInstanceId	string	No	El ID de la instancia de ECS en la que está desplegada la instancia de base de datos. Nota Este parámetro es obligatorio si el parámetro InstanceSource se establece en ECS_OWN.	i-2zei9gs1t7h8l7ac****
VpcId	string	No	El ID de la VPC a la que pertenece la instancia de base de datos. Nota Este parámetro es obligatorio si el parámetro InstanceSource se establece en VPC_IDC.	vpc-xxx
EcsRegion	string	No	El ID de la región en la que reside la instancia de base de datos. Nota Este parámetro es obligatorio si InstanceSource se establece en RDS, ECS_OWN o VPC_IDC.	cn-hangzhou
Host	string	Sí	La dirección del host que se utiliza para conectarse a la instancia de base de datos.	192.XXX.0.56
Port	integer	Sí	El puerto que se utiliza para conectarse a la instancia de base de datos.	3306
Sid	string	No	El ID del sistema (SID) de la instancia de base de datos. Nota Este parámetro es obligatorio si el parámetro InstanceType se establece en ORACLE.	XXX
DatabaseUser	string	Sí	La cuenta que se utiliza para iniciar sesión en la base de datos.	dbuser
DatabasePassword	string	Sí	La contraseña que se utiliza para iniciar sesión en la base de datos.	******
InstanceAlias	string	Sí	El alias de la instancia de base de datos. Especifique un alias que le ayude a identificar la instancia de base de datos en DMS.	instance_test
DbaId	string	Sí	El ID del usuario que asume el rol de administrador de bases de datos (DBA) de la instancia de base de datos. Puede llamar a la operación ListUsers o GetInstance para consultar el ID del usuario.	27****
SafeRuleId	string	Sí	El nombre del conjunto de reglas de seguridad (GroupName) para la instancia. Puede llamar a la operación ListStandardGroups o GetInstance para consultar el nombre del conjunto de reglas de seguridad.	3****
QueryTimeout	integer	Sí	El periodo de tiempo de espera para consultar datos en la instancia de base de datos.	60
ExportTimeout	integer	Sí	El periodo de tiempo de espera para exportar datos desde la instancia de base de datos.	600
DataLinkName	string	No	El nombre del vínculo de base de datos para consultas entre bases de datos. Nota Este parámetro es obligatorio si UseDsql se establece en 1. El nombre solo puede contener letras minúsculas y guiones bajos (_). El nombre debe ser único dentro de un inquilino.	datalink_test
DdlOnline	integer	No	Especifica si se debe habilitar la función de cambio de esquema sin bloqueo para la instancia de base de datos. Valores válidos: 0: deshabilita la función de cambio de esquema sin bloqueo. 1: utiliza primero el DDL en línea de MySQL. 2: utiliza primero la función de cambio de esquema sin bloqueo de DMS.	0
UseDsql	integer	No	Especifica si se debe habilitar la función de consulta entre bases de datos para la instancia de base de datos. Valores válidos: 0: deshabilita la función de consulta entre bases de datos. 1: habilita la función de consulta entre bases de datos. Nota Tipos de base de datos compatibles: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible con Oracle) y ApsaraDB for Redis.	0
InstanceId	string	Sí	El ID de la instancia de base de datos. Puede llamar a la operación GetInstance para consultar el ID de la instancia.	126****
SkipTest	boolean	No	Especifica si se debe omitir la prueba de conectividad. Valores válidos: true: omite la prueba de conectividad false: no omite la prueba de conectividad	false
EnableSellSitd	string	No	Y: habilita la función de protección de datos confidenciales N: deshabilita la función de protección de datos confidenciales NULL u otro: no actualiza el estado de la función de protección de datos confidenciales	Y
TemplateId	integer	No	El ID de la plantilla de clasificación. Puede llamar a la operación ListClassificationTemplates para consultar el ID de la plantilla.	3***
TemplateType	string	No	El tipo de plantilla de clasificación. Puede llamar a la operación ListClassificationTemplates para consultar el tipo de plantilla.	INNER

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	E9BEBF41-4F69-4605-A5D5-A67955173941
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	false

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "E9BEBF41-4F69-4605-A5D5-A67955173941",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": false
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.