すべてのプロダクト
Search

このプロダクト

    :ConfigureBackupPlan

    ドキュメントセンター

    :ConfigureBackupPlan

    最終更新日:Jan 13, 2026

    DBS バックアッププランを設定します。

    今すぐお試しください

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

    update

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアッププランの ID。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    dbstooi0*******
    SourceEndpointInstanceType

    string

    必須

    データベースソースのタイプ。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。 有効な値：

    • RDS

    • ECS

    • Express：専用回線、VPN Gateway、または Smart Access Gateway 経由で接続されたデータベース。

    • Agent：バックアップゲートウェイ経由で接続されたデータベース。

    • DDS：ApsaraDB for MongoDB。

    • Other：IP アドレスとポート経由で接続されたデータベース。

    RDS
    SourceEndpointRegion

    string

    任意

    データベースのリージョン。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    このパラメーターは、SourceEndpointInstanceType が RDS、ECS、DDS、Express、または Agent に設定されている場合に必要です。

    cn-hangzhou
    SourceEndpointInstanceID

    string

    任意

    データベースインスタンスの ID。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    このパラメーターは、SourceEndpoint.InstanceType が RDS、ECS、DDS、または Express に設定されている場合に必要です。

    rm-uf6wjk5*********
    SourceEndpointIP

    string

    任意

    データベースのエンドポイント。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    このパラメーターは、SourceEndpointInstanceType が express、agent、または other に設定されている場合に必要です。

    rm-uf6wjk5*******.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    任意

    データベースのポート。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    このパラメーターは、SourceEndpoint.InstanceType が express、agent、other、または ECS に設定されている場合に必要です。

    3306
    SourceEndpointDatabaseName

    string

    任意

    データベースの名前。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    このパラメーターは、データベースタイプが PostgreSQL または MongoDB の場合に必要です。

    testRDS
    SourceEndpointUserName

    string

    任意

    データベースアカウント。

    説明

    このパラメーターは、データベースタイプが Redis の場合、または SourceEndpointInstanceType が agent でデータベースタイプが SQL Server の場合はオプションです。 それ以外の場合、このパラメーターは必須です。

    testRDS
    SourceEndpointPassword

    string

    任意

    データベースアカウントのパスワード。

    説明

    このパラメーターは、データベースタイプが Redis の場合、または SourceEndpointInstanceType が agent でデータベースタイプが SQL Server の場合はオプションです。 それ以外の場合、このパラメーターは必須です。

    testPassword
    BackupGatewayId

    integer

    任意

    バックアップゲートウェイの ID。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    このパラメーターは、SourceEndpointInstanceType が agent に設定されている場合に必要です。

    23313123312
    OSSBucketName

    string

    任意

    Object Storage Service (OSS) バケットの名前。

    説明

    デフォルトでは、システムが自動的に新しい名前を生成します。

    TestOssBucket
    BackupObjects

    string

    任意

    バックアップオブジェクト。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    [ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
    BackupPeriod

    string

    任意

    完全バックアップサイクル。 有効な値：

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Monday
    BackupStartTime

    string

    任意

    完全バックアップの開始時刻。 時刻は HH:mmZ 形式 (UTC) です。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    14:22
    EnableBackupLog

    boolean

    任意

    増分ログバックアップを有効にするかどうかを指定します。 有効な値：

    • true：有効化。

    • false：無効化。

    true
    BackupLogIntervalSeconds

    integer

    任意

    増分バックアップの間隔 (秒単位)。

    説明

    このパラメーターは、物理バックアップに対してのみ有効です。

    1000
    BackupRetentionPeriod

    integer

    任意

    バックアップデータの保持期間 (日数)。 有効な値：0～1825。 デフォルト値：730。

    730
    DuplicationInfrequentAccessPeriod

    integer

    任意

    バックアップが低頻度アクセス (IA) ストレージに変換されるまでの日数。 デフォルト値：180。

    180
    DuplicationArchivePeriod

    integer

    任意

    バックアップがアーカイブストレージに変換されるまでの日数。 デフォルト値：365。

    365
    BackupPlanName

    string

    必須

    バックアッププランのカスタム名。 DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    dbstooi0*******
    SourceEndpointOracleSID

    string

    任意

    Oracle システム ID (SID)。

    説明

    このパラメーターは、データベースタイプが Oracle の場合に必要です。

    test
    BackupStorageType

    string

    任意

    組み込みストレージタイプ：

    • 空 (デフォルト)：バックアップデータはご利用の OSS バケットに保存されます。

    • system：バックアップデータは DBS の組み込み OSS バケットに保存されます。

    无
    BackupSpeedLimit

    integer

    任意

    ディスク I/O 制限 (KB/s)。

    説明

    このパラメーターは、MySQL データベースの物理バックアップに対してのみ有効です。

    262144
    BackupRateLimit

    integer

    任意

    ネットワーク帯域幅調整制限 (KB/s)。 最大値は 10 GB です。

    説明

    このパラメーターは、MySQL データベースの物理バックアップに対してのみ有効です。

    262144
    BackupStrategyType

    string

    任意

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

    • simple：定期バックアップ。 この値は BackupPeriod および BackupStartTime と共に使用します。

    • manual：手動バックアップ。

    説明

    デフォルト値：simple。

    simple
    CrossAliyunId

    string

    任意

    クロスアカウントバックアップ用の Alibaba Cloud アカウントの UID。 DescribeRestoreTaskList 操作を呼び出して、このパラメーターの値を取得します。

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    任意

    クロスアカウントバックアップ用の Resource Access Management (RAM) ロールの名前。 DescribeRestoreTaskList 操作を呼び出して、このパラメーターの値を取得します。

    test123
    AutoStartBackup

    boolean

    任意

    自動バックアップを有効にするかどうかを指定します。

    • true：有効化。

    • false：無効化。

    false
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。 これにより、重複したリクエストを防ぐことができます。 クライアントがこの値を生成し、異なるリクエスト間で一意である必要があります。 値は最大 64 文字の ASCII 文字で、ASCII 以外の文字を含めることはできません。

    ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-aekzecovzti****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    詳細は次のとおりです。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエスト ID。

    F1FB49D4-B504-47F1-9F43-D7EAB33F****
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

    リクエストが成功したかどうかを示します。 有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    バックアッププランの ID。

    dbstooi01ex****

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "BackupPlanId": "dbstooi01ex****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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