ModifyBackupPolicy - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

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

操作説明

サポートされるデータベースエンジン

MySQL
PostgreSQL
SQL Server
MariaDB

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:ModifyBackupPolicy

update

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:EnableBackupLog
rds:BackupLog

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンスの ID。DescribeDBInstances 操作を呼び出してインスタンスの ID を照会できます。	rm-uf6wjk5****
BackupPolicyMode	string	任意	バックアップのタイプ。有効な値： DataBackupPolicy：データバックアップ LogBackupPolicy：ログバックアップ	DataBackupPolicy
PreferredBackupTime	string	任意	バックアップを実行する時間。時間は、HH:mmZ-HH:mmZ 形式の ISO 8601 規格で指定する必要があります。時間は協定世界時 (UTC) である必要があります。説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合に指定する必要があります。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	00:00Z-01:00Z
PreferredBackupPeriod	string	任意	バックアップサイクル。曜日を 2 日以上指定し、コンマ (,) で区切ります。有効な値： Monday Tuesday Wednesday Thursday Friday Saturday Sunday 説明このパラメーターと BackupInterval パラメーターを使用してバックアップポリシーを設定できます。たとえば、このパラメーターを Saturday,Sunday に設定し、BackupInterval パラメーターを 30 に設定すると、毎週土曜日と日曜日に 30 分ごとにバックアップが実行されます。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合に指定する必要があります。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	Monday
BackupRetentionPeriod	string	任意	データバックアップファイルを保持する日数。有効な値：7～730。説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合に指定する必要があります。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	7
BackupLog	string	任意	ログバックアップ機能を有効にするかどうかを指定します。有効な値： Enable：機能を有効にします。 Disabled：機能を無効にします。説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合に指定する必要があります。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	Enable
LogBackupRetentionPeriod	string	任意	ログバックアップの保持日数。有効な値：7～730。ログバックアップの保持期間は、データバックアップの保持期間より長くすることはできません。説明ログバックアップ機能を有効にする場合は、ログバックアップの保持期間を指定できます。このパラメーターは、MySQL および PostgreSQL を実行するインスタンスでサポートされています。このパラメーターは、BackupPolicyMode が DataBackupPolicy または LogBackupPolicy に設定されている場合にのみ有効です。	7
EnableBackupLog	string	任意	ログバックアップ機能を有効にするかどうかを指定します。有効な値： True または 1：ログバックアップ機能を有効にします。 False または 0：ログバックアップ機能を無効にします。説明 BackupPolicyMode パラメーターを LogBackupPolicy に設定する場合は、このパラメーターを指定する必要があります。このパラメーターは、BackupPolicyMode パラメーターを LogBackupPolicy に設定した場合にのみ有効です。	1
LocalLogRetentionHours	string	任意	インスタンスにログバックアップファイルを保持する時間数。有効な値：0～168。値 0 は、ログバックアップファイルがインスタンスに保持されないことを指定します。値 168 は、数式 7 × 24 に基づいて計算されます。説明このパラメーターは、BackupPolicyMode が LogBackupPolicy に設定されている場合に指定する必要があります。このパラメーターは、BackupPolicyMode が LogBackupPolicy に設定されている場合にのみ有効です。	18
LocalLogRetentionSpace	string	任意	インスタンス上のログバックアップファイルに許可される最大ストレージ使用量。インスタンス上のログバックアップファイルのストレージ使用量がこのパラメーターの値を超えると、ストレージ使用量がこのパラメーターの値を下回るまで、システムは古いログバックアップファイルを削除します。有効な値：0～50。デフォルト値のままにすることができます。説明このパラメーターは、BackupPolicyMode が LogBackupPolicy に設定されている場合に指定する必要があります。このパラメーターは、BackupPolicyMode が LogBackupPolicy に設定されている場合にのみ有効です。	30
HighSpaceUsageProtection	string	任意	インスタンスのストレージ使用量が 80% を超えた場合、またはインスタンスの残りのストレージ容量が 5 GB 未満の場合に、インスタンスからログバックアップファイルを強制的に削除するかどうかを指定します。有効な値：Enable および Disable。デフォルト値のままにすることができます。説明 BackupPolicyMode パラメーターを LogBackupPolicy に設定する場合は、このパラメーターを指定する必要があります。このパラメーターは、BackupPolicyMode パラメーターを LogBackupPolicy に設定した場合にのみ有効です。	Enable
LogBackupFrequency	string	任意	インスタンスのログをバックアップする頻度。有効な値： LogInterval：ログバックアップは 30 分ごとに実行されます。デフォルト値は、データバックアップ頻度と同じです。説明値 LogInterval は、SQL Server を実行するインスタンスでのみサポートされます。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	LogInterval
CompressType	string	任意	バックアップデータを圧縮するために使用されるフォーマット。有効な値： 0：バックアップは圧縮されません。 1：zlib ツールを使用してバックアップを .tar.gz ファイルに圧縮します。 2：zlib ツールを使用してバックアップを並行して圧縮します。 4：QuickLZ ツールを使用してバックアップを .xb.gz ファイルに圧縮します。この圧縮フォーマットは、MySQL 5.6 または MySQL 5.7 を実行するインスタンスでサポートされています。この圧縮フォーマットのバックアップは、個別のデータベースとテーブルを復元するために使用できます。詳細については、「ApsaraDB RDS for MySQL インスタンスの個別のデータベースとテーブルの復元」をご参照ください。 8：QuickLZ ツールを使用してバックアップを .xb.gz ファイルに圧縮します。この圧縮フォーマットは、MySQL 8.0 を実行するインスタンスでのみサポートされています。この圧縮フォーマットのバックアップは、個別のデータベースとテーブルを復元するために使用できません。説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	4
ArchiveBackupRetentionPeriod	string	任意	アーカイブバックアップが保持される日数。デフォルト値 0 は、バックアップアーカイブ機能が無効になっていることを指定します。有効な値：30～1095。説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	365
ArchiveBackupKeepPolicy	string	任意	アーカイブバックアップファイルの保持期間。指定された保持期間内に保持できるアーカイブバックアップファイルの数は、ArchiveBackupKeepCount によって指定されます。デフォルト値：0。有効な値： ByMonth ByWeek KeepAll 説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	ByMonth
ArchiveBackupKeepCount	integer	任意	保持されるアーカイブバックアップファイルの数。デフォルト値：1。有効な値： ArchiveBackupKeepPolicy が ByMonth に設定されている場合の有効な値：1～31。 ArchiveBackupKeepPolicy が ByWeek に設定されている場合の有効な値：1～7。説明 ArchiveBackupKeepPolicy が KeepAll に設定されている場合、このパラメーターを指定する必要はありません。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	1
ReleasedKeepPolicy	string	任意	インスタンスがリリースされた場合にアーカイブバックアップファイルを保持するために使用されるポリシー。有効な値： None：アーカイブバックアップファイルは保持されません。 Lastest：最新のアーカイブバックアップファイルのみが保持されます。 All：すべてのアーカイブバックアップファイルが保持されます。説明このパラメーターは、BackupPolicyMode パラメーターを DataBackupPolicy に設定した場合にのみ有効です。インスタンスがクラウドディスクを使用し、2024 年 2 月 1 日以降に作成された場合、このパラメーターは自動的に Lastest に設定されます。同じシナリオでインスタンスがローカルディスクを使用する場合、このパラメーターは自動的に None に設定されます。詳細については、「削除されたインスタンスのバックアップ」をご参照ください。	None
LogBackupLocalRetentionNumber	integer	任意	インスタンスに保持するバイナリログファイルの数。デフォルト値：60。有効な値：6～100。説明このパラメーターは、BackupPolicyMode パラメーターを LogBackupPolicy に設定した場合にのみ有効です。インスタンスが MySQL を実行している場合、このパラメーターを -1 に設定できます。値 -1 は、インスタンスに無制限の数のバイナリログファイルを保持できることを指定します。	60
Category	string	任意	秒単位のバックアップ機能を有効にするかどうかを指定します。有効な値： Flash：機能を有効にします。 Standard：機能を無効にします。説明このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	Standard
BackupInterval	string	任意	インスタンスでスナップショットバックアップを実行する頻度。有効な値： -1：バックアップ頻度は指定されません。 30：スナップショットバックアップは 30 分ごとに実行されます。 60：スナップショットバックアップは 60 分ごとに実行されます。 120：スナップショットバックアップは 120 分ごとに実行されます。 240：スナップショットバックアップは 240 分ごとに実行されます。 480：スナップショットバックアップは 480 分ごとに実行されます。説明このパラメーターと PreferredBackupPeriod パラメーターを使用してバックアップポリシーを設定できます。たとえば、PreferredBackupPeriod を Saturday,Sunday に設定し、BackupInterval を -1 に設定すると、毎週土曜日と日曜日にスナップショットバックアップが実行されます。インスタンスが PostgreSQL を実行している場合、BackupInterval はインスタンスがクラウドディスクを搭載している場合にのみサポートされます。インスタンスが SQL Server を実行している場合、BackupInterval はインスタンスのスナップショットバックアップ機能が有効になっている場合にのみサポートされます。詳細については、「ApsaraDB RDS for SQL Server インスタンスのスナップショットバックアップの有効化」をご参照ください。 Category が Flash に設定されている場合、BackupInterval は無効です。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	30
BackupMethod	string	任意	インスタンスのバックアップ方法。有効な値： Physical：物理バックアップ Snapshot：スナップショットバックアップデフォルト値：Physical。説明このパラメーターは、クラウドディスクを使用する SQL Server を実行するインスタンスでのみ有効です。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	Physical
EnableIncrementDataBackup	boolean	任意	増分バックアップを有効にするかどうかを指定します。有効な値： false (デフォルト)：機能を無効にします。 true：機能を有効にします。説明このパラメーターは、クラウドディスクを使用する SQL Server を実行するインスタンスでのみ有効です。このパラメーターは、BackupPolicyMode が DataBackupPolicy に設定されている場合にのみ有効です。	False
BackupPriority	integer	任意	セカンダリインスタンスのバックアップ設定が構成されているかどうかを指定します。有効な値： 1：セカンダリインスタンス優先 2：プライマリインスタンス優先説明このパラメーターは、RDS Cluster Edition で SQL Server を実行するインスタンスにのみ適しています。このパラメーターは、BackupMethod が Physical に設定されている場合にのみ有効です。BackupMethod が Snapshot に設定されている場合、バックアップは RDS Cluster Edition で SQL Server を実行するプライマリインスタンスで強制的に実行されます。	2
EnableAdvancedBackupPolicy	integer	任意
AdvancedDataPolicies	array<object>	任意
	object	任意
