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

Registra una instancia de base de datos en DMS.

Descripción de la operación

Requisitos previos: Debe tener el rol de Administrador o Administrador de bases de datos (DBA). Puede obtener el RoleIdList mediante la API ListUsers o GetUser.

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

create

*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 obtener este ID.	3***
InstanceType	string	Sí	El tipo de base de datos. Para obtener más información, consulte Descripción del parámetro DbType.	MySQL
InstanceSource	string	Sí	El origen de la instancia de base de datos. 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 desplegada en una instancia de Elastic Compute Service (ECS). VPC_IDC: una instancia autogestionada en un centro de datos que está conectada a una Virtual Private Cloud (VPC).	RDS
NetworkType	string	Sí	El tipo de red. Valores válidos: CLASSIC: red clásica VPC: Virtual Private Cloud (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 de pruebas de integración del sistema (SIT) `uat`: entorno de pruebas de aceptación del usuario (UAT) `pet`: entorno de pruebas de rendimiento `stag`: entorno de staging	product
EcsInstanceId	string	No	El ID de la instancia de ECS. Nota Este parámetro es obligatorio si `InstanceSource` se establece en `ECS_OWN`.	i-2zei9gs1t7h8l7ac****
VpcId	string	No	El ID de la VPC. Nota Este parámetro es obligatorio si `InstanceSource` se establece en `VPC_IDC`.	vpc-xxxxxxxxxxxxxxxxxxxxx
EcsRegion	string	No	La región donde se encuentra la instancia. Nota Este parámetro es obligatorio si `InstanceSource` se establece en `RDS`, `ECS_OWN` o `VPC_IDC`.	cn-hangzhou
Host	string	Sí	El endpoint de la instancia de base de datos.	172.XX.XXX.254
Port	integer	Sí	El puerto de conexión de la instancia de base de datos.	3306
Sid	string	No	El ID del sistema (SID) de la base de datos. Nota Este parámetro es obligatorio si `InstanceType` se establece en `ORACLE`.	XXX
DatabaseUser	string	Sí	El nombre de usuario de la cuenta de la base de datos.	dmstest
DatabasePassword	string	Sí	La contraseña de la cuenta de la base de datos.	******
InstanceAlias	string	Sí	Un alias para la instancia que le ayuda a identificarla rápidamente.	测试实例
DbaUid	integer	Sí	El UID del usuario con el rol de Administrador de bases de datos (DBA) para la instancia. Puede llamar a la operación ListUsers o GetInstance para obtener este ID.	22275482072787****
SafeRule	string	Sí	El nombre del conjunto de reglas de seguridad (GroupName) para la instancia. Puede llamar a la operación ListStandardGroups o GetInstance para obtener este valor.	测试使用
QueryTimeout	integer	Sí	El periodo de tiempo de espera de la consulta, en segundos.	60
ExportTimeout	integer	Sí	El periodo de tiempo de espera de la exportación, en segundos.	600
DataLinkName	string	No	El nombre del enlace de datos para consultas entre instancias. Nota Este parámetro es obligatorio si `UseDsql` se establece en `1`. El nombre del enlace de datos solo puede contener letras minúsculas y guiones bajos (_). El nombre del enlace de datos debe ser único dentro del inquilino.	dblink_test
DdlOnline	integer	No	La estrategia para cambios de esquema sin bloqueo. Valores válidos: 0: Deshabilitado. 1: Priorizar las operaciones nativas sin bloqueo. Si una operación falla, se recurre a Data Management (DMS) para su ejecución. 2: Usar Data Management (DMS) para cambios de esquema sin bloqueo. Nota Tipos de base de datos compatibles: ApsaraDB RDS for MySQL, PolarDB for MySQL, ApsaraDB for MyBase (MySQL) y otras bases de datos compatibles con MySQL.	2
UseDsql	integer	No	Especifica si se deben habilitar las consultas entre instancias. Valores válidos: 0: Deshabilitado 1: Habilitado 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. Valores válidos: true: Omitir la prueba. false: Realizar la prueba.	true
EnableSellSitd	string	No	Y: Habilitar la protección de datos sensibles. NULL u otros valores: Deshabilitar la protección de datos sensibles.	Y
TemplateId	integer	No	El ID de la plantilla de clasificación de sensibilidad. Puede llamar a la operación ListClassificationTemplates para obtener este ID.	31***
TemplateType	string	No	El tipo de la plantilla de clasificación de sensibilidad. Puede llamar a la operación ListClassificationTemplates para obtener este valor.	INNER
DbaUidByString	string	No	Este parámetro reemplaza a `DbaUid` y admite UID no numéricos, como los UID de roles de RAM.	22275482072787****
ResourceGroup	string	No	El ID del grupo de recursos.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
RequestId	string	El ID de la solicitud.	F4E2A94B-604F-43FF-93E7-F4EE3DCF412E
ErrorCode	string	El código de error devuelto si la solicitud falla.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falla.	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": "F4E2A94B-604F-43FF-93E7-F4EE3DCF412E",
  "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.