Descripción general de la API - Database Autonomy Service - Centro de documentación de Alibaba Cloud

Estándares de API y SDK preconfigurados multilenguaje

La OpenAPI de este producto (DAS/2020-01-16) 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.

Acceso a instancias

API	Título	Descripción
AddHDMInstance	Conectar una instancia de base de datos.	Llama a la operación AddHDMInstance para conectar una instancia de base de datos a Database Autonomy Service (DAS).

Inspección y puntuación

API	Título	Descripción
GetInstanceInspections	GetInstanceInspections.	Consulta el resultado de una inspección realizada en una instancia de base de datos mediante la función de inspección y puntuación.

Notificación de eventos

API	Título	Descripción
SetEventSubscription	SetEventSubscription.	Configura los ajustes de suscripción a eventos para una instancia de base de datos.
GetEventSubscription	GetEventSubscription.	Consulta la configuración de suscripción a eventos de una instancia de base de datos.
GetAutonomousNotifyEventContent	Obtener contenido del evento de notificación autónoma.	Devuelve los detalles de los eventos de notificación autónoma de una instancia de base de datos.
GetAutonomousNotifyEventsInRange	GetAutonomousNotifyEventsInRange.	Consulta los eventos de notificación de uno o más niveles de urgencia dentro de un período.

Informe de diagnóstico

API	Título	Descripción
CreateDiagnosticReport	CreateDiagnosticReport.	Crea un informe de diagnóstico.
DescribeDiagnosticReportList	DescribeDiagnosticReportList.	Consulta informes de diagnóstico.
GetDBInstanceConnectivityDiagnosis	Obtención del resultado del diagnóstico de conectividad de red para una instancia de base de datos.	Obtiene el resultado del diagnóstico de conectividad de red desde una dirección IP especificada por el usuario hasta una instancia de base de datos especificada.

Análisis de caché

API	Título	Descripción
CreateCacheAnalysisJob	Crear una tarea de análisis de caché.	Crea una tarea de análisis de caché mediante la operación CreateCacheAnalysisJob.
DescribeCacheAnalysisJob	DescribeCacheAnalysisJob.	Devuelve los detalles de una tarea de análisis de caché.
DescribeCacheAnalysisJobs	Consultar tareas de análisis de caché.	Consulta una lista de tareas de análisis de caché.

Limitación de SQL

API	Título	Descripción
EnableSqlConcurrencyControl	EnableSqlConcurrencyControl.	Habilita el control de limitación de SQL para gestionar la cantidad de solicitudes de acceso a la base de datos y las sentencias SQL simultáneas.
DisableSqlConcurrencyControl	DisableSqlConcurrencyControl.	Deshabilita una regla de limitación.
DisableAllSqlConcurrencyControlRules	DisableAllSqlConcurrencyControlRules.	Deshabilita todas las reglas de limitación que están en vigor.
GetRunningSqlConcurrencyControlRules	GetRunningSqlConcurrencyControlRules.	Consulta las reglas de limitación que están en vigor.
GetSqlConcurrencyControlRulesHistory	GetSqlConcurrencyControlRulesHistory.	Consulta las reglas de limitación que se están ejecutando o que se han activado.
GetSqlConcurrencyControlKeywordsFromSqlText	GetSqlConcurrencyControlKeywordsFromSqlText.	Genera una cadena de palabras clave de limitación basada en una sentencia SQL.

Diagnóstico de SQL

API	Título	Descripción
CreateRequestDiagnosis	CreateRequestDiagnosis.	Inicia una solicitud de diagnóstico de sentencias SQL.
GetRequestDiagnosisResult	GetRequestDiagnosisResult.	Obtiene los resultados del diagnóstico de SQL.
GetRequestDiagnosisPage	GetRequestDiagnosisPage.	Consulta registros de diagnóstico de SQL por páginas.
DescribeQueryExplain	DescribeQueryExplain.	Obtiene el plan de ejecución de una sentencia SQL.

Análisis de claves

API	Título	Descripción
DescribeHotBigKeys	Obtener las claves activas y grandes actuales en tiempo real.	Llama a la operación DescribeHotBigKeys para obtener las claves activas y las claves grandes en la memoria actual en tiempo real.
DescribeTopHotKeys	DescribeTopHotKeys.	Consulta las 100 claves más activas dentro de un período de tiempo especificado.
DescribeTopBigKeys	DescribeTopBigKeys.	Consulta las 100 claves grandes principales durante un período de tiempo.
DescribeHotKeys	Consultar claves activas de una instancia.	Consulta las claves activas de una instancia de Redis mediante la operación DescribeHotKeys.

