すべてのプロダクト
Search

このプロダクト

    :CreateAndStartBackupPlan

    ドキュメントセンター

    :CreateAndStartBackupPlan

    最終更新日:Feb 26, 2026

    バックアッププランの作成、設定、および開始を行います。

    操作説明

    この操作を呼び出す前に、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：サブスクリプション

    prepay
    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

    任意

    クロスアカウントバックアップ用の 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

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

    変更履歴

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