ModifyBackupPolicy API による PolarDB バックアップポリシーの更新 - DMS - Alibaba Cloud - Data Management

PolarDB インスタンスのバックアップポリシーを変更します。

操作説明

対応エンジン

PolarDB for MySQL

説明

この操作は現在、特定のお客様のみ利用可能です。この操作を使用するには、DBS カスタマーコンサルテーショングループ（DingTalk グループ ID: 35585947）でリクエストを送信してください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dbs:ModifyBackupPolicy

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionCode	string	任意	バックアップセットが存在するリージョン。	cn-shanghai
PreferredBackupWindowBegin	string	任意	基本バックアップウィンドウの開始時刻。	17:00Z
InstanceName	string	任意	PolarDB インスタンス ID。	pc-2ze3nrr64c5****
Category	string	任意	バックアップタイプ。有効な値: Flash: 秒レベルバックアップ Standard: 基本バックアップ。	Flash
AdvanceLogPolicies	array<object>	任意	バックアップポリシーのターゲットリージョン。
	object	任意	バックアップポリシーのソースリージョン。
LogRetentionType	string	任意	保持期間タイプ。有効な値: Never: 無期限 Delay: 固定日数後に期限切れ。	Never
DestType	string	任意	バックアップポリシーの送信先タイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。	level1
FilterType	string	任意	高度なポリシーフィルタータイプ。有効な値: Crontab: 定期スケジューリング Event: イベントベースのスケジューリング。	crontab
ActionType	string	任意	操作タイプ。有効な値: CREATE、UPDATE、DELETE。	CREATE
SrcRegion	string	任意	バックアップポリシーのソースリージョン。	cn-hangzhou
EnableLogBackup	integer	任意	ログバックアップが有効かどうかを指定します。有効な値: 1: 有効。 0: 無効。	1
SrcType	string	任意	バックアップポリシーのソースタイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。	db
LogRetentionValue	string	任意	期限切れまでの日数。	30
PolicyId	string	任意	高度なポリシー ID。	31289676-bb8d-4dee-b83e-******
FilterKey	string	任意	スケジューリングタイプ。このパラメーターは FilterType が crontab にセットされている場合にのみ有効です。有効な値: dayOfWeek: 週次スケジューリング dayOfMonth: 月次スケジューリング dayOfYear: 年次スケジューリング backupInterval: 固定バックアップ間隔スケジューリング。	dayOfMonth
DestRegion	string	任意	バックアップポリシーのターゲットリージョン。	cn-hangzhou
FilterValue	string	任意	具体的なフィルター値。	1
AdvanceDataPolicies	array<object>	任意	データバックアップポリシーの詳細。
	object	任意	ポリシーの詳細。
DestType	string	任意	バックアップポリシーの送信先タイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。	level1
FilterType	string	任意	高度なポリシーフィルタータイプ。有効な値: crontab: 定期スケジューリング event: イベントベースのスケジューリング。	crontab
ActionType	string	任意	操作タイプ。有効な値: CREATE: 作成。 UPDATE: 更新。 DELETE: 削除。	UPDATE
SrcRegion	string	任意	バックアップポリシーのソースリージョン。	cn-shanghai
SrcType	string	任意	バックアップポリシーのソースタイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。	db
OnlyPreserveOneEachDay	boolean	任意	1 日以上経過したバックアップについて、1 日あたり 1 つの高クロック周波数バックアップセットのみを保持するかどうかを指定します。	true
RetentionValue	string	任意	期限切れまでの日数。	4
PolicyId	string	任意	高度なポリシー ID。 DescribeBackupPolicy を呼び出してこの値をクエリできます。	6s67c7i3y8f8p72808p******
FilterKey	string	任意	スケジューリングタイプ。有効な値: dayOfWeek: 週次スケジューリング dayOfMonth: 月次スケジューリング dayOfYear: 年次スケジューリング backupInterval: 固定バックアップ間隔スケジューリング説明このパラメーターは FilterType が crontab にセットされている場合にのみ返されます。	backupInterval
DestRegion	string	任意	バックアップポリシーのターゲットリージョン。	cn-shanghai
FilterValue	string	任意	バックアップサイクル。	180
RetentionType	string	任意	バックアップセットの保持期間タイプ。有効な値: never: 無期限。 delay: 固定日数後に期限切れ。	delay
StorageClass	string	任意	バケットのストレージクラス。有効な値: Standard（デフォルト）: 標準ストレージ。 IA: 低頻度アクセスストレージ。 Archive: アーカイブストレージ。 ColdArchive: コールドアーカイブストレージ。 DeepColdArchive: ディープコールドアーカイブストレージ。	Standard
AdvanceIncPolicies	array<object>	任意	バックアップポリシーのターゲットリージョン。
	object	任意	バックアップポリシーのソースリージョン。
