Todos os produtos
Search
Central de documentação

ApsaraDB RDS:Visão geral da API

Última atualização: Aug 17, 2026

Padrões de API e SDKs predefinidos multilíngues

A OpenAPI deste produto (Rds/2014-08-15) 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.

Cobrança

API

Título

Descrição

TransformDBInstancePayType TransformDBInstancePayType Altera o método de faturamento de uma instância do ApsaraDB RDS.
ModifyDBInstancePayType ModifyDBInstancePayType Altera o método de cobrança de uma instância de pós-pago para assinatura.
ModifyInstanceAutoRenewalAttribute ModifyInstanceAutoRenewalAttribute Modifica as configurações de renovação automática de uma instância.
DescribePrice DescribePrice Consulta o preço de uma instância.
DescribeRenewalPrice DescribeRenewalPrice Consulta as taxas de renovação de uma instância de assinatura.
DescribeInstanceAutoRenewalAttribute DescribeInstanceAutoRenewalAttribute Consulta o status de renovação automática de uma instância.
RenewInstance RenewInstance Renova manualmente uma instância.
DescribeDBInstancePromoteActivity DescribeDBInstancePromoteActivity A operação foi descontinuada.

Instâncias

API

Título

Descrição

CreateDBInstance Create an apsaraDB RDS instance Cria uma instância do ApsaraDB RDS.
CreateDBInstanceForRebuild CreateDBInstanceForRebuild Reconstrói uma instância a partir da lixeira.
DeleteDBInstance DeleteDBInstance Libera uma instância.
RestartDBInstance RestartDBInstance Reinicia uma instância.
StopDBInstance StopDBInstance Suspende uma instância ApsaraDB RDS.
StartDBInstance StartDBInstance Retoma uma instância.
ModifyDBInstanceSpec Modificar especificações de instância RDS Modifica as especificações e a capacidade de armazenamento de uma instância ApsaraDB RDS.
DestroyDBInstance Destruir uma instância. Destrói uma instância do ApsaraDB RDS na lixeira.
ModifyDasInstanceConfig ModifyDasInstanceConfig Configura a expansão automática de armazenamento para uma instância.
MigrateToOtherZone MigrateToOtherZone Migra uma instância RDS para uma zona de disponibilidade diferente.
ModifyDBInstanceDescription Modificar o nome de uma instância. Você pode chamar a operação ModifyDBInstanceDescription para modificar o nome de uma instância.
ModifyDBInstanceMaintainTime ModifyDBInstanceMaintainTime Modifica a janela de manutenção de uma instância.
ModifyResourceGroup ModifyResourceGroup Move uma instância do ApsaraDB RDS para um grupo de recursos especificado.
ModifyHADiagnoseConfig ModifyHADiagnoseConfig Altera o método de verificação de disponibilidade de uma instância.
ModifyAccountSecurityPolicy ModifyAccountSecurityPolicy Modifica a política de senha de uma conta de uma instância do ApsaraDB RDS for SQL Server.
DescribeSupportOnlineResizeDisk DescribeSupportOnlineResizeDisk Verifica se o disco de uma instância do ApsaraDB RDS for SQL Server pode ser redimensionado online.
DescribeAvailableZones DescribeAvailableZones Consulta as zonas disponíveis para uma instância.
DescribeAvailableClasses DescribeAvailableClasses Consulta as especificações compatíveis com uma instância. As especificações incluem o tipo de instância e a capacidade de armazenamento.
DescribeDBInstanceAttribute Consulta de detalhes da instância. Consulta os detalhes de uma instância do ApsaraDB RDS.
GetDBInstanceTopology GetDBInstanceTopology Consulta a topologia de uma instância.
DescribeDBInstances Consulta a lista de instâncias. Consulta uma lista de instâncias do ApsaraDB RDS.
ListClasses ListClasses Consulta os detalhes das especificações de uma instância.
DescribeDBInstancesByExpireTime DescribeDBInstancesByExpireTime Consulta as informações de uma instância do ApsaraDB RDS com base no tempo restante de assinatura da instância.
DescribeRegions DescribeRegions Consulta os detalhes de todas as regiões e zonas do ApsaraDB RDS. As regiões que não são mais suportadas também são consultadas. Tenha cautela ao chamar esta operação.
CheckInstanceExist Consulta se uma instância existe. Consulta se uma instância do ApsaraDB RDS existe.
DescribeHADiagnoseConfig DescribeHADiagnoseConfig Consulta o método de verificação de disponibilidade de uma instância.
CheckCloudResourceAuthorized CheckCloudResourceAuthorized Verifica as permissões concedidas em uma instância.
ReleaseInstanceConnection ReleaseInstanceConnection Libera o endpoint público de uma instância.
DescribeDBInstanceDetail Consultar os detalhes de uma instância. Você pode chamar a operação DescribeDBInstanceDetail para consultar os detalhes de uma instância.
DescribeDBInstancesByPerformance Consulta de instâncias com base no desempenho. Consulta o desempenho das instâncias por meio da operação DescribeDBInstancePerformance.
DescribeDBInstancesForClone DescribeDBInstancesForClone Consulta uma lista de instâncias.
DescribeDBInstancesAsCsv DescribeDBInstancesAsCsv Obtém uma lista de instâncias. Esta API está obsoleta.

Atualização de versão

API

Título

Descrição

