Descripción general de la API - Data Management - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (dms-enterprise/2018-11-01) utiliza el estilo de firma RPC. Se han encapsulado SDK para los lenguajes de programación más comunes con el fin de facilitar el desarrollo. Los desarrolladores pueden descargar el SDK para invocar directamente la OpenAPI de este producto sin preocuparse por los detalles técnicos. Si el SDK existente no satisface sus necesidades, utilice el mecanismo de firma para una integración con autofirma. Dado que los detalles de la autofirma son muy complejos, este proceso puede tardar alrededor de 5 días hábiles. Por lo tanto, se recomienda unirse a nuestro grupo de servicio de DingTalk (147535001692) para llevar a cabo la integración de firmas bajo la guía de expertos.

Antes de usar la API, prepare su cuenta de identidad y su clave de acceso (AccessKey) para acceder eficazmente a la API mediante herramientas cliente (como SDK y CLI). Para obtener más información, consulte Obtener un AccessKey.

Escenarios de firma personalizada

Si su escenario empresarial tiene requisitos especiales y necesita integrar la API mediante autofirma, se recomienda consultar primero a nuestro equipo de soporte técnico (grupo de servicio de DingTalk: 147535001692) para obtener orientación profesional y garantizar una integración eficiente.

Preparación de cuenta y seguridad

Las cuentas de Alibaba Cloud tienen permisos administrativos completos sobre todos los recursos. Si un AccessKey se ve comprometido, todos los recursos asociados corren el riesgo de sufrir accesos no autorizados. Para garantizar la seguridad, se recomienda crear un RAM user con permisos de acceso exclusivos a la API y configurar su AccessKey, además de establecer directivas de RAM basadas en el principio de menor privilegio (PoLP). Utilice la cuenta de Alibaba Cloud únicamente en escenarios específicos donde se requieran explícitamente sus permisos.

Gestión de usuarios

API	Título	Descripción
DeleteUser	DeleteUser.	Elimina una cuenta de Alibaba Cloud que ya no se utiliza.
UpdateUser	UpdateUser.	Actualiza la información del usuario.
DisableUser	DisableUser.	Deshabilita un usuario que no se utiliza temporalmente en Data Management (DMS).
EnableUser	EnableUser.	Habilita un usuario que está deshabilitado.
ListUsers	ListUsers.	Consulta los detalles de los usuarios.
GetUser	GetUser.	Consulta la información de un usuario.
GetUserActiveTenant	GetUserActiveTenant.	Consulta los detalles del inquilino activo.
ListUserTenants	ListUserTenants	Consulta los inquilinos.
RegisterUser	RegisterUser.	Agrega un usuario de su empresa.

Gestión de instancias

API	Título	Descripción
AddInstance	Registrar una instancia de base de datos.	Registra una instancia de base de datos en Data Management Service (DMS) y habilita el alojamiento seguro para la instancia.
ModifyInstance	Modificar información de la instancia.	Modifica la información básica de una instancia, como el modo de gestión, las credenciales de la base de datos y los paquetes de funciones, así como información avanzada como el tipo de entorno, el nombre de la instancia en DMS y los tiempos de espera para consultar y exportar datos.
ListInstances	Obtener lista de instancias.	Obtiene una lista de instancias.
GetInstance	GetInstance.	Obtiene los detalles de una instancia especificada.
DeleteInstance	DeleteInstance.	Elimina una instancia de base de datos de Data Management (DMS).
RegisterInstance	RegisterInstance.	Registra una instancia de base de datos en DMS.
UpdateInstance	UpdateInstance.	Actualiza la información de una instancia de base de datos y verifica la conectividad de la instancia de base de datos.

Auditoría de operaciones

API	Título	Descripción
GetOpLog	GetOpLog.	Consulta los detalles de los registros de operaciones generados en un período de tiempo especificado.
ListInstanceLoginAuditLog	ListInstanceLoginAuditLog.	Consulta los registros de inicio de sesión de una instancia.
ListProxySQLExecAuditLog	ListProxySQLExecAuditLog.	Consulta los registros de auditoría generados por la función de proxy de acceso seguro.
ListSQLExecAuditLog	ListSQLExecAuditLog.	Consulta los registros de auditoría de las sentencias SQL que se ejecutan en Data Management (DMS).

Flujos de trabajo de aprobación

API	Título	Descripción
ListWorkFlowTemplates	ListWorkFlowTemplates.	Consulta las plantillas de aprobación.
ListWorkFlowNodes	ListWorkFlowNodes.	Consulta los nodos de aprobación.
SetWorkflowExtraInfo	SetWorkflowExtraInfo.	Configura si los botones de operación, como Agree, Revoke y Sign, se muestran en la sección de aprobación de tickets de la consola de DMS.

Metadatos de bases de datos y tablas