DestType	string	任意	バックアップポリシーの送信先タイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。	level1
FilterType	string	任意	高度なポリシーフィルタータイプ。有効な値: Crontab: 定期スケジューリング Event: イベントベースのスケジューリング。	crontab
ActionType	string	任意	操作タイプ。有効な値: CREATE、UPDATE、DELETE。	CREATE
SrcRegion	string	任意	バックアップポリシーのソースリージョン。	cn-hangzhou
SrcType	string	任意	バックアップポリシーのソースタイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。	db
OnlyPreserveOneEachDay	boolean	任意	1 日以上経過したバックアップについて、1 日あたり 1 つの高クロック周波数バックアップセットのみを保持するかどうかを指定します。	true
RetentionValue	string	任意	期限切れまでの日数。	365
PolicyId	string	任意	高度なポリシー ID。	1
FilterKey	string	任意	スケジューリングタイプ。このパラメーターは FilterType が crontab にセットされている場合にのみ有効です。有効な値: dayOfWeek: 週次スケジューリング dayOfMonth: 月次スケジューリング dayOfYear: 年次スケジューリング backupInterval: 固定バックアップ間隔スケジューリング。	dayOfMonth
DestRegion	string	任意	バックアップポリシーのターゲットリージョン。	cn-hangzhou
FilterValue	string	任意	具体的なフィルター値。	1
RetentionType	string	任意	保持期間タイプ。有効な値: Never: 無期限 Delay: 固定日数後に期限切れ。	delay
BackupRetentionPolicyOnClusterDeletion	string	任意	削除されたインスタンスのアーカイブバックアップデータ保持ポリシー。有効な値: NONE: 保持しない。 LATEST: 最後のバックアップのみ保持。 ALL: すべてのバックアップを保持。	0
BackupMethod	string	任意	バックアップメソッド。有効な値: logical: 論理バックアップ physical: 物理バックアップ。	logical
BackupPriority	integer	任意	セカンダリインスタンスのバックアップポリシー。有効な値: 1: セカンダリインスタンス優先。 2: プライマリインスタンス強制。説明このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ適用されます。その他のエンジンでは、値 0 が返されます。	2
EnableIncBackup	boolean	任意	増分バックアップを有効にするかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	D570F209-A166-50C6-98A3-155A20B218B7
Message	string	返されたメッセージ。	instanceName can not be empty.
Data	object	バックアップポリシーの詳細。
PreferredBackupWindowBegin	string	基本バックアップウィンドウの開始時刻。	17:00Z
PreferredBackupWindow	string	基本バックアップウィンドウ。	17:00Z-18:00Z
Category	string	秒レベルバックアップが有効かどうかを示します。有効な値: Flash: 秒レベルバックアップが有効。 Standard: 基本バックアップ。説明このパラメーターは MySQL にのみ適用されます。	Standard
AdvanceLogPolicies	array<object>	ポリシーの詳細。
	object	ポリシーの詳細。
