すべてのプロダクト
Search

このプロダクト

    :ConfigureBackupPlan

    ドキュメントセンター

    :ConfigureBackupPlan

    最終更新日:Mar 19, 2026

    この API は、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 API を呼び出します。

    dbstooi0*******
    SourceEndpointInstanceType

    string

    必須

    データベースの場所。このパラメーターの値を取得するには、DescribeBackupPlanList API を呼び出します。有効な値:

    • RDS

    • ECS

    • Express: 専用回線、VPN Gateway、または Smart Gateway を介して接続されたデータベース。

    • Agent: バックアップゲートウェイを介して接続されたデータベース。

    • DDS: Cloud MongoDB。

    • Other: IP:Port を介して直接接続されたデータベース。

    RDS
    SourceEndpointRegion

    string

    任意

    データベースのリージョン。このパラメーターの値を取得するには、DescribeBackupPlanList API を呼び出します。

    説明

    このパラメーターは、SourceEndpointInstanceType が RDS、ECS、DDS、Express、または Agent の場合に必須です。

    cn-hangzhou
    SourceEndpointInstanceID

    string

    任意

    データベースインスタンス ID。このパラメーターの値を取得するには、DescribeBackupPlanList API を呼び出します。

    説明

    このパラメーターは、SourceEndpoint.InstanceType が RDS、ECS、DDS、または Express の場合に必須です。

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

    string

    任意

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

    説明

    このパラメーターは、SourceEndpointInstanceType が express、agent、または other の場合に必須です。

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

    integer

    任意

    データベースポート。このパラメーターの値を取得するには、DescribeBackupPlanList API を呼び出します。

    説明

    このパラメーターは、SourceEndpoint.InstanceType が express、agent、other、または ECS の場合に必須です。

    3306
    SourceEndpointDatabaseName

    string

    任意

    データベース名。このパラメーターの値を取得するには、DescribeBackupPlanList API を呼び出します。

    説明

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

    testRDS
    SourceEndpointUserName

    string

    任意

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

    説明

    このパラメーターは、データベースタイプが Redis の場合、またはデータベースの場所が agent でデータベースタイプが SQL Server の場合にオプションです。その他のシナリオでは必須です。

    testRDS
    SourceEndpointPassword

    string

    任意

    パスワード。

    説明

    このパラメーターは、データベースタイプが Redis の場合、またはデータベースの場所が agent でデータベースタイプが SQL Server の場合にオプションです。その他のシナリオでは必須です。

    testPassword
    BackupGatewayId

    integer

    任意

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

    説明

    このパラメーターは、SourceEndpointInstanceType が agent の場合に必須です。

    23313123312
    OSSBucketName

    string

    任意

    OSS バケット名。

    説明

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

    TestOssBucket
    BackupObjects

    string

    任意

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

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

    string

    任意

    完全バックアップ期間。有効な値:

    • Monday: 月曜日

    • Tuesday: 火曜日

    • Wednesday: 水曜日

    • Thursday: 木曜日

    • Friday: 金曜日

    • Saturday: 土曜日

    • Sunday: 日曜日

    Monday
    BackupStartTime

    string

    任意

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

    14:22
    EnableBackupLog

    boolean

    任意

    増分ログバックアップを有効にします。有効な値:

    • true: 有効

    • false: 無効

    true
    BackupLogIntervalSeconds

    integer

    任意

    増分間隔 (秒)。

    説明

    物理バックアップのみがサポートされています。

    1000
    BackupRetentionPeriod

    integer

    任意

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

    730
    DuplicationInfrequentAccessPeriod

    integer

    任意

    データが低頻度アクセスストレージに変換されるまでの期間。デフォルト値: 180 日。

    180
    DuplicationArchivePeriod

    integer

    任意

    データがアーカイブコールドストレージに変換されるまでの期間。デフォルト値: 365 日。

    365
    BackupPlanName

    string

    必須

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

    dbstooi0*******
    SourceEndpointOracleSID

    string

    任意

    Oracle SID 名。

    説明

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

    test
    BackupStorageType

    string

    任意

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

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

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

    无
    BackupSpeedLimit

    integer

    任意

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

    説明

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

    262144
    BackupRateLimit

    integer

    任意

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

    説明

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

    262144
    BackupStrategyType

    string

    任意

    完全バックアップ期間。有効な値:

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

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

    説明

    デフォルト値: simple。

    simple
    CrossAliyunId

    string

    任意

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

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    任意

    クロス Alibaba Cloud アカウントバックアップの RAM ロール名。このパラメーターの値を取得するには、DescribeRestoreTaskList API を呼び出します。

    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

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

    変更履歴

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