API	Título	Descripción
Bases de datos y tablas lógicas	Bases de datos y tablas lógicas
CreateLogicDatabase	Crear una base de datos lógica.	Crea una base de datos lógica de DMS.
AddLogicTableRouteConfig	AddLogicTableRouteConfig.	Agrega un algoritmo de enrutamiento a una tabla lógica.
DeleteLogicDatabase	DeleteLogicDatabase.	Elimina una base de datos lógica de Data Management (DMS). Esta operación solo elimina la base de datos lógica especificada, pero no elimina las bases de datos físicas.
DeleteLogicTableRouteConfig	DeleteLogicTableRouteConfig.	Elimina un algoritmo de enrutamiento de una tabla lógica.
ListLogicDatabases	ListLogicDatabases.	Consulta la información detallada de las bases de datos lógicas.
GetLogicDatabase	GetLogicDatabase.	Consulta los detalles de una base de datos lógica.
ListLogicTables	ListLogicTables.	Consulta los detalles de las tablas lógicas en una base de datos lógica.
GetDBTopology	GetDBTopology.	Consulta las topologías de una base de datos lógica y sus fragmentos de base de datos física.
GetTableDBTopology	GetTableDBTopology.	Consulta la topología de una tabla de datos.
ListLogicTableRouteConfig	ListLogicTableRouteConfig.	Consulta los algoritmos de enrutamiento de una tabla lógica.
EditLogicDatabase	Devuelve los detalles de una base de datos lógica.	Edita la información de una base de datos lógica.
Bases de datos y tablas de data lake	Bases de datos y tablas de data lake
ListDataLakeDatabase	ListDataLakeDatabase.	Consulta la lista de bases de datos en el lago de datos.
GetDataLakeDatabase	GetDataLakeDatabase.	Consulta la información de la base de datos en el lago de datos.
ListDataLakeCatalog	ListDataLakeCatalog.	Consulta una lista de catálogos de datos en un lago de datos.
GetDataLakeCatalog	GetDataLakeCatalog.	Consulta el catálogo de datos del lago de datos.
ListDataLakeTablebaseInfo	ListDataLakeTablebaseInfo.	Consulta la información básica de las tablas en el data lake.
GetDataLakeTable	GetDataLakeTable.	Consulta información básica sobre tablas en el data lake.
BatchCreateDataLakePartitions	BatchCreateDataLakePartitions.	Crea particiones de tabla de lago de datos en lotes.
UpdateDataLakeTable	UpdateDataLakeTable.	Actualiza la información de una tabla en un data lakehouse.
UpdateDataLakePartition	UpdateDataLakePartition.	Actualiza la información de partición de una tabla en un data lakehouse.
UpdateDataLakeDatabase	UpdateDataLakeDatabase.	Actualiza la información de una base de datos en un data lakehouse.
ListDataLakeTableName	ListDataLakeTableName.	Consulta una lista de nombres de tablas en un data lake.
ListDataLakeTable	ListDataLakeTable.	Consulta una lista de tablas en un data lake.
ListDataLakePartitionName	ListDataLakePartitionName.	Consulta una lista de nombres de particiones de una tabla en un data lake.
ListDataLakePartitionByFilter	ListDataLakePartitionByFilter.	Enumera las particiones de tabla de lago de datos que coinciden con una condición de filtro.
ListDataLakePartition	ListDataLakePartition.	Consulta las particiones de una tabla de data lake.
GetDataLakePartition	GetDataLakePartition.	Obtiene los detalles de una partición de tabla de lake house.
DeleteDataLakeTable	DeleteDataLakeTable.	Elimina una tabla de un data lakehouse.
DeleteDataLakePartition	DeleteDataLakePartition.	Elimina una partición de una tabla en un data lakehouse.
DeleteDataLakeDatabase	DeleteDataLakeDatabase.	Elimina una base de datos de un data lakehouse.
CreateDataLakeTable	CreateDataLakeTable.	Crea una tabla en un data lakehouse.
CreateDataLakePartition	CreateDataLakePartition.	Crea una partición para una tabla en un data lakehouse.
CreateDataLakeDatabase	CreateDataLakeDatabase.	Crea una base de datos en un data lakehouse.
BatchUpdateDataLakePartitions	BatchUpdateDataLakePartitions.	Actualiza varias particiones de una tabla en un data lakehouse a la vez.
BatchDeleteDataLakePartitions	BatchDeleteDataLakePartitions.	Elimina varias particiones de una tabla en un data lakehouse a la vez.
CreateDataLakeFunction	CreateDataLakeFunction.	Llama a esta API para crear una nueva función definida por el usuario del lago de datos.
GetDataLakeFunction	GetDataLakeFunction.	Llama a esta API para obtener los detalles de una función definida por el usuario del data lake.
UpdateDataLakeFunction	UpdateDataLakeFunction.	Actualiza una función definida por el usuario en un data lakehouse.
DeleteDataLakeFunction	DeleteDataLakeFunction.	Elimina una función definida por el usuario en un data lakehouse.
ListDataLakeFunction	ListDataLakeFunction.	Consulta las funciones del lago de datos.
ListDataLakeFunctionName	ListDataLakeFunctionName.	Obtiene una lista de nombres de funciones de data lake.
SearchDatabase	SearchDatabase.	Detalles del índice.
SearchTable	SearchTable.	Consulta información detallada sobre tablas.
ListDatabases	ListDatabases.	Invoca ListDatabases para obtener la lista de bases de datos de una instancia.
ListTables	ListTables.	Enumera los detalles de todas las tablas en una base de datos.
ListTableColumns	ListTableColumns.	Consulta los detalles de los campos de una tabla.
ListColumns	ListColumns.	Devuelve la información de las columnas de una tabla.
ListIndexes	ListIndexes.	Consulta los índices de una tabla.
GetDatabase	Obtener información detallada sobre una base de datos específica.	Obtiene los detalles de una base de datos especificada.
GetPhysicalDatabase	GetPhysicalDatabase.	Consulta los detalles de una base de datos física.
GetTableTopology	GetTableTopology.	Consulta la topología de una tabla.
GetMetaTableDetailInfo	GetMetaTableDetailInfo.	Llama a la operación GetMetaTableDetailInfo para obtener detalles sobre una tabla, como sus campos e índices.
GetMetaTableColumn	GetMetaTableColumn.	Consulta los detalles de las columnas de una tabla.
SyncInstanceMeta	SyncInstanceMeta.	Sincroniza los metadatos de todas las bases de datos en una instancia de base de datos.
SyncDatabaseMeta	Sincronizar metadatos de base de datos.	Sincroniza los metadatos de una base de datos.
GetTableKnowledgeInfo	GetTableKnowledgeInfo.	Obtiene el conocimiento de metadatos para un GUID especificado.
EditMetaKnowledgeAsset	EditMetaKnowledgeAsset.	Edita el conocimiento empresarial de metadatos para los GUID especificados.

Operaciones de tickets