Gobernanza de consultas

API	Título	Descripción
CreateQueryOptimizeTag	Agregar etiquetas a las sentencias SQL de destino.	Llama a la operación CreateQueryOptimizeTag para agregar etiquetas a las sentencias SQL de destino.
GetQueryOptimizeExecErrorStats	GetQueryOptimizeExecErrorStats.	Consulta las plantillas SQL cuya ejecución falló.
GetQueryOptimizeExecErrorSample	GetQueryOptimizeExecErrorSample.	Consulta las sentencias SQL fallidas bajo una plantilla de SQL.
GetQueryOptimizeSolution	GetQueryOptimizeSolution.	Consulta las sugerencias proporcionadas por la gobernanza de consultas para optimizar una plantilla SQL.
GetQueryOptimizeRuleList	GetQueryOptimizeRuleList.	Consulta las etiquetas agregadas por la función de gobernanza de consultas a instancias de base de datos especificadas.
GetQueryOptimizeDataTrend	GetQueryOptimizeDataTrend.	Consulta los datos de tendencias de gobernanza de consultas.
GetQueryOptimizeDataTop	GetQueryOptimizeDataTop.	Devuelve las instancias con mejor y peor rendimiento según los datos de gobernanza de consultas.
GetQueryOptimizeDataStats	GetQueryOptimizeDataStats.	Devuelve estadísticas de plantillas SQL a partir de datos de gobernanza de consultas.
GetQueryOptimizeTag	Obtener etiquetas de SQL.	Consulta las etiquetas de una sentencia SQL especificada mediante la operación GetQueryOptimizeTag.
GetQueryOptimizeShareUrl	GetQueryOptimizeShareUrl.	Consulta una URL para compartir proporcionada por la función de gobernanza de consultas.

Explorador de SQL

API	Título	Descripción
GetErrorRequestSample	GetErrorRequestSample.	Consulta de forma asíncrona información sobre consultas SQL fallidas en los datos de SQL Explorer. Puede consultar hasta 20 consultas SQL fallidas dentro del rango de tiempo especificado.
GetAsyncErrorRequestStatResult	GetAsyncErrorRequestStatResult.	Llama a GetAsyncErrorRequestStatResult para obtener de forma asíncrona el recuento de errores de ejecución de una sentencia SQL específica a partir de los resultados de SQL Insight de una instancia de base de datos.
GetAsyncErrorRequestListByCode	GetAsyncErrorRequestListByCode.	Consulta de forma asíncrona los ID de las sentencias SQL que generan un código de error de MySQL en los resultados de SQL Explorer de una instancia de base de datos.
GetAsyncErrorRequestStatByCode	GetAsyncErrorRequestStatByCode.	Consulta de forma asíncrona los códigos de error de MySQL en los datos de SQL Explorer y el número de consultas SQL correspondientes a cada código de error.
GetFullRequestOriginStatByInstanceId	GetFullRequestOriginStatByInstanceId.	Recopila las estadísticas completas de solicitudes en los resultados de SQL Explorer de una instancia de base de datos, agrupadas por origen de acceso.
GetFullRequestStatResultByInstanceId	GetFullRequestStatResultByInstanceId.	Recopila de forma asíncrona las estadísticas completas de solicitudes en los resultados de SQL Explorer de una instancia de base de datos por ID de SQL.
GetFullRequestSampleByInstanceId	Consulta de datos de muestra de SQL por ID de SQL.	Consulta los datos de muestra de SQL de los resultados de SQL Explorer de una instancia de base de datos por ID de SQL mediante la operación GetFullRequestSampleByInstanceId. Se devuelve un máximo de 20 registros de muestra.

Gestión de la edición empresarial

