DocsICP FilingConsole
Documentation
Home Page Hologres Developer Reference API Reference API overview

API overview

Updated at:
Copy as MD
Product
My Favorites

API standards and multilingual preset SDKs

The OpenAPI of this product (Hologram/2022-06-01) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Upgrade

API

Title

Description
GetUpgradeable Query whether an instance can be upgraded Queries whether an instance can be upgraded.
GetUpgradeStatus Query upgrade status Queries the upgrade status.
GetLastUpgradeRecord Query upgrade record Retrieves the last upgrade history.
ListUpgradeReleaseVersions List upgradable versions Retrieves the list of versions available for upgrade.
UpdateAutoUpgrade Enable automatic minor version update Enables automatic minor version updates. After this feature is enabled, the instance is automatically upgraded during the time window.
UpgradeInstance Upgrade an instance Upgrades an instance. If the preparation is successful, the instance can start the upgrade directly.
UpdateOperationEventScheduleTime Update O&M event execution time Modifies the execution time of an O&M event.
UpdateMaintenanceWindow Set maintenance window Sets the maintenance window for an instance to schedule system maintenance.
PrepareUpgrade PrepareUpgrade Prepares an instance for an upgrade by running a pre-upgrade assessment. You can upgrade the instance only if the assessment passes. If it fails, contact technical support for a manual upgrade.
DiscardUpgrade DiscardUpgrade Cancels an upgrade. You can call this operation only if the upgrade task has not started or is in the `pre_check` state. You cannot cancel the upgrade after the task enters the `backup` state or any subsequent state.

Tags

API

Title

Description
UntagResources UntagResources Removes tags from one or more instances.
TagResources TagResources Adds tags to one or more resources.
DescribeTags DescribeTags Lists all tags.

Execute SQL

API

Title

Description
GetExecuteStatementEnabled GetExecuteStatementEnabled Checks whether a specified Hologres instance allows SQL execution through OpenAPI.
ExecuteStatement ExecuteStatement Executes an SQL statement synchronously on a specified database via OpenAPI and returns the result.
EnableExecuteStatement EnableExecuteStatement Enables SQL execution via OpenAPI for a specified Hologres instance.
DisableExecuteStatement Disable the executeStatement feature for an instance Shuts down the ExecuteStatement API access permissions for a specified Hologres instance.

Large language models

API

Title

Description
ListInstanceModel List AI node resources Queries the list of AI node resources.
UpdateModelService UpdateModelService Updates a model service. This operation applies only to Hologres AI.
ListModelCatalog List models Lists models.
CreateModelService CreateModelService Creates a model service that allows AI functions to invoke models. You can create a service for two types of models: a model from Alibaba Cloud Model Studio or a model on a Hologres AI node. If you use a Hologres AI node, you must purchase the AI node resources separately.
DeleteModelResource DeleteModelResource Deletes a model resource. This action permanently deletes all models deployed on the node.
DeleteModelService DeleteModelService Deletes a specified model service.
GetInstanceModel Instance deployed model details Queries the list of large model services bound to a Hologres instance.

Databases

API

Title

Description
CreateDatabase CreateDatabase Creates a database.
CreateExternalDatabase CreateExternalDatabase Creates an external database.
CreateUser CreateUser Adds a RAM user or an STS account to a Hologres instance. Once added, the account can be used to log on to the instance.
DropUser DropUser Deletes a RAM user or an STS account from a Hologres instance. Once deleted, the user can no longer log in to the instance. To restore access, call the CreateUser operation to add the user.
RevokeTablePermission Revoke table authorization Cancels table authorization.
RevokeSchemaPermission RevokeSchemaPermission Revokes permissions on a schema from a specified user within a Hologres instance.
RevokeDatabasePermission RevokeDatabasePermission Revokes permissions on a database from a specified user within a Hologres instance.
ListDatabases ListDatabases Queries the databases in a Hologres instance.
GrantTablePermission Grant table permissions Grants permissions on a database table.
GrantSchemaPermission GrantSchemaPermission Grants permissions on a schema to a specified user within a Hologres instance.
GrantDatabasePermission GrantDatabasePermission Grants permissions on a database to a specified user within a Hologres instance.

Instances

API

Title

Description
BindLeaderInstance BindLeaderInstance Binds a follower instance to a leader instance.
ListLeaderInstances Retrieve primary instance list Retrieves the list of possible primary instance IDs.
ListFollowerInstances List secondary instances Retrieves the read-only secondary instances of a specified Hologres primary instance.
UnBindLeaderInstance UnBindLeaderInstance Detaches a read-only instance from its primary instance.
CreateInstance CreateInstance Creates a Hologres instance in the specified region.
DeleteInstance Delete an instance Releases an instance.
RenewInstance RenewInstance Renews a subscription Hologres instance. You can also enable monthly auto-renewal.
RestartInstance RestartInstance Restarts a Hologres instance.
ResumeInstance ResumeInstance Resumes a paused instance.
UpdateInstanceName UpdateInstanceName Changes the name of an instance.
UpdateInstanceNetworkType UpdateInstanceNetworkType Modifies the network type of an instance.
DisableHiveAccess DisableHiveAccess Disables data lake acceleration.
EnableHiveAccess EnableHiveAccess Enables data lake acceleration for a Hologres instance.
StopInstance StopInstance Stops a running instance.
ScaleInstance ScaleInstance Changes the specifications and storage space of a Hologres instance.
ChangeResourceGroup ChangeResourceGroup Updates the resource group of a Hologres instance.
ListInstances Retrieve instance list Retrieves a list of instances.
GetInstance Retrieve instance details Retrieves the details of an instance.

