CreateBackup API によるオンデマンド MongoDB バックアップのトリガー - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

操作説明

インスタンスは実行中の状態である必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:CreateBackup

create

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	d-bp2235****
BackupMethod	string	任意	バックアップ方法。有効な値： Snapshot：スナップショットバックアップ。 Logical：論理バックアップ。 Physical (デフォルト)：物理バックアップ。説明クラウドディスクを使用するインスタンスは、スナップショットバックアップのみをサポートします。このパラメーターは、レプリカセットインスタンスとシャードクラスターインスタンスにのみ適用されます。スタンドアロンインスタンスはスナップショットバックアップを使用するため、このパラメーターは不要です。	Logical
BackupRetentionPeriod	integer	任意	バックアップの保持期間 (日数)。このパラメーターは、クラウドディスクを使用するレプリカセットインスタンスとシャードクラスターインスタンスにのみ適用されます。説明このパラメーターを指定しない場合、デフォルトのバックアップポリシーの保持期間が使用されます。このパラメーターには、次のいずれかの値を設定できます。 7 から 730 までの値 -1 (永久保持)	30

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
BackupId	string	バックアップ ID。説明このパラメーターは非推奨です。バックアップ ID を取得するには、DescribeBackups 操作を呼び出してください。	5664****
RequestId	string	リクエスト ID。	7016B12F-7F64-40A4-BAFF-013F02AC82FC
BackupJobId	string	バックアップジョブ ID。	775051

例

成功レスポンス

JSONJSON

{
  "BackupId": "5664****",
  "RequestId": "7016B12F-7F64-40A4-BAFF-013F02AC82FC",
  "BackupJobId": "775051"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidBackupMethod.ValueNotSupport	The specified parameter BackupMethod is not valid.
403	OperationDenied.BackupJobExists	The operation is not permitted due to backup job exist.
403	OperationDenied.NoDatabase	The operation is not permitted due to no database.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。