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

CreateCluster

処理概要

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

リクエストURL

POST /v1/clusters

指定するパラメーター

リクエストボディ

パラメーター	型	説明	必須
cluster	object
␣name	string	クラスター名 使用可能文字: 半角英数小文字40文字以内	○
␣description	string	メモ 使用可能文字: 全角半角255文字以内
␣kubernetesVersion	string	構築するKubernetesのバージョン 値: v1.21.1 | v1.21.5 | v1.21.9 | v1.22.2 | v1.22.6 | v1.23.3 Default: v1.23.3
␣locations	string[]	クラスタを構築するゾーン	○
␣addonsConfig	object
␣␣httpLoadBalancing	object
␣␣␣disabled	boolean	HTTPロードバランサーアドオンの有効、無効 値: false (有効) | true (無効) Default: false (有効)
␣nodePools[]	object[]
␣␣name	string	ノードプール名 使用可能文字: 半角英数小文字40文字以内	○
␣␣instanceType	string	ノードプール内に作成するノードのサーバータイプ 値: c-medium | e-medium | medium | c-medium4 | e-medium4 | medium4 | c-medium8 | e-medium8 | medium8 | e-medium16 | medium16 | e-medium24 | medium24 | c-large | e-large | large | c-large8 | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large8 | extra-large8 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-extra-large48 | extra-large48 | e-double-large16 | double-large16 | e-double-large24 | double-large24 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96	○
␣␣nodeCount	integer	ノードプール内に作成するノードの数 Default: 1
␣networkConfig	object
␣␣networkId	string	ネットワークID Default: net-COMMON_PRIVATE (共通プライベート) 使用可能文字: net-COMMON_PRIVATE(共通プライベートにする場合) | プライベートLANのネットワークユニークID(プライベートLANにする場合)
␣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
␣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"
  }
}