本文へジャンプします。

ニフクラ ユーザーガイド

UpdateSnapshot

処理概要

スナップショットの設定を変更します。

リクエストURL

PUT /v1/snapshots/{snapshot_name}

指定するパラメーター

パスパラメーター
パラメーター 説明 必須
snapshot_name string 設定変更対象のスナップショット名
リクエストボディ
パラメーター 説明 必須
snapshot object
name string 新しいスナップショット名
使用可能文字: 半角英数字40文字以内
expirationTime string 有効期限
description string メモ
使用可能文字: 全角半角255文字以内

応答フィールド

フィールド (項目) 説明
snapshot object
name string スナップショット名
cluster object
name string スナップショット元クラスター名
kubernetesVersion string スナップショット作成時のクラスターのKubernetesのバージョン
nodePools[] object[]
name string スナップショット作成時のノードプール名
instanceType string スナップショット作成時のノードプール内のノードのサーバータイプ
nodeCount integer スナップショット作成時のノードプールのノード数
expirationTime string スナップショット有効期限
description string メモ
resourceVersion string スナップショット取得時点で最後に生成されたKubernetesリソースバージョン
createTime string スナップショット作成完了日時
status string ステータス
値: CREATING (作成中) | AVAILABLE (利用可能) | FAILED (作成失敗) | RESTORING (リストア中)

リクエストサンプル

    curl -XPUT https://jp-east-1.hatoba.api.nifcloud.com/v1/snapshots/snapshot01
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."
  -d {
    "snapshot": {
      "expirationTime": "2019-08-25T15:00:00Z",
      "description": "hoge"
    }
  }

  

応答サンプル

    {
  "snapshot": {
    "name": "snapshot01",
    "cluster": {
      "name": "cluster01",
      "kubernetesVersion": "v1.20.1",
      "nodePools": [
        {
          "name": "nodepool01",
          "instanceType": "e-medium",
          "nodeCount": 1
        }
      ]
    },
    "expirationTime": "2019-08-25T15:00:00Z",
    "description": "hoge",
    "resourceVersion": "2576518",
    "createTime": "2019-07-24T00:00:00Z",
    "status": "AVAILABLE"
  }
}

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

推奨画面サイズ 1024×768 以上