API の概要 - Hologres - Alibaba Cloud ドキュメントセンター

API 標準および多言語対応の SDK

本製品 (Hologram/2022-06-01) の API は、ROA 標準に準拠した OpenAPI 仕様を採用しています。Alibaba Cloud には主要なプログラミング言語に対応した SDK が用意され、リクエスト署名のような手間がかかる手順を省略できます。そのため、開発者は HTTP 通信の詳細を意識することなく、各言語の構文で API を呼び出すことが可能になります。

カスタム署名

署名のカスタマイズが必要な場合、「署名メカニズム」を参照してリクエストに手動で署名できます。手動署名プロセスは非常に煩雑で、通常はおよそ 5 営業日かかります。詳細については、DingTalk サポート窓口 (グループチャット ID：147535001692) までお問い合わせください。

はじめに

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ち、その AccessKey ペアが悪用されると、関連するすべてのリソースが不正にアクセスされ、重大なセキュリティリスクを引き起こす可能性があります。そのため、必要な場合以外は、Alibaba Cloud アカウントを使用しないでください。その代わりに、API のみでのアクセスを許可された Resource Access Management (RAM) ユーザーを作成し、RAM ポリシーを設定することで、最小権限の原則 (PoLP) を徹底してください。

API セキュリティを確保するには、以下を作成し、設定する必要があります。

RAM ユーザー
RAM ユーザー用の AccessKey ペア

スペックアップ

API	タイトル	説明
GetUpgradeStatus	GetUpgradeStatus	インスタンスのアップグレードステータスを照会します。
GetLastUpgradeRecord	GetLastUpgradeRecord	最後のアップグレードレコードを取得します。
UpdateAutoUpgrade	UpdateAutoUpgrade	インスタンスの自動マイナーバージョンアップグレードを有効にします。アップグレードはメンテナンスウィンドウ中に自動的に実行されます。
UpdateOperationEventScheduleTime	UpdateOperationEventScheduleTime	操作イベントのスケジュールされた実行時間を更新します。
UpdateMaintenanceWindow	UpdateMaintenanceWindow	指定されたインスタンスのメンテナンスウィンドウを更新します。
PrepareUpgrade	PrepareUpgrade	アップグレード前の評価を実行し、インスタンスのアップグレードを準備します。評価に合格した場合にのみ、インスタンスをアップグレードできます。失敗した場合は、テクニカルサポートに連絡して手動アップグレードを依頼してください。
DiscardUpgrade	DiscardUpgrade	アップグレードをキャンセルします。この操作は、アップグレードタスクが開始されていない場合、または `pre_check` 状態の場合にのみ呼び出すことができます。タスクが `backup` 状態またはそれ以降の状態になると、アップグレードをキャンセルすることはできません。

SQL の実行

API	タイトル	説明
GetExecuteStatementEnabled	GetExecuteStatementEnabled	指定された Hologres インスタンスで OpenAPI 経由の SQL の実行が許可されているかどうかを確認します。
ExecuteStatement	ExecuteStatement	OpenAPI を介して指定されたデータベースで SQL ステートメントを同期実行し、結果を返します。
EnableExecuteStatement	EnableExecuteStatement	指定の Hologres インスタンスで、OpenAPI 経由の SQL 実行を有効にします。
DisableExecuteStatement	インスタンスの executeStatement 特徴を無効にします。	指定された Hologres インスタンスの ExecuteStatement API アクセス権限をダウンします。

大規模言語モデル

API	タイトル	説明
ListInstanceModel	AI ノードリソース	AI ノードリソース。
UpdateModelService	UpdateModelService	モデルサービスを更新します。この操作は Hologres AI にのみ適用されます。
ListModelCatalog	モデルの一覧を表示します。	モデルの一覧を表示します。
CreateModelService	CreateModelService	AI 関数がモデルを呼び出すためのモデルサービスを作成します。作成できるサービスは 2 種類のモデルに対応しています：Alibaba Cloud Model Studio のモデル、または Hologres AI ノード上のモデルです。Hologres AI ノードを使用する場合は、AI ノードリソースを別途購入する必要があります。
DeleteModelResource	DeleteModelResource	モデルリソースを削除します。この操作により、ノードにデプロイされているすべてのモデルが完全に削除されます。
DeleteModelService	DeleteModelService	指定されたモデルサービスを削除します。
GetInstanceModel	GetInstanceModel	Hologres インスタンスにバインドされた大規模モデルサービス

