API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Hologram/2022-06-01) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
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 | DisableExecuteStatement | Disables the ExecuteStatement API for a specified Hologres instance. |
Large models
|
API |
Title |
Description |
| ListInstanceModel | ListInstanceModel | Lists AI node resources. |
| UpdateModelService | UpdateModelService | Updates a model service. This operation applies only to Hologres AI. |
| ListModelCatalog | ListModelCatalog | Lists the available 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 | GetInstanceModel | Large model services bound to the 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 | RevokeTablePermission | Revokes permissions on a table from a specified user. |
| 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 | GrantTablePermission | Grants permissions on a table to a specified user. |
| 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. |
Instance
|
API |
Title |
Description |
| 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 | ListInstances | Retrieves a list of instances. |
| GetInstance | GetInstance | Retrieves the details of an instance. |
Virtual warehouse
|
API |
Title |
Description |
| UpdateWarehouseScheduleTask | UpdateWarehouseScheduleTask | Updates an elastic schedule for a warehouse. |
| ListWarehouseScheduleTask | ListWarehouseScheduleTask | Lists all warehouse schedule tasks for 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 | CreateWarehouseScheduleTask | Creates a warehouse schedule task. |
| 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 |
| 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. |
Security
|
API |
Title |
Description |
| 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 |
| BindLeaderInstance | BindLeaderInstance | Binds a follower instance to a leader instance. |
| CreateManualBackup | CreateManualBackup | Creates a manual backup for an instance. |
| DeleteBackupData | DeleteBackupData | Deletes a backup. |
| DescribeTags | DescribeTags | Lists all tags. |
| DisableSupportAccount | DisableSupportAccount | Disables a Support Account. |
| 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. |
| EnableSupportAccount | EnableSupportAccount | Enables a support account. |
| GetHoloWebLoginSetting | GetHoloWebLoginSetting | Gets the external account login setting for HoloWeb. |
| GetLastUpgradeRecord | GetLastUpgradeRecord | Retrieves the last upgrade record. |
| GetScheduledBackupConfig | GetScheduledBackupConfig | Retrieves the backup configuration. |
| GetUpgradeStatus | GetUpgradeStatus | Queries the upgrade status of an instance. |
| ListLeaderInstances | ListLeaderInstances | Retrieves a list of potential leader instances. |
| 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. |
| 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. |
| 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. |
| TagResources | TagResources | Adds tags to one or more resources. |
| UnBindLeaderInstance | UnBindLeaderInstance | Detaches a read-only instance from its primary instance. |
| UpdateAutoUpgrade | UpdateAutoUpgrade | Enables automatic minor version upgrades for an instance. The upgrade occurs automatically during the maintenance window. |
| UpdateBackupDataDesc | UpdateBackupDataDesc | Updates the description of a backup. |
| UpdateHoloWebLoginSetting | UpdateHoloWebLoginSetting | Modifies the login settings for holoweb. |
| UpdateInstancePort | UpdateInstancePort | Updates the port of an instance. |
| UpdateMaintenanceWindow | UpdateMaintenanceWindow | Updates the maintenance window of a specified instance. |
| UpdateOperationEventScheduleTime | UpdateOperationEventScheduleTime | Updates the scheduled execution time for an operation event. |
| 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. |
该文章对您有帮助吗？