DescribeDataBackupSet - データバックアップセット情報の照会|OceanBase Cloud|ドキュメント|分散データベース

DescribeDataBackupSet - データバックアップセット情報の照会

最終更新日：2026-07-31 06:58:55 更新

機能の概要

指定されたOceanBaseクラスタの指定された期間内のデータバックアップセットリスト情報を照会するために使用されます。ページネーションクエリとバックアップセットダウンロード機能のチェックに対応しています。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。

リクエストパス

GET /api/v2/instances/{instanceId}/backup/data/sets

リクエストパラメータ

Path

パラメータ名	型	必須	説明
instanceId	String	はい	OceanBaseクラスタID

Query

パラメータ名	型	必須	説明
requestId	String	はい	リクエストID。追跡に使用されます
startTime	String	いいえ	開始時間(UTC)
endTime	String	いいえ	終了時間(UTC)
pageNumber	Integer	いいえ	ページ番号
pageSize	Integer	いいえ	ページサイズ
checkBackupSetDownloadEnable	Boolean	いいえ	バックアップセットダウンロード機能をチェックするかどうか

実行結果

パラメータ名	型	説明
data	Object	バックアップセットデータ
data.dataList	`Array<Object>`	バックアップセットリスト
data.dataList[].backupSetId	String	バックアップセットID
data.dataList[].backupMode	String	バックアップモード
data.dataList[].backupObjectType	String	バックアップオブジェクトタイプ
data.dataList[].checkpoint	String	チェックポイント時間
data.dataList[].dataBackupMode	String	データバックアップモード
data.dataList[].dataBackupSize	Number	データバックアップサイズ(GiB)
data.dataList[].dataVersion	Integer	データバージョン
data.dataList[].downloadEnabled	Boolean	ダウンロードは可能か
data.dataList[].downloadTaskId	Integer	ダウンロードタスクID。-1はダウンロードタスクが作成されていないことを示す
data.dataList[].status	String	バックアップの状態
data.dataList[].startTime	String	開始時間
data.dataList[].endTime	String	終了時間
data.dataList[].storageClass	String	ストレージタイプ
data.dataList[].tenantId	String	テナントID
data.dataList[].tenantName	String	テナント名
data.dataList[].triggerMode	String	トリガーモード
data.dataList[].validity	String	有効性
data.dataList[].tenantBackupSetList	`Array<Object>`	テナントのバックアップセットリスト
data.dataList[].tenantBackupSetList[].backupSetId	String	テナントのバックアップセットID
data.dataList[].tenantBackupSetList[].backupMode	String	テナントのバックアップモード
data.dataList[].tenantBackupSetList[].backupObjectType	String	テナントのバックアップオブジェクトタイプ
data.dataList[].tenantBackupSetList[].checkpoint	String	テナントのチェックポイント時間
data.dataList[].tenantBackupSetList[].dataBackupMode	String	テナントのデータバックアップモード
data.dataList[].tenantBackupSetList[].dataBackupSize	Number	テナントのデータバックアップサイズ(GiB)
data.dataList[].tenantBackupSetList[].dataVersion	Integer	テナントのデータバージョン
data.dataList[].tenantBackupSetList[].downloadEnabled	Boolean	テナントバックアップのダウンロードは可能か
data.dataList[].tenantBackupSetList[].downloadTaskId	Integer	テナントのダウンロードタスクID
data.dataList[].tenantBackupSetList[].status	String	テナントバックアップの状態
data.dataList[].tenantBackupSetList[].startTime	String	テナントバックアップの開始時間
data.dataList[].tenantBackupSetList[].endTime	String	テナントバックアップの終了時間
data.dataList[].tenantBackupSetList[].storageClass	String	テナントのストレージタイプ
data.dataList[].tenantBackupSetList[].tenantId	String	テナントID
data.dataList[].tenantBackupSetList[].tenantName	String	テナント名
data.dataList[].tenantBackupSetList[].triggerMode	String	テナントのトリガーモード
data.dataList[].tenantBackupSetList[].validity	String	テナントの有効性
data.total	Integer	合計
requestId	String	リクエストID
success	Boolean	リクエストが成功したかどうか

例

リクエスト例

curl --digest -u '<Your AK:SK>' \
  -X GET \
  'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/backup/data/sets' \
  -G \
  -d 'requestId={requestId}' \
  -d 'startTime={startTime}' \
  -d 'endTime={endTime}' \
  -d 'pageNumber={pageNumber}' \
  -d 'pageSize={pageSize}' \
  -d 'checkBackupSetDownloadEnable={checkBackupSetDownloadEnable}'

戻り値の例

JSON 形式

{
  "data": {
    "dataList": [
      {
        "backupMode": "PHYSICAL_BACKUP",
        "backupObjectType": "CLUSTER",
        "backupSetId": "bak-7aqvtc4ugvuo",
        "checkpoint": "2025-12-03T12:57:32Z",
        "dataBackupMode": "FULL_BACKUP",
        "dataBackupSize": 0.04,
        "dataVersion": 1,
        "downloadEnabled": true,
        "downloadTaskId": -1,
        "endTime": "2025-12-03T12:58:07Z",
        "startTime": "2025-12-03T12:55:35Z",
        "status": "DONE",
        "storageClass": "standard",
        "tenantBackupSetList": [
          {
            "backupMode": "PHYSICAL_BACKUP",
            "backupObjectType": "TENANT",
            "backupSetId": "bak-7aqvtc4ugvuo-1002",
            "checkpoint": "2025-12-03T12:57:32Z",
            "dataBackupMode": "FULL_BACKUP",
            "dataBackupSize": 0.04,
            "dataVersion": 123000325,
            "downloadEnabled": true,
            "downloadTaskId": -1,
            "endTime": "2025-12-03T12:57:42Z",
            "startTime": "2025-12-03T12:55:47Z",
            "status": "DONE",
            "storageClass": "standard",
            "tenantId": "t7amdemq4iu9s",
            "tenantName": "gyh",
            "triggerMode": "BACKUP_NOW",
            "validity": "VALID"
          }
        ],
        "tenantId": "sys",
        "tenantName": "*",
        "triggerMode": "BACKUP_NOW",
        "validity": "VALID"
      }
    ],
    "total": 1
  },
  "requestId": "df209ed9-ae31-4e9e-bf75-76385afaadf9",
  "success": true
}

OceanBase

顧客事例