getCloudPostgresqlBackupList

Prev Next

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

VPC環境で利用できます。

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

コマンド

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

ncloud vpostgresql getCloudPostgresqlBackupList [regionCode] [pageNo] [pageSize] [output]

パラメータ

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

パラメータ タイプ 要否 説明 制約事項
regionCode String N リージョンコード
- regionCodeは、getRegionListアクションを通じて取得
- default: getRegionList照会結果の最初のリージョンを選択
-
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
-

レスポンス

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

  • CloudPostgresqlBackupListタイプ
CloudPostgresqlBackupList extends CommonResponse 説明
private Integer totalRows; 照会されたリストの総数
private List<CloudPostgresqlBackup> cloudPostgresqlBackupList = new ArrayList<>(); Cloud DB for PostgreSQLバックアップリスト
  • CloudPostgresqlBackupタイプ
CloudPostgresqlBackup 説明
private String cloudPostgresqlInstanceNo; Cloud DB for PostgreSQLのインスタンス番号
private String cloudPostgresqlServiceName; Cloud DB for PostgreSQLのサービス名
private String backupType; バックアップタイプ
private Integer backupRetention; バックアップファイルの保存期間
private String backupTime; バックアップ時間
private Long backupSize; バックアップサイズ
private Date lastBackupDate; 最終バックアップ日

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

呼び出し例

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

ncloud vpostgresql getCloudPostgresqlBackupList --regionCode KR

レスポンス例

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

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

{
  "getCloudPostgresqlBackupListResponse": {
    "requestId": "2086d40d-d152-49a7-aa26-effaecb5a616",
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": "1",
    "cloudPostgresqlBackupList": [
      {
        "cloudPostgresqlInstanceNo": "****890",
        "cloudPostgresqlServiceName": "test-****",
        "backupType": "USER",
        "backupRetention": "10",
        "backupTime": "02:00",
        "backupSize": "571482767",
        "lastBackupDate": "2021-05-28T02:10:00+0900"
      }
    ]
  }
}

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

<getCloudPostgresqlBackupListResponse>
    <requestId>2086d40d-d152-49a7-aa26-effaecb5a616</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudPostgresqlBackupList>
        <cloudPostgresqlBackup>
            <cloudPostgresqlInstanceNo>****890</cloudPostgresqlInstanceNo>
            <cloudPostgresqlServiceName>test-****</cloudPostgresqlServiceName>
            <backupType>USER</backupType>
            <backupRetention>10</backupRetention>
            <backupTime>02:00</backupTime>
            <backupSize>571482767</backupSize>
            <lastBackupDate>2021-05-28T02:10:00+0900</lastBackupDate>
        </cloudPostgresqlBackup>
    </cloudPostgresqlBackupList>
</getCloudPostgresqlBackupListResponse>