Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (Hologram/2022-06-01) utiliza o estilo de assinatura ROA. 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.
Atualização
|
API |
Título |
Descrição |
| GetUpgradeable | Consultar se uma instância pode ser atualizada. | Consulta se uma instância pode ser atualizada. |
| GetUpgradeStatus | Consulta do status da atualização. | Consulta o status da atualização. |
| GetLastUpgradeRecord | Consulta de registro de atualização. | Obtém o histórico da última atualização. |
| ListUpgradeReleaseVersions | Listar versões atualizáveis. | Obtém a lista de versões disponíveis para upgrade. |
| UpdateAutoUpgrade | Ativar atualização automática de versão secundária. | Ativa as atualizações automáticas de versões secundárias. Após a ativação deste recurso, a instância é atualizada automaticamente durante a janela de tempo. |
| UpgradeInstance | Atualizar uma instância. | Atualiza uma instância. Se a preparação for bem-sucedida, a instância poderá iniciar a atualização diretamente. |
| UpdateOperationEventScheduleTime | Atualização do horário de execução de evento de O&M. | Modifica o horário de execução de um evento de O&M. |
| UpdateMaintenanceWindow | Definir janela de manutenção. | Define a janela de manutenção de uma instância para agendar a manutenção do sistema. |
| PrepareUpgrade | PrepareUpgrade. | Prepara uma instância para uma atualização executando uma avaliação pré-atualização. Você pode atualizar a instância somente se a avaliação for aprovada. Se falhar, entre em contato com o suporte técnico para uma atualização manual. |
| DiscardUpgrade | DiscardUpgrade. | Cancela uma atualização. Você pode chamar esta operação apenas se a tarefa de atualização não tiver sido iniciada ou estiver no estado pre_check. Você não pode cancelar a atualização depois que a tarefa entrar no estado backup ou em qualquer estado subsequente. |
Tags
|
API |
Título |
Descrição |
| UntagResources | UntagResources | Remove tags de uma ou mais instâncias. |
| TagResources | TagResources. | Adiciona tags a um ou mais recursos. |
| DescribeTags | DescribeTags. | Lista todas as tags. |
Executar SQL
|
API |
Título |
Descrição |
| GetExecuteStatementEnabled | GetExecuteStatementEnabled. | Verifica se uma instância Hologres especificada permite a execução de SQL por meio de OpenAPI. |
| ExecuteStatement | ExecuteStatement. | Executa uma instrução SQL de forma síncrona em um banco de dados especificado via OpenAPI e retorna o resultado. |
| EnableExecuteStatement | EnableExecuteStatement. | Ativa a execução de SQL via OpenAPI para uma instância Hologres especificada. |
| DisableExecuteStatement | Desativa o recurso executeStatement para uma instância. | Desativa as permissões de acesso à API ExecuteStatement para uma instância Hologres especificada. |
Modelos grandes
|
API |
Título |
Descrição |
| ListInstanceModel | Lista de recursos de nós de IA. | Consulta a lista de recursos de nós de IA. |
| UpdateModelService | UpdateModelService. | Atualiza um serviço de modelo. Esta operação aplica-se apenas ao Hologres AI. |
| ListModelCatalog | Listar modelos. | Lista os modelos. |
| CreateModelService | Criar um serviço de modelo | Cria um serviço de modelo que permite que funções de IA invoquem modelos. Suporta a criação de dois tipos de modelos: 1) modelos do Alibaba Cloud Model Studio e 2) nós de IA do Hologres. Para o Hologres AI, é necessário adquirir os recursos de nós de IA separadamente. |
| DeleteModelResource | Excluir recursos de nó | Exclui recursos de nó. Todos os modelos implantados no nó serão excluídos e não poderão ser recuperados. |
| DeleteModelService | Excluir um serviço de modelo | Exclui um serviço de modelo. |
| GetInstanceModel | Detalhes do modelo implantado na instância. | Consulta a lista de serviços de grandes modelos vinculados a uma instância Hologres. |
Bancos de dados
|
API |
Título |
Descrição |
| CreateDatabase | Criar um banco de dados | Cria um banco de dados. |
| CreateExternalDatabase | Criar um banco de dados externo | Cria um banco de dados externo. |
| CreateUser | Criar um usuário | Adiciona um usuário RAM ou uma conta STS a uma instância Hologres como uma conta de instância. Após a conta ser adicionada, você pode fazer login na instância usando a identidade RAM ou STS. |
| DropUser | Exclui um usuário | Exclui um usuário RAM ou uma conta STS do sistema de contas do Hologres. Após a exclusão, o usuário RAM ou a conta STS não poderá mais fazer login na instância. Para fazer login na instância, chame CreateUser para adicionar o usuário novamente. |
| RevokeTablePermission | Revogação de autorização de tabela | Revoga a autorização de tabela. |
| RevokeSchemaPermission | RevokeSchemaPermission. | Revoga as permissões em um schema de um usuário especificado em uma instância do Hologres. |
| RevokeDatabasePermission | RevokeDatabasePermission. | Revoga as permissões em um banco de dados de um usuário especificado em uma instância do Hologres. |
| ListDatabases | ListDatabases. | Consulta os bancos de dados em uma instância do Hologres. |
| GrantTablePermission | Concessão de permissões de tabela | Concede permissões de tabela a um usuário especificado. |
| GrantSchemaPermission | GrantSchemaPermission. | Concede permissões em um schema a um usuário especificado em uma instância do Hologres. |
| GrantDatabasePermission | GrantDatabasePermission. | Concede permissões em um banco de dados a um usuário especificado em uma instância do Hologres. |
Instâncias
|
API |
Título |
Descrição |
| BindLeaderInstance | Vincular uma instância follower | Vincula uma instância follower. |
| ListLeaderInstances | Lista de instâncias primárias. | Obtém a lista de possíveis IDs de instâncias primárias. |
| ListFollowerInstances | Lista de instâncias secundárias. | Obtém as instâncias secundárias somente leitura de uma instância primária do Hologres especificada. |
| UnBindLeaderInstance | UnBindLeaderInstance. | Desvincula uma instância somente leitura de sua instância primária. |
| CreateInstance | Criar uma instância Hologres | Cria uma instância Hologres. |
| DeleteInstance | Excluir uma instância | Libera uma instância. |
| RenewInstance | RenewInstance. | Renova uma instância Hologres de assinatura. Você também pode ativar a renovação automática mensal. |
| RestartInstance | RestartInstance. | Reinicia uma instância do Hologres. |
| ResumeInstance | ResumeInstance. | Retoma uma instância pausada. |
| UpdateInstanceName | UpdateInstanceName. | Altera o nome de uma instância. |
| UpdateInstanceNetworkType | Alternar o tipo de rede de uma instância | Modifica o tipo de rede de uma instância. |
| DisableHiveAccess | Desativação da aceleração de data lake | Desativa a aceleração de data lake. |
| EnableHiveAccess | EnableHiveAccess. | Ativa a aceleração de data lake para uma instância do Hologres. |
| StopInstance | StopInstance. | Para uma instância em execução. |
| ScaleInstance | Fazer upgrade ou downgrade de uma instância | Modifica as especificações e o espaço de armazenamento de uma instância. |
| ChangeResourceGroup | Atualizar um grupo de recursos | Atualiza um grupo de recursos. |
| ListInstances | Obter lista de instâncias. | Obtém uma lista de instâncias. |
| GetInstance | Detalhes da instância. | Obtém os detalhes de uma instância. |
Grupos de computação
|
API |
Título |
Descrição |
| UpdateWarehouseScheduleTask | Atualização do plano de dimensionamento elástico agendado para um grupo de computação. | Atualiza o plano de dimensionamento elástico agendado para um grupo de computação. |
| ListWarehouseScheduleTask | Lista os planos de dimensionamento elástico baseados em tempo para grupos de computação. | Obtém a lista de todas as tarefas de planos de dimensionamento elástico baseados em tempo para grupos de computação de uma instância especificada. |
| ListWarehouseScheduleEvent | Listar eventos elásticos | Consulta os eventos de agendamento elástico de uma instância especificada em um intervalo de tempo especificado. |
| CreateWarehouse | Criar um warehouse | Cria um warehouse. |
| CreateHoloWarehouse | Criar um grupo de computação | Cria um grupo de computação. |
| DeleteHoloWarehouse | Excluir um grupo de computação | Exclui um grupo de computação. |
| RebalanceHoloWarehouse | RebalanceHoloWarehouse. | Rebalanceia shards em um virtual warehouse. |
| ResumeHoloWarehouse | ResumeHoloWarehouse. | Retoma um warehouse virtual de Stopped para Running. |
| SuspendHoloWarehouse | SuspendHoloWarehouse. | Interrompe um warehouse virtual. |
| RenameHoloWarehouse | RenameHoloWarehouse. | Renomeia um virtual warehouse. |
| ScaleHoloWarehouse | ScaleHoloWarehouse. | Dimensiona um warehouse virtual. |
| RestartHoloWarehouse | RestartHoloWarehouse. | Reinicia um warehouse virtual. |
| GetWarehouseDetail | GetWarehouseDetail | Obtém os detalhes de um warehouse virtual. |
| CreateWarehouseScheduleTask | Cria um plano de escalonamento elástico baseado em tempo. | Cria um plano de escalonamento elástico baseado em tempo. |
| ListWarehouses | ListWarehouses. | Obtém uma lista de warehouses virtuais. |
| DisableWarehouseAutoScale | DisableWarehouseAutoScale. | Desativa o autoscale para um grupo de computação especificado. |
| DeleteWarehouseScheduleTask | DeleteWarehouseScheduleTask. | Exclui uma tarefa de agendamento de warehouse. |
| EnableWarehouseAutoScale | EnableWarehouseAutoScale. | Ativa o dimensionamento automático para um warehouse. |
Backups
|
API |
Título |
Descrição |
| UpdateScheduledBackupConfig | UpdateScheduledBackupConfig | Esta operação configura uma política de backup para uma instância. Você pode definir uma programação semanal para fazer backup de uma instância em dias específicos, como toda segunda, quarta e sexta-feira às 20:00:00. Você também pode especificar o número de backups concluídos a serem retidos. O sistema exclui automaticamente os backups expirados. |
| UpdateBackupDataDesc | UpdateBackupDataDesc. | Atualiza a descrição de um backup. |
| CreateManualBackup | Criar um backup de instância | Cria um backup de instância. |
| ListBackupData | ListBackupData. | Obtém uma lista de snapshots. Cada snapshot representa um backup point-in-time que pode ser usado para restaurar uma nova instância com seus dados completos. |
| DeleteBackupData | Excluir um backup de instância | Exclui um backup. |
| GetScheduledBackupConfig | GetScheduledBackupConfig. | Obtém a configuração de backup. |
Segurança
|
API |
Título |
Descrição |
| UpdateInstancePort | UpdateInstancePort. | Atualiza a porta de uma instância. |
| UpdateHoloWebLoginSetting | UpdateHoloWebLoginSetting. | Modifica as configurações de login do holoweb. |
| GetHoloWebLoginSetting | GetHoloWebLoginSetting. | Obtém a configuração de login de contas externas para o HoloWeb. |
| DisableSupportAccount | DisableSupportAccount. | Desativa uma conta de suporte. |
| EnableSupportAccount | Ativar conta de serviço. | Ativa a conta de serviço. |
| EnableSSL | EnableSSL. | Ativa a criptografia SSL para uma instância Hologres. |
| DisableSSL | DisableSSL. | Desativa a criptografia SSL para uma instância do Hologres. |
| GetCertificateAttribute | GetCertificateAttribute. | Obtém os atributos do certificado SSL de uma instância Hologres, incluindo o status do SSL e a data de expiração do certificado. |
| GetRootCertificate | GetRootCertificate. | Obtém o certificado SSL raiz de uma instância Hologres para conexões SSL no lado do cliente. |
| RenewSSLCertificate | RenewSSLCertificate. | Renova o certificado SSL de uma instância do Hologres. |
Outros
|
API |
Título |
Descrição |
| DisableOperationEvent | Desativar logs de O&M | Desativa os logs de O&M. |
| ListMigrationZones | ListMigrationZones. | Lista as zonas de disponibilidade para as quais uma instância pode ser migrada. Esta operação se aplica a instâncias implantadas em três zonas de disponibilidade. |
| ListOperationEvents | ListOperationEvents. | Obtém eventos de ação que correspondem aos critérios especificados, com suporte a paginação e ordenação. |
| ListRegions | Listar regiões. | Consulta a lista de todas as regiões suportadas pelo Hologres. |
| MigrateInstanceZone | MigrateInstanceZone. | Migra uma instância para uma zona de disponibilidade de destino. Esta operação suporta apenas instâncias implantadas em três zonas de disponibilidade. A instância é iniciada na zona de disponibilidade de destino sem migrar seu armazenamento. O processo leva aproximadamente 5 minutos. |