API 標準および多言語対応の SDK
本製品 (hbr/2017-09-08) の API は、RPC 標準に準拠した 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 |
タイトル |
説明 |
| CreateVault | CreateVault | バックアップボールトを作成します。 |
| CreateReplicationVault | CreateReplicationVault | ミラーボールトを作成します。 |
| DeleteVault | DeleteVault | バックアップボールトを削除します。 |
| UpdateVault | UpdateVault | バックアップボールトの設定情報を更新します。 |
| DescribeVaults | DescribeVaults | 指定された条件を満たす 1 つ以上のバックアップボールトを照会します。 |
バックアッププラン
|
API |
タイトル |
説明 |
| CreateBackupPlan | CreateBackupPlan | バックアッププランを作成します。 |
| DeleteBackupPlan | DeleteBackupPlan | バックアッププランを削除します。 |
| DisableBackupPlan | バックアッププランを一時停止します | バックアッププランを一時停止します。 |
| EnableBackupPlan | EnableBackupPlan | バックアッププランを再開します。 |
| UpdateBackupPlan | UpdateBackupPlan | バックアッププランを更新します。 |
| DescribeBackupPlans | DescribeBackupPlans | 指定された条件を満たす 1 つ以上のバックアッププランを取得します。 |
| ExecuteBackupPlan | ExecuteBackupPlan | バックアッププランを実行します。 |
バックアップポリシー
|
API |
タイトル |
説明 |
| CreatePolicyV2 | CreatePolicyV2 | ポリシーを作成します。 |
| DeletePolicyV2 | DeletePolicyV2 | ポリシーを削除します。 |
| UpdatePolicyV2 | UpdatePolicyV2 | バックアップポリシーを変更します。 |
| DescribePoliciesV2 | DescribePoliciesV2 | 1 つ以上のポリシーを照会します。 |
| CreatePolicyBindings | CreatePolicyBindings | 1 つ以上のデータソースをバックアップポリシーにバインドします。 |
| DeletePolicyBinding | DeletePolicyBinding | ポリシーからデータソースをデタッチします。データソースがデタッチされると、ポリシーはそのデータソースを保護しなくなります。この操作は注意して使用してください。 |
| UpdatePolicyBinding | UpdatePolicyBinding | バックアップポリシーとデータソース間の関連付けを更新します。 |
| DescribePolicyBindings | List Bound Policies | ポリシーにアタッチされているデータソース、またはデータソースにアタッチされているポリシーを照会できます。 |
| ExecutePolicyV2 | Execute Policy | 1 つまたはすべてのバインドされたデータソースに対してポリシーを実行します。 |
バックアップクライアント
|
API |
タイトル |
説明 |
| DeleteBackupClient | DeleteBackupClient | Cloud Backup クライアントを削除します。 |
| DeleteBackupClientResource | DeleteBackupClientResource | バックアップクライアントのリソースを削除します。 |
| UpdateClientSettings | UpdateClientSettings | HBR クライアントの構成を更新します。 |
| DescribeBackupClients | バックアップクライアントの情報を照会します | 指定された条件に一致する 1 つ以上のバックアップクライアントの情報を照会します。 |
| InstallBackupClients | バックアップクライアントのインストール | 1台または複数のECSインスタンスにバックアップクライアントをインストールします。 |
| UninstallBackupClients | UninstallBackupClients | 1 つ以上の Elastic Compute Service (ECS) インスタンスから Cloud Backup クライアントをアンインストールします。 |
| UpgradeBackupClients | UpgradeBackupClients | 1 つ以上の Elastic Compute Service (ECS) インスタンス上の HBR クライアントをアップグレードします。 |
バックアップスナップショット
|
API |
タイトル |
説明 |
| DeleteSnapshot | DeleteSnapshot | バックアップスナップショットを削除します。 |
| DescribeOtsTableSnapshots | DescribeOtsTableSnapshots | バックアップされた Tablestore インスタンスの詳細を照会します。 |
| DescribeRecoverableOtsInstances | DescribeRecoverableOtsInstances | 復元可能な Tablestore インスタンスのテーブルを照会します。 |
| SearchHistoricalSnapshots | SearchHistoricalSnapshots | 指定された条件を満たす 1 つ以上の履歴バックアップスナップショットを取得します。 |
| DescribeUdmSnapshots | DescribeUdmSnapshots | 完全バックアップのスナップショットを照会します。 |
復元ジョブ
|
API |
タイトル |
説明 |
| CreateRestoreJob | CreateRestoreJob | 復元ジョブを作成します。 |
| CancelRestoreJob | CancelRestoreJob | 復元ジョブをキャンセルします。 |
| DescribeRestoreJobs2 | DescribeRestoreJobs2 | 指定された条件に一致する復元ジョブを照会します。 |
バックアップジョブ
|
API |
タイトル |
説明 |
| CancelBackupJob | CancelBackupJob | バックアップジョブをキャンセルします。 |
| CreateBackupJob | CreateBackupJob | バックアップジョブを作成します。 |
| DescribeBackupJobs2 | DescribeBackupJobs2 | 指定された条件に一致するバックアップジョブを照会します。 |
SAP HANA バックアップ
|
API |
タイトル |
説明 |
| CreateHanaBackupPlan | CreateHanaBackupPlan | SAP HANA インスタンスのバックアッププランを作成します。 |
| CreateHanaInstance | CreateHanaInstance | SAP HANA インスタンスを登録します。 |
| CreateClients | CreateClients | 指定されたインスタンスに 1 つ以上の Cloud Backup クライアントをインストールします。 |
| DeleteClient | DeleteClient | クライアントを削除します。 |
| CreateHanaRestore | CreateHanaRestore | SAP HANA データベースの復元ジョブを作成します。 |
| DeleteHanaBackupPlan | DeleteHanaBackupPlan | SAP HANA バックアッププランを削除します。 |
| DeleteHanaInstance | DeleteHanaInstance | SAP HANA インスタンスを削除します。 |
| UninstallClient | UninstallClient | HBR クライアントをアンインストールします。 |
| UpdateHanaBackupPlan | UpdateHanaBackupPlan | SAP HANA バックアッププランを更新します。 |
| EnableHanaBackupPlan | EnableHanaBackupPlan | SAP HANA バックアッププランを有効にします。 |
| DisableHanaBackupPlan | DisableHanaBackupPlan | SAP HANA バックアッププランを無効にします。 |
| UpdateHanaInstance | UpdateHanaInstance | SAP HANA インスタンスを更新します。 |
| UpgradeClient | UpgradeClient | Cloud Backup クライアントをアップグレードします。 |
| StartHanaDatabaseAsync | StartHanaDatabaseAsync | SAP HANA データベースを起動します。 |
| StopHanaDatabaseAsync | StopHanaDatabaseAsync | SAP HANA データベースを停止します。 |
| UpdateHanaRetentionSetting | UpdateHanaRetentionSetting | SAP HANA データベースのバックアップの保存期間を更新します。 |
| UpdateHanaBackupSetting | UpdateHanaBackupSetting | SAP HANA データベースのバックアップパラメーターを更新します。 |
| DescribeHanaBackupPlans | DescribeHanaBackupPlans | 指定された条件に一致する 1 つ以上の SAP HANA バックアッププランを照会します。 |
| DescribeHanaInstances | DescribeHanaInstances | 指定された条件を満たす 1 つ以上の SAP HANA インスタンスをクエリします。 |
| DescribeClients | DescribeClients | 指定された条件を満たす Cloud Backup クライアントを 1 つ以上照会します。 |
| DescribeHanaDatabases | DescribeHanaDatabases | SAP HANA データベースの情報を照会します。 |
| DescribeHanaRetentionSetting | DescribeHanaRetentionSetting | SAP HANA データベースのバックアップ保存期間をクエリします。 |
| DescribeHanaBackupSetting | DescribeHanaBackupSetting | SAP HANA データベースのバックアップパラメーターを照会します。 |
| DescribeHanaBackupsAsync | DescribeHanaBackupsAsync | 指定された条件に一致する 1 つ以上の SAP HANA バックアップをクエリします。 |
| DescribeHanaRestores | DescribeHanaRestores | 指定された条件を満たす 1 つ以上の SAP HANA 復元ジョブを照会します。 |
ECS バックアップ Essential Edition
|
API |
タイトル |
説明 |
| DeleteAirEcsInstance | DeleteAirEcsInstance | ECS Backup Essential Edition の復元専用 Elastic Compute Service (ECS) インスタンスを削除します。 |
コンテナバックアップ
|
API |
タイトル |
説明 |
| DescribeContainerResource | DescribeContainerResource | コンテナクラスターのリソースリストを照会します。 |
| DeleteContainerCluster | DeleteContainerCluster | Cloud Backup に登録されているコンテナクラスターのレコードを登録解除します。クラスターの登録を解除すると、そのクラスターのバックアップを回復できなくなります。 |
| DescribeContainerCluster | DescribeContainerCluster | 指定された条件を満たす 1 つ以上のコンテナークラスターをクエリします。 |
| UpdateContainerCluster | Update Container Cluster Information | コンテナークラスター名、ネットワークタイプなど、コンテナークラスターの情報を更新します。 |
| AddContainerCluster | AddContainerCluster | Container Service for Kubernetes (ACK) クラスターを登録します。 |
その他
|
API |
タイトル |
説明 |
| OpenHbrService | OpenHbrService | Cloud Backup を有効化します。 |
| DescribeRegions | DescribeRegions | 利用可能なリージョンをクエリします。 |
| DescribeTask | DescribeTask | 非同期タスクを照会します。 |
| DescribeVaultReplicationRegions | DescribeVaultReplicationRegions | クロスリージョンレプリケーションに対応しているリージョンを照会します。 |
| DetachNasFileSystem | DetachNasFileSystem | Cloud Backup によって作成された内部マウントポイントを削除します。 |
| GenerateRamPolicy | GenerateRamPolicy | Resource Access Management (RAM) ポリシーを生成します。 |
| ChangeResourceGroup | ChangeResourceGroup | インスタンスが属するリソースグループを変更します。 |
| CreateTempFileUploadUrl | CreateTempFileUploadUrl | ファイルアップロード URL に必要なパラメーターと署名を生成します。 |
| GetTempFileDownloadLink | GetTempFileDownloadLink | ジョブレポートなどのファイルのダウンロードリンクを取得します。 |
| CheckRole | 権限の確認。 | 現在のユーザーが特定のリソースまたはページにアクセスする権限を持っているかどうかを確認します。 |
| DescribeCrossAccounts | DescribeCrossAccounts | クロスアカウント管理関係に関する情報を照会します。 |
| DeleteUdmEcsInstance | DeleteUdmEcsInstance | Elastic Compute Service (ECS) インスタンスのバックアップ保護を停止します。 |
| DeleteUdmDisk | DeleteUdmDisk | 保護されたディスクを解除します。 |
| AddCrossAccount | AddCrossAccount | クロスアカウント管理関係を作成します。 |
| AddDataSource | AddDataSource | データソースを作成します。 |
| BrowseFiles | BrowseFiles | バックアップファイルをリストします。 |
| CreateVaultReplication | CreateVaultReplication | バックアップボールトのレプリケーションを設定します。 |
| DeleteCrossAccount | DeleteCrossAccount | クロスアカウント管理関係を削除します。 |
| DeleteVaultReplication | DeleteVaultReplication | バックアップボールトのレプリケーションを停止します。 |
| DescribeDataSources | DescribeDataSources | データソースを一覧表示します。 |
| GetBasicStatistics | GetBasicStatistics | バックアップの基本統計情報を取得します。 |
| ListProtectedResources | ListProtectedResources | 保護対象リソースを照会します。 |
| RemoveDataSource | RemoveDataSource | データソースを削除します。 |
| UpdateDataSource | UpdateDataSource | データソースの構成を更新します。 |