本文へジャンプします。

ニフクラ ユーザーガイド

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/kubernetes-service-hatoba/api/RestoreClusterFromSnapshot.htmへ移行しました。 今後は新ページをご参照ください。

RestoreClusterFromSnapshot

処理概要

スナップショットから新しいクラスタを作成します。

リクエストURL

POST /v1/snapshots/{SnapshotName}:restore

指定するパラメーター

パスパラメーター
パラメーター 説明 必須
SnapshotName string リストアしたいスナップショット名
リクエストボディ
パラメーター 説明 必須
cluster object
name string クラスター名
使用可能文字: 半角英数小文字またはハイフン(先頭と末尾を除く)40文字以内
description string メモ
使用可能文字: UTF-8で全角半角255文字以内
locations string[] ゾーン
addonsConfig object
httpLoadBalancing object
disabled boolean HTTPロードバランサーアドオンの有効、無効
値:
  • false (有効)
  • true (無効)
Default: false (有効)
firewallGroup string 適用するファイアウォールグループ名
networkConfig object
networkId string ネットワークID
Default: net-COMMON_PRIVATE (共通プライベート)
使用可能文字: net-COMMON_PRIVATE(共通プライベートにする場合) | プライベートLANのネットワークユニークID(プライベートLANにする場合)
tags[] object[]
key string 付与したいタグキー
使用可能文字: UTF-8で全角半角128文字以内
value string 付与したいタグ値
使用可能文字: UTF-8で全角半角256文字以内

応答フィールド

フィールド (項目) 説明
cluster object
name string クラスター名
description string メモ
kubernetesVersion string 現在のKubernetesのバージョン
initialKubernetesVersion string クラスター作成時のKubernetesのバージョン
addonsConfig object
httpLoadBalancing object
disabled boolean HTTPロードバランサーアドオンの有効、無効
値:
  • false (有効)
  • true (無効)
nodePools[] object[]
name string ノードプール名
instanceType string ノードプール内のノードのサーバータイプ
nodeCount integer ノードプール内の現在のノード数
initialNodeCount integer ノードプール作成時に設定したノードプール内のノード数
status string ノードプールのステータス
値:
  • PROVISIONING (ノードプール作成中)
  • RUNNING (稼働中)
  • RUNNING_WITH_ERROR (一部ノードでエラーが発生中)
  • RECONCILING (設定変更中)
  • STOPPING (削除中)
  • ERROR (エラー)
nodes[] object[]
name string ノード名
availabilityZone string ノードが稼働しているゾーン名
publicIpAddress string グローバルIPアドレス
privateIpAddress string プライベートIPアドレス
status string ノードのステータス
値:
  • PROVISIONING (ノード作成中)
  • RUNNING (稼働中)
  • RECONCILING (設定変更中)
  • STOPPING (削除中)
  • ERROR (エラー)
nrn string ノードプールのNRN
tags[] object[]
id string ノードプールのタグID
key string ノードプールのタグキー
value string ノードプールのタグ値
locations string[] ゾーン情報
networkConfig object
networkId string 接続しているプライベートLANのネットワークID
firewallGroup string ファイアウォールグループ名
nodeCount integer 現在の全ノード数 (マスターノードは除く)
initialNodeCount integer クラスター作成時の全ノード数 (マスターノードは除く)
createTime string クラスターの作成日時
status string クラスターのステータス
値:
  • PROVISIONING (クラスター作成中)
  • RUNNING (稼働中)
  • RECONCILING (設定変更中)
  • STOPPING (削除中)
  • DEGRADED (デグレード中)
  • ERROR (エラー)
nrn string NRN
tags[] object[]
id string タグID
key string タグキー
value string タグ値

リクエストサンプル

    curl -XPOST https://jp-east-1.hatoba.api.nifcloud.com/v1/snapshots/snapshot01:restore
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."
  -d {
    "cluster": {
      "name": "cluster01",
      "locations": [
        "east-11"
      ],
      "firewallGroup": "default",
      "networkConfig": {
        "networkId": "net-COMMON_PRIVATE"
      },
      "description": "memo",
      "addonsConfig": {
        "httpLoadBalancing": {
          "disabled": false
        }
      }
    }
  }

  

応答サンプル

    {
  "cluster": {
    "name": "cluster01",
    "description": "memo",
    "kubernetesVersion": "v1.20.1",
    "initialKubernetesVersion": "v1.20.1",
    "addonsConfig": {
      "httpLoadBalancing": {
        "disabled": false
      }
    },
    "nodePools": [
      {
        "name": "nodepool01",
        "instanceType": "e-medium",
        "nodeCount": 1,
        "initialNodeCount": 1,
        "status": "PROVISIONING",
        "nodes": [
          {
            "name": "nodepool01-fgabi1",
            "availabilityZone": "east-11",
            "publicIpAddress": "",
            "privateIpAddress": "",
            "status": "PROVISIONING"
          }
        ],
        "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:node-pool:4ca8d005-a568-4d21-8d65-c8db0ac6c9c0",
        "tags": []
      }
    ],
    "locations": [
      "east-11"
    ],
    "networkConfig": {
      "networkId": "net-COMMON_PRIVATE"
    },
    "firewallGroup": "default",
    "nodeCount": 1,
    "initialNodeCount": 1,
    "createTime": "2019-07-24T00:00:00Z",
    "status": "PROVISIONING"
    "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:cluster:48dd7202-e5fe-4d71-9073-969b6dd46a7d",
    "tags": [
      {
        "id": "d630411f-d567-48de-be1b-3f9e5d82d53b",
        "key": "key01",
        "value": "value01"
      }
    ]
  }
}

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

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