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 |
| GetUpgradeStatus | GetUpgradeStatus. | Consulta o status de atualização de uma instância. |
| GetLastUpgradeRecord | GetLastUpgradeRecord. | Obtém o último registro de upgrade. |
| UpdateAutoUpgrade | UpdateAutoUpgrade. | Ativa atualizações automáticas de versão secundária para uma instância. A atualização ocorre automaticamente durante a janela de manutenção. |
| UpdateOperationEventScheduleTime | UpdateOperationEventScheduleTime. | Atualiza o horário de execução agendado para um evento de operação. |
| UpdateMaintenanceWindow | UpdateMaintenanceWindow. | Atualiza a janela de manutenção de uma instância especificada. |
| 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 as 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 de linguagem grande
|
API |
Título |
Descrição |
| ListInstanceModel | Recursos de nós de IA | Recursos de nós de IA. |
| UpdateModelService | UpdateModelService. | Atualiza um serviço de modelo. Esta operação aplica-se apenas ao Hologres AI. |
| ListModelCatalog | List models. | Lista modelos. |
| CreateModelService | CreateModelService. | Cria um serviço de modelo que permite que funções de IA invoquem modelos. Você pode criar um serviço para dois tipos de modelos: um modelo do Alibaba Cloud Model Studio ou um modelo em um nó de IA do Hologres. Se você usar um nó de IA do Hologres, deverá adquirir os recursos do nó de IA separadamente. |
| DeleteModelResource | DeleteModelResource. | Exclui um recurso de modelo. Esta ação exclui permanentemente todos os modelos implantados no nó. |
| DeleteModelService | DeleteModelService. | Exclui um serviço de modelo especificado. |
| GetInstanceModel | GetInstanceModel. | Obtém os serviços de modelos grandes vinculados à instância do Hologres. |
Bancos de dados
|
API |
Título |
Descrição |
| CreateDatabase | CreateDatabase. | Cria um banco de dados. |
| CreateExternalDatabase | CreateExternalDatabase. | Cria um banco de dados externo. |
| CreateUser | CreateUser. | Adiciona um usuário RAM ou uma conta STS a uma instância do Hologres. Após a adição, a conta pode ser usada para fazer login na instância. |
| DropUser | DropUser. | Exclui um usuário RAM ou uma conta STS de uma instância Hologres. Uma vez excluído, o usuário não poderá mais fazer login na instância. Para restaurar o acesso, chame a operação CreateUser para adicionar o usuário. |
| RevokeTablePermission | RevokeTablePermission. | Revoga as permissões de uma tabela de um usuário especificado. |
| 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 | GrantTablePermission. | Concede permissões em uma 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 | BindLeaderInstance. | Vincula uma instância seguidora a uma instância líder. |
| ListLeaderInstances | ListLeaderInstances. | Obtém uma lista de possíveis instâncias leader. |
| UnBindLeaderInstance | UnBindLeaderInstance. | Desvincula uma instância somente leitura de sua instância primária. |
| CreateInstance | CreateInstance. | Cria uma instância Hologres na região especificada. |
| 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 | UpdateInstanceNetworkType | Modifica o tipo de rede de uma instância. |
| DisableHiveAccess | DisableHiveAccess. | Desativa a aceleração do 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 | Escalar uma instância. | Altera as especificações e o espaço de armazenamento de uma instância Hologres. |
| ChangeResourceGroup | ChangeResourceGroup. | Atualiza o grupo de recursos de uma instância Hologres. |
| ListInstances | ListInstances. | Obtém uma lista de instâncias. |
| GetInstance | GetInstance. | Obtém os detalhes de uma instância. |
Grupos de computação
|
API |
Título |
Descrição |
| UpdateWarehouseScheduleTask | UpdateWarehouseScheduleTask. | Atualiza um agendamento elástico para um warehouse. |
| ListWarehouseScheduleTask | ListWarehouseScheduleTask. | Lista todas as tarefas de agendamento de warehouse para uma instância especificada. |
| ListWarehouseScheduleEvent | ListWarehouseScheduleEvent. | Obtém os eventos de agendamento elástico para uma instância e um intervalo de tempo especificados. |
| CreateWarehouse | CreateWarehouse. | Cria um warehouse. |
| CreateHoloWarehouse | CreateHoloWarehouse. | Cria um warehouse virtual. |
| DeleteHoloWarehouse | DeleteHoloWarehouse. | Exclui um warehouse virtual. |
| 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 | CreateWarehouseScheduleTask. | Cria uma tarefa de agendamento de warehouse. |
| 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. |
Backup
|
API |
Título |
Descrição |
| UpdateScheduledBackupConfig | UpdateScheduledBackupConfig. | Configura uma política de backup para uma instância. Você pode definir uma programação semanal para realizar o 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 | CreateManualBackup. | Cria um backup manual para uma 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 | DeleteBackupData. | 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 | EnableSupportAccount. | Ativa uma conta de suporte. |
| 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 |
| 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. |
| 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. |