API 標準および多言語対応の SDK
本製品 (Dbs/2019-03-06) の 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 |
タイトル |
説明 |
| CreateBackupPlan | CreateBackupPlan | Database Backup Service (DBS) のバックアッププランを作成します。 |
| CreateAndStartBackupPlan | CreateAndStartBackupPlan | バックアッププランの作成、設定、および開始を行います。 |
| StartBackupPlan | StartBackupPlan | この操作は、DBS のバックアッププランを開始します。 |
| EnableBackupLog | EnableBackupLog | バックアップスケジュールに対して増分バックアップを有効にします。 |
| StopBackupPlan | StopBackupPlan | この操作は、DBS バックアッププランを一時停止します。 |
| DisableBackupLog | DisableBackupLog | バックアッププランの増分バックアップを無効にします。 |
| ModifyBackupObjects | ModifyBackupObjects | Database Backup Service (DBS) のバックアッププランに含まれるオブジェクトを変更します。 |
| ModifyBackupSourceEndpoint | ModifyBackupSourceEndpoint | DBS のバックアップソースエンドポイントを変更します。 |
| ModifyStorageStrategy | ModifyStorageStrategy | バックアッププランに保存されているデータのライフサイクルを変更します。 |
| ModifyBackupPlanName | ModifyBackupPlanName | バックアッププランの名前を変更します。 |
| ModifyBackupStrategy | ModifyBackupStrategy | バックアップスケジュールのバックアップ時間を変更します。 |
| DescribeBackupPlanList | DescribeBackupPlanList | DBS のバックアッププランを照会します。 |
| DescribeRestoreRangeInfo | DescribeRestoreRangeInfo | この操作は、バックアッププランからデータを復元するために利用可能な時間範囲を返します。 |
| DescribeBackupPlanBilling | DescribeBackupPlanBilling | この操作は、バックアッププランの課金情報を照会します。 |
| ConfigureBackupPlan | ConfigureBackupPlan | この API は、DBS バックアッププランを設定するために使用されます。 |
| RenewBackupPlan | RenewBackupPlan | バックアップスケジュールを更新します。 |
| UpgradeBackupPlan | UpgradeBackupPlan | バックアップスケジュールをアップグレードします。 |
| ReleaseBackupPlan | ReleaseBackupPlan | この操作では、従量課金制のバックアッププランをリリースします。 |
バックアップタスク
|
API |
タイトル |
説明 |
| DescribeIncrementBackupList | DescribeIncrementBackupList | この操作は、DBS の増分バックアップタスクのリストを照会します。 |
| DescribeFullBackupList | DescribeFullBackupList | この操作は、Database Backup (DBS) の完全バックアップタスクを一覧表示します。 |
復元タスク
|
API |
タイトル |
説明 |
| CreateRestoreTask | CreateRestoreTask | この操作は、DBS の復元タスクを作成するために使用されます。 |
| StartRestoreTask | StartRestoreTask | DBS の復元ジョブを開始します。 |
| DescribeRestoreTaskList | DescribeRestoreTaskList | Database Backup Service (DBS) の復元ジョブを照会します。 |
バックアップゲートウェイ
|
API |
タイトル |
説明 |
| DescribeBackupGatewayList | DescribeBackupGatewayList | Database Backup Service (DBS) のバックアップゲートウェイのリストを照会します。 |
バックアップセットのダウンロード
|
API |
タイトル |
説明 |
| CreateFullBackupSetDownload | CreateFullBackupSetDownload | この操作は、完全バックアップセットをダウンロードするためのタスクを作成します。 |
| CreateIncrementBackupSetDownload | CreateIncrementBackupSetDownload | 増分バックアップセットのダウンロードタスクを作成し、開始します。 |
| ModifyBackupSetDownloadRules | バックアップセットのダウンロードルールを設定します | 自動ダウンロード特徴を有効化、変更、または無効化します。 |
| DescribeBackupSetDownloadTaskList | DescribeBackupSetDownloadTaskList | Database Backup Service (DBS) のバックアップセットのダウンロードタスクのリストを照会します。 |
サービス管理
|
API |
タイトル |
説明 |
| CreateGetDBListFromAgentTask | CreateGetDBListFromAgentTask | バックアップゲートウェイを使用してデータベースリストを取得するタスクを作成します。 |
| DescribeNodeCidrList | DescribeNodeCidrList | Database Backup (DBS) が実行されているノードの CIDR ブロックを照会します。 |
| DescribeJobErrorCode | DescribeJobErrorCode | Database Backup Service (DBS) ジョブのエラーコードを照会します。 |
| DescribePreCheckProgressList | DescribePreCheckProgressList | この操作は、バックアッププランまたは復元ジョブの事前チェックの進捗状況を照会するために使用されます。 |
| DescribeDLAService | DescribeDLAService | バックアップスケジュールの Data Lake Analytics (DLA) サービスのステータスを照会します。 |
| GetDBListFromAgent | バックアップゲートウェイを使用してデータベースリストを取得します | バックアップゲートウェイを使用して物理バックアップからデータベースおよびテーブルデータを取得します。 |
| InitializeDbsServiceLinkedRole | InitializeDbsServiceLinkedRole | Database Backup (DBS) にサービスリンクロール (AliyunServiceRoleForDBS) を付与します。 |
Others
|
API |
タイトル |
説明 |
| DescribeRegions | DescribeRegions | Database Backup Service (DBS) が利用可能なリージョンを問い合わせます。 |