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 | Conectar uma instância de banco de dados. | Chama a operação AddHDMInstance para conectar 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. |
| GetDBInstanceConnectivityDiagnosis | Obter resultado do diagnóstico de conectividade de rede para uma instância de banco de dados. | Obtém o resultado do diagnóstico de conectividade de rede de um endereço IP especificado pelo usuário para uma instância de banco de dados especificada. |
Análise de cache
|
API |
Título |
Descrição |
| CreateCacheAnalysisJob | Criar uma tarefa de análise de cache. | Cria uma tarefa de análise de cache chamando a operação CreateCacheAnalysisJob. |
| 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 | Consulta do plano de execução de SQL | Consulta 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 | Consultar hot keys de uma instância. | Consulta as hot keys de uma instância Redis chamando a operação DescribeHotKeys. |
Governança de consultas
|
API |
Título |
Descrição |
| CreateQueryOptimizeTag | Adicionar tags a instruções SQL de destino. | Chama a operação CreateQueryOptimizeTag para adicionar tags a instruções SQL de destino. |
| 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 | Obter tags SQL. | Consulta as tags de uma instrução SQL especificada chamando a operação GetQueryOptimizeTag. |
| GetQueryOptimizeShareUrl | Obter a URL de compartilhamento para a governança de consultas | Obtém a URL de compartilhamento para a Governança de Consultas. |
Explorador de SQL
|
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 | Obter de forma assíncrona as estatísticas completas de solicitações por ID de SQL | Obtém de forma assíncrona as estatísticas completas de solicitações dos resultados do SQL Explorer de uma instância de banco de dados por ID de SQL. |
| GetFullRequestSampleByInstanceId | Consulta dados de amostra de SQL por ID de SQL. | Consulta dados de amostra de SQL dos resultados do SQL Explorer de uma instância de banco de dados por ID de SQL ao chamar a operação GetFullRequestSampleByInstanceId. São retornados no máximo 20 registros 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 | Ativar ou configurar o DAS Enterprise Edition | Ativa ou configura o DAS Enterprise Edition para uma instância de banco de dados. |
| DescribeSqlLogStatistic | Consultar informações estatísticas do DAS Enterprise Edition. | Invoca a operação DescribeSqlLogStatistic para consultar as informações estatísticas do DAS Enterprise Edition. |
| GetDasSQLLogHotData | Consulta os detalhes dos dados de armazenamento quente da edição Enterprise do DAS | Obtém os dados quentes dos logs de auditoria. |
| CreateSqlLogTask | Criar uma tarefa em lote da edição empresarial do DAS. | Cria uma tarefa assíncrona para dados detalhados. |
| DescribeSqlLogTask | Consultar detalhes da tarefa em lote do DAS Enterprise Edition. | Consulta os detalhes de uma tarefa em lote do DAS Enterprise Edition chamando a operação DescribeSqlLogTask. |
| DescribeSqlLogTasks | Listar tarefas em lote da edição empresarial do DAS. | Consulta a lista de 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 | Encerrar todas as sessões. | Chama a operação KillInstanceAllSession para encerrar todas as sessões em uma instância especificada. |
| CreateKillInstanceSessionTask | Criar uma tarefa para encerrar sessões. | 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 | Create a recent deadlock analysis task | Cria uma tarefa de análise de deadlocks recentes. |
| 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 | Consulta a tendência de contagens de deadlocks na análise completa de deadlocks dentro de um intervalo de tempo | Consulta a tendência de contagens de deadlocks com base na análise completa de deadlocks dos 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 de consultas lentas
|
API |
Título |
Descrição |
| DescribeSlowLogHistogramAsync | Obtenção assíncrona de dados de tendências de slow logs para uma instância | Obtém assincronamente os dados de tendências de slow logs de uma instância. |
| DescribeSlowLogStatistic | Informações de estatísticas do log de consultas lentas | Obtém informações de estatísticas do log de consultas lentas. |
| DescribeSlowLogRecords | Consulta de registros de log de consultas lentas. | Consulta os registros de log de consultas lentas de uma instância de banco de dados. Você pode filtrar e classificar os resultados por várias condições. |
Limitação automática de SQL
|
API |
Título |
Descrição |
| UpdateAutoThrottleRulesAsync | Definir parâmetros de limitação automática de SQL. | Chama a operação UpdateAutoThrottleRulesAsync para configurar de forma assíncrona os parâmetros de limitação automática de SQL para instâncias de banco de dados especificadas em lotes. |
| 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 | Consultar sugestões de diagnóstico geradas pela otimização automática de SQL. | Consulta as sugestões de diagnóstico geradas pelo recurso de otimização automática de SQL do 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. |
Escalonamento elástico automático
|
API |
Título |
Descrição |
| ModifyAutoScalingConfig | Modificação da configuração de dimensionamento elástico de uma instância | Modifica a configuração de dimensionamento elástico de uma instância. |
| DescribeAutoScalingConfig | Consultar a configuração do recurso de escalonamento elástico da instância. | Invoca a operação DescribeAutoScalingConfig para consultar a configuração do recurso de escalonamento elástico de uma instância. |
| DescribeAutoScalingHistory | Consultar histórico de escalonamento elástico da instância. | Consulta o histórico de escalonamento elástico 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 |
| GetPartitionsHeatmap | GetPartitionsHeatmap. | Consulta estatísticas de frequência de acesso e dados quentes em partições de uma instância PolarDB-X 2.0. |
Insight de desempenho (Nova versão)
|
API |
Título |
Descrição |
| GetPfsSqlSample | Obter dados de amostra de SQL | Obtém os dados de amostra de SQL para o recurso Performance Insight (Nova Versão). |
| 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. |
Log de erros
|
API |
Título |
Descrição |
| DescribeErrorLogRecords | Consulta de detalhes do log de erros. | Consulta os detalhes do log de erros de uma instância dentro de um intervalo de tempo especificado. |
Agente do DAS
|
API |
Título |
Descrição |
| Chat | Interagir com o agente do DAS | Invoca a interface de lógica assíncrona para os recursos de modelo de linguagem grande do Database Autonomy Service (DAS). |
| GetInstanceGroupInspectReportList | Consulta de relatórios de O&M do agente DAS | Consulta a lista de relatórios de O&M gerados pelo DAS Agent. |
| GetInstanceGroupInspectReportDetail | Query DAS agent operations report details. | Obtém os detalhes de um relatório de operações automatizadas do DAS Agent. |
Lista de permissões entre produtos
|
API |
Título |
Descrição |
| CreateSecurityIPGroup | Criar um modelo de lista de permissões entre serviços. | Cria um modelo de lista de permissões entre serviços para um usuário. |
| DescribeSecurityIPGroup | Display cross-engine whitelist template details | Exibe os detalhes de um modelo de lista de permissões entre mecanismos para um usuário. |
| DescribeSecurityIPGroupRelation | Exibir informações de vinculação de modelo de lista de permissões entre mecanismos. | Exibe as informações de vinculação entre um modelo de lista de permissões entre mecanismos e instâncias para um usuário. |
| ModifySecurityIPGroup | ModifySecurityIPGroup. | Modifica um modelo de lista de permissões entre produtos. |
| ModifySecurityIPGroupRelation | Vincular ou desvincular um modelo de lista de permissões entre mecanismos. | Vincula ou desvincula um modelo de lista de permissões entre mecanismos a ou de um usuário. |
| DeleteSecurityIPGroup | Excluir um modelo de lista de permissões entre produtos. | Exclui um modelo de lista de permissões entre produtos para um usuário. |
Outros
|
API |
Título |
Descrição |
| GetDasAgentSSE | (Obsoleto) Interface de fluxo de dados do agente DAS. | Fornece uma interface SSE interativa de modelo grande do DAS. Suporta recursos como chat de IA e diagnósticos de desempenho. |
| DescribeSqlLogRecords | (Descontinuado) Consulta dos detalhes de log do DAS Enterprise Edition | Consulta os detalhes de log do DAS Enterprise Edition. |
| EnableDasPro | Ativar o DAS Enterprise Edition V1 | Ativa o DAS Professional Edition para uma instância especificada. |
| 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 | Consultar o uso de armazenamento do DAS Enterprise Edition (V1 ou V2) | Consulta o uso de armazenamento do DAS Enterprise Edition V1 ou V2 para uma instância de banco de dados. |
| RunCloudBenchTask | RunCloudBenchTask. | Chama a operação RunCloudBenchTask para executar uma tarefa de teste de estresse. |
| DescribeCloudbenchTask | Consultar uma tarefa de teste de estresse. | Consulta uma tarefa de teste de estresse. |
| DescribeCloudBenchTasks | Consulta a lista de tarefas de teste de estresse. | Consulta a lista de 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 | Invoca a API do modelo de linguagem grande do ApsaraDB Agent | Invoca a API do modelo de linguagem grande do ApsaraDB Agent para executar tarefas como perguntas e respostas de conhecimento e diagnósticos de desempenho. |
| CreateYaoChiAgentConfirm | Confirmar operação de chamada de API do agente ApsaraDB | Confirma ou rejeita uma operação pendente em uma sessão do agente ApsaraDB do Alibaba Cloud. |
| DescribeAuditLogs | Consulta de logs de alertas de auditoria | Consulta a lista de logs de alertas de auditoria de dados para facilitar a pesquisa e o processamento de alertas. |
| DescribeDasOpsConfig | Visualizar configurações do Alibaba Cloud Managed Services | Consulta os itens ativados do Alibaba Cloud Managed Services. |
| DescribeSqlInsightStatistic | Consulta estatísticas do SQL Insight | Invoca a operação DescribeSqlInsightStatistic para realizar a agregação de estatísticas do SQL Explorer para uma instância especificada dentro de uma determinada janela de tempo por dimensões como modelo de SQL, origem de acesso ou usuário do banco de dados. |
| ModifyDasOpsConfig | Ativar ou desativar o Alibaba Cloud Managed Services do DAS | Modifica os itens de configuração do Alibaba Cloud Managed Services. |
Others
|
API |
Título |
Descrição |
| ModifyForwardSqlLogConfig | Ativar ou desativar o encaminhamento e a entrega de logs | Modifica a configuração de encaminhamento de auditoria. |