すべてのプロダクト
Search

このプロダクト

    :CreateAndStartBackupPlan

    ドキュメントセンター

    :CreateAndStartBackupPlan

    最終更新日:Dec 01, 2025

    バックアッププランを作成、設定し、開始します。

    操作説明

    この操作を呼び出す前に、Database Backup (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:CreateAndStartBackupPlan

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    任意

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

    dbstooi0*******
    Region

    string

    任意

    DBS がサポートされているリージョン。詳細については、「DescribeRegions」をご参照ください。

    cn-hangzhou
    InstanceClass

    string

    必須

    バックアッププランの仕様。有効な値：

    • micro

    • small

    • medium

    • large

    • xlarge

    説明

    仕様が高いほど、バックアップと回復のパフォーマンスが向上します。詳細については、「仕様」をご参照ください。

    micro
    DatabaseType

    string

    必須

    データベースのタイプ。有効な値：

    • MySQL

    • MSSQL

    • Oracle

    • MariaDB

    • PostgreSQL

    • DRDS

    • MongoDB

    • Redis

    MySQL
    BackupMethod

    string

    必須

    バックアップメソッド。有効な値：

    • logical：論理バックアップ

    • physical：物理バックアップ

    logical
    Period

    string

    任意

    サブスクリプションインスタンスの課金サイクル。有効な値：

    • Year：インスタンスは年単位で課金されます。

    • Month：インスタンスは月単位で課金されます。

    Year
    UsedTime

    integer

    任意

    サブスクリプション期間。有効な値：

    • Period を Year に設定した場合、UsedTime の値は 1 から 5 までです。

    • Period を Month に設定した場合、UsedTime の値は 1 から 11 までです。

    1
    PayType

    string

    任意

    支払方法。有効な値：

    prepay：サブスクリプション

    postpay
    DatabaseRegion

    string

    任意

    データベースが配置されているリージョン。

    cn-hangzhou
    StorageRegion

    string

    任意

    ストレージリージョン。

    cn-hangzhou
    InstanceType

    string

    任意

    データベースインスタンスのタイプ。有効な値：

    • RDS

    • PolarDB

    • DDS：Alibaba Cloud MongoDB

    • Kvstore：Alibaba Cloud Redis

    • Other：IP アドレスとポートを介して接続されたデータベース。

    • dg：パブリック IP アドレスとポートを持たない自己管理データベース。このデータベースは Database Gateway (DG) を介して接続されます。

    RDS
    StorageType

    string

    任意

    このパラメーターはまだ利用できません。

    无
    FromApp

    string

    任意

    リクエストのソース。デフォルト値は OpenApi です。このパラメーターを設定する必要はありません。

    OpenApi
    SourceEndpointInstanceType

    string

    必須

    データベースの場所。有効な値：

    • RDS

    • ECS

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

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

    • DDS：Alibaba Cloud MongoDB

    • Other：IP アドレスとポートを介して直接接続されたデータベース。

    • dg：パブリック IP アドレスとポートを持たない自己管理データベース。このデータベースは Database Gateway (DG) を介して接続されます。

    RDS
    SourceEndpointRegion

    string

    任意

    データベースが配置されているリージョン。

    説明

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

    cn-hangzhou
    SourceEndpointInstanceID

    string

    任意

    データベースインスタンスの ID。

    説明

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

    rm-uf6wjk5xxxxxxxxxx
    SourceEndpointIP

    string

    任意

    データベースエンドポイント。

    説明

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

    rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    任意

    データベースポート。

    説明

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

    3306
    SourceEndpointDatabaseName

    string

    任意

    データベース名。

    説明

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

    testRDS
    SourceEndpointUserName

    string

    任意

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

    説明

    このパラメーターは、データベースタイプが Redis の場合、またはデータベースの場所が agent でデータベースタイプが MSSQL の場合は不要です。他のシナリオでは、このパラメーターは必須です。

    testRDS
    SourceEndpointPassword

    string

    任意

    パスワード。

    説明

    このパラメーターは、データベースタイプが Redis の場合、またはデータベースの場所が agent でデータベースタイプが MSSQL の場合は不要です。他のシナリオでは、このパラメーターは必須です。

    testPassword
    BackupGatewayId

    integer

    任意

    バックアップゲートウェイの ID。

    説明

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

    • バックアップゲートウェイの作成方法については、「バックアップゲートウェイの追加」をご参照ください。

    • 既存のバックアップゲートウェイのリストを表示するには、DescribeBackupGatewayList 操作を呼び出します。

    23313123312
    OSSBucketName

    string

    任意

    Object Storage Service (OSS) バケットの名前。 デフォルト：システムが自動的に新しい名前を生成します。

    TestOssBucket
    BackupObjects

    string

    任意

    バックアップオブジェクト。

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

    string

    任意

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

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    説明

    複数の値を選択できます。コンマ (,) で区切ります。

    Monday
    BackupStartTime

    string

    任意

    完全バックアップの開始時刻。時刻は HH:mm 形式で、UTC です。

    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

    必須

    バックアッププランのカスタム名。

    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。

    1648821913******
    CrossRoleName

    string

    任意

    クロスアカウントバックアップ用の Resource Access Management (RAM) ロールの名前。

    test123
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。これにより、重複したリクエストを防ぎます。

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-aekzecovzti****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエスト ID。

    4F1888AC-1138-4995-B9FE-D2734F61C058
    CreateBackupSet

    boolean

    バックアップセットが作成されたかどうかを示します。戻り値：

    • true：バックアップセットが作成されます。

    • false：バックアップセットは作成されません。

    true
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.
    BackupPlanId

    string

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

    dbs1hvb0wwwe****
    OrderId

    string

    注文 ID。

    2056157***

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "CreateBackupSet": true,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbs1hvb0wwwe****",
  "OrderId": "2056157***"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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