データベース

API	タイトル	説明
CreateDatabase	CreateDatabase	データベースを作成します。
CreateExternalDatabase	CreateExternalDatabase	外部データベースを作成します。
CreateUser	CreateUser	RAM ユーザーまたは STS アカウントを Hologres インスタンスに追加します。追加後、そのアカウントを使用してインスタンスにログインできます。
DropUser	DropUser	Hologres インスタンスから RAM ユーザーまたは STS アカウントを削除します。削除されたユーザーは、インスタンスにログインできなくなります。アクセスを復元するには、CreateUser 操作を呼び出してユーザーを追加する必要があります。
RevokeTablePermission	RevokeTablePermission	指定したユーザーからテーブルの権限を取り消します。
RevokeSchemaPermission	RevokeSchemaPermission	スキーマに対する権限を取り消します。
RevokeDatabasePermission	RevokeDatabasePermission	データベース権限を取り消します。
ListDatabases	ListDatabases	データベースを一覧表示します。
GrantTablePermission	GrantTablePermission	指定したユーザーにテーブルの権限を付与します。
GrantSchemaPermission	GrantSchemaPermission	データベーススキーマに対する権限を付与します。
GrantDatabasePermission	GrantDatabasePermission	データベース権限を付与します。

インスタンス

API	タイトル	説明
BindLeaderInstance	BindLeaderInstance	フォロワーインスタンスをリーダーインスタンスに読み取り専用としてバインドします。
ListLeaderInstances	ListLeaderInstances	潜在的なリーダーのインスタンスのリストを取得します。
UnBindLeaderInstance	UnBindLeaderInstance	読み取り専用インスタンスをプライマリインスタンスからデタッチします。
CreateInstance	CreateInstance	この API 操作はインスタンスを作成します。
DeleteInstance	Delete an instance	指定されたインスタンスをリリースします。
RenewInstance	RenewInstance	この操作を呼び出してインスタンスを手動で更新します。月次自動更新を有効にすることもできます。
RestartInstance	RestartInstance	Hologres インスタンスを再起動します。
ResumeInstance	ResumeInstance	一時停止中のインスタンスを再開します。
UpdateInstanceName	UpdateInstanceName	インスタンスの名前を変更します。
UpdateInstanceNetworkType	UpdateInstanceNetworkType	インスタンスのネットワークタイプを変更します。
DisableHiveAccess	DisableHiveAccess	データレイクアクセラレーションを無効にします。
EnableHiveAccess	EnableHiveAccess	この操作は、データレイクアクセラレーションを有効にします。
StopInstance	StopInstance	実行中のインスタンスを停止します。
ScaleInstance	ScaleInstance	インスタンスの仕様とストレージ容量を変更します。
ChangeResourceGroup	ChangeResourceGroup	リソースグループを更新します。
ListInstances	ListInstances	インスタンスのリストを取得します。
GetInstance	GetInstance	インスタンスの詳細情報を取得します。

コンピューティンググループ

