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

ニフクラユーザーガイド

クラウドトップ>Kubernetes Service Hatoba> API> ListClusters

ListClusters

処理概要

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

リクエストURL

GET /v1/clusters

指定するパラメーター

クエリパラメーター

パラメーター	型	説明	必須
filters	string	取得対象のクラスターのフィルター。タグのキーと値の組み合わせによってフィルタリング可能。例) tags.owner=user01 AND tags.owner=user02

応答フィールド

フィールド (項目)	型	説明
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 (エラー)
␣␣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 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"
            }
          ],
          "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:node-pool:4ca8d005-a568-4d21-8d65-c8db0ac6c9c0",
          "tags": [
            {
              "id": "66661cb9-edc5-45b3-a823-5b4623d48d10",
              "key": "key01",
              "value": "value01"
            }
          ]
        }
      ],
      "locations": [
        "east-11"
      ],
      "networkConfig": {
        "networkId": "net-COMMON_PRIVATE"
      },
      "firewallGroup": "firewall01",
      "nodeCount": 1,
      "initialNodeCount": 1,
      "createTime": "2019-07-24T00:00:00Z",
      "status": "RUNNING",
      "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"
        }
      ]
    }
  ]
}