ModifyDBInstanceAutoUpgradeMinorVersion ModifyDBInstanceAutoUpgradeMinorVersion Altera o método usado para atualizar a versão secundária do mecanismo de uma instância do ApsaraDB RDS for MySQL ou de uma instância do ApsaraDB RDS for PostgreSQL.
DescribeUpgradeMajorVersionPrecheckTask DescribeUpgradeMajorVersionPrecheckTask Obtém o relatório de pré-verificação para uma atualização de versão principal do ApsaraDB RDS for MySQL e do ApsaraDB RDS for PostgreSQL.
DescribeUpgradeMajorVersionTasks Consultar jobs de upgrade de versão principal para instâncias RDS PostgreSQL. Esta API é utilizada para consultar o histórico de jobs de upgrade de versão principal para instâncias RDS PostgreSQL.
UpgradeDBInstanceEngineVersion UpgradeDBInstanceEngineVersion Atualiza a versão principal do mecanismo de uma instância do ApsaraDB RDS for MySQL.
UpgradeDBInstanceKernelVersion UpgradeDBInstanceKernelVersion Atualiza a versão secundária do mecanismo de uma instância do ApsaraDB RDS.
UpgradeDBInstanceMajorVersionPrecheck Verificação prévia para atualização da versão principal do mecanismo do RDS. Realiza uma verificação pré-atualização antes de uma atualização da versão principal do mecanismo para instâncias ApsaraDB RDS for MySQL ou ApsaraDB RDS for PostgreSQL.
UpgradeDBInstanceMajorVersion UpgradeDBInstanceMajorVersion Inicia uma atualização de versão principal para uma instância ApsaraDB RDS for PostgreSQL.

Rede e endereços de conexão

API

Título

Descrição

AllocateInstancePublicConnection Solicitar um endpoint público. Solicita um endpoint público para uma instância do ApsaraDB RDS.
ReleaseInstancePublicConnection Liberar o endpoint público de uma instância. Libera o endpoint público de uma instância.
ModifyDBInstanceConnectionString Gerenciar o endpoint e a porta de uma instância. Gerencia o endpoint e a porta de uma instância.
ModifyDBInstanceNetworkExpireTime ModifyDBInstanceNetworkExpireTime Altera o tempo de expiração do endpoint de rede clássica de uma instância no modo de acesso híbrido.
SwitchDBInstanceNetType SwitchDBInstanceNetType Alterna entre os endpoints interno e público de uma instância na rede clássica.
ModifyDBInstanceNetworkType ModifyDBInstanceNetworkType Altera o tipo de rede de uma instância do ApsaraDB RDS de rede clássica para VPC.
SwitchDBInstanceVpc SwitchDBInstanceVpc Altera a nuvem privada virtual (VPC) e o vSwitch de uma instância do ApsaraDB RDS.
ModifyDBInstanceConfig ModifyDBInstanceConfig Modifica o item de configuração de uma instância.
DescribeDBInstanceNetInfo DescribeDBInstanceNetInfo Consulta todos os endpoints de uma instância.
DescribeVSwitches DescribeVSwitches Consulta os detalhes dos vSwitches disponíveis em uma virtual private cloud (VPC).

Alta disponibilidade primária/secundária e replicação de dados

API

Título

Descrição

ModifyDBInstanceHAConfig ModifyDBInstanceHAConfig Altera o modo de alta disponibilidade (HA) e de replicação de dados de uma instância.
ModifyHASwitchConfig ModifyHASwitchConfig Ativa ou desativa o recurso de alternância automática primário/secundário para uma instância.
DescribeDBInstanceHAConfig DescribeDBInstanceHAConfig Consulta o modo de alta disponibilidade e o modo de replicação de dados de uma instância.
DescribeHASwitchConfig DescribeHASwitchConfig Consulta as configurações do recurso de alternância automática primária/secundária de uma instância.
SwitchDBInstanceHA SwitchDBInstanceHA Alterna cargas de trabalho entre instâncias primária e secundária do ApsaraDB RDS.

Eventos históricos

API

Título

Descrição

ModifyActionEventPolicy ModifyActionEventPolicy Ativa ou desativa o recurso de histórico de eventos de uma instância.
DescribeEvents DescribeEvents Consulta os eventos históricos de uma instância.
DescribeActionEventPolicy DescribeActionEventPolicy Consulta se o recurso de eventos históricos está ativado.

Notificações

API

Título

Descrição

QueryNotify QueryNotify Consulta as notificações de uma instância do ApsaraDB RDS.
ConfirmNotify ConfirmNotify Marca as notificações de uma instância em sua conta Alibaba Cloud como confirmadas.
DescribeRdsResourceSettings DescribeRdsResourceSettings Obtém as configurações de notificação para recursos de instância. Esta operação ainda pode ser chamada, mas não é mais mantida.

Contas

API

Título

Descrição

CreateAccount Cria uma conta de banco de dados. Cria uma conta de banco de dados.
DeleteAccount DeleteAccount Exclui uma conta de uma instância.
ModifyAccountCheckPolicy ModifyAccountCheckPolicy Verifica se uma política de senha está aplicada a uma conta.
ModifyAccountDescription ModifyAccountDescription Modifica a descrição de uma conta de banco de dados.
ModifyPGHbaConfig ModifyPGHbaConfig Modifica o arquivo pg_hba.conf de uma instância ApsaraDB RDS for PostgreSQL.
DescribeAccounts Consultar informações da conta do banco de dados. Consulta as informações da conta de uma instância do ApsaraDB RDS.
DescribeInstanceKeywords DescribeInstanceKeywords Consulta as palavras-chave reservadas de uma instância. As palavras-chave reservadas não podem ser usadas para os nomes de usuário de contas ou os nomes de bancos de dados.
DescribePGHbaConfig DescribePGHbaConfig Consulta a configuração do arquivo pg_hba.conf de uma instância do ApsaraDB RDS for PostgreSQL.
DescribeModifyPGHbaConfigLog DescribeModifyPGHbaConfigLog Consulta os detalhes sobre as modificações no arquivo pg_hba.conf de uma instância ApsaraDB RDS for PostgreSQL.
ResetAccountPassword ResetAccountPassword Redefine a senha de uma conta de banco de dados.
LockAccount LockAccount Bloqueia uma conta de uma instância do ApsaraDB RDS for PostgreSQL.
UnlockAccount UnlockAccount Desbloqueia uma conta de banco de dados de uma instância ApsaraDB RDS para PostgreSQL.
GrantAccountPrivilege Concessão de permissões de acesso ao banco de dados a uma conta. Concede permissões de acesso a um ou mais bancos de dados para uma conta de banco de dados especificada.
GrantOperatorPermission GrantOperatorPermission Concede permissões a uma conta de serviço.
RevokeOperatorPermission RevokeOperatorPermission Revoga as permissões da conta de serviço de uma instância do ApsaraDB RDS.
RevokeAccountPrivilege RevokeAccountPrivilege Revoga as permissões de uma conta em um banco de dados de uma instância do ApsaraDB RDS.
ResetAccount ResetAccount Redefine as permissões da conta privilegiada.
CheckAccountNameAvailable CheckAccountNameAvailable Verifica se o nome de usuário da conta que você deseja criar em uma instância está disponível.

