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

ListClusters

処理概要

クラスターの情報一覧を取得します。 1回のリクエストで、複数のクラスター情報を取得できます。

リクエストURL

GET /v1/clusters

指定するパラメーター

なし

応答フィールド

フィールド (項目)	型	説明
clusters[]	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 https://jp-east-1.hatoba.api.nifcloud.com/v1/clusters
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."

  

応答サンプル

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