getCloudPostgresqlBackupDetailList

Prev Next

VPC環境で利用できます。

Cloud DB for PostgreSQLバックアップの詳細リストを照会します。

コマンド

コマンド構文は、次のとおりです。

ncloud vpostgresql getCloudPostgresqlBackupDetailList [regionCode] [cloudPostgresqlInstanceNo] [pageNo] [pageSize] [output]

パラメータ

パラメータについての説明は、次のとおりです。

パラメータ タイプ 要否 説明 制約事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択		 -
cloudPostgresqlInstanceNo String Y Cloud DB for PostgreSQLのインスタンス番号
- cloudPostgresqlInstanceNoは、getCloudPostgresqlInstanceListアクションを通じて取得		 -
pageNo Integer N ページングされた結果のページ番号
- 結果値を、pageNo、pageSizeを利用してページング処理可能		 - Min: 0
pageSize Integer N ページング時に表示する各ページサイズ
- 結果値を、pageNo、pageSizeを利用してページング処理可能
- pageNo入力時に必ず入力		 - Min: 1
- Max: 1000
output String N レスポンス結果のフォーマットタイプ
- options: xml | json
- default: json		 -

レスポンス

レスポンスデータのタイプ

  • CloudPostgresqlBackupDetailListタイプ
CloudPostgresqlBackupDetailList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudPostgresqlBackupDetail> cloudPostgresqlBackupDetailList = new ArrayList<>(); Cloud DB for PostgreSQLバックアップの詳細リスト
  • CloudPostgresqlBackupDetailタイプ
CloudPostgresqlBackupDetail 説明
private String fileName; バックアップファイル名
private Date startTime; バックアップ開始時間
private Date endTime; バックアップ終了時間
private Long backupSize; バックアップサイズ
private Long dataStorageSize; データストレージサイズ
private Long archivedWalFileSize; Archived Wal Fileサイズ

例

呼び出しとレスポンス例を説明します。

呼び出し例

呼び出し例は、次のとおりです。

ncloud vpostgresql getCloudPostgresqlBackupDetailList --regionCode KR --cloudPostgresqlInstanceNo ****890

レスポンス例

レスポンス例は、次のとおりです。

レスポンス結果フォーマットタイプ(output)が jsonのとき

{
  "getCloudPostgresqlBackupDetailListResponse": {
    "requestId": "11ca8ac0-841c-4776-aef5-3feb6eb9440e",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": "1",
    "cloudPostgresqlBackupDetailList": [
      {
        "fileName": "20210528",
        "startTime": "2021-05-28T02:10:00+0900",
        "endTime": "2021-05-28T02:10:10+0900",
        "backupSize": "571482767",
        "dataStorageSize": "10737418240",
        "archivedWalFileSize": "0"
      }
    ]
  }
}

レスポンス結果フォーマットタイプ(output)が xmlの場合

<getCloudPostgresqlBackupDetailListResponse>
    <requestId>d76f9b88-fb9f-44b9-b7a1-f19b4710681e</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlBackupDetailList>
        <cloudPostgresqlBackupDetail>
            <fileName>20210528</fileName>
            <startTime>2021-05-28T02:10:00+0900</startTime>
            <endTime>2021-05-28T02:10:10+0900</endTime>
            <backupSize>571482767</backupSize>
            <dataStorageSize>10737418240</dataStorageSize>
            <archivedWalFileSize>0</archivedWalFileSize>
        </cloudPostgresqlBackupDetail>
    </cloudPostgresqlBackupDetailList>
</getCloudPostgresqlBackupDetailListResponse>