すべてのプロダクト
Search

このプロダクト

    :CreateBackupJob

    ドキュメントセンター

    :CreateBackupJob

    最終更新日:Dec 23, 2025

    バックアップジョブを作成します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:CreateBackupJob

    create

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    JobName

    string

    任意

    バックアップジョブの名前。

    k8s-backup-infra-20220131150046-hbr
    SourceType

    string

    必須

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

    • UDM_ECS：Elastic Compute Service (ECS) インスタンス

    列挙値:

    • UDM_ECS :

    CONTAINER
    Retention

    integer

    任意

    バックアップデータの保存期間。単位：日。

    15
    InstanceId

    string

    任意

    このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合にのみ必須です。このパラメーターは、ECS インスタンスの ID を指定します。

    i-bp1xxxxxxxxxxxxxxysm
    Detail

    object

    任意

    このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合にのみ必須です。値は JSON 文字列です。有効な値：

    • doCopy：リモートレプリケーションを有効にするかどうかを指定します。

    • destinationRegionId：リモートレプリケーションのターゲットリージョン。

    • destinationRetention：リモートレプリケーションのバックアップポイントの保存期間。

    • diskIdList：バックアップするディスクの ID。このパラメーターを空のままにすると、すべてのディスクがバックアップされます。

    • snapshotGroup：スナップショット整合性グループを使用するかどうかを指定します。このパラメーターは、ECS インスタンスのすべてのディスクが企業向け SSD (ESSD) である場合にのみ有効です。

    • appConsistent：アプリケーション整合性バックアップ機能を使用するかどうかを指定します。このパラメーターは、preScriptPath および postScriptPath パラメーターと共に使用する必要があります。

    • preScriptPath：フリーズ前スクリプトへのパス。

    • postScriptPath：解凍後スクリプトへのパス。

    • enableWriters：このパラメーターは、AppConsistent パラメーターを true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットを作成するかどうかを指定します。

      • true：アプリケーション整合性スナップショットを作成します。

      • false：ファイルシステム整合性スナップショットを作成します。

    • enableFsFreeze：このパラメーターは、AppConsistent パラメーターを true に設定した場合にのみ必須です。このパラメーターは、アプリケーション整合性スナップショットが作成される前に、Linux fsfreeze を有効にしてファイルシステムを読み取り専用状態にするかどうかを指定します。デフォルト値：true。

    • timeoutSeconds：このパラメーターは、AppConsistent パラメーターを true に設定した場合にのみ必須です。このパラメーターは、I/O フリーズタイムアウト期間を指定します。デフォルト値：30。単位：秒。

    { "doCopy": false, "destinationRegionId": "", "destinationRetention": null, "diskIdList": [], "snapshotGroup": false, "appConsistent": false, "enableWriters": true, "preScriptPath": "", "postScriptPath": "", "enableFsFreeze": true, "timeoutInSeconds": 60 }
    BackupType

    string

    任意

    バックアップタイプ。このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合にのみ必須です。

    • COMPLETE：完全バックアップ

    列挙値:

    • COMPLETE :

    INCREMENTAL
    VaultId

    string

    任意

    バックアップボールトの ID。このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合は必須ではありません。

    v-000xxxxxxxxxxxxxxy1v
    SpeedLimit

    string

    任意

    このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合は有効になりません。このパラメーターは、速度制限ルールを指定します。フォーマット：{start}|{end}|{bandwidth}。複数の速度制限ルールは、縦棒 (|) で区切ります。指定した時間範囲は、他の時間範囲と重複できません。

    • start：開始時間。

    • end：終了時間。

    • bandwidth：帯域幅。単位：KB/s。

    0:24:NaN
    Options

    string

    任意

    このパラメーターを指定する必要はありません。

    {"UseVSS":false}
    Include

    string

    任意

    このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合は有効になりません。このパラメーターは、バックアップするファイルのパスを指定します。値の長さは 255 文字までです。

    ["/home/alice/*.pdf", "/home/bob/*.txt"]
    Exclude

    string

    任意

    このパラメーターは、SourceType パラメーターを UDM_ECS に設定した場合は有効になりません。このパラメーターは、バックアップジョブから除外するファイルのパスを指定します。値の長さは 255 文字までです。

    ["/var", "/proc"]
    ClusterId

    string

    任意

    このパラメーターを指定する必要はありません。

    cl-00068btz******oku
    ContainerResources

    string

    任意

    このパラメーターを指定する必要はありません。

    [{\"resourceType\":\"PV\",\"backupMethod\":\"FILE\",\"resourceId\":\"674dac6d-74cd-47e9-a675-09e2f10d2c45\",\"resourceInfo\":\"{\\\"pv_name\\\":\\\"nas-650dac6d-74cd-47e9-a675-09e2f10d2c45\\\",\\\"pv_size\\\":\\\"8Gi\\\",\\\"storage_class\\\":\\\"alibabacloud-cnfs-nas\\\",\\\"pvc_name\\\":\\\"data-postgresql-default-0\\\",\\\"namespace\\\":\\\"database\\\"}\",\"host\":\"cn-huhehaote.192.168.13.133\",\"hostPrefix\":\"6f5e758e-8d35-4584-b9ce-8333adfc7547/volumes/kubernetes.io~csi/nas-670dac6d-74cd-47e9-a675-09e2f10d2c45/mount\",\"pvPath\":\"/\"}]
    InitiatedByAck

    boolean

    任意

    false または空のままにします

    false
    ContainerClusterId

    string

    任意

    このパラメーターを指定する必要はありません。

    cc-000xxxxxxxxxxxxxxi00
    CrossAccountType

    string

    任意

    データが同じ Alibaba Cloud アカウント内でバックアップされるか、Alibaba Cloud アカウント間でバックアップされるかを指定します。有効な値：

    • SELF_ACCOUNT：データは同じ Alibaba Cloud アカウント内でバックアップされます。

    • CROSS_ACCOUNT：データは Alibaba Cloud アカウント間でバックアップされます。

    SELF_ACCOUNT
    CrossAccountUserId

    integer

    任意

    現在の Alibaba Cloud アカウントに Alibaba Cloud アカウント間でのデータバックアップを承認する、ソース Alibaba Cloud アカウントの ID。

    158975xxxxxx4625
    CrossAccountRoleName

    string

    任意

    ソース Alibaba Cloud アカウント内に作成され、現在の Alibaba Cloud アカウントに割り当てられて、現在の Alibaba Cloud アカウントに Alibaba Cloud アカウント間でのデータバックアップを承認する RAM ロールの名前。

    BackupRole

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    HTTP ステータスコード。ステータスコード 200 は、リクエストが成功したことを示します。

    200
    Message

    string

    返されるメッセージ。リクエストが成功した場合、「successful」が返されます。リクエストが失敗した場合、エラーメッセージが返されます。

    successful
    RequestId

    string

    リクエスト ID。

    25F49E7B-7E39-542E-83AD-62E6E7F73786
    Success

    boolean

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

    • true

    • false

    true
    JobId

    string

    バックアップジョブの ID。

    job-000csy09q50a2jdcbwbo

    例

    成功レスポンス

    JSONJSON

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "25F49E7B-7E39-542E-83AD-62E6E7F73786",
  "Success": true,
  "JobId": "job-000csy09q50a2jdcbwbo"
}

    エラーコード

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

    変更履歴

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