StrategyId	string	任意
ActionType	string	任意
OnlyPreserveOneEachHour	boolean	任意
RetentionValue	integer	任意
BakType	string	任意
FilterKey	string	任意
FilterValue	string	任意
DestType	string	任意
FilterType	string	任意
SrcRegion	string	任意
OnlyPreserveOneEachDay	boolean	任意
SrcType	string	任意
DestRegion	string	任意
RetentionType	string	任意
AdvancedLogPolicies	array<object>	任意
	object	任意
StrategyId	string	任意
ActionType	string	任意
LogRetentionType	string	任意
DestType	string	任意
EnableLogBackup	integer	任意
SrcType	string	任意
SrcRegion	string	任意
LogRetentionValue	integer	任意
DestRegion	string	任意
FilterKey	string	任意
FilterValue	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
CompressType	string	バックアップの圧縮方法。有効な値： 0：バックアップは圧縮されません。 1：バックアップは zlib ツールを使用して圧縮されます。 2：バックアップは zlib ツールを使用して並行して圧縮されます。 4：バックアップは QuickLZ ツールを使用して圧縮され、個別のデータベースとテーブルを復元するために使用できます。 8：バックアップは QuickLZ ツールを使用して圧縮されますが、個別のデータベースやテーブルを復元するために使用することはできません。この値は、MySQL 8.0 を実行するインスタンスでのみサポートされます。	4
DBInstanceID	string	インスタンスの ID。	rm-uf6wjk5****
EnableBackupLog	string	ログバックアップ機能が有効になっているかどうかを示します。有効な値： 1：機能は有効です。 0：機能は無効です。	1
HighSpaceUsageProtection	string	インスタンスのストレージ使用量が 80% を超えた場合、またはインスタンスの残りのストレージ容量が 5 GB 未満の場合に、インスタンスからログバックアップファイルを強制的に削除するかどうかを指定します。	Disable
LocalLogRetentionHours	integer	インスタンスにログバックアップファイルが保持される時間数。	18
LocalLogRetentionSpace	string	インスタンスで許可されるログバックアップファイルの最大ストレージ使用量。	30
LogBackupLocalRetentionNumber	integer	インスタンス上のバイナリログファイルの数。	60
RequestId	string	リクエストの ID。	DA147739-AEAD-4417-9089-65E9B1D8240D

