UpdateBackupPlan API でバックアップスケジュールを更新 - Cloud Backup

バックアッププランを更新します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hbr:UpdateBackupPlan

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PlanId	string	必須	バックアッププランの ID。	plan-20211***735
PlanName	string	任意	バックアッププランの名前。	planname
Schedule	string	任意	バックアップポリシー。`I\|{startTime}\|{interval}` 形式を使用します。これは、バックアップジョブが定期的な間隔で実行されることを指定します。`{startTime}` はバックアップの開始時刻です。`{interval}` はジョブ間の時間です。HBR は期限切れのバックアップジョブを実行しません。前のバックアップジョブが終了していない場合、次のジョブは開始されません。たとえば、`I\|1631685600\|P1D` は、バックアップが 2021 年 9 月 15 日の 14:00:00 から 1 日に 1 回実行されることを意味します。 startTime: バックアップの開始時刻。これは秒単位の UNIX タイムスタンプです。 interval: 時間間隔。ISO 8601 標準を使用します。たとえば、PT1H は 1 時間の間隔を指定します。P1D は 1 日の間隔を指定します。	I\|1602673264\|P1D
Retention	integer	任意	バックアップを保持する日数。最小値は 1 です。	7
Prefix	string	任意	このパラメーターは、SourceType が OSS に設定されている場合にのみ必要です。このパラメーターは、バックアップするオブジェクトのプレフィックスを指定します。プレフィックスを指定すると、プレフィックスに一致するオブジェクトのみがバックアップされます。	oss-prefix
VaultId	string	任意	バックアップリポジトリの ID。	v-0006******q
Detail	object	任意	ECS インスタンスバックアップの詳細。これは JSON 文字列です。 snapshotGroup: スナップショット整合性グループを使用するかどうかを指定します。この機能は、インスタンスのすべてのディスクが拡張 SSD (ESSD) である場合にのみ使用できます。 appConsistent: アプリケーションの整合性を有効にするかどうかを指定します。preScriptPath および postScriptPath パラメーターも構成する必要があります。 preScriptPath: フリーズ前スクリプトへのパス。 postScriptPath: 解凍後スクリプトへのパス。	{\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}
SourceType	string	任意	データソースのタイプ。有効な値: ECS_FILE: ECS ファイルをバックアップします。 OSS: Alibaba Cloud OSS をバックアップします。 NAS: Alibaba Cloud NAS をバックアップします。 OTS: Alibaba Cloud Tablestore をバックアップします。 UDM_ECS: ECS インスタンス全体をバックアップします。	ECS_FILE
SpeedLimit	string	任意	このパラメーターは、SourceType が ECS_FILE に設定されている場合にのみ必要です。このパラメーターは、バックアップのトラフィックシェーピングを指定します。トラフィックシェーピングは、ピーク時のビジネス時間中にバックアップトラフィックを制御して、サービスへの影響を回避するのに役立ちます。フォーマットは `{start}\|{end}\|{bandwidth}` です。複数のトラフィックシェーピングルールを指定できます。縦棒 (\|) で区切ります。ルールの時間範囲は重複できません。 start: 開始時間。 end: 終了時間。 bandwidth: 最大速度。単位: KB/s。	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 に設定されている場合にのみ必要です。このパラメーターは、ボリュームシャドウコピーサービス (VSS) を使用してバックアップパスを定義するかどうかを指定します。この機能は、Windows ECS インスタンスでのみ使用できます。バックアップソースでデータ変更が発生した場合は、データ整合性を確保するために、このパラメーターを `["UseVSS":true]` に設定します。 VSS を有効にすると、複数のファイルディレクトリを同時にバックアップすることはできません。	{"UseVSS":false}
UpdatePaths	boolean	任意	Path パラメーターが空の場合にバックアップパスを更新するかどうかを指定します。 true: この呼び出しで指定されたパスに基づいてバックアップパスを更新します。 false: バックアップパスを更新しません。バックアッププランの作成時に構成されたバックアップパスが使用されます。	false
Path	array	任意	バックアップパス。
	string	任意	バックアップパス。値の長さは最大 65,536 文字です。次のルールが適用されます: ワイルドカード文字 () を使用しない場合は、最大 20 個のパスを入力できます。ワイルドカード文字 () を使用する場合は、1 つのパスのみ入力できます。`//` などのワイルドカード文字がサポートされています。各パスは絶対パスである必要があります。 VSS を使用する場合、複数のパス、UNC パス、ワイルドカード文字、または除外ファイルを指定することはできません。 UNC パスを使用する場合、VSS、ワイルドカード文字、または除外ファイルを使用することはできません。バックアップソースに UNC パスが含まれている場合、Windows アクセス制御リスト (ACL) はバックアップされません。	["/home"]
Rule	array<object>	任意	バックアッププランのルール。
	object	任意
DestinationRetention	integer	任意	geo 冗長バックアップを保持する日数。	7
Schedule	string	任意	バックアップポリシー。I\|{startTime}\|{interval} 形式を使用します。これは、バックアップジョブが定期的な間隔で実行されることを指定します。{startTime} はバックアップの開始時刻です。{interval} はジョブ間の時間です。HBR は期限切れのバックアップジョブを実行しません。前のバックアップジョブが終了していない場合、次のジョブは開始されません。たとえば、I\|1631685600\|P1D は、バックアップが 2021 年 9 月 15 日の 14:00:00 から 1 日に 1 回実行されることを意味します。 startTime: バックアップの開始時刻。これは秒単位の UNIX タイムスタンプです。interval: 時間間隔。ISO 8601 標準を使用します。たとえば、PT1H は 1 時間の間隔を指定します。P1D は 1 日の間隔を指定します。	I\|1631685600\|P1D
Disabled	boolean	任意	ポリシーを無効にするかどうかを指定します。	false
Retention	integer	任意	バックアップを保持する日数。最小値は 1 です。	7
DoCopy	boolean	任意	geo 冗長レプリケーションを有効にするかどうかを指定します。	false
DestinationRegionId	string	任意	geo 冗長バックアップのターゲットリージョンの ID。	cn-shanghai
RuleName	string	任意	ポリシーの名前。	rule-test-name
BackupType	string	任意	バックアップタイプ。値を COMPLETE に設定します。これは完全バックアップを示します。	COMPLETE
OtsDetail	OtsDetail	任意	Tablestore インスタンスの詳細。
KeepLatestSnapshots	integer	任意	最新のバックアップバージョンを永続的に保持するかどうかを指定します。 0: いいえ 1: はい	1
ChangeListPath	string	任意	増分ファイル同期リストの構成。(このパラメーターはファイル同期にのみ必要です。)	{"dataSourceId": "ds-123456789", "path": "/changelist"}
Edition	string	任意	エディション。有効な値は BASIC と STANDARD です。デフォルト値は STANDARD です。	STANDARD

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	リターンコード。値 200 は、リクエストが成功したことを示します。	200
Message	string	返されるメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	リクエストが成功したかどうかを示します。 true: リクエストは成功しました。 false: リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

エラーコード

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

変更履歴

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