API 標準および多言語対応の SDK
本製品 (ebs/2021-07-30) の 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 |
タイトル |
説明 |
| DescribeRegions | DescribeRegions | Elastic Block Storage (EBS) の機能 (非同期レプリケーション、CloudLens for EBS、Dedicated Block Storage Cluster など) がサポートされているリージョンの詳細を照会します。 |
レプリケーションペア
|
API |
タイトル |
説明 |
| ListReplicaEdgeSupported | ListReplicaEdgeSupported | 指定されたゾーンに対して非同期レプリケーションをサポートするターゲットリージョンおよびゾーンをクエリします。 |
| CreateDiskReplicaPair | CreateDiskReplicaPair | ディスクレプリケーションペアを作成します。 |
| AddDiskReplicaPair | AddDiskReplicaPair | レプリケーション整合性グループにレプリケーションペアを追加します。レプリケーション整合性グループを使用すると、レプリケーションペアを一括で管理できます。この操作を呼び出す際に、リクエストに `ReplicaGroupId`、`ReplicaPairId`、`ClientToken` などのパラメーターを指定できます。 |
| ModifyDiskReplicaPair | ModifyDiskReplicaPair | 非同期レプリケーションペアを変更します。 |
| StartDiskReplicaPair | StartDiskReplicaPair | 特定のレプリケーションペアに対して非同期レプリケーション機能をアクティブ化します。 |
| StopDiskReplicaPair | StopDiskReplicaPair | レプリケーションペアを停止します。 |
| ReprotectDiskReplicaPair | ReprotectDiskReplicaPair | レプリケーションペアの逆方向レプリケーション機能を有効にします。 |
| FailoverDiskReplicaPair | FailoverDiskReplicaPair | レプリケーションペアのフェールオーバー機能を有効にします。 |
| DescribeDiskReplicaPairProgress | DescribeDiskReplicaPairProgress | レプリケーションペアのレプリケーション進捗を照会します。 |
| DeleteDiskReplicaPair | DeleteDiskReplicaPair | レプリケーションペアを削除します。 |
| DescribeDiskReplicaPairs | DescribeDiskReplicaPairs | 指定されたリージョンにある 1 つ以上のレプリケーションペアに関する情報をクエリします。 |
| RemoveDiskReplicaPair | RemoveDiskReplicaPair | レプリケーション整合性グループからレプリケーションペアを削除します。 レプリケーションペアがレプリケーション整合性グループから削除されると、そのペアとグループの関連付けは解除されますが、ペア自体は削除されません。 |
| DescribePairDrills | DescribePairDrills | セカンダリディスクが特定のリージョンに存在するレプリケーションペアで実行された災害復旧訓練を照会します。 |
| StartPairDrill | StartPairDrill | 継続的なレプリケーションを確保し、セカンダリディスクの最終リカバリーポイントから新しいディスクにデータをクローンするための災害復旧訓練を開始します。これにより、ディザスタリカバリサイトにデプロイされたアプリケーションの完全性と正確性を定期的にテストできます。 |
| ClearPairDrill | ClearPairDrill | レプリケーションペアのセカンダリディスクから開始された災害復旧訓練をクリアし、自動作成された訓練ディスクを削除します。 |
レプリケーショングループ
|
API |
タイトル |
説明 |
| CreateDiskReplicaGroup | CreateDiskReplicaGroup | レプリケーション整合性グループを作成します。 |
| DescribeDiskReplicaGroups | DescribeDiskReplicaGroups | 指定されたリージョン内の 1 つ以上のレプリケーション整合性グループに関する情報をクエリします。 |
| ModifyDiskReplicaGroup | ModifyDiskReplicaGroup | レプリケーション整合性グループの名前、説明、または目標復旧時点 (RPO) を変更します。 |
| StartDiskReplicaGroup | StartDiskReplicaGroup | レプリケーション整合性グループに属するレプリケーションペアの非同期レプリケーション機能を有効にします。レプリケーションペアに対して非同期レプリケーション機能が初めて有効化されると、システムは完全同期を実行し、プライマリサイトのディスク (プライマリディスク) からセカンダリサイトのディスク (セカンダリディスク) にすべてのデータを同期します。その後、システムはレプリケーション整合性グループの目標復旧時点 (RPO) に基づいて、定期的に増分データを同期します。 |
| StopDiskReplicaGroup | StopDiskReplicaGroup | レプリケーション整合性グループを停止します。この操作は、レプリケーション整合性グループ内のすべてのレプリケーションペアを停止します。 |
| FailoverDiskReplicaGroup | FailoverDiskReplicaGroup | レプリケーション整合性グループ内のレプリケーションペアに対してフェールオーバー機能を有効にします。レプリケーション整合性グループ内の特定のレプリケーションペアのプライマリディスクに障害が発生した場合、この操作を呼び出して、セカンダリディスクの読み取り/書き込み権限を有効にすることができます。 |
| ReprotectDiskReplicaGroup | ReprotectDiskReplicaGroup | レプリケーション整合性グループに属するレプリケーションペアのリバースレプリケーション機能を有効にします。リバースレプリケーションを有効にすると、元のセカンダリディスクに保存されているデータが元のプライマリディスクにレプリケートされます。リバースレプリケーションの実行中、レプリケーション整合性グループのプライマリサイトとセカンダリサイトは変更されませんが、データはセカンダリサイトからプライマリサイトにレプリケートされます。 |
| DeleteDiskReplicaGroup | DeleteDiskReplicaGroup | レプリケーション整合性グループを削除します。 |
| DescribeReplicaGroupDrills | DescribeReplicaGroupDrills | セカンダリディスクが特定のリージョンにあるレプリケーション整合性グループで実行された災害復旧訓練をクエリします。 |
| StartReplicaGroupDrill | StartReplicaGroupDrill | レプリケーション整合性グループで災害復旧訓練を開始します。この操作により、レプリケーションを継続しながら、セカンダリディスクの最新のリカバリポイントから新しいディスクにデータを復元します。これにより、ディザスタリカバリサイトにデプロイされたアプリケーションの完全性と正確性を定期的にテストできます。 |
| ClearReplicaGroupDrill | ClearReplicaGroupDrill | レプリケーション整合性グループのセカンダリディスクから開始された災害復旧訓練をクリアし、自動作成されたドリルディスクを削除します。 |
専用ブロックストレージクラスター
|
API |
タイトル |
説明 |
| CreateDedicatedBlockStorageCluster | 専用ブロックストレージクラスターを作成します。 | Azone、Capacity、Type、PeriodUnit などのパラメーターを指定して CreateDedicatedBlockStorageCluster 操作を呼び出し、専用ブロックストレージクラスターを作成します。 |
| DescribeDedicatedBlockStorageClusters | DescribeDedicatedBlockStorageClusters | 専用クラスターを照会します。 |
| ModifyDedicatedBlockStorageClusterAttribute | ModifyDedicatedBlockStorageClusterAttribute | 専用ブロックストレージクラスターの情報を変更します。 |
| DescribeDedicatedBlockStorageClusterDisks | 専用ブロックストレージクラスターのクラウドディスクを照会します。 | 専用ブロックストレージクラスターで作成された 1 つ以上のクラウドディスクの情報を照会します。 |
| QueryDedicatedBlockStorageClusterInventoryData | QueryDedicatedBlockStorageClusterInventoryData | 特定の期間における専用 Elastic Block Storage (EBS) クラスターの容量トレンドデータ (利用可能容量と総容量を含む) を照会します。 |
エンタープライズレベルのスナップショットポリシー
|
API |
タイトル |
説明 |
| CreateEnterpriseSnapshotPolicy | エンタープライズレベルのスナップショットポリシーを作成します。 | エンタープライズレベルのスナップショットポリシーを作成します。 |
| DescribeEnterpriseSnapshotPolicy | エンタープライズレベルのスナップショットポリシーを照会します。 | PolicyIds、ResourceGroupId、Tag などのパラメーターを指定して、エンタープライズレベルのスナップショットポリシーを照会します。 |
| UpdateEnterpriseSnapshotPolicy | エンタープライズレベルのスナップショットポリシーの変更。 | エンタープライズレベルのスナップショットポリシーの構成を変更します。 |
| BindEnterpriseSnapshotPolicy | BindEnterpriseSnapshotPolicy | ディスクをエンタープライズレベルのスナップショットポリシーにバインドします。 |
| UnbindEnterpriseSnapshotPolicy | エンタープライズスナップショットポリシーからディスクのバインドを解除します | エンタープライズレベルのスナップショットポリシーからディスクのバインドを解除します。 |
| DeleteEnterpriseSnapshotPolicy | DeleteEnterpriseSnapshotPolicy | エンタープライズレベルのスナップショットポリシーを削除します。 |
EBS レンズ
|
API |
タイトル |
説明 |
| ApplyLensService | EBS レンズを有効にします | EBS レンズ（CloudLens for EBS）を有効にします。 |
| DescribeLensServiceStatus | EBSレンズサービスステータスの照会 | ユーザーが有効化したEBS Lensサービスのステータスを照会します。 |
| CancelLensService | EBS レンズをキャンセルします | EBS レンズ（CloudLens for EBS）をキャンセルします。 |
| DescribeLensMonitorDisks | DescribeLensMonitorDisks | 1 つ以上の Elastic Block Storage (EBS) ディスクに関する情報をクエリします。 |
| DescribeEvents | DescribeEvents | ディスクに関する脅威イベントを照会します。 |
| DescribeMetricData | DescribeMetricData | リソースのモニタリングメトリックをクエリします。 |
| DescribeDiskMonitorData | DescribeDiskMonitorData | ディスクの高精度モニタリングデータをクエリします。 |
ラボ
|
API |
タイトル |
説明 |
| UpdateSolutionInstanceAttribute | UpdateSolutionInstanceAttribute | ソリューションインスタンスの属性を更新します。 |
その他
|
API |
タイトル |
説明 |
| TagResources | TagResources | タグを作成し、Elastic Block Storage (EBS) リソースに追加します。 |
| ListTagResources | ListTagResources | EBS リソースに追加されたタグを照会するか、デフォルト以外のリソースグループ内のリソースの ID とタグを照会します。 |
| UntagResources | UntagResources | 指定された Elastic Block Storage (EBS) リソースからタグを削除します。 |
| ChangeResourceGroup | ChangeResourceGroup | Elastic Block Storage (EBS) リソースが属するリソースグループを変更します。 |
| DescribeSolutionInstanceConfiguration | DescribeSolutionInstanceConfiguration | ソリューションのデフォルト構成を照会します。 |
| QueryDedicatedBlockStorageClusterDiskThroughputStatus | QueryDedicatedBlockStorageClusterDiskThroughputStatus | SetDedicatedBlockStorageClusterDiskThroughput API を呼び出して設定された、専用ブロックストレージクラスターディスクのスループットステータスを照会します。 |
| SetDedicatedBlockStorageClusterDiskThroughput | SetDedicatedBlockStorageClusterDiskThroughput | エラスティックタイプの専用ブロックストレージクラスターにおいて、ターゲットディスクのスループット (Bps) を指定の値に簡単に設定できます。クラウドディスクの ID と目標のスループットを設定するだけで、設定プロセスを簡略化できます。 |
| ListReports | 使用量レポートリストを照会します。 | 集中ロールを使用して、指定されたアプリケーションの履歴レポートリストを照会します。 |
| GetReport | Get User Cloud Disk Usage Report | 一元管理ロール：reportId を使用してユーザー利用状況レポートを取得します |
| DescribeUserTagKeys | DescribeUserTagKeys | ユーザーのディスクとスナップショットのタグキーを照会します。 |
| DescribeUserTagValues | DescribeUserTagValues | ユーザーディスクとスナップショットの tagValue をクエリします。 |
| DeleteApp | アプリケーションを削除します | 集中ロールのアプリケーションを削除します。 |
| DescribeApps | アプリケーション詳細を照会します | 集中ロール: アプリケーション情報のフォーマットを照会します。 |
| CreateApp | アプリを作成します | アプリを作成します。 |
| ModifyApp | アプリを変更します | 集中ロール: アプリを変更します。 |
| CreateDiagnoseReport | CreateDiagnoseReport | 指定されたリソースの診断レポートを作成します。 |
| DescribeDiagnoseReport | リソース診断レポートを照会します。 | 診断レポートを照会します。 |