API	Título	Descripción
General	General
CreateOrder	Crear un ticket.	Crea un ticket.
GetApprovalDetail	GetApprovalDetail.	Consulta los detalles de aprobación de un ticket.
ListOrders	ListOrders.	Puede llamar a ListOrders para obtener una lista de tickets.
GetOrderBaseInfo	GetOrderBaseInfo.	Consulta la información básica de un ticket.
SubmitOrderApproval	SubmitOrderApproval.	Envía un ticket para su aprobación.
ApproveOrder	ApproveOrder.	Revisa un ticket.
CloseOrder	CloseOrder.	Cierra un ticket.
GetOrderAttachmentFile	GetOrderAttachmentFile.	Consulta la URL de descarga del archivo adjunto de un ticket.
PreviewWorkflow	PreviewWorkflow.	Obtiene una vista previa del proceso de aprobación de un ticket antes de que se envíe.
Solicitudes de permisos	Solicitudes de permisos
GetOwnerApplyOrderDetail	GetOwnerApplyOrderDetail.	Consulta los detalles de los tickets de Database-OWNER, Table-OWNER e Instance-OWNER.
GetPermApplyOrderDetail	Obtención de los detalles de un ticket para solicitar permisos de operación.	Invoca GetPermApplyOrderDetail para obtener los detalles del ticket de una solicitud de permisos.
Sincronización de bases de datos y tablas	Sincronización de bases de datos y tablas
CreateStructSyncOrder	CreateStructSyncOrder.	Crea un ticket de sincronización de esquemas.
GetStructSyncOrderDetail	GetStructSyncOrderDetail.	Consulta los detalles de un ticket de sincronización de esquemas.
GetStructSyncJobDetail	GetStructSyncJobDetail.	Consulta la información de una tarea de sincronización de esquemas.
GetStructSyncJobAnalyzeResult	GetStructSyncJobAnalyzeResult.	Consulta el resultado del análisis de una tarea de sincronización de esquemas.
GetStructSyncExecSqlDetail	GetStructSyncExecSqlDetail.	Consulta las sentencias SQL involucradas en un ticket de sincronización de esquemas.
SubmitStructSyncOrderApproval	SubmitStructSyncOrderApproval.	Envía un ticket de sincronización de esquema para su aprobación.
ExecuteStructSync	ExecuteStructSync.	Ejecuta una tarea de sincronización de esquemas.
Cambios de datos	Cambios de datos
CreateDataCorrectOrder	CreateDataCorrectOrder.	Crea un ticket para cambiar datos en Data Management (DMS).
CreateDataCronClearOrder	Crear un ticket de limpieza de datos históricos.	Crea un ticket de limpieza de datos históricos.
CreateDataImportOrder	Crear un ticket de importación de datos.	Crea un ticket de importación de datos.
CreateFreeLockCorrectOrder	Create a lockless change ticket	Crea un ticket de cambio sin bloqueo.
ModifyDataCorrectExecSQL	Modificar el script SQL de un ticket de cambio de datos.	Modifica el script SQL enviado en un ticket de cambio de datos.
PauseDataCorrectSQLJob	PauseDataCorrectSQLJob.	Pausa una tarea de SQL para cambio de datos.
GetDataCorrectTaskDetail	GetDataCorrectTaskDetail.	Consulta la información sobre una tarea de cambio de datos, cambio de datos sin bloqueo o importación de datos.
GetDataCronClearTaskDetailList	GetDataCronClearTaskDetailList.	Consulta los detalles de un ticket histórico de limpieza de datos.
GetDataCorrectRollbackFile	GetDataCorrectRollbackFile.	Consulta la URL de descarga del archivo adjunto de reversa enviado junto con un ticket de cambio de datos.
GetDataCorrectBackupFiles	Obtener la URL de descarga del archivo de respaldo.	Obtiene la URL de descarga del archivo de respaldo para un ticket de cambio de datos.
GetDataCorrectOrderDetail	GetDataCorrectOrderDetail.	Consulta la información sobre un ticket de cambio de datos en Data Management (DMS).
GetDataCronClearConfig	GetDataCronClearConfig.	Consulta la configuración de programación de un ticket para limpiar datos históricos.
GetDataCorrectSQLFile	GetDataCorrectSQLFile.	Consulta la URL de descarga del script SQL para una tarea de cambio de datos.
ListDataCorrectPreCheckSQL	ListDataCorrectPreCheckSQL.	Consulta la información sobre las sentencias SQL involucradas en la verificación previa de un ticket de cambio de datos.
ListDataCorrectPreCheckDB	ListDataCorrectPreCheckDB.	Consulta las bases de datos involucradas en la verificación previa de un ticket de cambio de datos.
ExecuteDataCorrect	ExecuteDataCorrect.	Ejecuta un ticket de cambio de datos.
RetryDataCorrectPreCheck	Volver a ejecutar la verificación previa de un ticket de cambio de datos.	Vuelve a ejecutar el paso de verificación previa de un ticket de cambio de datos.
RestartDataCorrectSQLJob	Reintentar un trabajo SQL de cambio de datos fallido.	Reintenta un trabajo SQL de cambio de datos que ya falló en su ejecución.
ListDataImportSQLPreCheckDetail	Consultar detalles de la preverificación de SQL de importación de datos.	Consulta la información de preverificación de las sentencias SQL utilizadas para la importación de datos en un ticket.
ListDataImportSQLType	ListDataImportSQLType.	Consulta los tipos de sentencias SQL utilizadas para la importación de datos en un ticket.
GetDataImportSQL	GetDataImportSQL.	Consulta las sentencias SQL utilizadas para la importación de datos en un ticket.
SkipDataCorrectRowCheck	Omitir la validación del recuento de filas en la verificación previa de cambio de datos.	Omite la validación del recuento de filas en la verificación previa de cambio de datos.
CreateProcCorrectOrder	CreateProcCorrectOrder.	Crea un ticket de objeto programable.
Diseño de esquemas	Diseño de esquemas
CreatePublishGroupTask	CreatePublishGroupTask.	Ejecuta un ticket de diseño de esquema.
ListDDLPublishRecords	ListDDLPublishRecords.	Consulta los detalles de publicación de un ticket de diseño de esquema.
GetTableDesignProjectFlow	GetTableDesignProjectFlow.	Consulta la información sobre un ticket de diseño de esquema, como el nodo actual del ticket, si el ticket puede devolverse al nodo de diseño de esquema y la estrategia de publicación.
GetTableDesignProjectInfo	GetTableDesignProjectInfo.	Consulta la información sobre el proyecto y la base de datos de referencia de cambios de un ticket de diseño de esquema, como el estado del ticket, el ID del usuario que creó el ticket, y el nombre y el ID de la base de datos de referencia de cambios.
Exportación de datos	Exportación de datos
CreateDatabaseExportOrder	CreateDatabaseExportOrder.	Crea un ticket de exportación de base de datos.
CreateDataExportOrder	CreateDataExportOrder.	Crea un ticket para exportar un conjunto de resultados SQL.
ExecuteDataExport	ExecuteDataExport.	Ejecuta un ticket de exportación de datos.
GetDataExportPreCheckDetail	GetDataExportPreCheckDetail.	Consulta los detalles de la verificación previa de un ticket de exportación de conjunto de resultados SQL.
GetDataExportDownloadURL	GetDataExportDownloadURL.	Consulta la URL de descarga de los resultados de exportación para un ticket de exportación de datos.
GetDatabaseExportOrderDetail	GetDatabaseExportOrderDetail.	Consulta los detalles de un ticket de exportación de base de datos.
GetDataExportOrderDetail	GetDataExportOrderDetail.	Consulta la información de un ticket de exportación de datos.
GetDbExportDownloadURL	GetDbExportDownloadURL.	Consulta la URL de descarga de los resultados de un ticket de exportación de base de datos.
SuspendDataExportJob	SuspendDataExportJob.	Suspende una tarea de exportación de conjuntos de resultados SQL en curso o programada.
PauseDataExportJob	Pausar un trabajo de exportación de datos.	Finaliza una tarea de exportación de conjunto de resultados SQL.
RemoveDataExportJob	RemoveDataExportJob.	Elimina una tarea de exportación de datos.
RestartDataExportJob	RestartDataExportJob.	Reinicia una tarea de exportación de conjunto de resultados SQL.
Revisión de SQL	Revisión de SQL
CreateSQLReviewOrder	Crear un ticket de revisión de SQL.	Crea un ticket de revisión de SQL.
GetSQLReviewCheckResultStatus	GetSQLReviewCheckResultStatus.	Consulta el resultado de una revisión de SQL.
ListSQLReviewOriginSQL	ListSQLReviewOriginSQL.	Consulta los detalles de las sentencias SQL involucradas en un ticket de revisión de SQL.
GetSQLReviewOptimizeDetail	GetSQLReviewOptimizeDetail.	Consulta los detalles de las sugerencias de optimización. La operación solo se aplica a los tickets para cambios de datos y revisión de SQL.
Seguimiento de datos	Seguimiento de datos
CreateDataTrackOrder	Crear un ticket de seguimiento de datos.	Crea un ticket de seguimiento de datos.
GetDataTrackJobDegree	GetDataTrackJobDegree.	Consulta el progreso de una tarea de seguimiento de datos.
GetDataTrackJobTableMeta	GetDataTrackJobTableMeta.	Consulta los metadatos de las tablas involucradas en una tarea de seguimiento de datos.
GetDataTrackOrderDetail	GetDataTrackOrderDetail.	Consulta los detalles de un ticket de seguimiento de datos.
SearchDataTrackResult	SearchDataTrackResult.	Busca el resultado de análisis de una tarea de rastreo de datos.
DownloadDataTrackResult	DownloadDataTrackResult.	Descarga el resultado de análisis de una tarea de seguimiento de datos.
QueryDataTrackResultDownloadStatus	QueryDataTrackResultDownloadStatus.	Consulta el progreso de descarga y análisis de los registros de seguimiento de datos.
Carga de archivos adjuntos	Carga de archivos adjuntos
CreateUploadFileJob	CreateUploadFileJob.	Crea una tarea para cargar un archivo adjunto.
CreateUploadOSSFileJob	CreateUploadOSSFileJob.	Crea una tarea para cargar un archivo de Object Storage Service (OSS) y obtener la clave de la tarea.
GetUserUploadFileJob	GetUserUploadFileJob.	Obtiene la información de una tarea de carga de archivos.
Archivado de datos	Archivado de datos
CreateDataArchiveOrder	CreateDataArchiveOrder.	Crea un ticket de archivado de datos para archivar información en destinos como espacio de almacenamiento dedicado o instancias de ApsaraDB RDS for MySQL.
GetDataArchiveOrderDetail	GetDataArchiveOrderDetail.	Consulta los detalles de un ticket de archivado de datos, incluida la hora en que se creó el ticket, la información de programación de la tarea de archivado de datos, los registros de la tarea de archivado de datos y la base de datos en la que se archivan los datos.
GetDataArchiveCount	GetDataArchiveCount.	Consulta las estadísticas sobre la cantidad de tickets de archivado de datos, incluida la cantidad de tickets de archivado de datos exitoso, fallido y en curso, así como el número total de tickets de archivado de datos.
GetPagedInstance	GetPagedInstance.	Consulta la información de la tarea de un ticket.