Bancos de dados

API

Título

Descrição

CreateDatabase Criar um banco de dados. Cria um banco de dados em uma instância ApsaraDB RDS.
DeleteDatabase DeleteDatabase Exclui um banco de dados de uma instância RDS.
CopyDatabase CopyDatabase Replica os bancos de dados de uma instância que executa o SQL Server 2008 R2 para outra instância. Esta operação foi descontinuada.
ModifyDBDescription ModifyDBDescription Modifica a descrição de uma instância.
ModifyDatabaseConfig ModifyDatabaseConfig Modifica as configurações de propriedade de uma instância do ApsaraDB RDS for SQL Server.
ModifyCollationTimeZone ModifyCollationTimeZone Modifica a collation do conjunto de caracteres e o fuso horário dos bancos de dados do sistema em uma instância.
DescribeDatabases DescribeDatabases Obtém informações sobre bancos de dados em uma instância RDS.
DescribeCollationTimeZones DescribeCollationTimeZones Consulta as collations de conjuntos de caracteres e os fusos horários disponíveis para uso no ApsaraDB RDS for SQL Server.
DescribeCharacterSetName DescribeCharacterSetName Consulta os conjuntos de caracteres suportados por uma instância.
CopyDatabaseBetweenInstances CopyDatabaseBetweenInstances Replica bancos de dados entre instâncias RDS SQL Server.
CheckDBNameAvailable CheckDBNameAvailable Verifica se um nome de banco de dados é único e está em conformidade com as convenções de nomenclatura em uma instância.

Instâncias somente leitura

API

Título

Descrição

CreateReadOnlyDBInstance Criação de uma instância somente leitura. Cria uma instância somente leitura para uma instância RDS.
ModifyReadonlyInstanceDelayReplicationTime ModifyReadonlyInstanceDelayReplicationTime Modifica a latência na qual uma instância somente leitura do ApsaraDB RDS for MySQL replica dados de sua instância primária.
DescribeReadDBInstanceDelay DescribeReadDBInstanceDelay Consulta a latência de replicação de dados entre uma instância primária e sua instância somente leitura.
PrecheckDuckDBDependency PrecheckDuckDBDependency. Verifica se instâncias analíticas baseadas em DuckDB podem ser criadas para a instância primária especificada do RDS for PostgreSQL. Se as instâncias analíticas baseadas em DuckDB não puderem ser criadas, esta operação retorna as causas da falha e fornece soluções ou valores de especificação recomendados.

Instâncias da edição cluster do RDS

API

Título

Descrição

CreateDBNodes CreateDBNodes Adiciona um nó a uma instância do ApsaraDB RDS for MySQL ou ApsaraDB RDS for PostgreSQL que executa a RDS Cluster Edition. Uma instância do RDS que executa a RDS Cluster Edition é chamada de cluster do RDS.
CreateDBInstanceEndpoint CreateDBInstanceEndpoint Cria um endpoint para uma instância que executa o RDS Cluster Edition.
CreateDBInstanceEndpointAddress CreateDBInstanceEndpointAddress Cria um endpoint público para uma instância que executa o RDS Cluster Edition.
DeleteDBNodes DeleteDBNodes Exclui um nó de uma instância que executa o RDS Cluster Edition.
DeleteDBInstanceEndpoint DeleteDBInstanceEndpoint Exclui um endpoint de uma instância que executa a edição Cluster do RDS.
DeleteDBInstanceEndpointAddress DeleteDBInstanceEndpointAddress Libera o endpoint público de uma instância que executa a edição Cluster do RDS.
ModifyDBInstanceEndpoint Modificar as informações de peso do endpoint de uma instância. Modifica as informações de peso do endpoint de uma instância de cluster ApsaraDB RDS.
ModifyDBInstanceEndpointAddress ModifyDBInstanceEndpointAddress Modifica as informações do endpoint de uma instância que executa o RDS Cluster Edition.
DescribeDBInstanceEndpoints DescribeDBInstanceEndpoints Consulta as informações sobre os endpoints de uma instância que executa a Edição Cluster do RDS.

Proxy de banco de dados

API

Título

Descrição

CreateDBProxyEndpointAddress CreateDBProxyEndpointAddress Cria o endpoint que é usado para conectar ao proxy dedicado de uma instância.
DeleteDBProxyEndpointAddress DeleteDBProxyEndpointAddress Exclui o endpoint usado para conectar-se ao proxy dedicado de uma instância.
ModifyDBProxy ModifyDBProxy Ativa ou modifica o recurso de proxy de banco de dados de uma instância.
UpgradeDBProxyInstanceKernelVersion UpgradeDBProxyInstanceKernelVersion Atualiza a versão secundária do kernel de um proxy de banco de dados.
ModifyDBProxyInstance ModifyDBProxyInstance Altera a configuração de um proxy de banco de dados de uma instância.
ModifyDBProxyEndpoint ModifyDBProxyEndpoint Modifica as configurações de conexão de um endpoint de proxy de banco de dados.
ModifyDBProxyEndpointAddress ModifyDBProxyEndpointAddress Modifica o endpoint do proxy de banco de dados de uma instância.
ModifyDbProxyInstanceSsl ModifyDbProxyInstanceSsl Configura a criptografia SSL para um endpoint de proxy dedicado de uma instância do ApsaraDB RDS for MySQL.
DescribeDBProxy Consultar detalhes do PolarProxy. Esta API é usada para consultar as configurações do PolarProxy de uma instância RDS.
DescribeDBProxyEndpoint DescribeDBProxyEndpoint Obtém o endpoint de proxy de banco de dados de uma instância RDS.
DescribeDBProxyPerformance Consulta de dados de desempenho do PolarProxy. Consulta os dados de desempenho do proxy de banco de dados de uma instância do ApsaraDB RDS.
GetDbProxyInstanceSsl GetDbProxyInstanceSsl Consulta as configurações de criptografia SSL para um endpoint de proxy dedicado de uma instância do ApsaraDB RDS for MySQL.