LogRetentionType	string	ログバックアップの保持タイプ。有効な値：	delay
DestType	string	バックアップポリシーの送信先タイプ。有効な値：	level1
FilterType	string	高度なポリシーのフィルタータイプ。有効な値： crontab：定期スケジュール。 event：イベントベースのスケジュール。	crontab
SrcRegion	string	バックアップポリシーのソースリージョン。	cn-beijing
EnableLogBackup	integer	このパラメーターは予約済みです。	1
SrcType	string	バックアップポリシーのソースタイプ。有効な値：	level1
PolicyId	string	バックアップポリシーの ID。	dc13b153acc91141789122c23835****
DestRegion	string	バックアップポリシーのターゲットリージョン。	cn-shanghai
LogRetentionValue	string	ログバックアップの保持期間 (日数)。	3
FilterKey	string	スケジューリングタイプ。このパラメーターは、`FilterType` が crontab に設定されている場合にのみ適用されます。有効な値：	dayOfMonth
FilterValue	string	フィルターの値。	1
AdvanceDataPolicies	array<object>	データバックアップポリシーの詳細。
	object	ポリシーの詳細。
RetentionValue	string	保持期間 (日数)。	4
BakType	string	バックアップタイプ。有効な値： F：完全バックアップ。 L：ログバックアップ。	F
FilterKey	string	スケジューリングタイプ。有効な値： dayOfWeek：週次スケジュール。 dayOfMonth：月次スケジュール。 dayOfYear：年次スケジュール。 backupInterval：固定間隔スケジュール。説明このパラメーターは、`FilterType` が crontab に設定されている場合にのみ返されます。	backupInterval
FilterValue	string	フィルターの値。	180
DestType	string	バックアップポリシーの送信先タイプ。有効な値： db：データベース level1：レベル 1 バックアップ level2：レベル 2 バックアップ level2Cross：レベル 2 のクロスリージョンバックアップ	level1
FilterType	string	高度なポリシーのフィルタータイプ。有効な値： crontab：定期スケジュール。 event：イベントベースのスケジュール。	crontab
SrcRegion	string	バックアップポリシーのソースリージョン。	cn-shanghai
AutoCreated	boolean	ポリシーがシステムによって自動的に生成されたかどうかを指定します。有効な値： true：ポリシーはシステムによって生成されます。 false：ポリシーはカスタムポリシーです。	false
SrcType	string	バックアップポリシーのソースタイプ。有効な値： db：データベース level1：レベル 1 バックアップ level2：レベル 2 バックアップ level2Cross：レベル 2 のクロスリージョンバックアップ	db
OnlyPreserveOneEachDay	boolean	1 日あたり 1 つのバックアップセットのみを保持するかどうかを指定します。有効な値： true：1 日あたり 1 つのバックアップセットのみが保持されます。 false：すべてのバックアップセットが保持されます。	true
DumpAction	string	ダンプ操作。有効な値： copy：コピー move：移動	copy
PolicyId	string	高度なポリシーの ID。	dc13b153acc91141789122c23835****
DestRegion	string	バックアップポリシーのターゲットリージョン。	cn-shanghai
RetentionType	string	バックアップセットの保持期間タイプ。有効な値： Never：バックアップセットは有効期限が切れません。 Delay：バックアップセットは指定された日数後に有効期限が切れます。	delay
StorageClass	string	ストレージクラス。	ARCHIVE
AdvanceIncPolicies	array<object>	保持期間タイプ。有効な値: Never: 無期限 Delay: 固定日数後に期限切れ。
	object	バックアップポリシーの送信先タイプ。有効な値: db: データベース level1: プライマリバックアップ level2: セカンダリバックアップ level2Cross: セカンダリクロスリージョンバックアップ。