Tareas de SQL

API	Título	Descripción
ListDBTaskSQLJob	ListDBTaskSQLJob.	Consulta una lista de tareas SQL.
ListDBTaskSQLJobDetail	ListDBTaskSQLJobDetail.	Obtiene los detalles de la tarea SQL.
GetDBTaskSQLJobLog	GetDBTaskSQLJobLog.	Consulta el registro que detalla la programación de una tarea SQL.
GetOnlineDDLProgress	GetOnlineDDLProgress.	Consulta los detalles y el progreso de una tarea OnlineDDL.

Gestión de permisos

API	Título	Descripción
SetOwners	SetOwners.	Configura el propietario de una instancia, una base de datos o una tabla.
ListInstanceUserPermissions	ListInstanceUserPermissions.	Consulta los permisos de un usuario en una instancia.
ListDatabaseUserPermssions	ListDatabaseUserPermssions.	Consulta los permisos de los usuarios en una base de datos.
ListUserPermissions	ListUserPermissions.	Consulta los permisos de un usuario sobre bases de datos y tablas.
GrantUserPermission	GrantUserPermission.	Otorga permisos sobre una instancia, una base de datos o una tabla a un usuario.
RevokeUserPermission	RevokeUserPermission.	Revoca los permisos sobre instancias, bases de datos y tablas de un usuario.
ListAuthorizedInstancesForUser	ListAuthorizedInstancesForUser.	Consulta las instancias sobre las que el usuario especificado tiene permisos.
ListAuthorizedUsersForInstance	ListAuthorizedUsersForInstance.	Consulta una lista de usuarios que tienen permisos sobre la instancia especificada.
ListAuthorizedDatabasesForUser	ListAuthorizedDatabasesForUser.	Consulta las bases de datos sobre las que el usuario especificado tiene permisos.
ListAuthorizedUsersForDatabase	ListAuthorizedUsersForDatabase.	Consulta una lista de usuarios que tienen permisos sobre la base de datos especificada.