Proxy de banco de dados compartilhado (sendo descontinuado)

API

Título

Descrição

ModifyReadWriteSplittingConnection ModifyReadWriteSplittingConnection Modifica o limite de latência do link de separação de leitura/gravação e os pesos de leitura de uma instância primária e suas instâncias somente leitura.
DescribeDBInstanceProxyConfiguration DescribeDBInstanceProxyConfiguration Consulta as configurações de proxy compartilhado ativadas em uma instância.
AllocateReadWriteSplittingConnection AllocateReadWriteSplittingConnection Solicita um endpoint de roteamento somente leitura para uma instância.
ReleaseReadWriteSplittingConnection ReleaseReadWriteSplittingConnection Libera um endpoint de divisão de leitura e gravação.
CalculateDBInstanceWeight Cálculo do peso da instância de banco de dados. Consulta os pesos de leitura atribuídos pelo sistema.

Segurança e criptografia

API

Título

Descrição

AttachWhitelistTemplateToInstance AttachWhitelistTemplateToInstance Associa um modelo de lista de permissões a uma instância.
CreateServiceLinkedRole CreateServiceLinkedRole Cria uma função vinculada a serviço.
DetachWhitelistTemplateToInstance DetachWhitelistTemplateToInstance Desassocia um modelo de lista de permissões de uma instância.
ModifyWhitelistTemplate ModifyWhitelistTemplate Edita uma whitelist. Você pode chamar esta operação para criar, modificar ou excluir uma whitelist.
DescribeSecurityGroupConfiguration DescribeSecurityGroupConfiguration Consulta os grupos de segurança do ECS aos quais uma instância foi adicionada.
ModifySecurityGroupConfiguration ModifySecurityGroupConfiguration Altera os grupos de segurança ECS aos quais uma instância é adicionada.
CreateDBInstanceSecurityGroupRule CreateDBInstanceSecurityGroupRule Adiciona uma regra de grupo de segurança a uma instância do ApsaraDB RDS for SQL Server.
DescribeDBInstanceSecurityGroupRule DescribeDBInstanceSecurityGroupRule Consulta as regras de grupo de segurança configuradas para uma instância do ApsaraDB RDS for SQL Server.
ModifyDBInstanceSecurityGroupRule ModifyDBInstanceSecurityGroupRule Modifica uma regra de grupo de segurança configurada para uma instância do ApsaraDB RDS for SQL Server.
DeleteDBInstanceSecurityGroupRule DeleteDBInstanceSecurityGroupRule Exclui uma regra de grupo de segurança configurada para uma instância do ApsaraDB RDS for SQL Server.
ModifySecurityIps ModifySecurityIps Modifica a whitelist de endereços IP de uma instância ApsaraDB RDS.
ModifyDBInstanceSSL Modificar configuração SSL de uma instância RDS. Modifica a configuração de link SSL de uma instância ApsaraDB RDS.
ModifyDBInstanceTDE Modificar status de TDE de uma instância RDS. Ativa ou modifica o recurso de Criptografia Transparente de Dados (TDE) para uma instância do ApsaraDB RDS.
ModifyDTCSecurityIpHostsForSQLServer ModifyDTCSecurityIpHostsForSQLServer Configura uma lista de permissões de transação distribuída para uma instância do ApsaraDB RDS for SQL Server.
ModifyDBInstanceDeletionProtection ModifyDBInstanceDeletionProtection Ativa ou desativa o recurso de proteção contra liberação para uma instância.
DescribeWhitelistTemplateLinkedInstance DescribeWhitelistTemplateLinkedInstance Consulta instâncias associadas por modelo de whitelist.
DescribeInstanceLinkedWhitelistTemplate DescribeInstanceLinkedWhitelistTemplate Consulta as listas de permissões associadas pelo nome da instância.
DescribeWhitelistTemplate DescribeWhitelistTemplate Consulta informações sobre a lista de permissões de IP especificada.
DescribeAllWhitelistTemplate DescribeAllWhitelistTemplate Consulta modelos de lista de permissões por vez usando pesquisa fuzzy.
DescribeDBInstanceIPArrayList DescribeDBInstanceIPArrayList Consulta a lista de permissões de endereços IP de uma instância do ApsaraDB RDS.
DescribeDBInstanceSSL DescribeDBInstanceSSL Consulta as configurações SSL de uma instância.
DescribeDBInstanceTDE Consultar status TDE de uma instância RDS. Consulta o status da Criptografia de Dados Transparente (TDE) de uma instância ApsaraDB RDS.
DescribeDBInstanceEncryptionKey DescribeDBInstanceEncryptionKey Você pode chamar a operação DescribeDBInstanceEncryptionKey para verificar se a criptografia de disco está ativada para uma instância. Você também pode consultar detalhes sobre as chaves usadas para criptografia de disco. Esta operação é compatível com instâncias que executam MySQL, SQL Server ou PostgreSQL.
DescribeDBInstanceIpHostname DescribeDBInstanceIpHostname Consulta o endereço IP interno e o nome do host da instância do Elastic Compute Service (ECS) na qual a instância do ApsaraDB RDS for SQL Server é executada.
DescribeDTCSecurityIpHostsForSQLServer DescribeDTCSecurityIpHostsForSQLServer Consulta as listas brancas de transações distribuídas de uma instância do ApsaraDB RDS for SQL Server.
MigrateSecurityIPMode MigrateSecurityIPMode Altera o modo de lista de permissões de uma instância do modo padrão para o modo aprimorado.

