CreatePolicyBindings でバックアップポリシーバインディングを自動化 - Cloud Backup - Alibaba Cloud -

1 つ以上のデータソースをポリシーにバインドします。

操作説明

各呼び出しでは、同じタイプのデータソースのみを単一のポリシーにバインドできます。
ECS インスタンス（サーバー全体のバックアップ）は、1 つのポリシーにのみバインドできます。

今すぐお試しください

この 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:CreatePolicyBindings

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PolicyId	string	任意	ポリシーの ID。	po-000************8ep
PolicyBindingList	array<object>	任意	ポリシーバインディングのリスト。
	array<object>	任意	ポリシーバインディングの詳細。
PolicyBindingDescription	string	任意	ポリシーバインディングの説明。	これはポリシーバインディングの説明です
DataSourceId	string	任意	データソースの ID。値の意味は SourceType フィールドによって異なります。 UDM_ECS: ECS インスタンスの ID。 OSS: OSS バケット名。 NAS: Alibaba Cloud NAS ファイルシステムの ID。 COMMON_NAS: オンプレミス NAS インスタンスの ID。 ECS_FILE: ECS インスタンスの ID。 File: Cloud Backup クライアントの ID。 COMMON_FILE_SYSTEM: CPFS バックアップデータソースの ID。	i-bp1************dl8
Disabled	string	任意	このデータソースに対してポリシーを一時停止するかどうかを指定します。 true: 一時停止。 false: 一時停止しない。	true
SourceType	string	任意	データソースのタイプ。有効な値: UDM_ECS: ECS サーバー全体のバックアップ。 OSS: OSS バックアップ。 NAS: Alibaba Cloud NAS バックアップ。 COMMON_NAS: オンプレミス NAS バックアップ。 ECS_FILE: ECS File Backup Essential エディション。 File: オンプレミスファイルバックアップ。 COMMON_FILE_SYSTEM: CPFS バックアップ。 OTS: Tablestore バックアップ。	UDM_ECS
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:1024
AdvancedOptions	object	任意	詳細オプション。
UdmDetail	object	任意	ECS サーバー全体バックアップの詳細オプション。
ExcludeDiskIdList	array	任意	保護する必要のないディスクの ID。 DiskIdList パラメーターが空でない場合、このパラメーターは無視されます。
	string	任意	保護する必要のないディスクの ID。	d-bp1************apo
DiskIdList	array	任意	保護する必要があるディスクの ID。すべてのディスクを保護する必要がある場合、このパラメーターは空です。
	string	任意	保護する必要があるディスクの ID。	d-bp1************apo
SnapshotGroup	boolean	任意	スナップショット整合性グループを作成するかどうかを指定します。スナップショット整合性グループは、すべてのディスクが企業向け SSD (ESSD) である場合にのみ作成できます。	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	任意	OSS バックアップの詳細オプション。
InventoryId	string	任意	OSS インベントリの名前。このパラメーターが空でない場合、OSS インベントリはパフォーマンス最適化に使用されます。 1 億個を超える OSS オブジェクトをバックアップする場合は、インベントリリストを使用して増分バックアップを高速化することを推奨します。インベントリリストのストレージ料金は、OSS の請求書に含まれます。 OSS がインベントリリストを生成するには、一定の時間が必要です。インベントリリストが生成される前に、OSS オブジェクトのバックアップに失敗する場合があります。この場合、次のバックアップサイクルで OSS オブジェクトをバックアップできます。	oss-inventory-default
InventoryCleanupPolicy	string	任意	バックアップが完了したときにシステムがインベントリリストを削除するかどうかを指定します。このパラメーターは、OSS インベントリが使用されている場合にのみ有効です。有効な値： NO_CLEANUP：インベントリリストを削除しません。 DELETE_CURRENT：現在のインベントリリストを削除します。 DELETE_CURRENT_AND_PREVIOUS：すべてのインベントリリストを削除します。	NO_CLEANUP
IgnoreArchiveObject	boolean	任意	タスク統計および失敗したファイルリストにアーカイブタイプのオブジェクトをプロンプト表示しません。	true
FileDetail	object	任意	ファイルバックアップの詳細オプション。
UseVSS	boolean	任意	ボリュームシャドウコピーサービス (VSS) 機能を有効にするかどうかを指定します。有効な値： true：機能を有効にします。 false：機能を無効にします。	true
AdvPolicy	boolean	任意	詳細ポリシーを使用するかどうかを指定します。有効な値： true：詳細ポリシーを使用します。 false：詳細ポリシーを使用しません。	true
CommonNasDetail	object	任意	オンプレミス NAS バックアップの詳細オプション。
FullOnIncrementFail	boolean	任意	増分バックアップが失敗した場合にシステムが完全バックアップを実行するかどうかを指定します。有効な値： true：増分バックアップが失敗した場合、システムは完全バックアップを実行します。 false：増分バックアップが失敗した場合、システムは完全バックアップを実行しません。	true
FetchSliceSize	integer	任意	バックアップシャードのサイズ (ファイル数)。	100000
ClusterId	string	任意	バックアップクライアントグループの ID。オンプレミス NAS バックアップを実行すると、Cloud Backup は指定されたバックアップクライアントグループからクライアントを選択します。	cl-000**************ggu
CommonFileSystemDetail	object	任意	CPFS バックアップの詳細オプション。
FullOnIncrementFail	boolean	任意	増分バックアップが失敗した場合にシステムが完全バックアップを実行するかどうかを指定します。有効な値： true：増分バックアップが失敗した場合、システムは完全バックアップを実行します。 false：増分バックアップが失敗した場合、システムは完全バックアップを実行しません。	true
FetchSliceSize	integer	任意	バックアップシャードのサイズ (ファイル数)。	100000
CrossAccountType	string	任意	クロスアカウントバックアップのタイプ。デフォルト値: SELF_ACCOUNT。有効な値: SELF_ACCOUNT: 同じアカウント内でのバックアップ。 CROSS_ACCOUNT: クロスアカウントバックアップ。	SELF_ACCOUNT
CrossAccountUserId	integer	任意	クロスアカウントバックアップのソースアカウントの Alibaba Cloud UID。	144**********732
CrossAccountRoleName	string	任意	クロスアカウントバックアップのためにソースアカウントで作成された RAM ロール名。	hbrcrossrole

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Success	boolean	リクエストが成功したかどうかを示します。 true: 成功。 false: 失敗。	true
Code	string	リターンコード。値が 200 の場合は成功を示します。	200
Message	string	返されるメッセージ。成功時は "successful" が返されます。失敗時はエラーメッセージが返されます。	successful
RequestId	string	リクエストの ID。	82CC5B6C-72F7-5D39-92F6-67887DF9AD46

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "82CC5B6C-72F7-5D39-92F6-67887DF9AD46"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	PolicyAlreadyBoundWithThisDataSource	This datasource has already been bound with the policy, please use another one.	データソースはすでにこのポリシーにバインドされています。新しいポリシーのバインドを試してください。

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

変更履歴

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