Gestión de seguridad

API	Título	Descripción
Reglas de seguridad	Reglas de seguridad
CreateStandardGroup	CreateStandardGroup.	Crea un conjunto de reglas de seguridad.
ListStandardGroups	ListStandardGroups.	Consulta conjuntos de reglas de seguridad.
UpdateStandardGroup	UpdateStandardGroup.	Modifica el nombre y la descripción de un conjunto de reglas de seguridad específico.
DeleteStandardGroup	DeleteStandardGroup.	Elimina un conjunto de reglas de seguridad.
GetStandardGroup	GetStandardGroup.	Consulta la información sobre los conjuntos de reglas de seguridad de un inquilino. La información incluye el nombre y la descripción de las reglas de seguridad, así como las instancias asociadas a dichas reglas.
Gestión de datos sensibles	Gestión de datos sensibles
AddDesensitizationRule	AddDesensitizationRule.	Agrega una regla de enmascaramiento.
ListDesensitizationRule	ListDesensitizationRule.	Consulta una lista de reglas de enmascaramiento.
ModifyDesensitizationStrategy	ModifyDesensitizationStrategy.	Modifica la regla de enmascaramiento vinculada a un campo especificado.
ListClassificationTemplates	ListClassificationTemplates.	Consulta las plantillas de clasificación.
ListSensitiveDataAuditLog	ListSensitiveDataAuditLog.	Consulta los registros de auditoría de información sensible.
ListSensitiveColumns	ListSensitiveColumns.	Consulta los campos sensibles en una tabla de una base de datos.
ListSensitiveColumnsDetail	ListSensitiveColumnsDetail.	Consulta los detalles de un campo sensible.
ChangeColumnSecLevel	ChangeColumnSecLevel.	Ajusta el nivel de sensibilidad de los campos.
ChangeColumnSecurityLevel	ChangeColumnSecurityLevel.	Cambia el nivel de seguridad de una columna.
GetClassificationTemplate	GetClassificationTemplate.	Consulta la información sobre la plantilla de clasificación y categorización asociada a una instancia.
ListSensitivityLevel	ListSensitivityLevel.	Consulta los niveles de sensibilidad de una plantilla de clasificación.
ListSensitiveColumnInfo	ListSensitiveColumnInfo.	Consulta la información de un campo sensible. La información incluye el ID del algoritmo de enmascaramiento, el nombre del algoritmo de enmascaramiento y el nivel de seguridad del campo.
Proxy de acceso seguro	Proxy de acceso seguro
CreateProxy	CreateProxy.	Habilita la función de proxy de acceso seguro para una instancia de base de datos.
DeleteProxy	DeleteProxy.	Puede llamar a esta operación para deshabilitar el proxy de protección de seguridad de datos de una instancia de base de datos.
ListProxies	ListProxies.	Consulta los proxies generados por la función de proxy de acceso seguro.
GetProxy	GetProxy.	Consulta los detalles de un proxy de acceso seguro.
CreateProxyAccess	CreateProxyAccess.	Otorga a un usuario los permisos para acceder a una instancia de base de datos mediante la función de proxy de acceso seguro.
DeleteProxyAccess	DeleteProxyAccess.	Revoca los permisos de acceso a una instancia de base de datos mediante la función de proxy de acceso seguro para un usuario.
ListProxyAccesses	ListProxyAccesses.	Consulta información sobre los usuarios autorizados para acceder a una instancia de base de datos mediante la función de proxy de acceso seguro.
InspectProxyAccessSecret	InspectProxyAccessSecret.	Obtiene la contraseña de autorización del agente de protección de seguridad InspectProxyAccessSecret.
GetProxyAccess	GetProxyAccess.	Consulta la información de autorización sobre la función de proxy de acceso seguro.
Plantillas de permisos	Plantillas de permisos
GrantTemplateAuthority	GrantTemplateAuthority.	Otorga permisos sobre recursos a usuarios mediante una plantilla de permisos.
RevokeTemplateAuthority	RevokeTemplateAuthority.	Revoca permisos sobre recursos de usuarios de Data Management (DMS) mediante una plantilla de permisos.
CreateAuthorityTemplate	CreateAuthorityTemplate.	Crea una plantilla de permisos.
UpdateAuthorityTemplate	UpdateAuthorityTemplate.	Modifica una plantilla de permisos.
AddAuthorityTemplateItems	AddAuthorityTemplateItems.	Agrega instancias, bases de datos y tablas a la plantilla de permisos especificada.
GetAuthorityTemplateItem	GetAuthorityTemplateItem.	Consulta los recursos en una plantilla de permisos.
GetAuthorityTemplate	GetAuthorityTemplate.	Consulta la información de una plantilla de permisos.
ListAuthorityTemplate	ListAuthorityTemplate.	Consulta la información sobre las plantillas de permisos, incluido el creador de la plantilla, el nombre de la plantilla y el número total de plantillas.
DeleteAuthorityTemplate	Eliminar una plantilla de permisos.	Elimina una plantilla de permisos.
Políticas de permisos	Políticas de permisos
CreateAbacPolicy	Crear una política ABAC.	Crea una política para gestionar los permisos sobre las funciones de DMS y los recursos de datos administrados en DMS de manera detallada.
ListAbacPolicies	ListAbacPolicies.	Consulta una lista de políticas creadas por un usuario.
UpdateAbacPolicy	UpdateAbacPolicy.	Actualiza el nombre, la descripción o el contenido de una política.
DeleteAbacPolicy	DeleteAbacPolicy.	Elimina una política de permisos creada.
GetAbacPolicy	GetAbacPolicy.	Consulta los detalles de una política, incluido el nombre, el contenido y el usuario que creó la política.
CreateAbacAuthorization	CreateAbacAuthorization.	Asocia una política del sistema o una política personalizada a un usuario de DMS o a un rol personalizado.
ListAbacAuthorizations	ListAbacAuthorizations.	Consulta una lista de usuarios a los que está asociada la política especificada y el número de dichos usuarios.
DeleteAbacAuthorization	DeleteAbacAuthorization.	Desvincula una política de un usuario o rol.

Consulta de datos

API	Título	Descripción
ExecuteScript	Ejecutar script SQL.	Ejecuta un script SQL.

Desarrollo de datos

