ニフクラAPI (Kubernetes Service Hatoba: CreateCluster)

CreateCluster

処理概要

クラスターを新規作成します。

リクエストURL

POST /v1/clusters

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
cluster	object
␣name	string	クラスター名使用可能文字: 半角英数字40文字以内	○
␣description	string	メモ使用可能文字: 全角半角255文字以内
␣kubernetesVersion	string	構築するKubernetesのバージョン値: v1.19.6 \| v1.20.1 Default: v1.20.1
␣locations	string[]	クラスタを構築するゾーン	○
␣addonsConfig	object
␣␣httpLoadBalancing	object
␣␣␣disabled	boolean	HTTPロードバランサーアドオンの有効、無効値: false (有効) \| true (無効) Default: false (有効)
␣nodePools[]	object[]
␣␣name	string	ノードプール名使用可能文字: 半角英数字40文字以内	○
␣␣instanceType	string	ノードプール内に作成するノードのサーバータイプ値: e-medium \| medium \| e-medium4 \| medium4 \| e-medium8 \| medium8 \| e-large \| large \| e-large8 \| large8	○
␣␣nodeCount	integer	ノードプール内に作成するノードの数 Default: 1
␣networkConfig	object
␣␣networkId	string	ネットワークID 値: net-COMMON_PRIVATE (共通プライベート) \| プライベートLANのネットワークID Default: net-COMMON_PRIVATE (共通プライベート)
␣firewallGroup	string	適用するファイアウォールグループ名	○

応答フィールド

フィールド (項目)	型	説明
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 (エラー)
␣locations	string[]	ゾーン情報
␣networkConfig	object
␣␣networkId	string	接続しているプライベートLANのネットワークID 値: net-COMMON_PRIVATE (共通プライベート) \| プライベートLANのネットワークID
␣firewallGroup	string	ファイアウォールグループ名
␣nodeCount	integer	現在の全ノード数 (マスターノードは除く)
␣initialNodeCount	integer	クラスター作成時の全ノード数 (マスターノードは除く)
␣createTime	string	クラスターの作成日時
␣status	string	クラスターのステータス値: PROVISIONING (クラスター作成中) \| RUNNING (稼働中) \| RECONCILING (設定変更中) \| STOPPING (削除中) \| DEGRADED (デグレード中) \| ERROR (エラー)

リクエストサンプル

    curl -XPOST https://jp-east-1.hatoba.api.nifcloud.com/v1/clusters
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."
  -d {
    "cluster": {
      "name": "cluster01",
      "description": "memo",
      "locations": [
        "east-11"
      ],
      "nodePools": [
        {
          "name": "nodepool01",
          "instanceType": "e-medium",
          "nodeCount": 1
        }
      ],
      "networkConfig": {
        "networkId": "net-COMMON_PRIVATE"
      },
      "firewallGroup": "default"
    }
  }

応答サンプル

    {
  "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-5jton1",
            "availabilityZone": "east-11",
            "publicIpAddress": "",
            "privateIpAddress": "",
            "status": "PROVISIONING"
          }
        ]
      }
    ],
    "locations": [
      "east-11"
    ],
    "networkConfig": {
      "networkId": "net-COMMON_PRIVATE"
    },
    "firewallGroup": "firewall01",
    "nodeCount": 1,
    "initialNodeCount": 1,
    "createTime": "2019-07-24T00:00:00Z",
    "status": "PROVISIONING"
  }
}