Logs

API

Título

Descrição

DescribeSQLLogReportList DescribeSQLLogReportList Consulta relatórios de log SQL.
PurgeDBInstanceLog PurgeDBInstanceLog Limpa os logs locais de uma instância do ApsaraDB RDS.
DescribeSQLLogFiles DescribeSQLLogFiles Consulta os arquivos de log gerados pelo recurso SQL Explorer (SQL Audit) para uma instância. A operação DescribeSQLLogFiles não retorna os arquivos de log gerados pelo recurso SQL Explorer e exportados manualmente do console do ApsaraDB RDS. A operação DescribeSQLLogFiles retorna os arquivos de log do SQL Explorer gerados pela chamada da operação DescribeSQLLogRecords com o parâmetro de solicitação Form definido como File.
DescribeSlowLogs DescribeSlowLogs Consulta as estatísticas dos logs de consultas lentas.
DescribeSlowLogRecords Visualizar detalhes do log de consultas lentas. Esta API é usada para visualizar os detalhes do log de consultas lentas de uma instância.
DescribeErrorLogs Visualizar logs de erro. Consulta os logs de erro de uma instância dentro de um intervalo de tempo especificado.
ModifySQLCollectorPolicy ModifySQLCollectorPolicy Esta operação ainda pode ser chamada, mas não é mais mantida. Esta operação ativa ou desativa o recurso SQL Explorer (SQL Audit) para uma instância.
ModifySQLCollectorRetention ModifySQLCollectorRetention Altera o período de retenção dos arquivos de log gerados pelo recurso SQL Explorer para uma instância do ApsaraDB RDS.
DescribeSQLCollectorPolicy DescribeSQLCollectorPolicy Consulta o status do recurso SQL Explorer (SQL Audit) para uma instância do ApsaraDB RDS.
DescribeSQLLogRecords Consultar logs de auditoria SQL de uma instância (obsoleto) Obsoleto: pode ser chamado normalmente, mas não é mais mantido. Consulta os logs do SQL Explorer (SQL Audit) de uma instância ApsaraDB RDS.
DescribeSQLCollectorRetention DescribeSQLCollectorRetention Consulta o período de retenção dos arquivos de log gerados pelo recurso SQL Explorer para uma instância.

Backup

API

Título

Descrição

ModifyBackupSetExpireTime ModifyBackupSetExpireTime Estende o tempo de expiração de conjuntos de backup gerados por backup manual para um único banco de dados, incluindo conjuntos de backup físico e conjuntos de backup completo.
CreateBackup Criar um conjunto de backup para uma instância RDS. Cria um conjunto de backup para uma instância RDS.
DeleteBackup DeleteBackup Exclui os arquivos de backup de dados de uma instância do ApsaraDB RDS.
DeleteBackupFile DeleteBackupFile Exclui os arquivos de backup de uma instância do ApsaraDB RDS for SQL Server. Esta operação está disponível apenas para usuários adicionados à lista de permissões da instância.
ModifyBackupPolicy Modificar a política de backup da instância. Modifica as configurações da política de backup de uma instância do ApsaraDB RDS.
DescribeBackups Consulta de conjuntos de backup de uma instância do ApsaraDB RDS. Consulta os conjuntos de backup de uma instância do ApsaraDB RDS.
DescribeDetachedBackups DescribeDetachedBackups Consulta os arquivos de backup de dados de uma instância do ApsaraDB RDS que foi liberada.
DescribeBackupPolicy Visualizar configurações de backup da instância Consulta as configurações de backup de uma instância do ApsaraDB RDS.
DescribeBackupTasks DescribeBackupTasks Consulta as tarefas de backup de uma instância.
DescribeBinlogFiles DescribeBinlogFiles Consulta os arquivos de log binário de uma instância que executa MySQL ou MariaDB ou os arquivos de log de gravação antecipada (WAL) de uma instância que executa PostgreSQL.
DescribeLogBackupFiles DescribeLogBackupFiles Consulta os arquivos de backup de log de uma instância ApsaraDB RDS para SQL Server.
DescribeBackupDatabase DescribeBackupDatabase Consulta os bancos de dados envolvidos em um arquivo de backup.

Restauração

API

Título

Descrição

CreateTempDBInstance CreateTempDBInstance Cria uma instância temporária para uma instância RDS que executa SQL Server 2008 R2 e utiliza discos locais.
DescribeLocalAvailableRecoveryTime DescribeLocalAvailableRecoveryTime Consulta o intervalo de tempo para o qual uma instância RDS pode ser restaurada.
DescribeMetaList DescribeMetaList Consulta as informações sobre os bancos de dados e as tabelas que podem ser restaurados a partir de um conjunto de backups especificado.
RecoveryDBInstance RecoveryDBInstance Restaura os dados de backup de uma instância do ApsaraDB RDS for SQL Server para uma instância existente ou uma nova instância.
CloneDBInstance Restaurar dados (Clonar instância) Restaura dados históricos para uma nova instância clonada.
RestoreTable Restaurar bancos de dados ou tabelas específicos para a instância RDS original. Restaura bancos de dados ou tabelas específicos de uma instância ApsaraDB RDS para a instância original.

Backup e restauração entre regiões

API

Título

Descrição

