Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (DAS/2020-01-16) utiliza o estilo de assinatura RPC. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.
Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.
Cenários de assinatura personalizada
Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.
Preparação de conta e segurança
As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.
Acesso à instância
|
API |
Título |
Descrição |
| AddHDMInstance | AddHDMInstance. | Adiciona uma instância de banco de dados ao Database Autonomy Service (DAS). |
Inspeção e pontuação
|
API |
Título |
Descrição |
| GetInstanceInspections | GetInstanceInspections. | Consulta o resultado de uma inspeção realizada em uma instância de banco de dados usando o recurso de inspeção e pontuação. |
Notificação de eventos
|
API |
Título |
Descrição |
| SetEventSubscription | SetEventSubscription. | Configura as definições de assinatura de eventos para uma instância de banco de dados. |
| GetEventSubscription | Consulta das configurações de assinatura de eventos. | Consulta as configurações de assinatura de eventos de uma instância de banco de dados. |
| GetAutonomousNotifyEventContent | GetAutonomousNotifyEventContent. | Retorna os detalhes de eventos de notificação autônoma para uma instância de banco de dados. |
| GetAutonomousNotifyEventsInRange | GetAutonomousNotifyEventsInRange. | Consulta os eventos de notificação de um ou mais níveis de urgência dentro de um período. |
Relatório de diagnóstico
|
API |
Título |
Descrição |
| CreateDiagnosticReport | CreateDiagnosticReport. | Cria um relatório de diagnóstico. |
| DescribeDiagnosticReportList | DescribeDiagnosticReportList. | Consulta relatórios de diagnóstico. |
Análise de cache
|
API |
Título |
Descrição |
| CreateCacheAnalysisJob | CreateCacheAnalysisJob. | Cria uma tarefa de análise de cache. |
| DescribeCacheAnalysisJob | DescribeCacheAnalysisJob. | Retorna detalhes de uma tarefa de análise de cache. |
| DescribeCacheAnalysisJobs | DescribeCacheAnalysisJobs. | Consulta uma lista de tarefas de análise de cache. |
Limitação de SQL
|
API |
Título |
Descrição |
| EnableSqlConcurrencyControl | EnableSqlConcurrencyControl. | Ativa a limitação de SQL para controlar o número de solicitações de acesso ao banco de dados e de instruções SQL simultâneas. |
| DisableSqlConcurrencyControl | DisableSqlConcurrencyControl. | Desativa uma regra de limitação. |
| DisableAllSqlConcurrencyControlRules | DisableAllSqlConcurrencyControlRules. | Desativa todas as regras de limitação que estão em vigor. |
| GetRunningSqlConcurrencyControlRules | GetRunningSqlConcurrencyControlRules. | Consulta as regras de limitação que estão em vigor. |
| GetSqlConcurrencyControlRulesHistory | GetSqlConcurrencyControlRulesHistory. | Consulta as regras de limitação que estão sendo executadas ou que foram acionadas. |
| GetSqlConcurrencyControlKeywordsFromSqlText | GetSqlConcurrencyControlKeywordsFromSqlText. | Gera uma string de palavras-chave de limitação com base em uma instrução SQL. |
Diagnóstico de SQL
|
API |
Título |
Descrição |
| CreateRequestDiagnosis | CreateRequestDiagnosis. | Inicia uma solicitação de diagnóstico de instrução SQL. |
| GetRequestDiagnosisResult | GetRequestDiagnosisResult. | Chama GetRequestDiagnosisResult para obter os resultados do diagnóstico de SQL. |
| GetRequestDiagnosisPage | GetRequestDiagnosisPage. | Consulta os registros de diagnóstico de SQL por página. |
| DescribeQueryExplain | DescribeQueryExplain. | Obtém o plano de execução de uma instrução SQL. |
Análise de chaves
|
API |
Título |
Descrição |
| DescribeHotBigKeys | Obter chaves quentes e chaves grandes atuais em tempo real. | Chama a operação DescribeHotBigKeys para obter as chaves quentes e as chaves grandes na memória atual em tempo real. |
| DescribeTopHotKeys | DescribeTopHotKeys. | Consulta as 100 principais hot keys em um período de tempo especificado. |
| DescribeTopBigKeys | DescribeTopBigKeys. | Consulta as 100 maiores chaves em um determinado período. |
| DescribeHotKeys | DescribeHotKeys. | Verifica as hot keys de uma instância Redis. |
Governança de consultas
|
API |
Título |
Descrição |
| CreateQueryOptimizeTag | CreateQueryOptimizeTag. | Adiciona uma tag a um modelo SQL. |
| GetQueryOptimizeExecErrorStats | GetQueryOptimizeExecErrorStats. | Consulta modelos SQL que falharam na execução. |
| GetQueryOptimizeExecErrorSample | GetQueryOptimizeExecErrorSample. | Consulta as instruções SQL com falha em um modelo SQL. |
| GetQueryOptimizeSolution | GetQueryOptimizeSolution | Consulta as sugestões fornecidas pela governança de consultas para otimizar um modelo SQL. |
| GetQueryOptimizeRuleList | GetQueryOptimizeRuleList. | Consulta as tags adicionadas pelo recurso de governança de consulta às instâncias de banco de dados especificadas. |
| GetQueryOptimizeDataTrend | GetQueryOptimizeDataTrend. | Consulta os dados de tendência de governança de consultas. |
| GetQueryOptimizeDataTop | GetQueryOptimizeDataTop. | Retorna as instâncias com melhor e pior desempenho com base nos dados de governança de consultas. |
| GetQueryOptimizeDataStats | GetQueryOptimizeDataStats. | Retorna estatísticas de modelos SQL a partir de dados de governança de consultas. |
| GetQueryOptimizeTag | GetQueryOptimizeTag. | Consulta as tags de uma instrução SQL. |
| GetQueryOptimizeShareUrl | GetQueryOptimizeShareUrl. | Consulta uma URL de compartilhamento fornecida pelo recurso de governança de consultas. |
SQL Explorer
|
API |
Título |
Descrição |
| GetErrorRequestSample | GetErrorRequestSample. | Consulta de forma assíncrona informações sobre consultas SQL com falha nos dados do SQL Explorer. Você pode consultar até 20 consultas SQL com falha dentro do intervalo de tempo especificado. |
| GetAsyncErrorRequestStatResult | GetAsyncErrorRequestStatResult. | Chama GetAsyncErrorRequestStatResult para obter de forma assíncrona a contagem de erros de execução de uma instrução SQL específica nos resultados do SQL Insight de uma instância de banco de dados. |
| GetAsyncErrorRequestListByCode | GetAsyncErrorRequestListByCode. | Consulta de forma assíncrona os IDs das instruções SQL que geram um código de erro do MySQL nos resultados do SQL Explorer de uma instância de banco de dados. |
| GetAsyncErrorRequestStatByCode | GetAsyncErrorRequestStatByCode. | Consulta de forma assíncrona os códigos de erro do MySQL nos dados do SQL Explorer e o número de consultas SQL correspondentes a cada código de erro. |
| GetFullRequestOriginStatByInstanceId | GetFullRequestOriginStatByInstanceId. | Coleta as estatísticas completas de solicitações nos resultados do SQL Explorer de uma instância de banco de dados por origem de acesso. |
| GetFullRequestStatResultByInstanceId | GetFullRequestStatResultByInstanceId. | Coleta assincronamente as estatísticas completas de solicitação nos resultados do SQL Explorer de uma instância de banco de dados por ID de SQL. |
| GetFullRequestSampleByInstanceId | GetFullRequestSampleByInstanceId. | Consulta instruções SQL de amostra nos dados do SQL Explorer de uma instância de banco de dados por ID de SQL. Você pode consultar até 20 instruções SQL de amostra. |
Gerenciamento da edição Enterprise
|
API |
Título |
Descrição |
| DescribeSqlLogConfig | Query DAS enterprise edition configuration. | Consulta a configuração da DAS Enterprise Edition de uma instância de banco de dados. |
| ModifySqlLogConfig | ModifySqlLogConfig. | Utiliza a operação ModifySqlLogConfig para ativar ou configurar o DAS Enterprise Edition para uma instância de banco de dados. |
| DescribeSqlLogStatistic | DescribeSqlLogStatistic | Chama a operação DescribeSqlLogStatistic para consultar as estatísticas de dados do DAS Enterprise Edition. |
| GetDasSQLLogHotData | GetDasSQLLogHotData. | Obtém dados quentes dos logs de auditoria de SQL. |
| CreateSqlLogTask | CreateSqlLogTask. | Cria uma tarefa offline para o Database Autonomy Service (DAS) Enterprise Edition. |
| DescribeSqlLogTask | DescribeSqlLogTask. | Chama a operação `DescribeSqlLogTask` para consultar os detalhes de uma tarefa offline na edição enterprise do DAS. |
| DescribeSqlLogTasks | DescribeSqlLogTasks. | Lista as tarefas de log de auditoria de uma instância. |
Sessão da instância
|
API |
Título |
Descrição |
| GetRedisAllSession | GetRedisAllSession. | Consulta a sessão atual em uma instância do ApsaraDB for Redis. |
| GetMongoDBCurrentOp | GetMongoDBCurrentOp. | Consulta as sessões atuais de uma instância do ApsaraDB for MongoDB (MongoDB). |
| KillInstanceAllSession | KillInstanceAllSession. | Encerra todas as sessões em uma instância. |
| CreateKillInstanceSessionTask | CreateKillInstanceSessionTask. | Cria uma tarefa que encerra sessões. |
| GetKillInstanceSessionTaskResult | GetKillInstanceSessionTaskResult. | Consulta os resultados de uma tarefa que encerra sessões. |
| GetMySQLAllSessionAsync | GetMySQLAllSessionAsync. | Consulta assincronamente as sessões de uma instância e coleta estatísticas das sessões com base em dimensões. |
Análise de armazenamento
|
API |
Título |
Descrição |
| CreateStorageAnalysisTask | CreateStorageAnalysisTask. | Cria uma tarefa de análise de armazenamento para consultar os detalhes de uso de um ou mais bancos de dados e tabelas. |
| GetStorageAnalysisResult | GetStorageAnalysisResult. | Consulta o status e os resultados de uma tarefa de análise de armazenamento. |
| GetAutoIncrementUsageStatistic | GetAutoIncrementUsageStatistic. | Consulta o uso de IDs de tabelas de incremento automático. |
Otimização de bloqueios
|
API |
Título |
Descrição |
| GetDeadLockDetailList | GetDeadLockDetailList. | Consulta os detalhes de deadlock de uma instância ApsaraDB RDS for SQL Server. |
| GetBlockingDetailList | GetBlockingDetailList. | Consulta os dados de bloqueio de uma instância do ApsaraDB RDS for SQL Server. |
| CreateLatestDeadLockAnalysis | CreateLatestDeadLockAnalysis. | Aciona uma análise sob demanda do evento de deadlock mais recente capturado pela instância de banco de dados. |
| GetDeadLockHistory | GetDeadLockHistory. | Obtém as tarefas de análise histórica para análise recente e completa de deadlocks. |
| GetDeadLockDetail | GetDeadLockDetail. | Obtém as informações detalhadas de um único evento de deadlock. |
| GetDeadlockHistogram | GetDeadlockHistogram. | Obtém um histograma de série temporal de ocorrências de deadlock com base na análise completa de deadlock de logs de erros dentro de um intervalo de tempo especificado. |
Diagnóstico de índices
|
API |
Título |
Descrição |
| GetInstanceMissingIndexList | GetInstanceMissingIndexList. | Retorna detalhes de todos os índices ausentes de uma instância. |
Log lento
|
API |
Título |
Descrição |
| DescribeSlowLogHistogramAsync | DescribeSlowLogHistogramAsync. | Obtém assincronamente os dados de tendência de logs lentos de uma instância. |
| DescribeSlowLogStatistic | DescribeSlowLogStatistic. | Obtém estatísticas de log de consultas lentas. |
| DescribeSlowLogRecords | DescribeSlowLogRecords. | Consulta, filtra e classifica registros de logs de consultas lentas de uma instância de banco de dados com base em várias condições. |
Limitação automática de SQL
|
API |
Título |
Descrição |
| UpdateAutoThrottleRulesAsync | UpdateAutoThrottleRulesAsync. | Configura assincronamente os parâmetros relacionados ao recurso de limitação automática de SQL para várias instâncias de banco de dados simultaneamente. |
| DisableAutoThrottleRules | DisableAutoThrottleRules. | Desativa o recurso de limitação automática de SQL para várias instâncias de banco de dados de uma só vez. |
| GetAutoThrottleRules | GetAutoThrottleRules | Consulta as regras de limitação automática de SQL de uma instância de banco de dados. |
Otimização automática de SQL
|
API |
Título |
Descrição |
| UpdateAutoSqlOptimizeStatus | UpdateAutoSqlOptimizeStatus. | Ativa, modifica ou desativa o recurso de otimização automática de SQL para várias instâncias de banco de dados de uma só vez. |
| GetSqlOptimizeAdvice | GetSqlOptimizeAdvice. | Consulta sugestões de otimização geradas pelo recurso de diagnóstico de SQL do Database Autonomy Service (DAS). |
| GetInstanceSqlOptimizeStatistic | GetInstanceSqlOptimizeStatistic. | Consulta estatísticas sobre eventos de otimização automática de SQL dentro de um período de tempo, como o número total de eventos de otimização e a melhoria máxima. |
Otimização automática de espaço
|
API |
Título |
Descrição |
| UpdateAutoResourceOptimizeRulesAsync | UpdateAutoResourceOptimizeRulesAsync. | Configura assincronamente os parâmetros relacionados ao recurso de reciclagem automática de fragmentos para várias instâncias de banco de dados simultaneamente. |
| DisableAutoResourceOptimizeRules | DisableAutoResourceOptimizeRules. | Desativa o recurso de reciclagem automática de fragmentos de tablespace para instâncias de banco de dados simultaneamente. |
| GetAutoResourceOptimizeRules | GetAutoResourceOptimizeRules. | Consulta as regras de reciclagem automática de fragmentos de instâncias de banco de dados. |
Dimensionamento elástico automático
|
API |
Título |
Descrição |
| ModifyAutoScalingConfig | ModifyAutoScalingConfig. | Modifica as configurações de auto scaling de uma instância. |
| DescribeAutoScalingConfig | DescribeAutoScalingConfig. | Consulta as configurações do recurso de auto scaling para uma instância. |
| DescribeAutoScalingHistory | DescribeAutoScalingHistory. | Consulta o histórico de dimensionamento automático de uma instância. |
| DisableInstanceDasConfig | DisableInstanceDasConfig. | Desativa o recurso de escalonamento automático para uma instância de banco de dados. |
Mapa de calor de partições
|
API |
Título |
Descrição |
| GetPfsSqlSample | GetPfsSqlSample. | Consulta os dados de amostra de SQL da nova versão do recurso performance insight de uma instância de banco de dados. |
| GetPfsMetricTrends | GetPfsMetricTrends. | Consulta a tendência de uma métrica da nova versão do recurso Performance Insight de uma instância de banco de dados. |
| GetPfsSqlSummaries | GetPfsSqlSummaries. | Consulta todos os dados de solicitação usando a dimensão de ID de SQL no Performance Insight (Nova Versão) para uma instância de banco de dados. |
Performance Insight (nova versão)
|
API |
Título |
Descrição |
| DescribeErrorLogRecords | DescribeErrorLogRecords. | Consulta os detalhes dos logs de erros de uma instância de banco de dados específica dentro de um intervalo de tempo especificado. |
Log de erros
|
API |
Título |
Descrição |
| Chat | Chat. | Fornece uma API assíncrona para acessar os recursos de modelo de linguagem grande do DAS. |
| GetInstanceGroupInspectReportList | Consulta da lista de relatórios de O&M do agente do DAS | Consulta a lista de relatórios de O&M gerados pelo DAS Agent. |
| GetInstanceGroupInspectReportDetail | Consulta os detalhes do relatório de operações do DAS Agent | Obtém os detalhes de um relatório de operações do DAS Agent. |
DAS Agent
|
API |
Título |
Descrição |
| CreateSecurityIPGroup | CreateSecurityIPGroup. | Cria um modelo de whitelist que pode ser usado em vários produtos. |
| DescribeSecurityIPGroup | DescribeSecurityIPGroup. | Visualiza os detalhes de um modelo de whitelist entre produtos. |
| DescribeSecurityIPGroupRelation | DescribeSecurityIPGroupRelation. | Consulta como os modelos de lista de permissões entre produtos são vinculados às instâncias. |
| ModifySecurityIPGroup | ModifySecurityIPGroup. | Modifica um modelo de lista de permissões entre produtos. |
| ModifySecurityIPGroupRelation | ModifySecurityIPGroupRelation. | Vincula ou desvincula um modelo de lista de permissões entre produtos. |
| DeleteSecurityIPGroup | DeleteSecurityIPGroup. | Exclui um modelo de whitelist entre produtos. |
Lista de permissões entre produtos
|
API |
Título |
Descrição |
| GetDasAgentSSE | GetDasAgentSSE. | Esta API utiliza Server-Sent Events (SSE) para interagir com o agente DAS. Você pode usar esta API para recursos como perguntas e respostas e diagnósticos de desempenho. |
| DescribeSqlLogRecords | DescribeSqlLogRecords. | Chama DescribeSqlLogRecords para consultar detalhes de log no DAS Enterprise Edition. |
| EnableDasPro | EnableDasPro. | Ativa a edição Professional do Database Autonomy Service (DAS). |
| DisableDasPro | DisableDasPro. | Desativa a edição Professional do Database Autonomy Service (DAS). |
| DescribeInstanceDasPro | DescribeInstanceDasPro. | Consulta se o Database Autonomy Service (DAS) Enterprise Edition V1 ou V2 está ativado para uma instância de banco de dados. |
| GetDasProServiceUsage | GetDasProServiceUsage. | Consulta o uso de armazenamento de uma instância de banco de dados para a qual o Database Autonomy Service (DAS) Enterprise Edition V1 ou V2 está ativado. |
| RunCloudBenchTask | RunCloudBenchTask. | Chama a operação RunCloudBenchTask para executar uma tarefa de teste de estresse. |
| DescribeCloudbenchTask | DescribeCloudbenchTask. | Consulta uma tarefa específica de teste de estresse. |
| DescribeCloudBenchTasks | DescribeCloudBenchTasks | Você pode chamar a operação DescribeCloudBenchTasks para consultar tarefas de teste de estresse. |
| CreateCloudBenchTasks | CreateCloudBenchTasks. | Cria uma tarefa de teste de estresse. |
| DescribeCloudbenchTaskConfig | DescribeCloudbenchTaskConfig. | Obtém a configuração detalhada, os caminhos de arquivos e os comandos de execução de uma tarefa específica de teste de estresse. |
| DeleteCloudBenchTask | DeleteCloudBenchTask. | Exclui uma tarefa de teste de estresse. |
| DeleteStopGateway | DeleteStopGateway. | Exclui os metadados de um gateway de banco de dados parado. |
| GetYaoChiAgent | Chama a interface de capacidade do modelo de base do ApsaraDB Agent. | Fornece a interface de capacidade do modelo de base do ApsaraDB Agent do Alibaba Cloud para chat de IA, diagnósticos de desempenho e outros recursos. |
| DescribeAuditLogs | DescribeAuditLogs. | Consulta os logs de alerta de auditoria de dados para localizar e tratar alertas. |
Outros
|
API |
Título |
Descrição |
| GetDBInstanceConnectivityDiagnosis | GetDBInstanceConnectivityDiagnosis. | Consulta o diagnóstico de conectividade de rede quando um usuário acessa uma instância de banco de dados específica especificando um endereço IP. |
| GetPartitionsHeatmap | GetPartitionsHeatmap. | Consulta estatísticas de frequência de acesso e dados quentes em partições de uma instância PolarDB-X 2.0. |