すべてのプロダクト
Search

このプロダクト

    ApsaraDB RDS:CreateBackup

    ドキュメントセンター

    ApsaraDB RDS:CreateBackup

    最終更新日:Jun 10, 2026

    RDS インスタンスのバックアップセットを作成します。

    操作説明

    サポート対象エンジン

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server

    • RDS MariaDB

    説明

    この API は、RDS のネイティブ バックアップ API を呼び出します。DBS を使用することもできます。詳細については「DBS API 概要」をご参照ください。

    注意事項

    API 呼び出しは、インスタンスが以下の条件を満たしている場合にのみ成功します。

    • インスタンスが実行中であること。

    • 進行中のバックアップタスクが存在しないこと。

    • 1 つのインスタンスにつき、1 日あたり最大 20 個のバックアップセットを作成できること。

    関連ドキュメント

    今すぐお試しください

    この 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:CreateBackup

    create

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。DescribeDBInstances オペレーションを呼び出してインスタンス ID を取得できます。

    rm-uf6wjk5****
    DBName

    string

    任意

    バックアップするデータベースの名前。複数のデータベース名をコンマ (,) で区切ります。

    説明

    このパラメーターは、BackupStrategy パラメーターが db に設定されている場合にのみ適用されます。

    rds_mysql
    BackupStrategy

    string

    任意

    バックアップ戦略。有効な値：

    • db：データベースバックアップ

    • instance：インスタンスバックアップ

    説明

    このパラメーターは、次の場合にのみ適用されます：

    • MySQL インスタンスの場合、このパラメーターは BackupMethod パラメーターが Logical に設定されている場合に適用されます。

    • SQL Server インスタンスの場合、このパラメーターは BackupType パラメーターが FullBackup に設定されている場合に適用されます。

    db
    BackupMethod

    string

    任意

    バックアップ方法。有効な値：

    • Logical：論理バックアップ。この方法は、ローカルディスクを使用する MySQL インスタンスにのみ適用されます。

    • Physical：物理バックアップ。この方法は、ローカルディスクを使用する MySQL インスタンス、および SQL Server インスタンスと PostgreSQL インスタンスに適用されます。

    • Snapshot：スナップショットバックアップ。この方法は、クラウドディスクを使用する MySQL インスタンス、および SQL Server、PostgreSQL、MariaDB インスタンスに適用されます。

    デフォルト値：Physical。

    説明

    • 論理バックアップでは、データベースを空にすることはできません。

    • MariaDB インスタンスはスナップショットバックアップのみをサポートしますが、このパラメーターを Physical に設定する必要があります。

    Physical
    BackupType

    string

    任意

    SQL Server インスタンスのバックアップタイプ。有効な値：

    • Auto (デフォルト)：システムは、完全バックアップと増分バックアップのどちらかを自動的に選択します。

    • FullBackup：完全バックアップ

    説明

    このパラメーターは、BackupMethod が Physical に設定されている場合にのみ有効になります。

    Auto
    BackupRetentionPeriod

    integer

    任意

    • SQL Server インスタンスの場合、BackupStrategy が db に、BackupMethod が Physical に、BackupType が FullBackup に設定されている場合、バックアップセットの保持期間を指定できます。値は 7〜730 の整数である必要があります。値 -1 は長期保存を意味します。

    • MySQL：バックアップセットの保持期間は 7〜730 日、または長期保存の場合は -1 に設定できます。

    7

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    BackupJobId

    string

    バックアップジョブ ID。

    507****
    RequestId

    string

    リクエスト ID。

    2C125605-266F-41CA-8AC5-3A643D4F42C5

    例

    成功レスポンス

    JSONJSON

    {
  "BackupJobId": "507****",
  "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 BackupType.NotSupport the specified backup type not support
    400 InvalidBackupMethod.ValueNotSupport The specified parameter "BackupMethod" is not valid.
    400 ReadDBInstanceNotSupport The operation is not permitted due to type of the instance.
    400 IncorrectDBInstanceLockMode.ValueNotSupported The Current DB instance lock mode does not support this operation.
    400 BackupJobExists A backup job already exists in the specified DB instance.
    400 InvalidPreferredBackupTime.Format Specified preferred backup time is not valid.
    400 InvalidDBName.Format Specified DB name 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 OperationDenied.ApiForbidden operation not permitted.
    403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. 現在のインスタンスがロックされているため、この操作は一時的にサポートされません。
    403 IncorrectDBInstanceType Current DB instance engine and type does not support operations. 現在のデータベースタイプはこの操作をサポートしていません。
    403 IncorrectDBInstanceState Current DB instance state does not support this operation.
    403 IncorrectDBInstanceCharacterType Current DB Instance character_type does not support this operation.
    403 Exceeded.BackupTimes The backup times exceeds.
    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 InvalidDBInstanceName.NotFound The database instance does not exist.
    404 InvalidDB.NotFound Specified db does not exist or DB status 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.

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

    変更履歴

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