すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB RDS:DescribeBackupPolicy

最終更新日:Apr 18, 2026

この API は、RDS インスタンスのバックアップ設定を取得するために使用されます。

操作説明

サポート対象エンジン

  • RDS MySQL

  • RDS PostgreSQL

  • RDS SQL Server

  • RDS MariaDB

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

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:バックアップは保持されません。

  • Latest:最後のバックアップが保持されます。

  • 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 インスタンスの場合:

  • このパラメーターは、ログバックアップ頻度が 5 分ごと の場合にのみ Enable として返されます。

  • このパラメーターは、ログバックアップ頻度が 30 分ごと または データバックアップサイクルと同じ の場合に Disabled として返されます。この場合、BackupInterval パラメーターの値が優先されます

Enable

BackupMethod

string

クラウドディスクを使用する SQL Server インスタンスのバックアップ方法。有効値:

  • Physical:物理バックアップ

  • Snapshot:スナップショットバックアップ

Physical

BackupPriority

integer

SQL Server 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 インスタンスの場合:

  • このパラメーターは、ログバックアップ頻度が 5 分ごと の場合にのみ 1 として返されます。

  • このパラメーターは、ログバックアップ頻度が 30 分ごと または データバックアップサイクルと同じ の場合に 0 として返されます。この場合、BackupInterval パラメーターの値が優先されます

1

EnableIncrementDataBackup

boolean

SQL Server インスタンスで増分バックアップが有効になっているかどうかを示します。有効値:

  • True:有効

  • False:無効

True

EnablePitrProtection

boolean

MySQL インスタンスでポイントインタイムリカバリ (PITR) 機能が有効になっているかどうかを示します。PITR 機能は、ログバックアップ機能の拡張版です。有効値:

  • True:有効

  • False:無効

説明

この機能の詳細については、「ポイントインタイムリカバリのポリシーを設定する」をご参照ください。

True

HighSpaceUsageProtection

string

ディスク使用率が 80% を超えるか、残りのディスク領域が 5 GB 未満の場合に、MySQL インスタンスからバイナリログファイルを強制的にクリアするかどうかを示します。有効値:

  • 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,
  "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": true,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": true,
        "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.

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

変更履歴

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