CreateDdrInstance CreateDdrInstance Restaura dados para uma nova instância entre regiões.
ModifyInstanceCrossBackupPolicy ModifyInstanceCrossBackupPolicy Modifica as configurações de backup entre regiões de uma instância.
DescribeInstanceCrossBackupPolicy DescribeInstanceCrossBackupPolicy Consulta as configurações de backup entre regiões de uma instância.
DescribeCrossBackupMetaList DescribeCrossBackupMetaList Consulta os bancos de dados e as tabelas cujos dados estão incluídos em um arquivo de backup entre regiões de uma instância.
DescribeCrossRegionBackups DescribeCrossRegionBackups Consulta os arquivos de backup de dados entre regiões de uma instância.
DescribeCrossRegionLogBackupFiles DescribeCrossRegionLogBackupFiles Consulta os arquivos de backup de log entre regiões de uma instância.
DescribeAvailableCrossRegion DescribeAvailableCrossRegion Consulta as regiões de destino disponíveis para as quais os arquivos de backup entre regiões de uma região de origem específica podem ser replicados.
DescribeAvailableRecoveryTime DescribeAvailableRecoveryTime Consulta o intervalo de tempo no qual os dados podem ser restaurados a partir de um arquivo de backup entre regiões.
DescribeCrossRegionBackupDBInstance DescribeCrossRegionBackupDBInstance Consulta as instâncias para as quais o recurso de backup entre regiões está ativado em uma região e as configurações de backup entre regiões dessas instâncias.
CheckCreateDdrDBInstance CheckCreateDdrDBInstance Consulta se uma instância pode ser restaurada usando um conjunto de backup entre regiões.
RestoreDdrTable RestoreDdrTable Restaura dados para uma instância existente entre regiões.

Monitoramento

API

Título

Descrição

ModifyDBInstanceMonitor ModifyDBInstanceMonitor Modifica a frequência de monitoramento.
ModifyDBInstanceMetrics ModifyDBInstanceMetrics Modifica as métricas do Enhanced Monitoring que são exibidas para uma instância do ApsaraDB RDS for PostgreSQL.
DescribeResourceUsage DescribeResourceUsage Consulta o uso de armazenamento de uma instância.
DescribeDBInstancePerformance DescribeDBInstancePerformance Consulta as métricas de desempenho de uma instância.
DescribeDBInstanceMonitor DescribeDBInstanceMonitor Consulta a frequência de monitoramento de uma instância.
DescribeAvailableMetrics DescribeAvailableMetrics Consulta todas as métricas do Enhanced Monitoring suportadas por uma instância do ApsaraDB RDS for PostgreSQL.
DescribeDBInstanceMetrics DescribeDBInstanceMetrics Consulta as métricas do Monitoramento Aprimorado que são exibidas para uma instância do ApsaraDB RDS for PostgreSQL.

Parâmetros

API

Título

Descrição

CreateParameterGroup CreateParameterGroup Cria um modelo de parâmetros para uma instância.
DeleteParameterGroup DeleteParameterGroup Exclui um modelo de parâmetros de uma instância.
ModifyParameter ModifyParameter Modifica os valores de parâmetros de uma instância.
ModifyParameterGroup ModifyParameterGroup Modifica o modelo de parâmetros de uma instância.
DescribeParameters DescribeParameters Consulta as configurações de parâmetros de uma instância.
DescribeModifyParameterLog DescribeModifyParameterLog Consulta os logs de modificação de parâmetros de uma instância.
DescribeParameterTemplates DescribeParameterTemplates Consulta modelos de parâmetros.
DescribeParameterGroups DescribeParameterGroups Consulta os modelos de parâmetros disponíveis em uma região.
DescribeParameterGroup DescribeParameterGroup Consulta as informações sobre um modelo de parâmetros.
CloneParameterGroup CloneParameterGroup Replica um modelo de parâmetros para a região atual ou para outra região.

Migração de dados

API

Título

Descrição

DescibeImportsFromDatabase DescibeImportsFromDatabase Consulta as tarefas de migração de uma instância.

Gerenciamento de tarefas de O&M

API

Título

Descrição

ModifyActiveOperationTasks ModifyActiveOperationTasks Altera o horário de alternância de tarefas de O&M agendadas para uma instância.
DescribeActiveOperationTasks DescribeActiveOperationTasks Consulta os detalhes sobre as tarefas de O&M agendadas para uma instância.
CancelActiveOperationTasks CancelActiveOperationTasks Cancela tarefas de O&M que ainda não foram iniciadas.

Migração de arquivo de backup do MySQL para a nuvem

API

Título

Descrição

DeleteUserBackupFile DeleteUserBackupFile Exclui os arquivos de backup de uma instância ApsaraDB RDS para MySQL.
UpdateUserBackupFile UpdateUserBackupFile Modifica a descrição e o período de retenção de um arquivo de backup completo.
ListUserBackupFiles ListUserBackupFiles Consulta os detalhes dos arquivos de backup completo importados para uma instância.
ImportUserBackupFile Import User Backup Esta API é usada para importar dados de backup de um banco de dados MySQL 5.7 autogerenciado para o RDS.

Migração de arquivo de backup do SQL Server para a nuvem

API

Título

Descrição

CreateMigrateTask CreateMigrateTask Cria uma tarefa de migração para restaurar arquivos de backup de um bucket do Object Storage Service (OSS) para uma instância ApsaraDB RDS for SQL Server.
CreateOnlineDatabaseTask CreateOnlineDatabaseTask Abre o banco de dados envolvido em uma tarefa de migração de dados de backup de uma instância do ApsaraDB RDS for SQL Server.
DescribeMigrateTasks DescribeMigrateTasks Consulta as tarefas criadas para migrar os dados de backup de uma instância do ApsaraDB RDS for SQL Server.
DescribeOssDownloads DescribeOssDownloads Consulta os arquivos de backup incluídos em uma tarefa de migração de dados de backup de uma instância do ApsaraDB RDS for SQL Server.
DescribeMigrateTaskById DescribeMigrateTaskById Consulta uma tarefa usada para importar os dados de backup de uma instância do ApsaraDB RDS for SQL Server para um bucket do Object Storage Service (OSS).
TerminateMigrateTask TerminateMigrateTask Encerra uma tarefa de migração em andamento de uma instância do ApsaraDB RDS for SQL Server.

Domínio AD do SQL Server

API

Título

Descrição

DeleteADSetting DeleteADSetting Remove uma instância do ApsaraDB RDS for SQL Server de um domínio do Active Directory (AD).
ModifyADInfo ModifyADInfo Modifica as informações do domínio AD de uma instância do ApsaraDB RDS for SQL Server.
DescribeADInfo DescribeADInfo Consulta as informações sobre o domínio AD de uma instância. As informações incluem se a instância foi adicionada ao domínio AD, o nome do domínio AD e a conta.

