UpdatePolicyV2 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:UpdatePolicyV2

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PolicyId	string	任意	バックアップポリシーの ID。	po-000************viy
PolicyName	string	任意	バックアップポリシーの名前。	Daily Local Backup + Remote Backup
PolicyDescription	string	任意	バックアップポリシーの説明。	Data is backed up at 10:00:00 every day and replicated to the China (Shanghai) region for geo-redundancy.
Rules	array<object>	任意	バックアップポリシー内のルール。
	array<object>	任意	ルールの詳細。
RuleId	string	任意	ルールの ID。	rule-000************rof
RuleType	string	任意	ルールのタイプ。各バックアップポリシーには、BACKUP タイプのルールが少なくとも 1 つ、TRANSITION タイプのルールが 1 つだけ必要です。有効な値： BACKUP：バックアップルール TRANSITION：ライフサイクルルール REPLICATION：レプリケーションルール	BACKUP
Schedule	string	任意	このパラメーターは、RuleType パラメーターが BACKUP に設定されている場合にのみ必須です。このパラメーターはバックアップスケジュールの設定を指定します。フォーマット： `I\|{startTime}\|{interval}`：システムは、{startTime} パラメーターで指定された時点で最初のバックアップジョブを実行し、{interval} パラメーターで指定された間隔で後続のバックアップジョブを実行します。たとえば、`I\|1631685600\|P1D` は、システムが 2021 年 9 月 15 日 14:00:00 に最初のバックアップジョブを実行し、その後は 1 日に 1 回バックアップジョブを実行することを示します。 startTime：システムがバックアップジョブの実行を開始する時間。時間は UNIX 時間形式に従う必要があります。単位：秒。 interval：システムがバックアップジョブを実行する間隔。間隔は ISO 8601 標準に従う必要があります。たとえば、`PT1H` は 1 時間の間隔を指定し、`P1D` は 1 日の間隔を指定します。 `C\|{startTime}\|{crontab}`：システムは、{crontab} 式に基づいて、{startTime} パラメーターで指定された時点でバックアップジョブを実行します。たとえば、C\|1631685600\|0 0 2 ?* 3,5,7 は、システムが 2021 年 9 月 15 日 14:00:00 から、毎週火曜日、木曜日、土曜日の 02:00:00 にバックアップジョブを実行することを示します。`` startTime：システムがバックアップジョブの実行を開始する時間。時間は UNIX 時間形式に従う必要があります。単位：秒。 crontab：crontab 式。たとえば、0 0 2 ?* 3,5,7 は、毎週火曜日、木曜日、土曜日の 02:00:00 を示します。`` システムは指定された時刻より前にバックアップジョブを実行しません。最初のバックアップジョブを除き、各バックアップジョブは前のバックアップジョブが完了した後にのみ開始されます。	I\|1648647166\|P1D
BackupType	string	任意	このパラメーターは、RuleType パラメーターが BACKUP に設定されている場合にのみ必須です。このパラメーターはバックアップタイプを指定します。有効な値：COMPLETE (完全バックアップを示します)。	COMPLETE
Retention	integer	任意	このパラメーターは、RuleType パラメーターが TRANSITION または REPLICATION に設定されている場合にのみ必須です。 RuleType パラメーターが TRANSITION に設定されている場合、このパラメーターはバックアップデータの保持期間を指定します。最小値：1。単位：日。 RuleType パラメーターが REPLICATION に設定されている場合、このパラメーターはリモートバックアップの保持期間を指定します。最小値：1。単位：日。	7
ReplicationRegionId	string	任意	このパラメーターは、RuleType パラメーターが REPLICATION に設定されている場合にのみ必須です。このパラメーターはターゲットリージョンの ID を指定します。	cn-shanghai
ArchiveDays	integer	任意	このパラメーターは、RuleType パラメーターが TRANSITION に設定されている場合にのみ必須です。このパラメーターは、データがバックアップボールトからアーカイブボールトにダンプされるまでの時間を指定します。単位：日。	90
ColdArchiveDays	integer	任意	このパラメーターは、RuleType パラメーターが TRANSITION に設定されている場合にのみ必須です。このパラメーターは、データがバックアップボールトからコールドアーカイブボールトにダンプされるまでの時間を指定します。単位：日。	365
VaultId	string	任意	このパラメーターは、RuleType パラメーターが BACKUP に設定されている場合にのみ必須です。バックアップボールトの ID。	v-0001************aseg
RetentionRules	array<object>	任意	このパラメーターは、RuleType パラメーターが TRANSITION に設定されている場合にのみ必須です。このパラメーターは特別保持ルールを指定します。
	object	任意	特別保持ルール。
AdvancedRetentionType	string	任意	特別保持ルールのタイプ。有効な値： WEEKLY：週次バックアップを保持 MONTHLY：月次バックアップを保持 YEARLY：年次バックアップを保持	YEARLY
WhichSnapshot	integer	任意	特別保持ルールに基づいて保持されるバックアップを指定します。最初のバックアップのみ保持できます。	1
Retention	integer	任意	バックアップの特別保持期間。最小値：1。単位：日。	365
KeepLatestSnapshots	integer	任意	少なくとも 1 つのバックアップバージョンを保持する機能を有効にするかどうかを指定します。有効な値： 0：機能は無効です。 1：機能は有効です。	1
DataSourceFilters	array<object>	任意	このパラメーターは、RuleType パラメーターが TAG に設定されている場合にのみ必須です。このパラメーターはデータソースのフィルタールールを指定します。
	object	任意
SourceType	string	任意	データソースのタイプ。有効な値： UDM_ECS：Elastic Compute Service (ECS) インスタンス。このタイプのデータソースは、RuleType パラメーターが UDM_ECS_ONLY に設定されている場合にのみサポートされます。 OSS：Object Storage Service (OSS) バケット。このタイプのデータソースは、RuleType パラメーターが STANDARD に設定されている場合にのみサポートされます。 NAS：File Storage NAS (NAS) ファイルシステム。このタイプのデータソースは、RuleType パラメーターが STANDARD に設定されている場合にのみサポートされます。 ECS_FILE：ECS ファイル。このタイプのデータソースは、RuleType パラメーターが STANDARD に設定されている場合にのみサポートされます。 OTS：Tablestore インスタンス。このタイプのデータソースは、RuleType パラメーターが STANDARD に設定されている場合にのみサポートされます。	UDM_ECS
DataSourceIds	array	任意	このパラメーターは非推奨です。
	string	任意	このパラメーターは非推奨です。	deprecated
TagFilters	array<object>	任意	このパラメーターは、RuleType パラメーターが TAG に設定されている場合にのみ必須です。このパラメーターはリソースのタグフィルタールールを指定します。
	object	任意
Key	string	任意	タグキー。	env
Value	string	任意	タグ値。このパラメーターを空のままにすると、値は任意の値になります。	prod
Operator	string	任意	タグベースの照合ルール。有効な値： EQUAL：タグキーとタグ値の両方が一致します。 NOT：タグキーは一致しますが、タグ値は一致しません。	EQUAL
Immutable	boolean	任意	このパラメーターは、PolicyType パラメーターが UDM_ECS_ONLY に設定されている場合にのみ必須です。このパラメーターは、不変バックアップ機能を有効にするかどうかを指定します。	true

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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