すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeSharedBackups

最終更新日:May 20, 2026

共有バックアップセットをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID。

説明

DescribeRegions API を呼び出して、利用可能なリージョンを照会できます。

cn-hangzhou

DBClusterId

string

任意

クラスター ID。

pc-**************

BackupId

string

任意

バックアップセット ID。

111111111

ShareType

string

必須

共有タイプ。有効な値:

  • ShareIncoming:自分に共有されたバックアップ。

  • ShareOutgoing:自分が共有したバックアップ。

ShareIncoming

PageSize

integer

任意

1 ページあたりのエントリ数。有効な値:30~100。デフォルト値:30

30

PageNumber

integer

任意

ページ番号。値は 1 以上の整数である必要があります。デフォルト値:1

1

DBType

string

任意

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

  • MySQL

  • PostgreSQL

  • Oracle

複数のタイプは、コンマで区切って指定します。

MySQL,PostgreSQL,Oracle

DBVersion

string

任意

データベースバージョン。

8.0

レスポンスフィールド

フィールド

説明

object

応答オブジェクト。

TotalRecordCount

string

合計レコード数。

16

PageRecordCount

string

現在のページのエントリ数。

1

RequestId

string

リクエスト ID。

3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF

PageNumber

string

ページ番号。

1

Items

array<object>

共有バックアップセットのリスト。

object

共有バックアップセットの詳細。

BackupSetSize

string

バックアップセットのサイズ (バイト)。

4639948800

ConsistentTime

string

一貫性のあるスナップショットの UNIX タイムスタンプ (秒)。

1589253947

BackupStatus

string

バックアップステータス。有効な値:

  • Success:バックアップは完了しました。

  • Failed:バックアップが失敗しました。

Success

BackupType

string

バックアップタイプ。フルバックアップのみがサポートされます。値は FullBackup で固定です。

FullBackup

BackupStartTime

string

バックアップの開始時刻 (UTC)。

2020-11-15T07:30:05Z

BackupEndTime

string

バックアップの終了時刻 (UTC)。

2020-05-12T03:25:55Z

BackupId

string

バックアップセット ID。

111111111

DBClusterId

string

クラスター ID。

pc-****************

BackupsLevel

string

バックアップレベル。有効な値:

  • Level-1:レベル 1 バックアップ。

  • Level-2:レベル 2 バックアップ。

Level-2

BackupMode

string

バックアップモード。有効な値:

  • Automated:自動バックアップ。

  • Manual:手動バックアップ。

Manual

BackupMethod

string

バックアップ方法。スナップショットバックアップのみがサポートされます。値は Snapshot で固定です。

Snapshot

DBType

string

データベースエンジンタイプ。

MySQL

DBVersion

string

データベースエンジンバージョン。

5.6

ShareType

string

共有タイプ。

ShareIncoming

PayType

string

課金方法。有効な値:

  • Postpaid:従量課金。

  • Prepaid:前払い (サブスクリプション)。

Postpaid

ServerlessType

string

Serverless タイプ。値が AgileServerless の場合はサーバーレスクラスターを、空の値の場合は標準クラスターを示します。

AgileServerless

RegionId

string

リージョン ID。

cn-hongzhou

SharerUID

string

バックアップセットを共有したアカウントの UID。

170*************

成功レスポンス

JSONJSON

{
  "TotalRecordCount": "16",
  "PageRecordCount": "1",
  "RequestId": "3E5CD764-FCCA-5C9C-838E-20E0DE84B2AF",
  "PageNumber": "1",
  "Items": [
    {
      "BackupSetSize": "4639948800",
      "ConsistentTime": "1589253947",
      "BackupStatus": "Success",
      "BackupType": "FullBackup",
      "BackupStartTime": "2020-11-15T07:30:05Z",
      "BackupEndTime": "2020-05-12T03:25:55Z",
      "BackupId": "111111111",
      "DBClusterId": "pc-****************",
      "BackupsLevel": "Level-2",
      "BackupMode": "Manual",
      "BackupMethod": "Snapshot",
      "DBType": "MySQL",
      "DBVersion": "5.6",
      "ShareType": "ShareIncoming",
      "PayType": "Postpaid",
      "ServerlessType": "AgileServerless",
      "RegionId": "cn-hongzhou",
      "SharerUID": "170*************"
    }
  ]
}

エラーコード

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

変更履歴

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