RetentionValue	string	保持期間 (日数)。	365
BakType	string	バックアップタイプ。有効な値：	F
FilterKey	string	スケジューリングタイプ。このパラメーターは、`FilterType` が crontab に設定されている場合にのみ適用されます。有効な値：	dayOfMonth
FilterValue	string	フィルターの値。	1
DestType	string	バックアップポリシーの送信先タイプ。有効な値：	level1
FilterType	string	高度なポリシーのフィルタータイプ。有効な値：	Crontab
SrcRegion	string	バックアップポリシーのソースリージョン。	cn-hangzhou
AutoCreated	boolean	ポリシーがシステムによって自動的に生成されたかどうかを示します。有効な値：	true
SrcType	string	バックアップポリシーのソースタイプ。有効な値：	db
OnlyPreserveOneEachDay	boolean	1 日あたり 1 つのバックアップセットのみを保持するかどうかを指定します。有効な値： true：1 日あたり 1 つのバックアップセットのみが保持されます。 false：すべてのバックアップセットが保持されます。	true
DumpAction	string	ダンプ操作。有効な値：	Copy
PolicyId	string	高度なポリシーの ID。	smp-8sv763r9boydzb***
DestRegion	string	バックアップポリシーのターゲットリージョン。	cn-hangzhou
RetentionType	string	バックアップセットの保持期間タイプ。有効な値：	Delay
BackupRetentionPolicyOnClusterDeletion	string	削除されたインスタンスのアーカイブバックアップデータ保持ポリシー。有効な値: NONE: 保持しない。 LATEST: 最後のバックアップのみ保持。 ALL: すべてのバックアップを保持。	LATEST
BackupMethod	string	バックアップメソッド。有効な値: Physical: 物理バックアップ Snapshot: スナップショットバックアップ。	Physical
BackupPriority	integer	セカンダリインスタンスのバックアップポリシー。有効な値: 1: セカンダリインスタンス優先。 2: プライマリインスタンス強制。説明このパラメーターは ApsaraDB RDS for SQL Server インスタンスにのみ適用されます。その他のエンジンでは、値 0 が返されます。	1
EnableIncBackup	boolean	増分バックアップを有効にするかどうかを指定します。	true
ErrMessage	string	エラーメッセージ。	The specified parameter %s value is not valid.
Code	string	状態コード。	Success
Success	string	リクエストが成功したかどうかを示します。有効な値: true: リクエストが成功しました。 false: リクエストが失敗しました。	true
ErrCode	string	エラーコード。	Success

例

成功レスポンス

JSONJSON

{
  "RequestId": "D570F209-A166-50C6-98A3-155A20B218B7",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupWindowBegin": "17:00Z",
    "PreferredBackupWindow": "17:00Z-18:00Z",
    "Category": "Standard",
    "AdvanceLogPolicies": [
      {
        "LogRetentionType": "delay",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-beijing",
        "EnableLogBackup": 1,
        "SrcType": "level1",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "LogRetentionValue": "3",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "RetentionValue": "4",
        "BakType": "F",
        "FilterKey": "backupInterval",
        "FilterValue": "180",
        "DestType": "level1",
        "FilterType": "crontab",
        "SrcRegion": "cn-shanghai",
        "AutoCreated": false,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "copy",
        "PolicyId": "dc13b153acc91141789122c23835****",
        "DestRegion": "cn-shanghai",
        "RetentionType": "delay",
        "StorageClass": "ARCHIVE"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "RetentionValue": "365",
        "BakType": "F",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DestType": "level1",
        "FilterType": "Crontab",
        "SrcRegion": "cn-hangzhou",
        "AutoCreated": true,
        "SrcType": "db",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "Copy",
        "PolicyId": "smp-8sv763r9boydzb***",
        "DestRegion": "cn-hangzhou",
        "RetentionType": "Delay"
      }
    ],
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "BackupMethod": "Physical",
    "BackupPriority": 1,
    "EnableIncBackup": true
  },
  "ErrMessage": "The specified parameter %s value is not valid.",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Request.Forbidden	Have no Permissions

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

変更履歴

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