API オンラインデバッグ、Alibaba Cloud SDK、Terraform、Resource Orchestration Service などの呼び出し方法 - Cloud Backup

Cloud Backup は、ビジュアルコンソールと複数の統合方法を提供しています。これには、API オンラインデバッグ、Alibaba Cloud SDK、Resource Orchestration Service (ROS) が含まれます。ビジネス要件に基づいて統合方法を選択してください。

API の概要

Alibaba Cloud は、Alibaba Cloud サービスの API オペレーションを理解し使用するために、OpenAPI Explorer を提供しています。OpenAPI Explorer は、インテリジェント検索、ドキュメント、オンラインデバッグ、SDK サンプルコード、エラー診断、呼び出し統計を統合しています。API オペレーションを呼び出し、リクエストとレスポンスを表示し、自動生成された SDK サンプルコードを取得できます。詳細については、「OpenAPIとは」をご参照ください。

バージョンの説明

Alibaba Cloud OpenAPI Explorer は、バージョン番号で API バージョンを管理します。 Cloud Backup は、日付ではなく API バージョン識別子である 2017-09-08 バージョンをサポートしています。 2017-09-08 は、Cloud Backup API の最新バージョンです。

API バージョン	説明
2017-09-08	推奨

オンラインデバッグ

Cloud Backup は、OpenAPI Explorer での API デバッグをサポートしています。API 操作を呼び出す前に、利用可能なバージョン、エンドポイント、および統合方法をよく理解してください。

デバッグページ

API デバッグページの URL はOpenAPI Explorer デバッグページです。

エンドポイント

リソースが所在するリージョンに基づいてエンドポイントを選択してください。たとえば、中国 (張家口) リージョンでは、Cloud Backup のパブリックエンドポイントは hbr.cn-zhangjiakou.aliyuncs.com で、VPC エンドポイントは hbr-vpc.cn-zhangjiakou.aliyuncs.com です。

パブリックエンドポイントは、グローバルからアクセス可能です。
VPC エンドポイントは、対応するリージョン内の VPC からのみアクセス可能です。次の利点があります。
- 高いセキュリティ：VPC 内からのみアクセス可能なため、より高いセキュリティとプライバシー保護を実現します。
- 高速レスポンス：内部ネットワークルーティングにより、低レイテンシーを実現し、パブリックネットワークの帯域幅制限を回避します。
- 低コスト：内部ネットワーク経由のトラフィックでは、パブリック帯域幅の料金は発生しません。

詳細については、「エンドポイント」をご参照ください。

ユーザーアイデンティティ

デフォルトでは、OpenAPI Explorer はオンラインデバッグに Alibaba Cloud アカウントを使用します。Alibaba Cloud アカウントには完全な API 権限があるため、API 呼び出しと日常の運用保守には Resource Access Management (RAM) ユーザーを使用することを推奨します。RAM ユーザーには、Cloud Backup リソースを管理するために必要な権限のみを付与してください。詳細については、「Cloud Backup操作を実行するためのRAMユーザーの作成」をご参照ください。

アイデンティティ	対応
Alibaba Cloud アカウント	はい
RAM ユーザー (推奨)	はい
RAM ロール (推奨)	はい

統合方法

説明

SDK はアプリケーションと簡単に統合でき、最も広範なオペレーションに対応しています。API オペレーションの呼び出しには、SDK を使用することを推奨します。

統合方法の概要

呼び出し方法	対応
Alibaba Cloud SDK (推奨)	はい
Alibaba Cloud CLI	いいえ
ROS	はい
カスタム API カプセル化	はい

Alibaba Cloud SDK
- Alibaba Cloud は、Java、C#、Go、Python、Node.js、TypeScript、PHP、C++ など、複数のプログラミング言語向けの SDK を提供しています。SDK は、データ署名、タイムアウト処理、再試行ロジックをカプセル化し、構造化されたレスポンスオブジェクトを返します。詳細については、「Alibaba Cloud SDK」をご参照ください。
- Alibaba Cloud SDK を使用して、Cloud Backup の API オペレーションを呼び出すことができます。サポートされている言語と依存関係の詳細については、OpenAPI Portalをご参照ください。
Alibaba Cloud CLI
- aliyun コマンドを実行して、Alibaba Cloud サービスを操作し、クラウドリソースを管理できます。詳細については、「Alibaba Cloud CLIとは」をご参照ください。
- Alibaba Cloud コマンドラインインターフェイス (CLI) を使用して、Cloud Backup の API オペレーションを呼び出すことはできません。
ROS
- ROS は、クラウドリソース管理を簡素化する Alibaba Cloud サービスです。テンプレートを作成して、Elastic Compute Service (ECS) インスタンス、Object Storage Service (OSS) バケット、File Storage NAS (NAS) ファイルシステムなどの必要なリソースとその依存関係を記述できます。ROS は、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、デプロイと運用保守の自動化を実現します。詳細については、「Resource Orchestration Serviceとは」をご参照ください。
- ROS を使用して、Cloud Backup の API オペレーションを呼び出すことができます。ROS を使用してオーケストレーションできるリソースには、通常のリソース (バックアップクライアント、復元ジョブ、バックアッププランなど) とデータリソース (バックアップボールトなど) があります。
  - 通常のリソース：
    - ALIYUN::HBR::BackupClients：ECS インスタンスにバックアップクライアントをインストールします。
    - ALIYUN::HBR::RestoreJob：復元ジョブを作成します。
    - ALIYUN::HBR::DbAgent：データベース用のバックアップクライアントをインストールします。
    - ALIYUN::HBR::DbPlan：バックアッププランを作成します。
    - ALIYUN::HBR::DbVault：ミラーボールトを作成します。
    - ALIYUN::HBR::Vault：バックアップボールトを作成します。
  - データリソース：
    - DATASOURCE::HBR::Vaults：バックアップボールトに関する情報を照会します。
- ROS を使用して Cloud Backup リソースを効率的にオーケストレーションする方法の詳細については、「ROSとの統合の例」をご参照ください。
カスタム API カプセル化
ネイティブ HTTP 呼び出しを行うには、カスタムリクエストを構築し、リクエストに署名する必要があります。署名方法の詳細については、「API の概要」および「リクエスト構文と署名方法 V3」をご参照ください。

注意事項

API オペレーションがエラーを返した場合は、エラーコードを基にリクエストパラメーターを確認してください。詳細については、「パブリックエラーコード」をご参照ください。

返されたリクエスト ID または SDK エラー情報に基づいて、OpenAPI Diagnosis ページで自己診断を実行することも可能です。

よくある質問

Cloud Backup の詳細については、「Cloud Backupとは」をご参照ください。
Cloud Backup は、ECS インスタンス、ECS 上の MySQL、SQL Server、Oracle データベース、ECS ファイル、NAS ファイルシステム、OSS バケットのバックアップをサポートしています。また、自己管理型データセンターからのファイル、データベース、仮想マシン、大規模ファイルシステムのバックアップ、およびディザスタリカバリの実装も可能です。詳細については、「機能」をご参照ください。
Cloud Backup は、Java、C#、Go、Python、Node.js、TypeScript、PHP、C++ など、複数のプログラミング言語向けの SDK を提供しています。詳細については、「SDKリファレンス」をご参照ください。

Cloud Backup:API 統合の概要