例

成功レスポンス

JSONJSON

{
  "CompressType": "4",
  "DBInstanceID": "rm-uf6wjk5****",
  "EnableBackupLog": "1",
  "HighSpaceUsageProtection": "Disable",
  "LocalLogRetentionHours": 18,
  "LocalLogRetentionSpace": "30",
  "LogBackupLocalRetentionNumber": 60,
  "RequestId": "DA147739-AEAD-4417-9089-65E9B1D8240D"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidColdRetention.Format	Invalid cold retention format.
400	InvalidLogBackupFrequency.Malformed	Invalid log backup frequency.
400	InvalidBackupRetentionPeriod.Malformed	The specified backup retention period is invalid.
400	BackupPropertyNotFound	Backup policy not found
400	OperationDenied.SwitchToSnapshot	Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	IncorrectBackupPolicy	The current instance has an advanced backup policy enabled. Currently, you cannot use the OpenAPI to modify the backup policy. You need to modify the backup policy in the console.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectCategory	Current Instance type does not support Category.
403	OperationDenied.SwitchSnapshotToPhysical	Only physical backup to snapshot backup is supported.
403	OperationDenied.ModifyBackupSwitchOff	The switch is not turned on. It is forbidden to modify the backup mode.
403	OperationDenied.ApiForbiddenForLogBackupFrequency	When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.
403	OperationDenied.NotSupportedBackupMethod	When the storage is larger than 4000 GB, only snapshot backup is supported.
403	OperationDenied.ApiForbidden	Operation is not permitted.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.
408	NetworkOrSqlTimeoutError	Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.

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

変更履歴

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

ApsaraDB RDS:ModifyBackupPolicy