API	Título	Descripción
Orquestación de tareas	Orquestación de tareas
UpdateTaskFlowConstants	Actualizar la lista de constantes del flujo de tareas.	Llama a la operación UpdateTaskFlowConstants para actualizar la lista de constantes de un flujo de tareas.
DeleteTaskFlow	DeleteTaskFlow.	Elimina un flujo de tareas.
OfflineTaskFlow	OfflineTaskFlow.	Despublica un flujo de tareas publicado en Data Management (DMS).
ListTaskFlow	ListTaskFlow.	Consulta una lista de flujos de tareas.
GetTaskInstanceRelation	Consulta de relaciones de instancias de tarea.	Consulta los nodos de tarea de una instancia de flujo de tareas.
ListTaskFlowInstance	ListTaskFlowInstance.	Consulta los registros de ejecución de un flujo de tareas.
ListDAGVersions	ListDAGVersions.	Consulta las versiones publicadas de un flujo de tareas.
ReDeployLhDagVersion	ReDeployLhDagVersion.	Redespliega las versiones publicadas de un flujo de tareas.
UpdateScenario	Actualización del nombre y la descripción del escenario de negocio de flujo de tareas.	Llama a la operación UpdateScenario para actualizar el nombre y la descripción de un escenario de negocio de flujo de tareas.
ResumeTaskFlowInstance	Reanudar un flujo de tareas en pausa.	Reanuda una instancia de flujo de tareas en pausa.
UpdateTaskContent	Actualizar un nodo en un flujo de tareas.	Actualiza un nodo en un flujo de tareas mediante la operación UpdateTaskContent.
ListTaskFlowsByPage	ListTaskFlowsByPage.	Consulta los detalles de los flujos de tareas por página.
ListScenarios	ListScenarios.	Consulta los escenarios de negocio.
UpdateTaskConfig	Actualizar la configuración avanzada del nodo.	Actualiza la configuración avanzada de un nodo mediante la operación UpdateTaskConfig.
ListTaskFlowConstants	ListTaskFlowConstants.	Consulta las constantes de un flujo de tareas.
BackFill	Rellenar datos de un flujo de tareas.	Llama a la operación BackFill para rellenar datos de un flujo de tareas.
UpdateTaskTimeVariables	Actualizar variables de tiempo del nodo.	Actualiza las variables de tiempo de un nodo.
ListTaskFlowTimeVariables	ListTaskFlowTimeVariables.	Enumera las variables de tiempo de un flujo de tareas.
UpdateTaskFlowTimeVariables	Actualización de variables de tiempo del flujo de tareas.	Llama a la operación UpdateTaskFlowTimeVariables para actualizar las variables de tiempo de un flujo de tareas.
UpdateTaskFlowCooperators	Actualizar colaboradores del flujo de tareas.	Actualiza la lista de colaboradores de un flujo de tareas mediante la operación UpdateTaskFlowCooperators.
CreateScenario	CreateScenario.	Crea un escenario de negocio para agrupar flujos de tareas por escenario de negocio.
DeleteScenario	DeleteScenario.	Elimina un escenario de negocio.
UpdateSLARules	Actualizar alerta de tiempo de espera de SLA del flujo de tareas.	Actualiza la alerta de tiempo de espera de SLA para un flujo de tareas.
GetRuleNumLimitOfSLA	GetRuleNumLimitOfSLA.	Consulta el número máximo de reglas personalizadas de acuerdo de nivel de servicio (SLA) para la orquestación de tareas.
GetIntervalLimitOfSLA	GetIntervalLimitOfSLA.	Consulta el ciclo de programación mínimo de un flujo de tareas cuando se configura una regla de tiempo de espera del acuerdo de nivel de servicio (SLA) para el flujo de tareas.
ListDefaultSLARules	ListDefaultSLARules.	Consulta las reglas de tiempo de espera del acuerdo de nivel de servicio (SLA) predeterminado.
ListTaskFlowCooperators	ListTaskFlowCooperators.	Consulta una lista de usuarios que participan en un flujo de tareas.
ListSLARules	ListSLARules.	Consulta las reglas personalizadas del acuerdo de nivel de servicio (SLA) de un flujo de tareas.
GetTask	GetTask.	Consulta las configuraciones, incluidas las variables de tiempo, de un nodo de tarea especificado según el ID del nodo de tarea.
MoveTaskFlowToScenario	Mover un flujo de tareas a un escenario de negocio especificado.	Mueve un flujo de tareas a un escenario de negocio especificado.
GetTaskFlowNotification	GetTaskFlowNotification.	Consulta la configuración de notificaciones de los flujos de tareas.
UpdateTaskName	Actualizar nombre de nodo.	Actualiza el nombre de un nodo.
UpdateTaskOutput	Actualizar variables de salida de un nodo.	Llama a la operación UpdateTaskOutput para actualizar las variables de salida de un nodo.
DeleteTaskFlowEdgesByCondition	DeleteTaskFlowEdgesByCondition.	Elimina aristas de flujo de tareas según múltiples condiciones.
ListTaskFlowEdgesByCondition	ListTaskFlowEdgesByCondition.	Consulta las aristas del grafo acíclico dirigido (DAG) de un flujo de tareas según múltiples condiciones.
AddTaskFlowEdges	Crear aristas dirigidas para nodos de flujo de tareas.	Crea aristas dirigidas para nodos existentes en un flujo de tareas.
UpdateTaskFlowNameAndDesc	Actualización del nombre y la descripción del flujo de tareas.	Llama a la operación UpdateTaskFlowNameAndDesc para actualizar el nombre y la descripción de un flujo de tareas.
GetTaskFlowGraph	GetTaskFlowGraph.	Consulta el grafo acíclico dirigido (DAG) de un flujo de tareas.
UpdateTaskFlowEdges	Actualizar los nodos iniciales de las aristas del flujo de tareas especificado.	Actualiza en lote los nodos inicial y final de las aristas especificadas en un flujo de tareas determinado.
UpdateTaskFlowOwner	Actualizar propietario del flujo de tareas.	Actualiza el propietario de un flujo de tareas mediante la operación UpdateTaskFlowOwner.
UpdateTaskFlowSchedule	Actualizar la configuración de programación del flujo de tareas.	Actualiza la configuración de programación de un flujo de tareas mediante la operación UpdateTaskFlowSchedule.
UpdateTaskFlowRelations	Actualizar completamente las aristas del flujo de tareas.	Realiza una actualización completa de las aristas del flujo de tareas mediante la operación UpdateTaskFlowRelations.
UpdateTaskFlowNotification	Actualizar la configuración de notificaciones del flujo de tareas.	Actualiza la configuración de notificaciones de un flujo de tareas.
ListTasksInTaskFlow	ListTasksInTaskFlow.	Consulta las tareas en un flujo de tareas especificado.
CreateTaskFlow	CreateTaskFlow.	Crea un flujo de tareas.
SuspendTaskFlowInstance	Suspender una instancia de flujo de tareas.	Suspende una instancia de flujo de tareas en ejecución mediante la operación SuspendTaskFlowInstance.
ReRunTaskFlowInstance	Volver a ejecutar una instancia de flujo de tareas.	Vuelve a ejecutar una instancia de flujo de tareas mediante la operación ReRunTaskFlowInstance.
MakeTaskFlowInstanceSuccess	Establecer el estado de un flujo de tareas especificado como exitoso.	Establece el estado de una instancia de flujo de tareas especificada como exitoso.
DeleteTask	DeleteTask.	Elimina una tarea en un flujo de tareas especificado.
PublishAndDeployTaskFlow	Publicar y desplegar un flujo de tareas especificado.	Publica y despliega un flujo de tareas especificado.
StopTaskFlowInstance	StopTaskFlowInstance.	Detiene una instancia de flujo de tareas.
CreateTask	CreateTask.	Crea un nodo de tarea para un flujo de tareas.
UpdateTaskContentV2	Actualizar un nodo grande en un flujo de tareas.	Acepta archivos SQL grandes para actualizar el contenido de un nodo.
TryRunTaskFlow	Ejecución de prueba de un flujo de tareas.	Realiza una ejecución de prueba de un flujo de tareas en una orquestación de tareas.
Desarrollo de data warehouse	Desarrollo de data warehouse
CreateLakeHouseSpace	CreateLakeHouseSpace.	Crea un espacio de trabajo para el desarrollo de almacenes de datos en Data Management (DMS).
GetLhSpaceByName	Consultar información del espacio de trabajo del proyecto.	Consulta la información de un espacio de trabajo de proyecto de desarrollo de almacén de datos de DMS por nombre del espacio de trabajo.
DeleteLakeHouseSpace	Eliminar un espacio de proyecto.	Llama a la operación DeleteLakeHouseSpace para eliminar un espacio de proyecto en el desarrollo de almacenes de datos.
ListLhTaskFlowAndScenario	Consultar flujos de tareas por escenario de negocio en un espacio de trabajo de proyecto.	Consulta la lista de flujos de tareas correspondientes a escenarios de negocio en un espacio de trabajo de proyecto de desarrollo de almacén de datos de DMS.
AddLhMembers	Agregar administradores del espacio de trabajo, miembros del espacio de trabajo o desarrolladores de flujo de nodos.	Invoca la operación AddLhMembers para agregar administradores de gestión de almacenamiento, miembros del espacio de trabajo o desarrolladores de flujo de nodos a un espacio de trabajo de proyecto de desarrollo de almacén de datos de Data Management Service (DMS).
DeleteLhMembers	Eliminar miembros del espacio de trabajo del proyecto o desarrolladores de flujos de tareas.	Elimina miembros o desarrolladores de flujos de tareas de un espacio de trabajo de proyecto de desarrollo de almacén de datos de DMS.
ChangeLhDagOwner	Transferir propietario del flujo de tareas.	Transfiere la propiedad de un flujo de tareas en un espacio de trabajo de desarrollo de almacén de datos de DMS.

