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

Registra una instancia de base de datos en Data Management Service (DMS) y habilita el alojamiento seguro para la instancia.

Descripción de la operación

Su rol del sistema debe ser DBA o administrador. Para ver su rol del sistema, consulte Ver mi rol del sistema.

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:AddInstance

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID de inquilino. Nota Puede encontrar el ID de inquilino al pasar el cursor sobre el ícono de perfil en la esquina superior derecha de la consola de DMS.	23****
InstanceType	string	Sí	El tipo de base de datos. Para consultar los valores válidos, vea Descripción del parámetro DbType.	MySQL
InstanceSource	string	Sí	El origen de la instancia. Valores válidos: PUBLIC_OWN: una instancia autogestionada conectada a través de Internet. RDS: una instancia de ApsaraDB RDS. ECS_OWN: una instancia autogestionada en una instancia de ECS. VPC_IDC: una instancia autogestionada en un IDC conectado a VPC. GATEWAY: una instancia de Database Gateway.	RDS
NetworkType	string	Sí	El tipo de red. Valores válidos: CLASSIC: red clásica. VPC: red VPC.	VPC
EnvType	string	Sí	El tipo de entorno. Valores válidos: product: entorno de producción. dev: entorno de desarrollo. pre: entorno de prelanzamiento. test: entorno de pruebas. sit: entorno SIT. uat: entorno UAT. pet: entorno de pruebas de estrés. stag: entorno STAG.	product
EcsInstanceId	string	No	El ID de la instancia. Por ejemplo, si su instancia es una instancia de Database Gateway, ingrese el ID de la puerta de enlace. Nota Este parámetro es obligatorio si InstanceSource se establece en ECS_OWN o GATEWAY.	i-2zei9gs1t7h8l7ac****
VpcId	string	No	El ID de instancia de la VPC. Nota Este parámetro es obligatorio si InstanceSource se establece en VPC_IDC.	vpc-2zef4o1hu7ljd****
EcsRegion	string	No	La región en la que reside la instancia. Nota Este parámetro es obligatorio si InstanceSource se establece en RDS, ECS_OWN, GATEWAY o VPC_IDC.	cn-hangzhou
Host	string	Sí	La dirección de conexión de la base de datos.	rm-bp1g3tf90******.sqlserver.rds.aliyuncs.com
Port	integer	Sí	El puerto de conexión de la base de datos.	3306
Sid	string	No	El SID de la instancia. Nota Este parámetro es obligatorio si InstanceType se establece en ORACLE.	testSid
DatabaseUser	string	No	La cuenta de la base de datos.	testsdb
DatabasePassword	string	No	La contraseña de la base de datos.	test***
InstanceAlias	string	Sí	El alias de la instancia, que le ayuda a identificar rápidamente la instancia.	Instancia de prueba
DbaId	integer	Sí	El ID de usuario del DBA de la instancia. Puede llamar a la operación ListUsers o GetInstance para obtener este valor.	27****
QueryTimeout	integer	Sí	El periodo de tiempo de espera de la consulta. Unidad: segundos.	7200
ExportTimeout	integer	Sí	El periodo de tiempo de espera de la exportación. Unidad: segundos.	86400
EnableSellTrust	string	Sí	Especifica si se debe habilitar el alojamiento seguro para la instancia. Valores válidos: Y: Habilitar el modo de alojamiento seguro. N: No habilitar el modo de alojamiento seguro.	Y
EnableSellStable	string	No	Especifica si se debe habilitar la función de cambio estable para la instancia. Valores válidos: Y: Habilitar. N: No habilitar.	N
EnableSellCommon	string	No	Especifica si se debe habilitar la función de colaboración segura para la instancia. Valores válidos: Y: Habilitar. N: No habilitar.	Y
SafeRule	string	No	Si desea habilitar la función de colaboración segura, debe especificar el conjunto de reglas de seguridad (GroupName) para la instancia. Puede llamar a la operación ListStandardGroups o GetInstance para obtener este valor.	Finance-Production
EnableSellSitd	string	No	Especifica si se debe habilitar la función de protección de datos sensibles para la instancia. Valores válidos: Y: Habilitar. N: No habilitar.	Y
DataLinkName	string	No	El nombre del vínculo de datos de consulta entre bases de datos. Nota Este parámetro es obligatorio si UseDsql se establece en 1. El nombre del DBLink solo puede contener letras minúsculas y guiones bajos (_). El nombre del DBLink debe ser único globalmente dentro del inquilino.	dblink_test
DdlOnline	integer	No	Especifica si se prioriza el cambio de estructura de DMS. Valores válidos: 0: No usar. 1: Online DDL nativo tiene prioridad. 2: El cambio de estructura sin bloqueo de DMS tiene prioridad. Nota Tipos de base de datos compatibles: ApsaraDB RDS for MySQL, PolarDB for MySQL, MyBase for MySQL y otros orígenes MySQL.	2
UseDsql	integer	No	Especifica si se debe habilitar la consulta entre instancias. Valores válidos: 0: Deshabilitar. 1: Habilitar. Nota Tipos de base de datos compatibles: MySQL, SQL Server, PostgreSQL, PolarDB for PostgreSQL (compatible con Oracle) y Redis.	1
SkipTest	boolean	No	Especifica si se debe omitir la prueba de conectividad para la instancia. Valores válidos: true: Omitir. false: No omitir.	false
TemplateId	integer	No	El ID de la plantilla de clasificación de datos. Puede llamar a la operación ListClassificationTemplates para obtener este valor.	31***
TemplateType	string	No	El tipo de plantilla de categorización. Puede llamar a la operación ListClassificationTemplates para obtener este valor.	INNER
UseSsl	integer	No	Especifica si se debe habilitar la conexión SSL. Una vez habilitado SSL, DMS se conecta a la base de datos mediante SSL. La base de datos debe tener SSL habilitado antes de utilizar este parámetro. Valores válidos: 0: Valor predeterminado (DMS y el servicio de base de datos negocian automáticamente si se habilita SSL). El sistema identifica automáticamente si la base de datos destino tiene SSL habilitado. Si SSL está habilitado, DMS se conecta a la base de datos mediante SSL. De lo contrario, DMS se conecta mediante un método regular. 1: Habilitar conexión SSL. Si la base de datos no tiene SSL habilitado, este parámetro no surte efecto. -1: Deshabilitar conexión SSL. Nota Este elemento de configuración solo está disponible cuando el tipo de base de datos es MySQL o Redis. SSL (Secure Sockets Layer) cifra las conexiones de red en la capa de transporte, lo que mejora la seguridad e integridad de los datos de comunicación, pero aumenta el tiempo de respuesta de la conexión de red.	0
RoleArn	string	No	El ARN del rol autorizado en la cuenta destino, utilizado para el registro entre inquilinos.	acs:ram::1760865*********:role/dms-role-arn
LoginType	integer	No	0: inicio de sesión con nombre de usuario y contraseña. 1: solo contraseña (Redis). 2: inicio de sesión sin contraseña (Redis).	0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Puede utilizar este ID para localizar registros y solucionar problemas.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	El código de error.	UnknownError
ErrorMessage	string	El mensaje de error.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

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.