API	Título	Descripción
DescribeSqlLogConfig	Consultar la configuración de DAS Enterprise Edition.	Consulta la configuración de DAS Enterprise Edition de una instancia de base de datos.
ModifySqlLogConfig	ModifySqlLogConfig.	Utilice la operación ModifySqlLogConfig para habilitar o configurar DAS Enterprise Edition en una instancia de base de datos.
DescribeSqlLogStatistic	Consulta de información estadística de DAS Enterprise Edition.	Invoca la operación DescribeSqlLogStatistic para consultar la información estadística de DAS Enterprise Edition.
GetDasSQLLogHotData	GetDasSQLLogHotData.	Obtiene datos recientes de los registros de auditoría SQL.
CreateSqlLogTask	Crear una tarea por lotes de DAS Enterprise Edition.	Crea una tarea asíncrona para datos detallados.
DescribeSqlLogTask	Consulta de detalles de tareas por lotes de DAS Enterprise Edition.	Consulta los detalles de una tarea por lotes de DAS Enterprise Edition mediante la operación DescribeSqlLogTask.
DescribeSqlLogTasks	Listado de tareas por lotes de DAS Enterprise Edition.	Consulta la lista de tareas de registro de auditoría de una instancia.

Sesión de instancia

API	Título	Descripción
GetRedisAllSession	GetRedisAllSession	Consulta la sesión actual en una instancia de ApsaraDB for Redis.
GetMongoDBCurrentOp	Consultar las sesiones actuales de una instancia de MongoDB.	Consulta las sesiones actuales de una instancia de ApsaraDB for MongoDB.
KillInstanceAllSession	Finalizar todas las sesiones.	Llama a la operación KillInstanceAllSession para finalizar todas las sesiones en una instancia especificada.
CreateKillInstanceSessionTask	Crear una tarea para finalizar sesiones.	Llama a la operación CreateKillInstanceSessionTask para crear una tarea que finaliza sesiones.
GetKillInstanceSessionTaskResult	GetKillInstanceSessionTaskResult.	Consulta los resultados de una tarea que finaliza sesiones.
GetMySQLAllSessionAsync	GetMySQLAllSessionAsync.	Consulta de forma asíncrona las sesiones de una instancia y recopila estadísticas sobre las sesiones según dimensiones.

Análisis de almacenamiento

API	Título	Descripción
CreateStorageAnalysisTask	CreateStorageAnalysisTask.	Crea una tarea de análisis de almacenamiento para consultar los detalles de uso de una o más bases de datos y tablas.
GetStorageAnalysisResult	GetStorageAnalysisResult.	Consulta el estado y los resultados de una tarea de análisis de almacenamiento.
GetAutoIncrementUsageStatistic	GetAutoIncrementUsageStatistic.	Consulta el uso de los ID de tabla con incremento automático.

Optimización de bloqueos

API	Título	Descripción
GetDeadLockDetailList	GetDeadLockDetailList	Consulta los detalles de los interbloqueos de una instancia de ApsaraDB RDS for SQL Server.
GetBlockingDetailList	GetBlockingDetailList.	Consulta los datos de bloqueo de una instancia de ApsaraDB RDS for SQL Server.
CreateLatestDeadLockAnalysis	Crear una tarea de análisis de interbloqueos recientes.	Crea una tarea de análisis de interbloqueos recientes.
GetDeadLockHistory	GetDeadLockHistory.	Obtiene las tareas de análisis histórico para el análisis de interbloqueos recientes y completos.
GetDeadLockDetail	Get deadlock detail.	Obtiene la información detallada de un único evento de interbloqueo.
GetDeadlockHistogram	Consulta de la tendencia del recuento del análisis completo de bloqueos mutuos dentro de un intervalo de tiempo.	Consulta la tendencia del recuento de bloqueos mutuos con base en el análisis completo de bloqueos mutuos de los registros de errores dentro de un intervalo de tiempo especificado.

Diagnóstico de índices

API	Título	Descripción
GetInstanceMissingIndexList	GetInstanceMissingIndexList.	Devuelve los detalles de todos los índices faltantes para una instancia.

Registro de consultas lentas

API	Título	Descripción
DescribeSlowLogHistogramAsync	Obtención asíncrona de datos de tendencias de registros lentos de la instancia.	Obtiene de forma asíncrona los datos de tendencias de registros lentos de una instancia.
DescribeSlowLogStatistic	Información de estadísticas del registro de consultas lentas.	Consulta la información de estadísticas del registro de consultas lentas.
DescribeSlowLogRecords	Consulta de registros de consultas lentas.	Consulta los registros de consultas lentas de una instancia de base de datos con compatibilidad para filtrar y ordenar por múltiples condiciones.

Limitación automática de SQL