Pedidos de venta

API	Título	Descripción
ListEffectiveOrders	ListEffectiveOrders.	Consulta los pedidos válidos.
RefundPayAsYouGoOrder	RefundPayAsYouGoOrder.	Cancela la suscripción de un recurso de pago por uso de Data Management (DMS).

Categorías de activos

API	Título	Descripción
CreateMetaCategory	Crear una categoría de activos.	Crea una categoría de activos.
ListMetaCategory	ListMetaCategory.	Consulta una lista de categorías.
UpdateMetaCategory	Actualizar información de categoría de activos.	Actualiza la información de la categoría de activos.
DeleteMetaCategory	DeleteMetaCategory.	Elimina una categoría de activos.
ListTablesInCategory	ListTablesInCategory.	Obtiene la lista de tablas en una categoría.
AddTableToCategory	AddTableToCategory.	Agrega una tabla a una categoría de activos.
RemoveTableFromCategory	RemoveTableFromCategory.	Elimina una tabla de la categoría de activos.

Espacios de trabajo

API	Título	Descripción
CreateWorkspace	CreateWorkspace.	Crea un espacio de trabajo.
DeleteWorkspace	DeleteWorkspace.	Elimina un espacio de trabajo.
GetWorkspace	GetWorkspace.	Consulta los detalles de un espacio de trabajo.
ListWorkspaces	ListWorkspaces.	Consulta una lista de espacios de trabajo del inquilino.
UpdateWorkspace	UpdateWorkspace.	Actualiza la información de un espacio de trabajo.

Otros

