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

ApsaraDB RDS インスタンスのバックアップセットの設定を照会します。

操作説明

サポートされているエンジン

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS 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:DescribeBackupPolicy

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。DescribeDBInstances を呼び出してインスタンス ID を取得できます。	rm-uf6wjk5****
BackupPolicyMode	string	任意	バックアップタイプ。有効な値: DataBackupPolicy: データバックアップ LogBackupPolicy: ログバックアップ。	DataBackupPolicy
CompressType	string	任意	バックアップ圧縮メソッド。有効な値: 0: 非圧縮 1: zlib 圧縮 2: 並列 zlib 圧縮 4: 個別データベースおよびテーブルの高速リストアが有効な QuickLZ 圧縮 8: 個別データベースおよびテーブルの高速リストアがまだサポートされていない QuickLZ 圧縮。	1
ReleasedKeepPolicy	string	任意	削除された MySQL インスタンスのアーカイブバックアップデータ保持ポリシー。有効な値: None: アーカイブバックアップは保持されません。 Lastest: 最後のアーカイブバックアップのみが保持されます。 All: すべてのアーカイブバックアップが保持されます。	Lastest

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
ArchiveBackupKeepCount	string	MySQL インスタンスで保持されるアーカイブバックアップの数。	1
ArchiveBackupKeepPolicy	string	MySQL インスタンスのアーカイブバックアップの保持サイクル。	ByMonth
ArchiveBackupRetentionPeriod	string	MySQL インスタンスのアーカイブバックアップが保持される日数。	365
BackupInterval	string	バックアップ間隔。単位: 分。 MySQL インスタンスの場合、このパラメーターはスナップショットバックアップ頻度を指定します (スナップショットバックアップサイクルではありません)。 SQL Server インスタンスの場合、このパラメーターはログバックアップ頻度を指定します。	30
BackupLog	string	ログバックアップが有効かどうかを示します。有効な値: Enable: 有効 Disabled: 無効 SQL Server インスタンスの場合: Enable は、インスタンスのログバックアップ頻度が 5 分ごとの場合にのみ返されます。インスタンスのログバックアップ頻度が 30 分ごとまたはデータバックアップサイクルと一致の場合、このパラメーターは Disabled を返します。BackupInterval の値をリファレンスとして使用してください。	Enable
BackupMethod	string	クラウドディスクを使用する SQL Server インスタンスのバックアップメソッド。有効な値: Physical: 物理バックアップ Snapshot: スナップショットバックアップ。	Physical
BackupPriority	integer	SQL Server Enterprise Cluster Edition インスタンスのセカンダリインスタンスのバックアップ優先度設定。有効な値: 1: セカンダリインスタンス優先。 2: プライマリインスタンス強制。説明このパラメーターは、SupportModifyBackupPriority が True の場合にのみ返されます。	2
BackupRetentionPeriod	integer	データバックアップが保持される日数。	7
Category	string	MySQL または PostgreSQL インスタンスで秒単位のバックアップが有効かどうかを示します。有効な値: Flash: 有効 Standard: 標準 (無効) 説明このパラメーターは、BackupPolicyMode パラメーターが DataBackupPolicy に設定されている場合にのみ有効です。	Standard
CompressType	string	バックアップ圧縮メソッド。有効な値: 0: 非圧縮 1: zlib 圧縮 2: 並列 zlib 圧縮 4: 個別データベースおよびテーブルの高速リストアが有効な QuickLZ 圧縮 8: 個別データベースおよびテーブルの高速リストアがまだサポートされていない QuickLZ 圧縮。	1
EnableBackupLog	string	ログバックアップが有効かどうかを示します。有効な値: 1: 有効 0: 無効 SQL Server インスタンスの場合: 1 は、インスタンスのログバックアップ頻度が 5 分ごとの場合にのみ返されます。インスタンスのログバックアップ頻度が 30 分ごとまたはデータバックアップサイクルと一致の場合、このパラメーターは 0 を返します。BackupInterval の値をリファレンスとして使用してください。	1
EnableIncrementDataBackup	boolean	SQL Server インスタンスで増分バックアップが有効かどうかを示します。有効な値: True: 有効 False: 無効。	True
IncBackupInterval	integer
EnablePitrProtection	boolean	MySQL インスタンスでポイントインタイムリカバリ (PITR) が有効かどうかを示します。PITR はログバックアップのスペックアップ版です。有効な値: True: 有効 False: 無効説明詳細については、「ポイントインタイムリカバリポリシーの設定」をご参照ください。	True
HighSpaceUsageProtection	string	MySQL インスタンスのストレージ使用量が 80% を超えた場合、または残りストレージが 5 GB 未満の場合に、バイナリログを強制的に削除するかどうかを示します。有効な値: Disable: バイナリログは強制的に削除されません。 Enable: バイナリログは強制的に削除されます。	Enable
LocalLogRetentionHours	integer	MySQL インスタンスでバイナリログバックアップがローカルに保持される時間数。	0
LocalLogRetentionSpace	string	MySQL インスタンスでローカルに保存されるバイナリログの最大ストレージ使用量。	30
LogBackupFrequency	string	SQL Server インスタンスのログバックアップ頻度。有効な値: LogInterval: 30 分ごと。デフォルトでは、ログバックアップ頻度は PreferredBackupPeriod で指定されたデータバックアップサイクルと同じです。	LogInterval
LogBackupLocalRetentionNumber	integer	MySQL インスタンスで保持されるローカルバイナリログの数。	60
LogBackupRetentionPeriod	integer	ログバックアップが保持される日数。	7
PitrRetentionPeriod	integer	MySQL インスタンスでポイントインタイムリカバリがサポートされる日数。	7
PreferredBackupPeriod	string	データバックアップサイクル。複数の値はコンマ (,) で区切られます。有効な値: Monday: 月曜日 Tuesday: 火曜日 Wednesday: 水曜日 Thursday: 木曜日 Friday: 金曜日 Saturday: 土曜日 Sunday: 日曜日。	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	データバックアップ時間。フォーマット: HH:mmZ-HH:mmZ (協定世界時 (UTC))。	15:00Z-16:00Z
PreferredNextBackupTime	string	次のバックアップ時間。フォーマット: yyyy-MM-ddTHH:mmZ (協定世界時 (UTC))。	2018-01-19T15:15Z
ReleasedKeepPolicy	string	削除された MySQL インスタンスのアーカイブバックアップデータ保持ポリシー。有効な値: None: アーカイブバックアップは保持されません。 Lastest: 最後のアーカイブバックアップのみが保持されます。 All: すべてのアーカイブバックアップが保持されます。	None
RequestId	string	リクエスト ID。	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	SQL Server インスタンスでセカンダリインスタンスのバックアップオプションを変更できるかどうかを示します。有効な値: True: オプションを変更できます。 False: オプションを変更できません。	False
SupportReleasedKeep	integer	予約済みパラメーター。	0
SupportVolumeShadowCopy	integer	SQL Server インスタンスでスナップショットバックアップがサポートされているかどうかを示します。有効な値: 1: サポートされています 0: サポートされていません。	1
SupportsHighFrequencyBackup	integer	SQL Server インスタンスで 5 分間ログバックアップ特徴がサポートされているかどうかを示します。有効な値: 0: サポートされていません 1: サポートされています。	0
AdvancedDataPolicies	object
AdvancedDataPolicy	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	object
AdvancedLogPolicy	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
AdvancedBackupPolicyEnabled	boolean

例

成功レスポンス

JSONJSON

{
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 0,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "LogRetentionType": "",
        "DestType": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "SrcRegion": "",
        "LogRetentionValue": 0,
        "DestRegion": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IO.Exception	IO exception, retry later.
400	InternalFailure	Internal failure, retry later.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.
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	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
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	IncorrectDBInstanceState	Current DB instance state does not support this operation.
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	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.
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.

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

変更履歴

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