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. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Databases
|
API |
Title |
Description |
| RevokeTablePermission | RevokeTablePermission | Revokes permissions on a table. |
| RevokeSchemaPermission | RevokeSchemaPermission | Revokes permissions on a schema. |
| RevokeDatabasePermission | RevokeDatabasePermission | Revokes permissions on a database. |
| ListDatabases | ListDatabases | Lists databases. |
| GrantTablePermission | GrantTablePermission | DB authorization |
| GrantSchemaPermission | GrantSchemaPermission | Grants permissions on a database schema. |
| GrantDatabasePermission | GrantDatabasePermission | Grants permissions on a database. |
Instance
|
API |
Title |
Description |
| CreateInstance | CreateInstance | Creates an instance. |
| DeleteInstance | Delete an instance | Releases an instance. |
| RenewInstance | RenewInstance | Call this operation to manually renew an 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. |
| StopInstance | StopInstance | Stops a running instance. |
| ScaleInstance | ScaleInstance | Changes the instance specifications and storage space of an instance. |
| ChangeResourceGroup | ChangeResourceGroup | Changes the resource group of an instance. |
| ListInstances | ListInstances | Retrieves a list of instances. |
| GetInstance | GetInstance | Retrieves the details of an instance. |
Virtual warehouse
|
API |
Title |
Description |
| 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 compute group. |
| RestartHoloWarehouse | RestartHoloWarehouse | Restarts a virtual warehouse. |
| GetWarehouseDetail | GetWarehouseDetail | Retrieves the details of a virtual warehouse. |
| ListWarehouses | ListWarehouses | Retrieves a list of virtual warehouses. |
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. |
| DisableSSL | DisableSSL | Disables SSL. |
| GetCertificateAttribute | GetCertificateAttribute | Retrieves certificate information. |
| GetRootCertificate | GetRootCertificate | Retrieves the root certificate. |
| RenewSSLCertificate | RenewSSLCertificate | Renews the SSL certificate. |