API	タイトル	説明
UpdateWarehouseScheduleTask	UpdateWarehouseScheduleTask	ウェアハウスのエラスティックスケジュールを更新します。
ListWarehouseScheduleTask	ListWarehouseScheduleTask	指定したインスタンスのすべてのウェアハウススケジュールタスクを取得します。
ListWarehouseScheduleEvent	ListWarehouseScheduleEvent	インスタンスと時間範囲を指定して、エラスティックスケジューリングイベントを取得します。
CreateWarehouse	CreateWarehouse	ウェアハウスを作成します。
CreateHoloWarehouse	CreateHoloWarehouse	計算グループを作成します。
DeleteHoloWarehouse	DeleteHoloWarehouse	計算グループを削除します。
RebalanceHoloWarehouse	RebalanceHoloWarehouse	計算グループ内のシャードをリバランスします。
ResumeHoloWarehouse	ResumeHoloWarehouse	計算グループを停止状態から通常状態に再開します。
SuspendHoloWarehouse	SuspendHoloWarehouse	計算グループを一時停止します。
RenameHoloWarehouse	RenameHoloWarehouse	計算グループの名前を変更します。
ScaleHoloWarehouse	ScaleHoloWarehouse	仮想ウェアハウスのスケールを変更します。
RestartHoloWarehouse	RestartHoloWarehouse	計算グループを再起動します。
GetWarehouseDetail	GetWarehouseDetail	計算グループの詳細。
CreateWarehouseScheduleTask	CreateWarehouseScheduleTask	ウェアハウススケジュールタスクを作成します。
ListWarehouses	ListWarehouses	計算グループのリストを取得します。
DisableWarehouseAutoScale	DisableWarehouseAutoScale	指定されたコンピューティンググループのオートスケールを無効にします。
DeleteWarehouseScheduleTask	DeleteWarehouseScheduleTask	ウェアハウススケジュールタスクを削除します。
EnableWarehouseAutoScale	EnableWarehouseAutoScale	ウェアハウスのオートスケーリングを有効にします。

バックアップ

API	タイトル	説明
UpdateScheduledBackupConfig	UpdateScheduledBackupConfig	この API は、インスタンスのバックアップポリシーを設定します。毎週月曜日、水曜日、金曜日の 20:00:00 など、特定の曜日にインスタンスをバックアップする週次スケジュールを設定できます。また、保持する完了済みバックアップの数を指定することもできます。システムは期限切れのバックアップを自動的に削除します。
UpdateBackupDataDesc	UpdateBackupDataDesc	バックアップの説明を更新します。
CreateManualBackup	CreateManualBackup	インスタンスの手動バックアップを作成します。
ListBackupData	ListBackupData	バックアップデータのリストを照会します。バックアップは、特定の時点におけるインスタンスの完全なデータスナップショットであり、新しいインスタンスに完全なデータを回復するために使用できます。
DeleteBackupData	DeleteBackupData	バックアップを削除します。
GetScheduledBackupConfig	GetScheduledBackupConfig	バックアップ設定を取得します。

セキュリティ

API	タイトル	説明
UpdateInstancePort	UpdateInstancePort	インスタンスのポートを更新します。
UpdateHoloWebLoginSetting	UpdateHoloWebLoginSetting	HoloWeb のログイン設定を変更します。
GetHoloWebLoginSetting	GetHoloWebLoginSetting	HoloWeb の外部アカウントのログイン設定を取得します。
DisableSupportAccount	DisableSupportAccount	サポートアカウントを無効化します。
EnableSupportAccount	EnableSupportAccount	サポートアカウントを有効にします。
EnableSSL	EnableSSL	SSL を有効にします。
DisableSSL	DisableSSL	SSL を無効にします。
GetCertificateAttribute	GetCertificateAttribute	証明書情報を取得します。
GetRootCertificate	GetRootCertificate	ルート証明書を取得します。
RenewSSLCertificate	RenewSSLCertificate	SSL 証明書を更新します。

その他

API	タイトル	説明
ListMigrationZones	ListMigrationZones	インスタンスの移行先となるアベイラビリティーゾーンの一覧を取得します。この API は、3 つのアベイラビリティーゾーンにまたがってデプロイされたインスタンスに適用されます。
ListOperationEvents	ListOperationEvents	指定された条件に一致するアクションイベントを取得します。ページネーションとソートに対応しています。
MigrateInstanceZone	MigrateInstanceZone	インスタンスをターゲットアベイラビリティーゾーンに移行します。この操作は、3 つのアベイラビリティーゾーンにまたがってデプロイされたインスタンスにのみ適用されます。インスタンスは、ストレージを移行することなく、ターゲットアベイラビリティーゾーンで起動されます。このプロセスには約 5 分かかります。

API	タイトル	説明
UntagResources	UntagResources	1 つ以上のインスタンスからタグを削除します。
TagResources	TagResources	1 つ以上のリソースにタグを追加します。
DescribeTags	DescribeTags	すべてのタグを一覧表示します。