Cloud Backup：UpdatePolicyBinding - 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:UpdatePolicyBinding

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PolicyId	string	必須	バックアップポリシーの ID。	po-000************ky9
DataSourceId	string	必須	データソースの ID。	i-bp1************dtv
SourceType	string	必須	データソースのタイプ。有効な値： UDM_ECS：Elastic Compute Service (ECS) インスタンスのバックアップ	UDM_ECS
PolicyBindingDescription	string	任意	ポリシーバインディングの説明。	po-000**********5xx-i-2ze**********nw4
Disabled	boolean	任意	データソースのバックアップポリシーを無効にするかどうかを指定します。 true：バックアップポリシーは無効になります。 false：バックアップポリシーは無効になりません。	true
Source	string	任意	このパラメーターは、SourceType の値によって意味が異なります。 OSS：バックアップするオブジェクトのプレフィックス。このパラメーターを指定しない場合、バケット全体がバックアップされます。単一のプレフィックスのみがサポートされます。/backup ディレクトリをバックアップするには、このパラメーターを /backup に設定します。 ECS_FILE：バックアップするファイルのパス。このパラメーターを指定しない場合、すべてのファイルがバックアップされます。複数のパスを指定できます。/a と /b パス内のファイルをバックアップするには、このパラメーターを ["/a", "/b"] に設定します。 File：バックアップするファイルのパス。このパラメーターを指定しない場合、すべてのファイルがバックアップされます。複数のパスを指定できます。/a と /b ディレクトリ内のファイルをバックアップするには、このパラメーターを ["/a", "/b"] に設定します。 COMMON_FILE_SYSTEM：必須。バックアップパス。複数のパスを指定できます。/a と /b パスをバックアップするには、このパラメーターを ["/a", "/b"] に設定します。ルートディレクトリをバックアップするには、このパラメーターを ["/"] に設定します。 COMMON_NAS：必須。バックアップパス。単一のパスのみがサポートされます。/a パスをバックアップするには、このパラメーターを ["/a"] に設定します。ルートディレクトリをバックアップするには、このパラメーターを ["/"] に設定します。 OTS：バックアップするテーブルのリスト。このパラメーターを指定しない場合、すべてのテーブルがバックアップされます。複数のテーブルを指定できます。テーブル a とテーブル b をバックアップするには、このパラメーターを ["a", "b"] に設定します。	backup/
Include	string	任意	このパラメーターは、SourceType を ECS_FILE、File、NAS、COMMON_NAS、または COMMON_FILE_SYSTEM に設定した場合にのみ使用できます。このパラメーターは、バックアップするファイルタイプを指定します。指定されたタイプのすべてのファイルがバックアップされます。値の長さは最大 255 文字です。	[\".doc\",\".xltm\"]
Exclude	string	任意	このパラメーターは、SourceType が ECS_FILE、File、NAS、COMMON_NAS、または COMMON_FILE_SYSTEM に設定されている場合に必須です。バックアップに含めるファイルタイプを指定します。値の長さは最大 255 文字です。	[\".doc\",\".xltm\"]
SpeedLimit	string	任意	このパラメーターは、SourceType を ECS_FILE または File に設定した場合にのみ必須です。このパラメーターは、バックアップの速度制限ルールを指定します。フォーマットは `{start}{end}{bandwidth}` です。複数の速度制限ルールは、縦棒 (\|) で区切ります。ルールの期間は重複できません。 start：開始時間。 end：終了時間。 bandwidth：速度制限。単位：KB/s。	0:24:5120
AdvancedOptions	object	任意	詳細オプション。
UdmDetail	object	任意	ECS インスタンスのバックアップの詳細。
ExcludeDiskIdList	array	任意	保護する必要のないクラウドディスク ID のリスト。DiskIdList が空でない場合、このパラメーターは無視されます。
	string	任意	保護する必要のないクラウドディスクの ID。	d-bp1************apo
DiskIdList	array	任意	保護する必要のあるクラウドディスク ID のリスト。すべてのクラウドディスクを保護する場合は、このパラメーターを空のままにします。
	string	任意	保護する必要のあるクラウドディスクの ID。	d-bp1************apo
SnapshotGroup	boolean	任意	スナップショット整合性グループを作成するかどうかを指定します。スナップショット整合性グループは、すべてのディスクタイプが ESSD (Enhanced SSD) の場合にのみ作成できます。	true
AppConsistent	boolean	任意	アプリケーション整合性を有効にするかどうかを指定します。アプリケーション整合性は、すべてのディスクタイプが ESSD の場合にのみ有効にできます。	false
RamRoleName	string	任意	このパラメーターは、AppConsistent を true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットの作成に必要な Resource Access Management (RAM) ロールの名前を指定します。	AliyunECSInstanceForHbrRole
PreScriptPath	string	任意	このパラメーターは、AppConsistent を true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成される前に実行されるフリーズ前スクリプトへのパスを指定します。	/tmp/prescript.sh
PostScriptPath	string	任意	このパラメーターは、AppConsistent を true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成された後に実行される解凍後スクリプトへのパスを指定します。	/tmp/postscript.sh
EnableFsFreeze	boolean	任意	このパラメーターは、AppConsistent を true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成される前に、Linux の FsFreeze メカニズムを使用してファイルシステムの読み取り整合性を確保するかどうかを指定します。デフォルト値は true です。	true
TimeoutInSeconds	integer	任意	このパラメーターは、AppConsistent を true に設定した場合にのみ必須です。このパラメーターは、I/O フリーズのタイムアウト期間を指定します。デフォルト値は 30 秒です。	30
EnableWriters	boolean	任意	このパラメーターは、AppConsistent を true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットを作成するかどうかを指定します： true：アプリケーション整合性スナップショットを作成します。 false：ファイルシステム整合性スナップショットを作成します。デフォルト値は true です。	true
OssDetail	object	任意	Object Storage Service (OSS) バックアップの詳細。
InventoryId	string	任意	OSS インベントリの名前。このパラメーターを指定すると、パフォーマンスチューニングのために OSS インベントリが使用されます。 1 億を超える OSS オブジェクトをバックアップする場合、インベントリを使用して増分バックアップのパフォーマンスを向上させます。インベントリファイルのストレージ料金は OSS によって課金されます。 OSS インベントリファイルの生成には時間がかかります。インベントリファイルが生成される前に、バックアップジョブが失敗することがあります。次のバックアップサイクルで実行されるのを待つことができます。	30663060
InventoryCleanupPolicy	string	任意	バックアップ後にインベントリファイルを削除するかどうかを指定します。このパラメーターは、OSS インベントリを使用する場合にのみ有効です。有効な値： NO_CLEANUP：インベントリファイルを削除しません。 DELETE_CURRENT：現在のファイルを削除します。 DELETE_CURRENT_AND_PREVIOUS：すべてのファイルを削除します。	NO_CLEANUP
IgnoreArchiveObject	boolean	任意	タスク統計および失敗したファイルのリストからアーカイブオブジェクトを除外するかどうかを指定します。	true
CommonFileSystemDetail	object	任意	大規模ファイルシステムのバックアップの詳細。
FullOnIncrementFail	boolean	任意	増分バックアップが失敗した場合に完全バックアップを実行するかどうかを指定します。有効な値： true：完全バックアップを実行します。 false：完全バックアップを実行しません。	true
FetchSliceSize	integer	任意	バックアップシャードのサイズ (ファイル数)。	100000

レスポンスフィールド

フィールド	型	説明	例
	object	UpdatePolicyBindingResponse
Success	boolean	リクエストが成功したかどうかを示します。 true：リクエストは成功しました。 false：リクエストは失敗しました。	true
Code	string	リターンコード。値が 200 の場合、リクエストが成功したことを示します。	200
Message	string	返されるメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。	successful
RequestId	string	リクエスト ID。	B6F24C46-54B9-519B-9AB8-A8988D705E67

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "B6F24C46-54B9-519B-9AB8-A8988D705E67"
}

エラーコード

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

変更履歴

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