API	Título	Descripción
UpdateAutoThrottleRulesAsync	Configurar parámetros de limitación automática de SQL.	Llama a la operación UpdateAutoThrottleRulesAsync para configurar de forma asíncrona y por lotes los parámetros de limitación automática de SQL en instancias de base de datos especificadas.
DisableAutoThrottleRules	DisableAutoThrottleRules.	Deshabilita la función de limitación automática de SQL para varias instancias de base de datos a la vez.
GetAutoThrottleRules	GetAutoThrottleRules.	Consulta las reglas de limitación automática de SQL de una instancia de base de datos.

Optimización automática de SQL

API	Título	Descripción
UpdateAutoSqlOptimizeStatus	UpdateAutoSqlOptimizeStatus.	Habilita, modifica o deshabilita la función de optimización automática de SQL para varias instancias de base de datos a la vez.
GetSqlOptimizeAdvice	Consulta de sugerencias de diagnóstico generadas por la optimización automática de SQL.	Consulta las sugerencias de diagnóstico generadas por la función de optimización automática de SQL de DAS.
GetInstanceSqlOptimizeStatistic	GetInstanceSqlOptimizeStatistic.	Consulta estadísticas sobre eventos de optimización automática de SQL dentro de un período de tiempo, como el número total de eventos de optimización y la mejora máxima.

Optimización automática del espacio

API	Título	Descripción
UpdateAutoResourceOptimizeRulesAsync	UpdateAutoResourceOptimizeRulesAsync.	Configura de forma asíncrona los parámetros relacionados con la función de reciclaje automático de fragmentos para varias instancias de base de datos a la vez.
DisableAutoResourceOptimizeRules	DisableAutoResourceOptimizeRules.	Deshabilita la función de reciclaje automático de fragmentos de tablespace para instancias de base de datos de forma simultánea.
GetAutoResourceOptimizeRules	GetAutoResourceOptimizeRules.	Consulta las reglas de reciclaje automático de fragmentos de las instancias de base de datos.

Escalado elástico automático

API	Título	Descripción
ModifyAutoScalingConfig	ModifyAutoScalingConfig.	Modifica las configuraciones de escalado automático de una instancia.
DescribeAutoScalingConfig	Consulta de la configuración de la función de escalado elástico de la instancia.	Invoca la operación DescribeAutoScalingConfig para consultar la configuración de la función de escalado elástico de una instancia.
DescribeAutoScalingHistory	Consulta del historial de escalado elástico de la instancia.	Consulta el historial de escalado elástico de una instancia.
DisableInstanceDasConfig	DisableInstanceDasConfig.	Deshabilita la función de escalado automático para una instancia de base de datos.

Mapa de calor de particiones

API	Título	Descripción
GetPartitionsHeatmap	GetPartitionsHeatmap.	Consulta las estadísticas de frecuencia de acceso y los datos activos en las particiones de una instancia de PolarDB-X 2.0.

Información de rendimiento (nueva versión)

API	Título	Descripción
GetPfsSqlSample	GetPfsSqlSample.	Consulta los datos de muestra de SQL para la nueva versión de la función de performance insight de una instancia de base de datos.
GetPfsMetricTrends	GetPfsMetricTrends.	Consulta la tendencia de una métrica para la nueva versión de la función de performance insight de una instancia de base de datos.
GetPfsSqlSummaries	GetPfsSqlSummaries.	Llama a la API GetPfsSqlSummaries para consultar todos los datos de solicitudes mediante la dimensión de ID de SQL en Performance Insight (nueva versión) para una instancia de base de datos.

Registro de errores

API	Título	Descripción
DescribeErrorLogRecords	Consulta de detalles del registro de errores.	Consulta los detalles del registro de errores de una instancia dentro de un intervalo de tiempo especificado.

Agente de DAS

API	Título	Descripción
Chat	Interfaz de interacción con el agente de DAS.	Proporciona la interfaz de lógica asíncrona para las capacidades de modelos grandes de DAS.
GetInstanceGroupInspectReportList	Query DAS agent O&M report list.	Consulta la lista de informes de O&M generados por DAS Agent.
GetInstanceGroupInspectReportDetail	Consulta de detalles del informe de operaciones de DAS Agent.	Obtiene los detalles de un informe de operaciones automatizadas de DAS Agent.

Lista blanca entre productos

