すべてのプロダクト
Search

このプロダクト

    :CreateBackupPlan

    ドキュメントセンター

    :CreateBackupPlan

    最終更新日:Jan 13, 2026

    Database Backup Service (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:CreateBackupPlan

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Region

    string

    任意

    DBS インスタンスのリージョン ID です。このパラメーターは必須です。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

    Month
    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：インターネット経由で接続されているデータベース。

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

    RDS
    StorageType

    string

    任意

    このパラメーターは使用されません。

    无
    FromApp

    string

    任意

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

    OpenAPI
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。

    KJSAHKJFHKJSHFKASHFKJADFHKDXXXX
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-aekzecovzti****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエスト ID。

    7BCF6D62-885F-5A4A-91A1-679760E7****
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

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

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

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

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.
    BackupPlanId

    string

    バックアッププラン ID。

    dbsrhahrsu2****
    OrderId

    string

    注文 ID。

    21437345592****

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "7BCF6D62-885F-5A4A-91A1-679760E7****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbsrhahrsu2****",
  "OrderId": "21437345592****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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