Compute groups

API

Title

Description
UpdateWarehouseScheduleTask Update scheduled elastic scaling plan for a compute group Updates the scheduled elastic scaling plan for a compute group.
ListWarehouseScheduleTask List time-based elastic scaling plans for compute groups Retrieves the list of all time-based elastic scaling plan tasks for compute groups under a specified instance.
ListWarehouseScheduleEvent ListWarehouseScheduleEvent Retrieves the elastic scheduling events for a specified instance and time range.
CreateWarehouse CreateWarehouse Creates a warehouse.
CreateHoloWarehouse CreateHoloWarehouse Creates a virtual warehouse.
DeleteHoloWarehouse DeleteHoloWarehouse Deletes a virtual warehouse.
RebalanceHoloWarehouse RebalanceHoloWarehouse Rebalances shards in a virtual warehouse.
ResumeHoloWarehouse ResumeHoloWarehouse Resumes a virtual warehouse from Stopped to Running.
SuspendHoloWarehouse SuspendHoloWarehouse Stops a virtual warehouse.
RenameHoloWarehouse RenameHoloWarehouse Renames a virtual warehouse.
ScaleHoloWarehouse ScaleHoloWarehouse Scales a virtual warehouse.
RestartHoloWarehouse RestartHoloWarehouse Restarts a virtual warehouse.
GetWarehouseDetail GetWarehouseDetail Retrieves the details of a virtual warehouse.
CreateWarehouseScheduleTask Create a time-based elastic scaling plan Creates a time-based elastic scaling plan.
ListWarehouses ListWarehouses Retrieves a list of virtual warehouses.
DisableWarehouseAutoScale DisableWarehouseAutoScale Disables autoscale for a specified compute group.
DeleteWarehouseScheduleTask DeleteWarehouseScheduleTask Deletes a warehouse schedule task.
EnableWarehouseAutoScale EnableWarehouseAutoScale Enables auto scaling for a warehouse.

Backup

API

Title

Description
UpdateScheduledBackupConfig UpdateScheduledBackupConfig This operation configures a backup policy for an instance. You can set a weekly schedule to back up an instance on specific days, such as every Monday, Wednesday, and Friday at 20:00:00. You can also specify the number of completed backups to retain. The system automatically deletes expired backups.
UpdateBackupDataDesc UpdateBackupDataDesc Updates the description of a backup.
CreateManualBackup CreateManualBackup Creates a manual backup for an instance.
ListBackupData ListBackupData Retrieves a list of snapshots. Each snapshot represents a point-in-time backup that can be used to restore a new instance with its full data.
DeleteBackupData DeleteBackupData Deletes a backup.
GetScheduledBackupConfig GetScheduledBackupConfig Retrieves the backup configuration.

Security

API

Title

Description
UpdateInstancePort UpdateInstancePort Updates the port of an instance.
UpdateHoloWebLoginSetting UpdateHoloWebLoginSetting Modifies the login settings for holoweb.
GetHoloWebLoginSetting GetHoloWebLoginSetting Gets the external account login setting for HoloWeb.
DisableSupportAccount DisableSupportAccount Disables a Support Account.
EnableSupportAccount Enable service account Enables the service account.
EnableSSL EnableSSL Enables SSL encryption for a Hologres instance.
DisableSSL DisableSSL Disables SSL encryption for a Hologres instance.
GetCertificateAttribute GetCertificateAttribute Retrieves the SSL certificate attributes of a Hologres instance, including SSL status and certificate expiration time.
GetRootCertificate GetRootCertificate Retrieves the root SSL certificate of a Hologres instance for client-side SSL connections.
RenewSSLCertificate RenewSSLCertificate Renews the SSL certificate of a Hologres instance.

Others

API

Title

Description
DisableOperationEvent Disable instance log Disables the instance log.
ListMigrationZones ListMigrationZones Lists the availability zones to which an instance can be migrated. This operation applies to instances that are deployed across three availability zones.
ListOperationEvents ListOperationEvents Retrieves action events that match specified criteria, supporting pagination and sorting.
ListRegions List regions Queries the list of all regions supported by Hologres.
MigrateInstanceZone MigrateInstanceZone Migrates an instance to a target availability zone. This operation only supports instances deployed across three availability zones. The instance is launched in the target availability zone without migrating its storage. The process takes approximately 5 minutes.
Previous：API ReferenceNext：Endpoints