Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (polardbx/2020-02-02) 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.
Gerenciamento de instâncias
|
API |
Título |
Descrição |
| CreateDBInstance | Criar uma instância | Cria uma instância PolarDB-X. |
| DeleteDBInstance | Excluir uma instância | Chama a operação DeleteDBInstance para excluir uma instância. |
| DescribeDBInstanceAttribute | Obter atributos da instância | Obtém os atributos de uma instância. |
| DescribeDBInstanceConfig | Consultar parâmetros de configuração da instância. | Chama a operação DescribeDBInstanceConfig para obter os parâmetros de configuração da instância. |
| DescribeDBInstances | Lista de instâncias de banco de dados | Consulta uma lista de instâncias de banco de dados. |
| DescribeDBInstanceSSL | Visualizar informações de SSL | Obtém informações de SSL. |
| DescribeDBInstanceTDE | Consultar detalhes da TDE de uma instância. | Consulta os detalhes da Criptografia Transparente de Dados (TDE) de uma instância. |
| DescribeDBInstanceTopology | DescribeDBInstanceTopology | Obtém as informações de topologia de uma instância. |
| DescribeDBInstanceViaEndpoint | Obter informações da instância por endpoint. | Obtém as informações básicas de uma instância usando o endpoint da instância. |
| ModifyDBInstanceConfig | Modificar item de configuração da instância. | Chama a operação ModifyDBInstanceConfig para modificar um item de configuração da instância. |
| ModifyDBInstanceDescription | Modificar descrição da instância. | Chama a operação ModifyDBInstanceDescription para modificar a descrição de uma instância. |
| ReleaseInstancePublicConnection | Liberar o endpoint público de uma instância. | Libera a conexão de rede pública de uma instância. |
| RestartDBInstance | Reiniciar uma instância. | Reinicia uma instância chamando a operação RestartDBInstance. |
| UpgradeDBInstanceKernelVersion | Atualizar a versão do kernel de uma instância de banco de dados. | Invoca a operação UpgradeDBInstanceKernelVersion para atualizar a versão do kernel de uma instância. |
| ModifyDBInstanceClass | Modificar especificações da instância | Modifica as especificações de uma instância. |
| DescribeDBInstanceHA | Consulta das informações de alta disponibilidade da instância | Consulta as informações de alta disponibilidade de uma instância. |
| UpdatePolarDBXInstanceNode | Atualizar nós | Altera o número de nós de uma instância PolarDB-X, incluindo expansão e redução. Esta solicitação gera um pedido. |
| ChangeResourceGroup | Modify instance resource group. | Modifica o grupo de recursos de uma instância. |
| DescribeTransformStatus | Consulta do status de atualização da instância | Consulta o status atual de uma tarefa que atualiza ou converte uma instância padrão em uma instância Enterprise. |
| DescribePolarxDataNodes | Visualizar informações do nó de dados. | Consulta os detalhes de todos os nós de dados (Data Nodes) em uma instância PolarDB-X, incluindo status do nó, uso de armazenamento e endereços de rede, para facilitar o gerenciamento e o monitoramento de operações. |
| ModifyDBInstanceMaintainTime | Modify instance maintenance window. | Modifica a janela de manutenção de uma instância. |
| ModifyDBInstanceVip | Modificação do endereço IP virtual de uma instância | Modifica o endereço IP virtual ou as propriedades de rede de uma instância de banco de dados. Esta operação oferece suporte à alteração do endereço IP interno, ao ajuste da sub-rede e à migração entre zonas. |
| DescribeRdsVpcs | Consultar lista de VPCs. | Consulta a lista de VPCs do PolarDB-X. |
| DescribeRdsVswitches | Consultar lista de vSwitches. | Consulta a lista de vSwitches disponíveis em uma nuvem privada virtual (VPC) para uma instância do ApsaraDB RDS. |
| DescribeShowStorageInfo | Consultar informações de espaço de armazenamento. | Consulta os detalhes de uso de armazenamento de uma instância, incluindo capacidade total, espaço utilizado e espaço restante. |
| DescribeStoragePoolInfo | Consultar informações do pool de armazenamento. | Consulta os detalhes de um pool de armazenamento, incluindo capacidade, uso e status. |
| CreateStoragePool | Criar um pool de armazenamento. | Cria um pool de armazenamento de recursos. |
| CreateCustomEndpoint | Create a custom endpoint. | Cria um endpoint personalizado para uma instância de banco de dados. |
| DescribeCustomEndpointList | Consultar lista de nomes de domínio definidos pelo usuário. | Consulta a lista de nomes de domínio personalizados definidos pelo usuário. |
| ModifyCustomEndpointNet | Modify custom network endpoint. | Modifica as configurações de rede de um endpoint de rede personalizado, como sub-rede, grupo de segurança e configurações de acesso à rede pública. |
| DeleteCustomEndpoint | Excluir um nome de domínio de endpoint personalizado. | Exclui um nome de domínio de endpoint personalizado. |
| ModifyCustomEndpoint | Modify custom endpoint. | Modifica a configuração de um endpoint personalizado. |
| ModifyDBInstanceConnectionString | Modificar string de conexão da instância. | Modifica a string de conexão de um endpoint de instância. |
| AllocateInstancePublicConnection | Solicitar um endpoint público. | Chama a operação AllocateInstancePublicConnection para criar um endereço IP público. |
| AllocateColdDataVolume | AllocateColdDataVolume. | Chama a operação AllocateColdDataVolume. |
| ReleaseColdDataVolume | ReleaseColdDataVolume. | Chama a operação ReleaseColdDataVolume. |
| DescribeColdDataBasicInfo | Consulta de informações básicas de dados frios | Consulta as informações básicas do armazenamento frio. |
Monitoramento e logs
|
API |
Título |
Descrição |
| DescribeSlowLogRecords | Consultar detalhes de logs lentos. | Consulta os detalhes de instruções SQL lentas em nós de computação e nós de armazenamento de uma instância PolarDB-X. |
| DescribeDBNodePerformance | Consultar dados de desempenho da instância. | Consulta os dados de desempenho de uma instância. |
| DescribeSqlAuditInfo | Query SQL audit information. | Consulta informações de auditoria SQL. |
| EnableSqlAudit | Enable SQL audit. | Ativa o recurso de auditoria SQL. |
| DisableSqlAudit | Disable SQL audit. | Desativa o recurso de auditoria SQL. |
| CheckSqlAuditSlsStatus | Check audit status. | Verifica se os logs de auditoria SQL de uma instância de banco de dados especificada foram conectados com sucesso ao Simple Log Service (SLS). Após a chamada, o sistema retorna o status da conexão entre o recurso de auditoria SQL e o SLS para a instância atual, as informações de configuração do projeto e do Logstore e se a sincronização está normal. |
| DescribeEvents | Obter eventos históricos | Obtém eventos históricos. |
| DescribeActiveOperationMaintainConf | Mostrar configuração de horário de O&M | Consulta a configuração de horário de O&M. |
| DescribeActiveOperationTasks | Recuperar eventos de O&M | Consulta eventos de O&M. |
| DescribeActiveOperationTaskCount | Obter o número total de eventos de O&M. | Obtém o número total de eventos de O&M. |
| ModifyActiveOperationMaintainConf | Modificação da configuração de horário de eventos de O&M | Modifica a configuração de horário para eventos de O&M. |
Gerenciamento de tarefas
|
API |
Título |
Descrição |
| DescribeTasks | Lista de tarefas de uma instância | Obtém a lista de tarefas de uma instância. |
| DescribeScaleOutMigrateTaskList | Exibição do progresso da tarefa de migração de dados | Obtém o progresso de uma tarefa de migração de scale-out. |
| CreateTransformOperation | Criar uma tarefa de conversão. | Cria uma tarefa de conversão para alterar um status ou configuração específica de uma instância. |
| DescribeRplInspectionTask | Obter tarefa de inspeção da instância. | Consulta os detalhes da tarefa de inspeção de atraso de replicação de uma instância. |
| SkipCurrentStep | Pular etapa atual. | Pula a etapa atual. |
| CreateRplInspectionTask | Verificação de integridade da tarefa de replicação. | Realiza uma verificação de integridade em uma tarefa de replicação durante a migração de dados. |
| CancelActiveOperationTasks | Cancel active O&M event tasks. | Cancela tarefas ativas de eventos de O&M. |
| ModifyActiveOperationTasks | Modify O&M event execution time. | Modifica o horário de execução de eventos de O&M. |
Criptografia SSL
|
API |
Título |
Descrição |
| UpdateDBInstanceSSL | Atualizar configuração SSL da instância. | Atualiza a configuração SSL de uma instância. |
Gerenciamento de parâmetros
|
API |
Título |
Descrição |
| ModifyParameter | Modificar parâmetros da instância | Modifica os parâmetros de uma instância, incluindo os parâmetros das camadas de computação e armazenamento. |
| DescribeParameterTemplates | Visualizar detalhes do modelo de parâmetros | Consulta os modelos de parâmetros da instância. |
| DescribeParameters | Recuperar lista de parâmetros | Consulta os parâmetros de uma instância. |
| DescribeParameterGroups | Consultar informações do modelo de parâmetros. | Consulta a lista de modelos de parâmetros de banco de dados criados por usuários ou suportados pelo sistema, incluindo informações básicas, tipos de mecanismo associados e horários de modificação de cada modelo de parâmetros. |
Gerenciamento de backups
|
API |
Título |
Descrição |
| CreateBackup | Criar um backup | Cria um backup. |
| DescribeBackupPolicy | Consultar configurações de backup da instância. | Consulta as configurações de backup de uma instância. |
| DescribeBackupSetList | Consultar lista de conjuntos de backup. | Consulta a lista de conjuntos de backup chamando a operação DescribeBackupSetList. |
| DescribeBinaryLogList | Consulta de logs binários | Consulta logs binários. |
| UpdateBackupPolicy | Modify instance backup policy. | Modifica a política de backup de uma instância. |
| DescribeOpenBackupSet | Recupera informações do conjunto de backup para restauração offline. | Fornece as informações de topologia da instância e os links de download dos conjuntos de backup da edição comercial para oferecer suporte à restauração offline de instâncias em nuvem. |
| DescribeBackupSet | DescribeBackupSet | Consulta os detalhes de um conjunto de backup chamando a operação DescribeBackupSet. |
Segurança de dados
|
API |
Título |
Descrição |
| UpdateDBInstanceTDE | Ativar TDE da instância. | Ativa a Criptografia de Dados Transparente (TDE) para uma instância. |
| ModifySecurityIps | Modificar lista de permissões da instância. | Chama a operação ModifySecurityIps para modificar a lista de permissões de uma instância. |
| DescribeUserEncryptionKeyList | Obter lista de chaves TDE do usuário. | Chama a operação DescribeUserEncryptionKeyList para obter a lista de chaves de Transparent Data Encryption (TDE) de um usuário. |
| DescribeSecurityIps | Visualizar informações da lista de permissões da instância. | Consulta a lista de permissões de IP de uma instância. |
| CheckCloudResourceAuthorized | Verificar autorização de chave KMS. | Consulta se uma instância PolarDB-X está autorizada a usar o Key Management Service (KMS). |
| EnableRightsSeparation | Enable three-role mode. | Ativa o modo de três funções. |
| DisableRightsSeparation | DisableRightsSeparation. | Desativa o modo de três funções. |
Gerenciamento de contas
|
API |
Título |
Descrição |
| ResetAccountPassword | ResetAccountPassword. | Redefine a senha de uma conta. |
| CreateAccount | Criar uma conta padrão. | Cria uma conta chamando a operação CreateAccount. |
| CreateSuperAccount | Criar um usuário privilegiado. | Cria um usuário privilegiado. Cada instância pode ter apenas um usuário privilegiado. |
| DeleteAccount | Excluir uma conta de instância. | Chama a operação DeleteAccount para excluir uma conta. |
| DescribeAccountList | Consultar informações da conta da instância. | Consulta a lista de contas chamando a operação DescribeAccountList. |
| ModifyAccountDescription | Modificar descrição da conta de uma instância. | Modifica a descrição de uma conta chamando a operação ModifyAccountDescription. |
| ResetAccountPasswordRestrict | Reset account password. | Redefine a senha de uma conta. |
| ModifyAccountPrivilege | ModifyAccountPrivilege. | Modifica as permissões de uma conta padrão. |
Regiões
|
API |
Título |
Descrição |
| DescribeRegions | Visualizar regiões e zonas disponíveis. | Chama a operação DescribeRegions para obter a lista de regiões. |
| MigrateDBInstance | Migração de instância entre zonas | Migra uma instância de uma zona para outra. |
| DescribeAvailableCrossRegions | Consultar regiões entre zonas. | Consulta a lista de regiões disponíveis que suportam operações entre regiões, normalmente usadas para cenários de implantação multirregião ou replicação de dados. |
| DescribeEnabledCrossRegions | Consultar configurações entre zonas ativadas. | Consulta as configurações entre zonas atualmente ativadas. |
| AlignStoragePrimaryAzone | Alinhamento da zona primária dos nós de armazenamento | Alinha a zona primária dos nós de armazenamento de uma instância PolarDB-X. |
| SwitchDBInstanceHA | Alternar o nó primário para alta disponibilidade | Alterna a zona do nó primário de uma instância PolarDB-X. |
Gerenciamento de bancos de dados
|
API |
Título |
Descrição |
| CreateDB | Criar um banco de dados | Cria um banco de dados. |
| DeleteDB | Excluir um banco de dados. | Chama a operação DeleteDB para excluir um banco de dados. |
| DescribeCharacterSet | Consultar conjuntos de caracteres. | Invoca a operação DescribeCharacterSet para consultar os tipos de conjunto de caracteres suportados pelos bancos de dados em uma instância de destino. |
| DescribeDbList | Consultar informações do banco de dados de uma instância. | Consulta a lista de bancos de dados chamando a operação DescribeDbList. |
| DescribeDistributeTableList | Consultar lista de tabelas de banco de dados. | Consulta a lista de tabelas de banco de dados chamando a operação DescribeDistributeTableList. |
| ModifyDatabaseDescription | Modify database description. | Modifica a descrição de um banco de dados. |
| StartSwitchDatabase | Start database cutover. | Inicia um cutover de banco de dados para uma tarefa de migração ou sincronização de banco de dados. |
| DescribeComponentPropeties | Consultar propriedades do componente. | Obtém as informações de propriedade de um componente especificado, incluindo nomes e tipos de propriedades. |
| ModifyEngineMigration | Modify engine migration. | Modifica a configuração ou os parâmetros de migração de uma tarefa de migração de mecanismo de banco de dados, como o banco de dados de origem, o banco de dados de destino, os objetos de migração ou o modo de migração. |
| DescribeArchiveTableList | Listar tabelas de armazenamento a frio | Lista as tabelas de armazenamento a frio. |
Gerenciamento de CDC
|
API |
Título |
Descrição |
| UpgradeCDCVersion | Upgrade CDC version. | Atualiza a versão do nó CDC de uma instância PolarDB-X. |
| DescribeCdcInfo | Consultar informações da instância CDC. | Consulta informações do CDC. |
| DescribeCdcVersionList | Obter versões do CDC | Obtém uma lista de versões do CDC. |
| DescribeCdcClassList | Listar especificações de instâncias. | Consulta a lista de especificações de instâncias. |
| ModifyCdcClass | Modify CDC configuration. | Modifica a configuração do CDC. |
Gerenciamento de armazenamento em colunas
|
API |
Título |
Descrição |
| AttachColumnarInstance | Montar armazenamento colunar. | Monta uma instância colunar em uma instância de banco de dados primária especificada. |
| UpgradeColumnarVersion | Update column store version. | Atualiza a versão do column store. |
| ModifyColumnarClass | Modify column store specifications. | Modifica as especificações do column store. |
| DescribeColumnarVersionList | Consultar informações da versão do column store. | Consulta as informações da versão do column store. |
| DescribeColumnarInfo | Query column store information. | Consulta informações do column store. |
| DescribeColumnarClassList | Consultar especificações de column store. | Consulta a lista de especificações de column store para uma instância. |
Migração e sincronização de dados
|
API |
Título |
Descrição |
| DescribeEvaluateAndImportTask | Consultar lista de tarefas de importação de avaliação. | Consulta a lista de tarefas de importação de avaliação do PolarDB-X. (único) |
| DescribeEvaluateAndImportTasks | Consultar lista de tarefas de importação de avaliação. | Consulta uma lista de tarefas de importação de avaliação para PolarDB-X. |
| DeleteEvaluateAndImportTask | Excluir uma tarefa de importação de avaliação. | Exclui uma tarefa de importação de avaliação. |
| CreateSQLEvaluateTask | Avaliação de SQL. | Cria uma tarefa de avaliação de instruções SQL. Você envia instruções SQL por meio desta operação, e o sistema realiza análise estática e avaliação de riscos para identificar riscos de execução e problemas de compatibilidade na instância de banco de dados de destino. |
| CreateStructureImportTask | Criar uma tarefa de importação de esquema de dados. | Cria uma tarefa de importação de esquema de banco de dados. Esta operação importa arquivos de script SQL ou conteúdo de texto que contém instruções DDL para uma instância de banco de dados de destino e executa automaticamente operações estruturadas, como criação de tabelas, índices, visualizações e procedimentos armazenados. |
| DescribeDataImportTaskInfo | Obter informações da tarefa de importação de dados. | Consulta os detalhes de execução de uma tarefa de importação de dados. |
| CloseEngineMigration | Close engine migration. | Encerra o processo de migração do mecanismo de banco de dados para uma instância especificada. Depois que um usuário inicia uma tarefa de migração de dados de outro banco de dados (como uma instância MySQL autogerenciada ou ApsaraDB RDS) para o PolarDB-X, esta operação pode ser chamada para interromper com segurança o processo de migração caso a migração precise ser encerrada ou o estado da migração precise ser limpo. |
| ConfirmNoConnection | Confirmar ausência de conexões antes da troca por rollback. | Confirma que não existem conexões ativas antes de realizar uma troca por rollback. |
| RestartDataImportTask | Reiniciar uma tarefa de importação de dados. | Reinicia uma tarefa de importação de dados. |
| StopDataImportTask | Interromper uma tarefa de importação de dados. | Interrompe uma tarefa de importação de dados. |
| CreateDataImportTask | Criar uma tarefa de importação de dados. | Cria uma tarefa de importação de dados para importar arquivos de dados externos, como scripts SQL e arquivos CSV, para uma instância de banco de dados de destino. |
| DescribeStructureImportTaskInfo | Consultar informações da tarefa de importação de dados. | Consulta os detalhes de uma tarefa de importação de esquema de banco de dados. |
| RefreshImportMeta | Refresh import metadata. | Atualiza os metadados de uma tarefa de importação. |
Gerenciamento de GDN
|
API |
Título |
Descrição |
| DeleteGdnInstance | Excluir uma instância GDN. | Exclui uma instância de rede global de banco de dados (GDN). |
| DescribeGdnInstances | Recuperar lista de instâncias GDN | Consulta a lista de instâncias de rede global de banco de dados (GDN). |
| SwitchGdnMemberRole | Realizar alternância primária/secundária para uma GDN | Realiza uma alternância primária/secundária para uma rede global de banco de dados (GDN). |
| CreateGdnInstance | Criar uma instância GDN. | Cria uma instância GDN. |
SQL flashback
|
API |
Título |
Descrição |
| SubmitSqlFlashbackTask | Criar uma tarefa de flashback SQL. | Cria uma tarefa de flashback SQL chamando a operação SubmitSqlFlashbackTask. |
| PreCheckSqlFlashbackTask | Verificar recuperação flashback SQL. | Realiza uma pré-verificação e avaliação de viabilidade em uma tarefa de recuperação antes de executar a recuperação flashback SQL. |
| DescribeSqlFlashbackTaskList | Consultar lista de tarefas de flashback SQL. | Consulta a lista de tarefas de flashback SQL chamando a operação DescribeSqlFlashbackTaskList. |
Gerenciamento de tags
|
API |
Título |
Descrição |
| DescribeTags | Obter informações de tags. | Obtém informações de tags. |
| ListTagResources | Obter lista de labels. | Obtém uma lista de labels. |
| TagResources | Adicionar tags aos recursos. | Chama a operação TagResources para adicionar tags aos recursos. |
| UntagResources | Excluir tags de um recurso. | Exclui tags de um recurso. |
Outros
|
API |
Título |
Descrição |
| CheckHealth | Verificar integridade. | Realiza uma verificação de integridade do serviço. |
| RestoreDBInstance | Restaurar uma instância. | Clona uma instância PolarDB-X. |
| CreateMem0 | Ativação do mecanismo de memória | Ativa o mecanismo de memória. |
| DescribeMem0Info | Informações do mecanismo de memória. | Consulta as informações do mecanismo de memória. |
| DeleteMem0 | Desativação do mecanismo de memória | Desativa o mecanismo de memória. |
| CreateGdnStandbyMember | Add a GDN secondary instance | Adiciona uma instância secundária a uma rede de banco de dados global (GDN). |
| CreateSubCNInstance | Create a custom endpoint. | Cria um endpoint personalizado. |
| UpdateCustinsParam | Atualizar tags da instância | Atualiza as tags da instância. |
| DescribeDBInstanceEndpoint | Query custom endpoints. | Consulta endpoints personalizados. |
| DeleteSubCNInstance | Excluir um endereço personalizado. | Exclui um endereço personalizado. |
| CreateGatewayConsumerForPolarDBX | Ativar capacidades de IA para uma instância | Cria um consumidor de gateway de IA para uma instância PolarDB-X. |
| ResetMem0AccountPassword | Redefinir a chave de API do mecanismo de memória | Redefine a chave de API do mecanismo de memória. |
| DescribeMem0SecurityIps | Visualizar Whitelist do Memory Engine. | Consulta a whitelist de um memory engine. |
| ModifyMem0SecurityIps | ModifySecurityIps | Modifies the whitelist of a memory engine. |
| AllocateMem0PublicConnection | Ativação do endpoint público para o mecanismo de memória | Ativa o nome de domínio público para uma instância Mem0. |
| ReleaseMem0PublicConnection | Release the public endpoint of the memory engine | Releases the public domain name for a Mem0 instance. |
| DescribeSupabaseInstanceAttribute | Consulta dos detalhes da instância Supabase. | Consulta os detalhes de uma instância Supabase. |
| DescribeSupabaseIpWhitelist | Consulta a lista de permissões de IP do Supabase | Consulta a lista de permissões de IP do Supabase. |
| DeleteSupabaseNetType | Desativa o acesso à rede pública do Supabase. | Libera o endpoint público de uma instância Supabase. |
| CreatePolardbxSupabaseInstance | Criar uma instância do Supabase | Cria uma instância do Supabase. |
| ModifySupabaseDashboardPassword | Modificar a senha do painel do Supabase. | Modifica a senha do painel do Supabase. |
| RestartSupabaseInstance | Reiniciar uma instância do Supabase. | Reinicia uma instância do Supabase. |
| CreateSupabaseNetType | Ativar endpoint público do Supabase | Ativa o endpoint público do Supabase. |
| DescribeSupabaseApiKey | Recuperação da chave de API do Supabase | Consulta a chave de API do Supabase. |
| ModifySupabaseSecurityIPList | Modificar a lista de permissões de IP do Supabase | Modifica a lista de permissões de IP para o Supabase. |
| DescribeSupabaseInstances | Listar instâncias Supabase | Consulta uma lista de instâncias Supabase. |
| DeletePolardbxSupabaseInstance | Exclui uma instância Supabase. | Exclui uma instância Supabase. |
Outros
|
API |
Título |
Descrição |
| AllocateContext0PublicConnection | Ativar conexões de rede pública para o serviço de contexto | Ativa conexões de rede pública para um ReplicaSet físico especificado do serviço de contexto. |
| AllocateContextDBPublicConnection | Ativar acesso à rede pública para o serviço de contexto. | Ativa uma conexão de rede pública para um ReplicaSet do serviço ContextDB-X. |
| AllocatePxfsPublicConnection | Ativar a conexão de rede pública para o serviço de arquivos do agente | Ativa a conexão de rede pública para o PXFS. |
| CreateContext0 | Criar um serviço de contexto | Cria um serviço de contexto. |
| CreateContextDB | Criar um serviço de contexto. | Cria uma instância ContextDB-X. |
| CreateOpenSearch | Criar uma instância do PolarDBX Search | Cria uma instância do PolarDBX Search. |
| CreateOpenSearchAccount | Criar uma conta de instância do PolarDB-X Search | Cria uma conta de instância do PolarDB-X Search. |
| CreateOpenSearchWhitelistGroup | Criar um grupo de lista de permissões para o PolarDB-X Search | Cria um grupo de lista de permissões para o PolarDB-X Search. |
| CreatePxfs | Criar uma instância de serviço de arquivos do Agent | Cria uma instância de serviço de arquivos do Agent. |
| CreatePxfsAccessToken | Emissão de um token de acesso para o serviço de arquivos do Agent | Emite um token de acesso para o serviço de arquivos do Agent. |
| CreatePxfsTenant | Criar um tenant do serviço de arquivos do Agent | Cria um tenant do serviço de arquivos do Agent. |
| CreatePxfsUser | Cria uma identidade de locatário para o serviço de arquivos do Agent | Cria uma identidade de locatário para o serviço de arquivos do Agent. |
| CreatePxfuse | Criar um serviço de observabilidade de agente | Cria um nó PXFuse. |
| CreateServiceAccount | Criar uma conta de serviço. | Cria uma conta de serviço. |
| DeleteContext0 | Excluir serviço de contexto. | Exclui um serviço de contexto. |
| DeleteContextDB | Excluir serviço de contexto. | Exclui um ContextDB-X. |
| DeleteOpenSearch | Release a polarDB-X search instance | Libera uma instância PolarDB-X Search. |
| DeleteOpenSearchAccount | Excluir uma conta de instância do PolarDB-X Search. | Exclui uma conta de instância do PolarDB-X Search. |
| DeleteOpenSearchWhitelistGroup | Excluir um grupo de lista de permissões de busca do PolarDB-X. | Exclui um grupo de lista de permissões de busca do PolarDB-X. |
| DeletePxfs | Excluir uma instância do serviço de arquivos do Agent. | Exclui uma instância do serviço de arquivos do Agent. |
| DeletePxfsUser | Exclui uma identidade de locatário do serviço de arquivos do Agent. | Exclui uma identidade de locatário do serviço de arquivos do Agent. |
| DeletePxfuse | Excluir serviço de observação do agente. | Exclui um nó PXFuse. |
| DeleteServiceAccount | Excluir uma conta de serviço. | Exclui uma conta de serviço. |
| DescribeContext0Config | Consultar configuração do serviço de contexto. | Consulta as credenciais de gerenciamento do serviço de contexto. |
| DescribeContext0Info | Consulta de informações de instâncias do serviço de contexto | Consulta as informações sobre instâncias do serviço de contexto. |
| DescribeContext0SecurityIps | Consulta a whitelist do serviço de contexto | Consulta a whitelist do serviço de contexto. |
| DescribeContextDBConfig | Visualizar configuração do serviço de contexto. | Consulta as credenciais de gerenciamento do ContextDB-X. |
| DescribeContextDBInfo | Visualizar serviço de contexto. | Consulta as informações de uma instância ContextDB-X. |
| DescribeContextDBSecurityIps | Visualizar lista de permissões do serviço de contexto. | Consulta a lista de permissões de uma instância ContextDB-X. |
| DescribeOpenSearchAccountInfo | Consultar informações da conta do PolarDB-X Search. | Consulta as informações da conta do PolarDB-X Search. |
| DescribeOpenSearchConnectionInfo | Query polarDB-X search connection information | Consulta as informações de conexão do PolarDB-X Search, incluindo endpoints e protocolos internos, públicos e do Dashboard. |
| DescribeOpenSearchInfo | Consulta os detalhes da instância PolarDB-X Search | Consulta os detalhes de instâncias PolarDB-X Search. |
| DescribeOpenSearchInstances | Query polarDBX search instances. | Consulta a lista de instâncias PolarDBX Search. |
| DescribeOpenSearchNodes | Query polarDB-X search node list | Consulta a lista de nós de busca do PolarDB-X. |
| DescribeOpenSearchResourceUsage | Query polarDB-X search cluster resource usage | Consulta o uso de recursos de um cluster PolarDB-X Search. |
| DescribeOpenSearchTopology | Query polarDB-X search cluster node topology | Consulta a topologia de nós de um cluster PolarDB-X Search. |
| DescribeOpenSearchWhitelists | Query polarDB-X search whitelist. | Consulta a lista de permissões de uma instância PolarDB-X Search. Você pode filtrar os resultados por tipo de rede. |
| DescribePxfsAccessTokens | Consulta do token de acesso do serviço de arquivos do Agent. | Consulta o token de acesso para o serviço de arquivos do Agent. |
| DescribePxfsInfo | Consulta de informações da instância do serviço de arquivos do Agent. | Consulta as informações de uma instância do serviço de arquivos do Agent. |
| DescribePxfsSecurityIps | Consulta a lista de permissões do serviço de arquivos do Agent | Consulta a lista de permissões do serviço de arquivos do Agent. |
| DescribePxfsTenant | Consulta do tenant do serviço de arquivos do Agent. | Consulta o tenant do serviço de arquivos do Agent. |
| DescribePxfsUsers | Consulta a identidade do tenant do serviço de arquivos do Agent. | Consulta a identidade do tenant do serviço de arquivos do Agent. |
| DescribePxfuseInfo | Visualizar informações do serviço de observação do agente. | Consulta informações de instâncias PXFuse. |
| DescribePxfuseSecurityIps | Consultar lista de permissões do serviço de observabilidade do agente. | Consulta a lista de permissões de uma instância PXFuse. |
| DescribeServiceAccount | Consultar status da conta de serviço. | Consulta o status de uma conta de serviço. |
| DisableOpenSearchPublicEndpoint | Desativação do acesso à rede pública do PolarDB-X Search | Desativa o acesso à rede pública do PolarDB-X Search. |
| EnableOpenSearchPublicEndpoint | Enable polarDBX search public network access | Ativa o acesso à rede pública para o PolarDBX Search. |
| ExecuteMetaQuery | Execução de uma consulta de metadados somente leitura | Executa uma consulta de metadados. |
| ListPxfsTenants | Consulta da lista de tenants do PXFS | Consulta a lista de tenants do PXFS. |
| ModifyContext0SecurityIps | Modificação da lista de permissões do serviço de contexto | Modifica de forma síncrona as listas de permissões para o serviço de contexto e o painel. |
| ModifyContextDBSecurityIps | Modify context service whitelist. | Modifica a lista de permissões de um ReplicaSet de serviço ContextDB-X. |
| ModifyOpenSearchAccessProtocol | Modify polarDB-X search access protocol | Altera o protocolo de acesso (HTTP/HTTPS) para o PolarDB-X Search. |
| ModifyOpenSearchClass | Modificação das especificações de uma instância PolarDBX Search | Modifica as especificações de uma instância PolarDBX Search. |
| ModifyOpenSearchWhitelistGroup | Modificar um grupo de lista de permissões do PolarDB-X Search | Modifica um grupo de lista de permissões do PolarDB-X Search. |
| ModifyPxfsSecurityIps | Modificação da lista de permissões do serviço de arquivos do Agent. | Modifica a lista de permissões do serviço de arquivos do Agent. |
| ModifyPxfuseSecurityIps | Modify agent observability service whitelist | Modifica a lista de permissões do nó PXFuse. |
| QueryColumnarLog | Consultar logs de auditoria do column store. | Consulta logs de auditoria do column store. |
| QueryColumnarLogSSE | Consultar logs de auditoria de column store por streaming. | Consulta logs de auditoria de column store completos usando streaming. |
| ReleaseContext0PublicConnection | Release context service public endpoint | Encerra a conexão de rede pública de um ReplicaSet físico especificado para o serviço de contexto. |
| ReleaseContextDBPublicConnection | Release context service public endpoint | Encerra a conexão de rede pública para um ReplicaSet do serviço ContextDB-X. |
| ReleasePxfsPublicConnection | Desativar a conexão de rede pública do serviço de arquivos do Agent. | Desativa a conexão de rede pública para o serviço de arquivos do Agent. |
| ResetOpenSearchPassword | Redefinir senha da conta da instância PolarDB-X Search. | Redefine a senha de uma instância PolarDB-X Search sem exigir a senha antiga (verificação de permissão RAM necessária). |
| RestartOpenSearch | Restart a polarDB-X search instance | Reinicia uma instância PolarDB-X Search. |
| RestartPxfs | Reiniciar uma instância do serviço de arquivos do Agent. | Reinicia uma instância do serviço de arquivos do Agent. |
| RevokePxfsAccessToken | Revogar um token de acesso do serviço de arquivos do Agent. | Revoga um token de acesso para o serviço de arquivos do Agent. |
| ScaleInOpenSearch | Scale in a polarDB-X search instance | Reduz os nós de um cluster PolarDB-X Search. |
| ScaleOutOpenSearch | Escala horizontal de uma instância PolarDB-X Search | Escala horizontalmente os nós em um cluster PolarDB-X Search. |
| UpgradePxfsVersion | Atualização da versão secundária do serviço de arquivos do Agent. | Atualiza a versão secundária do serviço de arquivos do Agent. |