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

GetNodePool

処理概要

ノードプールの情報を取得します。

リクエストURL

GET /v1/clusters/{ClusterName}/nodePools/{NodePoolName}

指定するパラメーター

パスパラメーター

パラメーター	型	説明	必須
ClusterName	string	情報を取得したいノードプールが属しているクラスター名	○
NodePoolName	string	情報を取得したいノードプール名、もしくはNRN	○

応答フィールド

フィールド (項目)	型	説明
nodePool	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	タグ値

リクエストサンプル

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

  

応答サンプル

    {
  "nodePool": {
    "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:c22fa663-0502-45cc-894d-dccfdcd3c20d",
    "tags": [
      {
        "id": "31fac2be-013e-4702-b5ba-5d49b7d8e7b7",
        "key": "key01",
        "value": "value01"
      }
    ]
  }
}