API	Título	Descripción
CreateSecurityIPGroup	Crear una plantilla de lista blanca entre servicios.	Crea una plantilla de lista blanca entre servicios para un usuario.
DescribeSecurityIPGroup	Mostrar detalles de la plantilla de lista blanca entre motores.	Muestra los detalles de una plantilla de lista blanca entre motores para un usuario.
DescribeSecurityIPGroupRelation	Mostrar información de vinculación de plantilla de lista blanca multi-motor.	Muestra la información de vinculación entre una plantilla de lista blanca multi-motor y las instancias de un usuario.
ModifySecurityIPGroup	ModifySecurityIPGroup.	Modifica una plantilla de lista blanca entre productos.
ModifySecurityIPGroupRelation	Asociar o desasociar una plantilla de lista blanca entre motores.	Asocia o desasocia una plantilla de lista blanca entre motores a o de un usuario.
DeleteSecurityIPGroup	Eliminar una plantilla de lista blanca entre productos.	Elimina una plantilla de lista blanca entre productos para un usuario.

Otros

API	Título	Descripción
GetDasAgentSSE	(Obsoleto) Interfaz de flujo de datos del agente de DAS.	Proporciona una interfaz SSE interactiva de modelo grande de DAS. Admite funciones como chat de IA y diagnóstico de rendimiento.
DescribeSqlLogRecords	DescribeSqlLogRecords.	Consulta los detalles de registros en DAS Enterprise Edition.
EnableDasPro	EnableDasPro.	Activa la edición profesional de Database Autonomy Service (DAS).
DisableDasPro	DisableDasPro.	Desactiva Database Autonomy Service (DAS) Professional Edition.
DescribeInstanceDasPro	DescribeInstanceDasPro.	Consulta si Database Autonomy Service (DAS) Enterprise Edition V1 o V2 está habilitado para una instancia de base de datos.
GetDasProServiceUsage	Consulta del uso de almacenamiento de DAS Enterprise Edition (V1 o V2)	Consulta el uso de almacenamiento de DAS Enterprise Edition V1 o V2 para una instancia de base de datos.
RunCloudBenchTask	RunCloudBenchTask.	Llama a la operación RunCloudBenchTask para ejecutar una tarea de prueba de estrés.
DescribeCloudbenchTask	Consultar una tarea de prueba de estrés.	Consulta una tarea de prueba de estrés.
DescribeCloudBenchTasks	Consulta de la lista de tareas de prueba de estrés.	Consulta la lista de tareas de prueba de estrés.
CreateCloudBenchTasks	CreateCloudBenchTasks.	Puede llamar a la operación CreateCloudBenchTasks para crear una tarea de prueba de estrés.
DescribeCloudbenchTaskConfig	Describir la configuración de la tarea de prueba de estrés.	Obtiene la configuración detallada, las rutas de archivos y los comandos de ejecución de una tarea específica de prueba de estrés.
DeleteCloudBenchTask	DeleteCloudBenchTask.	Elimina una tarea de prueba de estrés.
DeleteStopGateway	DeleteStopGateway.	Elimina los metadatos de una puerta de enlace de base de datos detenida.
GetYaoChiAgent	Llamar a la interfaz de capacidad del modelo base del agente de ApsaraDB.	Proporciona la interfaz de capacidad del modelo base del agente de ApsaraDB de Alibaba Cloud para chat de IA, diagnóstico de rendimiento y otras funciones.
DescribeAuditLogs	Consulta de registros de alertas de auditoría.	Consulta la lista de registros de alertas de auditoría para la búsqueda y el manejo de alertas.
DescribeDasOpsConfig	Ver configuración de los Servicios administrados de Alibaba Cloud.	Consulta los elementos habilitados de los Servicios administrados de Alibaba Cloud.
DescribeSqlInsightStatistic	Consulta de estadísticas de SQL Explorer.	Invoca la operación DescribeSqlInsightStatistic para agregar y recopilar estadísticas de los datos de SQL Explorer de una instancia especificada dentro de una ventana de tiempo determinada, según dimensiones como la plantilla de SQL, el origen de acceso o el usuario de la base de datos.
ModifyDasOpsConfig	Habilitar o deshabilitar el servicio de operaciones y mantenimiento de DAS.	Modifica un elemento de configuración de los Servicios administrados de Alibaba Cloud.

Others

API	Título	Descripción
ModifyForwardSqlLogConfig	Habilitar o deshabilitar la entrega de reenvío de registros.	Modifica la configuración de reenvío de registros de auditoría.