API	Título	Descripción
OptimizeSqlByMetaAgent	OptimizeSqlByMetaAgent.	Analiza y optimiza las sentencias SQL en la base de datos especificada.
FixSqlByMetaAgent	FixSqlByMetaAgent.	Analiza y corrige el error de SQL mediante la instrucción SQL, el mensaje de error y el ID de base de datos especificados.
AnswerSqlSyntaxByMetaAgent	AnswerSqlSyntaxByMetaAgent.	Responde preguntas de sintaxis del motor correspondiente según el ID de base de datos especificado.
ListUserOwnedResources	ListUserOwnedResources.	Obtiene.
CheckBatchTableAccessPermission	CheckBatchTableAccessPermission.	Verifica en lote los permisos de tabla.
ListTagMetaAsset	ListTagMetaAsset.	Enumera los activos de bases de datos y tablas asociados con una etiqueta específica en un espacio de trabajo de DataAgent.
SearchTableKnowledge	SearchTableKnowledge.	Busca conocimiento de tablas basándose en la consulta de un usuario.
GetAIOrderApprovalCommentSSE	GetAIOrderApprovalCommentSSE.	Obtiene sugerencias de aprobación para un ticket desde un modelo de lenguaje grande (LLM).
AddWorkspaceUser	AddWorkspaceUser.	Agrega un usuario a un espacio de trabajo.
UpdateWorkspaceUser	UpdateWorkspaceUser.	Actualiza los roles de un usuario en un espacio de trabajo.
ListWorkspaceUsers	ListWorkspaceUsers.	Lista los usuarios de un espacio de trabajo especificado.
RemoveWorkspaceUser	RemoveWorkspaceUser.	Elimina un usuario de un espacio de trabajo.
SearchWorkspaceRoles	SearchWorkspaceRoles.	Busca roles en un espacio de trabajo.
ConfirmInventoryKnowledge	Adoptar resultado de inventario.	Confirma un único elemento de conocimiento en una tarea de inventario y lo marca como certificado.
CreateInventoryJob	Crear una tarea de inventario.	Crea una tarea de inventario de activos para realizar un inventario de conocimiento en instancias, bases de datos o tablas especificadas.
SearchInventoryKnowledge	SearchInventoryKnowledge.	Obtiene una lista paginada de conocimiento generado por una tarea de inventario. Puede filtrar los resultados por palabra clave, tipo de conocimiento y otros criterios.
CheckInventoryJob	Ver estado de la tarea de inventario.	Consulta el estado de ejecución y la información de progreso de una tarea de recopilación de información de activos.
SearchTableAssetKnowledge	SearchTableAssetKnowledge.	Consulta una lista paginada de conocimiento de activos relacionada con una tabla específica. Este conocimiento incluye información sobre tablas, columnas, sentencias SQL y fragmentos de código.
GetTableKnowledgeDetails	GetTableKnowledgeDetails.	Obtiene los detalles del conocimiento de activos de una tabla, incluidos sus metadatos, descripción empresarial y una lista de campos.
GetTableColumnList	GetTableColumnList.	Obtiene los detalles de cada columna en una tabla, incluidos los metadatos, las descripciones empresariales y el nivel de seguridad.
GetTableInstructions	GetTableInstructions.	Obtiene las instrucciones de uso y el contexto empresarial de una tabla, incluida su descripción empresarial, resumen y activos relacionados.
ListInventoryJobs	ListInventoryJobs.	Obtiene una lista paginada de trabajos de inventario de activos.
SearchInventoryAsset	SearchInventoryAsset.	Obtiene una lista paginada de activos de tabla de una tarea de inventario específica.
CreateForecastAgent	Crear una instancia de agente de pronóstico.	Crea una instancia de agente de pronóstico.
SetForecastAgentInstance	Set simulation-enabled inference identity.	Establece la información de autenticación para una instancia.
DescribeForecastAgent	Obtener detalles de la instancia de agente de pronóstico.	Obtiene los detalles de una instancia de agente de pronóstico.
GetForecastAgentInstance	Obtener lista de agentes de pronóstico.	Obtiene la lista de agentes de pronóstico.
DescribeInventoryFileUploadSignature	Obtener credenciales de carga para inventario de activos.	Obtiene las credenciales de carga directa de OSS para archivos de inventario de activos.
ExportInventoryKnowledge	Exportar conocimiento de los resultados del inventario.	Exporta la lista completa de conocimiento generado por una tarea de inventario como un archivo XLSX.
ExportInventoryAsset	Exportar conocimiento de activos de inventario.	Exporta la lista completa de activos de tabla bajo una tarea de inventario como un archivo XLSX.
AsyncExportInventoryAsset	Exportar resultados de inventario de forma asíncrona.	Envía de forma asíncrona una tarea de exportación completa de activos para una tabla de inventario.
AsyncExportInventoryKnowledge	Enviar una tarea de exportación asíncrona para activos de inventario.	Envía una confirmación asíncrona para un nodo de exportación completa de conocimiento de inventario.
GetInventoryExportTaskStatus	Obtener el estado de la tarea de exportación asíncrona.	Consulta el estado de una tarea de exportación asíncrona de resultados de inventario.

Others

API	Título	Descripción
AssetAnswerSSE	Consulta la información de activos a través de SSE.	Consulta la información de activos a través de la interfaz SSE de MetaAgent.
ClearCategoryMountedTables	Desmontar todas las tablas de una carpeta especificada.	Desmonta todas las tablas de una carpeta de categoría especificada.
CloneStandardGroup	Clonar un conjunto de reglas de seguridad.	Clona un conjunto de reglas de seguridad.
CreateWorkFlowNode	Crear un nodo de aprobación.	Crea una lista de nodos de aprobación.
CreateWorkFlowTemplate	Crear una plantilla de aprobación.	Crea una plantilla de aprobación.
EditTableAssetInfo	Editar conocimiento de tabla.	Edita el conocimiento empresarial (descripción y resumen mejorados con IA) de una tabla, lo que afecta la precisión de la búsqueda semántica de tablas.
ListAssetCategories	Listar árbol de categorías de activos.	Enumera el árbol de categorías de activos (hasta 4 niveles) para confirmar el ID de la carpeta de destino antes del montaje.
ListCategoryMountedTables	Enumera las tablas por catálogo empresarial.	Enumera los activos de tablas montadas en un catálogo empresarial junto con las rutas de montaje actuales del catálogo.
MountTableToCategory	Corregir el montaje de carpeta de la tabla.	Monta manualmente una tabla en una carpeta de negocio especificada para corregir un montaje de carpeta incorrecto. Cuando Replace se establece en true, primero se desvinculan las relaciones de carpeta existentes de la tabla (remontaje).
SearchTenantTableKnowledge	Búsqueda de conocimiento de tablas por lenguaje natural.	Busca tablas en todas las bases de datos a nivel de inquilino mediante lenguaje natural y devuelve una lista de entradas de conocimiento de tablas.
TestInstanceConnection	Probar la conectividad de la instancia.	Prueba la conectividad de una instancia.
UpdateWorkFlowNode	Actualizar información del nodo de aprobación.	Actualiza la lista de nodos de aprobación.
UpdateWorkFlowTemplate	Actualizar información de la plantilla de aprobación.	Actualiza una plantilla de aprobación.