バックアッププランを作成します。
操作説明
ECS ファイルバックアップ Essential エディション、クラウドディスクバックアップ、コンテナバックアップ、Tablestore バックアップ無料トライアル、アーカイブ、データ同期などの特徴を使用するには、この操作を呼び出します。
NAS バックアップまたは OSS バックアップの 30 日間無料トライアルを使用するには、CreateTrialBackupPlan 操作を呼び出します。
ECS ファイルバックアップ Standard エディションの標準特徴、ローカルファイルバックアップ、ECS フルコピーバックアップ、NAS バックアップ、OSS バックアップ、または CPFS バックアップを使用するには、CreatePolicyV2 および CreatePolicyBindings 操作を呼び出します。
バックアッププランは、データソースをバックアップポリシーおよびバックアップに必要なその他の必須情報に関連付けます。バックアッププランが実行されると、バックアップジョブが生成され、バックアップの進行状況と結果が Record されます。バックアップジョブが成功すると、バックアップスナップショットが生成されます。バックアップスナップショットを使用して復元ジョブを作成できます。
バックアッププランは 1 つのデータソースのみをサポートします。
バックアッププランは、固定間隔の単一バックアップサイクルポリシーのみをサポートします。
バックアッププランは、データを 1 つのボールトにのみバックアップできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
hbr:CreateBackupPlan |
create |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| SourceType |
string |
必須 |
データソースのタイプ。有効な値:
|
ECS_FILE |
| PlanName |
string |
任意 |
バックアッププランの名前。名前の長さは 1~64 文字である必要があります。バックアッププラン名は、単一のボールト内の各データソースタイプに対して一意である必要があります。 |
planname |
| BackupType |
string |
任意 |
バックアップタイプ。値を COMPLETE に設定します。これは完全バックアップを示します。 |
COMPLETE |
| VaultId |
string |
任意 |
ボールト ID。 |
v-0006******q |
| Schedule |
string |
任意 |
バックアップポリシー。フォーマット:
|
I|1602673264|P1D |
| Retention |
integer |
任意 |
バックアップデータの保持期間。最小値: 1。単位: 日。 |
7 |
| ClusterId |
string |
任意 |
データ同期プランを実行するクライアントグループの ID。このパラメーターはデータ同期の場合にのみ必須です。 |
cl-*************** |
| FileSystemId |
string |
任意 |
このパラメーターは SourceType が NAS に設定されている場合にのみ必須です。ファイルシステム ID。 |
005494 |
| CreateTime |
integer |
任意 |
このパラメーターは SourceType が NAS に設定されている場合にのみ必須です。ファイルシステムが作成された時間。値は UNIX タイムスタンプです。単位: 秒。セット。 |
1607436917 |
| Bucket |
string |
任意 |
このパラメーターは SourceType が OSS に設定されている場合にのみ必須です。OSS バケットの名前。 |
hbr-backup-oss |
| Prefix |
string |
任意 |
このパラメーターは SourceType が OSS に設定されている場合にのみ必須です。バックアッププレフィックス。指定した場合、プレフィックスに一致するオブジェクトのみがバックアップされます。 |
oss-prefix |
| InstanceId |
string |
任意 |
このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ必須です。ECS インスタンス ID。 |
i-m5e*****6q |
| Detail |
object |
任意 |
フルコピーバックアップの詳細。値は JSON 文字列です。投稿。
|
{\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60} |
| UdmRegionId |
string |
任意 |
フルコピーバックアップ対象の ECS インスタンスが存在するリージョン。 |
cn-shanghai |
| SpeedLimit |
string |
任意 |
このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ必須です。バックアップトラフィックコントロール。フォーマット:
|
0:24:5120 |
| Include |
string |
任意 |
このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ必須です。バックアップに含めるパス。このパス内のすべてのファイルがバックアップされます。値の長さは最大 255 文字です。 |
["/home/alice/*.pdf", "/home/bob/*.txt"] |
| Exclude |
string |
任意 |
このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ必須です。バックアップから除外するパス。このパス内のすべてのファイルはバックアップされません。値の長さは最大 255 文字です。 |
["/var", "/proc"] |
| Options |
string |
任意 |
このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ必須です。Windows Volume Shadow Copy サービス (VSS) を使用してソースパスを定義するかどうかを指定します。
|
{"UseVSS":false} |
| DataSourceId |
string |
任意 |
ソースデータソースの ID。このパラメーターはデータ同期の場合にのみ必須です。 |
ds-**************** |
| Path |
array |
任意 |
ソースパス。 |
|
|
string |
任意 |
ソースパス。値の長さは最大 65536 文字です。 ソースパスのルールは以下の通りです:
|
["/home"] |
|
| Rule |
array<object> |
任意 |
バックアッププランのルール。 |
|
|
object |
任意 |
バックアッププランのルール。 |
||
| DestinationRetention |
integer |
任意 |
地理的冗長バックアップの保持期間。単位: 日。 |
7 |
| Schedule |
string |
任意 |
バックアップポリシー。フォーマット: I|{startTime}|{interval}。これは、{startTime} から {interval} ごとにバックアップジョブが実行されることを示します。過去の期間のバックアップジョブは実行されません。前のバックアップジョブが完了していない場合、次のバックアップジョブはトリガーされません。例: I|1631685600|P1D は、2021-09-15 14:00:00 から 1 日 1 回バックアップが実行されることを示します。 startTime: バックアップの開始時刻。値は UNIX タイムスタンプです。単位: 秒。 interval: ISO 8601 時間間隔。例: PT1H は 1 時間の間隔を示します。P1D は 1 日の間隔を示します。 |
I|1602673264|P1D |
| Retention |
integer |
任意 |
バックアップの保持期間。 |
7 |
| Disabled |
boolean |
任意 |
ルールが無効化されているかどうかを指定します。 |
false |
| DoCopy |
boolean |
任意 |
クロスリージョンレプリケーションを有効にするかどうかを指定します。 |
false |
| DestinationRegionId |
string |
任意 |
クロスリージョンレプリケーションの送信先リージョンの ID。 |
cn-hangzhou |
| RuleName |
string |
任意 |
ルール名。 |
rule-test-name |
| BackupType |
string |
任意 |
バックアップタイプ。 |
COMPLETE |
| InstanceName |
string |
任意 |
Tablestore インスタンスの名前。 |
instancename |
| OtsDetail | OtsDetail |
任意 |
Tablestore インスタンスの詳細。 |
|
| CrossAccountType |
string |
任意 |
クロスアカウントバックアップタイプ。有効な値:
列挙値:
|
CROSS_ACCOUNT |
| CrossAccountUserId |
integer |
任意 |
クロスアカウントバックアップのソースアカウントの ID。 |
15897534xxxx4625 |
| CrossAccountRoleName |
string |
任意 |
クロスアカウントバックアップのためにソースアカウントで作成された RAM ロールの名前。 |
BackupRole |
| KeepLatestSnapshots |
integer |
任意 |
少なくとも 1 つのバックアップバージョンを保持するかどうかを指定します。有効な値:
列挙値:
|
1 |
| DestSourceType |
string |
任意 |
送信先データソースのタイプ。このパラメーターはデータ同期の場合にのみ必須です。 |
OSS |
| DestDataSourceId |
string |
任意 |
送信先データソースの ID。このパラメーターはデータ同期の場合にのみ必須です。 |
ds-********************* |
| DestDataSourceDetail |
object |
任意 |
送信先データソースの詳細。このパラメーターはデータ同期の場合にのみ必須です。 |
{\"prefix\":\"/\"} |
| ChangeListPath |
string |
任意 |
増分ファイル同期リストの構成。このパラメーターはデータ同期の場合にのみ必須です。 |
{"dataSourceId": "ds-123456789", "path": "/changelist"} |
| Disabled |
boolean |
任意 |
プランがデフォルトで無効化されているかどうかを指定します。 |
true |
| Edition |
string |
任意 |
エディションタイプ。有効な値: BASIC および STANDARD。デフォルト値: STANDARD。 |
STANDARD |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| Code |
string |
応答コード。値 200 は成功を示します。 |
200 |
| Message |
string |
返されるメッセージ。成功応答の場合は "successful" という値が返されます。失敗応答の場合はエラーメッセージが返されます。 |
successful |
| RequestId |
string |
リクエスト ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PlanId |
string |
バックアッププラン ID。 |
plan-********************* |
| Success |
boolean |
リクエストが成功したかどうかを示します。
|
true |
例
成功レスポンス
JSONJSON
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PlanId": "plan-*********************",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。