Migração com um clique do PostgreSQL para a nuvem

API

Título

Descrição

CreateCloudMigrationPrecheckTask CreateCloudMigrationPrecheckTask Cria uma tarefa de avaliação para migração para a nuvem para uma instância ApsaraDB RDS for PostgreSQL.
CreateCloudMigrationTask CreateCloudMigrationTask Cria uma tarefa de migração para a nuvem para uma instância do ApsaraDB RDS for PostgreSQL.
DescribeCloudMigrationPrecheckResult DescribeCloudMigrationPrecheckResult Consulta os detalhes do relatório de avaliação para migração em nuvem para uma instância.
DescribeCloudMigrationResult DescribeCloudMigrationResult Consulta os detalhes sobre a tarefa de migração para a nuvem de uma instância do ApsaraDB RDS for PostgreSQL.
ActivateMigrationTargetInstance ActivateMigrationTargetInstance Transfere as cargas de trabalho da instância PostgreSQL de origem para a instância ApsaraDB RDS for PostgreSQL de destino.

Tags

API

Título

Descrição

TagResources TagResources Cria e adiciona tags a uma ou mais instâncias.
AddTagsToResource AddTagsToResource Adiciona tags a uma instância.
UntagResources UntagResources Remove tags de uma ou mais instâncias.
RemoveTagsFromResource RemoveTagsFromResource Remove tags de uma instância.
ListTagResources ListTagResources Consulta as tags adicionadas a uma ou mais instâncias.
DescribeTags DescribeTags Consulta as tags de uma instância.
DescribeDBInstanceByTags DescribeDBInstanceByTags Consulta informações sobre as tags adicionadas a uma instância.

Gerenciar extensões do RDS PostgreSQL

API

Título

Descrição

CreatePostgresExtensions CreatePostgresExtensions Cria uma extensão para um banco de dados.
DeletePostgresExtensions DeletePostgresExtensions Exclui uma extensão de um banco de dados.
UpdatePostgresExtensions UpdatePostgresExtensions Atualiza a versão de uma extensão em um banco de dados.
DescribePostgresExtensions DescribePostgresExtensions Consulta as extensões instaladas em um banco de dados.

Gerenciamento de slots de replicação de instância PostgreSQL

API

Título

Descrição

DeleteSlot DeleteSlot Exclui um slot de replicação de uma instância.
DescribeSlots DescribeSlots Consulta todos os slots de replicação de uma instância.

Instâncias de recuperação de desastres

API

Título

Descrição

CreateReplicationLink CreateReplicationLink Cria uma tarefa de sincronização de dados para uma instância de recuperação de desastres (DR) do ApsaraDB RDS.
DescribeReplicationLinkLogs DescribeReplicationLinkLogs Consulta os logs de operação da tarefa de sincronização de dados para uma instância ApsaraDB RDS especificada.
RebuildReplicationLink RebuildReplicationLink Recria um link de sincronização de dados para uma instância ApsaraDB RDS de recuperação de desastres.
DeleteReplicationLink DeleteReplicationLink Exclui o link de sincronização de dados de uma instância de recuperação de desastres (DR) do ApsaraDB RDS e promove a instância de DR para instância primária.

Serverless comprometido

API

Título

Descrição

ModifyComputeBurstConfig Modificar ou desativar o recurso serverless reservado. Modifica ou desativa o recurso serverless reservado.
DescribeComputeBurstConfig DescribeComputeBurstConfig Consulta as configurações do Serverless garantido.

Outros

API

Título

Descrição

