本文へジャンプします。

ニフクラ ユーザーガイド

ListNodePools

処理概要

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

リクエストURL

GET /v1/clusters/{cluster_name}/nodePools

指定するパラメーター

パスパラメーター
パラメーター 説明 必須
cluster_name string ノードプール一覧を取得したいクラスター名

応答フィールド

フィールド (項目) 説明
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 (エラー)

リクエストサンプル

    curl https://jp-east-1.hatoba.api.nifcloud.com/v1/clusters/cluster01/nodePools
  -H "X-Amz-Date: 20190724T000000Z"
  -H "Authorization: AWS4-HMAC-SHA256 ..."

  

応答サンプル

    {
  "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"
        }
      ]
    }
  ]
}

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

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