Credenciais de usuário Credenciais de usuário
CreateSecret CreateSecret Cria uma credencial para um usuário que utiliza o recurso Data API.
DeleteSecret DeleteSecret Exclui a credencial de um usuário que utiliza o recurso Data API.
DescribeSecrets DescribeSecrets Consulta a credencial de um usuário que utiliza o recurso Data API.
MigrateConnectionToOtherZone MigrateConnectionToOtherZone Migra uma instância para uma zona diferente.
ModifyDBInstanceDelayedReplicationTime ModifyDBInstanceDelayedReplicationTime Configura a latência de replicação para uma instância somente leitura do ApsaraDB RDS for MySQL.
CheckServiceLinkedRole CheckServiceLinkedRole Verifica se uma função vinculada ao serviço (SLR) foi criada.
DescribeDBMiniEngineVersions DescribeDBMiniEngineVersions Consulta as versões secundárias do mecanismo disponíveis para uma instância do ApsaraDB RDS for MySQL ou uma instância do ApsaraDB RDS for PostgreSQL.
DescribeRegionInfos DescribeRegionInfos Consulta as regiões.
DescribeDBInstanceNetInfoForChannel DescribeDBInstanceNetInfoForChannel Consulta todos os endpoints de uma instância.
DescribeHostWebShell DescribeHostWebShell Consulta a URL do webshell usada para conectar-se ao host de uma instância do ApsaraDB RDS for SQL Server.
DescribeClassDetails DescribeClassDetails Consulta os detalhes dos tipos de instância de uma instância usando o código do tipo de instância.
DescribeKmsAssociateResources DescribeKmsAssociateResources Verifica se o recurso especificado do Key Management Service (KMS) está associado a uma instância do ApsaraDB RDS.
ModifyDBInstanceReplicationSwitch ModifyDBInstanceReplicationSwitch Ativa ou desativa o recurso de replicação nativa do ApsaraDB RDS for MySQL.
DescribeDBInstanceReplication Consulta do status de replicação da instância. Consulta o status e as configurações de instâncias de replicação nativa.
MigrateDBNodes MigrateDBNodes Altera a zona de um nó de uma instância do ApsaraDB RDS for MySQL que executa a RDS Cluster Edition.
SwitchOverMajorVersionUpgrade Switchover de atualização de versão principal. Realiza o switchover de tráfego para atualização de versão principal sem tempo de inatividade no RDS PostgreSQL.
AuthorizeBackupEncryption Validar criptografia de backup. Cria a função vinculada a serviço AliyunServiceRoleForRdsBackupEncryption.
CheckBackupEncryptionAuthorized Consultar resultados de validação para criptografia de backup. Verifica se a função vinculada ao serviço AliyunServiceRoleForRdsBackupEncryption existe na conta do usuário.
CheckRegionSupportBackupEncryption Verificar se a instância oferece suporte à criptografia de backup. Verifica se a região atual oferece suporte à criptografia de backup.
DescribeSQLServerUpgradeVersions Consultar versões atualizáveis do SQL Server. Descreve as versões para as quais uma instância SQL Server ou uma versão específica do SQL Server pode ser atualizada.
DescribeVpcs Consulta a lista de Virtual Private Cloud (VPC) Lista as Virtual Private Clouds (VPCs) na sua conta Alibaba Cloud.
EnableBackupEncryption Ativar criptografia de backup. Ativa a criptografia de backup.
DescribeActiveOperationMaintainConf Consulta a configuração proativa de O&M. Obtém as informações de configuração de O&M do usuário, que atualmente incluem informações sobre a janela de tempo de eventos de gerenciamento agendados.
CreateMaskingRules Criar uma regra de criptografia ou desensibilização. Cria uma nova regra de criptografia ou desensibilização para uma instância especificada.
ModifyAccountMaskingPrivilege Modificação da permissão de mascaramento de conta. Modifica as permissões de criptografia ou mascaramento de uma conta em uma instância especificada.
ModifyMaskingRules Modificar regra de criptografia ou mascaramento de dados. Modifica a regra de criptografia ou mascaramento de dados para uma instância especificada.
DescribeMaskingRules Consulta regras de criptografia ou desensibilização. Lista as regras de criptografia ou mascaramento de dados para uma instância especificada.
DeleteMaskingRules Excluir uma regra de criptografia ou desensibilização. Exclui as regras de criptografia ou desensibilização de dados para a instância especificada.
DescribeAccountMaskingPrivilege Consulta de permissões de criptografia ou mascaramento de dados da conta. Obtém a configuração de permissões de criptografia ou mascaramento de dados para uma conta em uma instância especificada.
DeleteParameterTimedScheduleTask Excluir uma tarefa agendada para modificação de parâmetros. Exclui uma tarefa agendada para modificação de parâmetros de instância.
DescribeParameterTimedScheduleTask Consulta de tarefa agendada para modificação de parâmetros da instância. Consulta uma tarefa agendada que modifica os parâmetros da instância.
ModifyParameterTimedScheduleTask Modificação da tarefa agendada para modificação de parâmetros. Altera o horário de efetivação de uma tarefa agendada de modificação de parâmetros.
DescribeDBInstanceCLS Consulta da configuração do algoritmo de criptografia de coluna. Consulta a configuração do algoritmo de criptografia de coluna para uma instância especificada.
ModifyDBInstanceCLS Modificar configuração do algoritmo de criptografia de coluna. Modifica a configuração do algoritmo de criptografia de coluna para uma instância especificada.
CreateRCImage CreateRCImage. Cria uma imagem personalizada para uma instância RDS Custom.
ModifyDBInstanceVectorSupportStatus Modifica a alternância de armazenamento vetorial para uma instância. Ativa ou desativa o armazenamento vetorial para uma instância MySQL.
DescribeImportTaskValidation Consulta os detalhes de uma pré-verificação para uma tarefa de importação. Consulta os detalhes de uma pré-verificação para uma tarefa de importação. Esta operação retorna cada item de pré-verificação e seu resultado.
DescribeImportTask Consulta dos detalhes da tarefa de importação. Obtém os detalhes de uma tarefa de importação de dados para uma instância RDS que usa replicação nativa.
CreateImportTask Criar uma tarefa de importação de dados. Cria uma tarefa de importação de dados.
ValidateImportTask Pré-verificação para tarefa de importação de dados. Executa uma pré-verificação em uma tarefa de importação de dados para uma instância RDS for MySQL que usa replicação nativa.
ListImportTasks Listar tarefas de importação de dados. Consulta as tarefas de importação de dados para replicação nativa.
ModifyImportTask Modify Data Import Job. Modifica uma tarefa de importação de dados para uma instância de replicação nativa do RDS MySQL.
ModifyRCDiskAttribute Modificar atributos de armazenamento em bloco. Modifica os atributos de um dispositivo de armazenamento em bloco, como seu nome, descrição, se é liberado com sua instância e se o burst de desempenho está ativado.
UpdateDBInstanceReplication Atualizar canal de replicação. Atualiza um canal de replicação para uma instância de replicação nativa.
CreateDBInstanceReplication Criar canal de replicação. Cria um link de replicação para uma instância de replicação nativa.
DeleteDBInstanceReplication Exclusão de canal de replicação. Exclui um canal de replicação de uma instância de replicação nativa.
ModifyDBInstance Modificar uma instância. Modifica uma instância. Atualmente, apenas o mecanismo PostgreSQL é suportado.

Eventos e tarefas

API

Título

Descrição

DescribeHistoryEventsStat DescribeHistoryEventsStat Consulta as estatísticas de eventos históricos no centro de eventos.
DescribeHistoryEvents DescribeHistoryEvents Consulta os eventos históricos no centro de eventos.
ModifyEventInfo ModifyEventInfo Modifica as informações sobre eventos no centro de eventos.
DescribeHistoryTasksStat DescribeHistoryTasksStat Coleta tarefas no centro de tarefas.
DescribeHistoryTasks DescribeHistoryTasks Consulta as tarefas históricas criadas nos últimos 30 dias.
ModifyTaskInfo ModifyTaskInfo Modifica as informações sobre as tarefas históricas no centro de tarefas.
DescribeTasks DescribeTasks Consulta as tarefas no estado Waiting ou Executing em uma instância do ApsaraDB RDS for SQL Server.