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

ListSnapshots

処理概要

スナップショット情報の一覧を取得します。 1回のリクエストで複数のスナップショット情報を取得できます。

リクエストURL

GET /v1/snapshots

指定するパラメーター

クエリパラメーター

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

応答フィールド

フィールド (項目)	型	説明
snapshots[]	object[]
␣name	string	スナップショット名
␣cluster	object
␣␣name	string	スナップショット元クラスター名
␣␣kubernetesVersion	string	スナップショット作成時のクラスターのKubernetesのバージョン
␣␣nodePools[]	object[]
␣␣␣name	string	スナップショット作成時のノードプール名
␣␣␣instanceType	string	スナップショット作成時のノードプール内のノードのサーバータイプ
␣␣␣nodeCount	integer	スナップショット作成時のノードプールのノード数
␣expirationTime	string	スナップショット有効期限
␣description	string	メモ
␣resourceVersion	string	スナップショット取得時点で最後に生成されたKubernetesリソースバージョン
␣createTime	string	スナップショット作成完了日時
␣status	string	ステータス 値: CREATING (作成中) AVAILABLE (利用可能) FAILED (作成失敗) RESTORING (リストア中)
␣nrn	string	NRN
␣tags[]	object[]
␣␣id	string	タグID
␣␣key	string	タグキー
␣␣value	string	タグ値

リクエストサンプル

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

  

応答サンプル

    {
  "snapshots": [
    {
      "name": "snapshot01",
      "cluster": {
        "name": "cluster01",
        "kubernetesVersion": "v1.20.1",
        "nodePools": [
          {
            "name": "nodepool01",
            "instanceType": "e-medium",
            "nodeCount": 1
          }
        ]
      },
      "expirationTime": "2019-07-25T15:00:00Z",
      "description": "memo",
      "resourceVersion": "2576505",
      "createTime": "2019-07-24T00:00:00Z",
      "status": "AVAILABLE",
      "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:snapshot:68632048-c720-4903-83b7-4860a15dffbf",
      "tags": [
        {
          "id": "31fac2be-013e-4702-b5ba-5d49b7d8e7b7",
          "key": "key01",
          "value": "value01"
        }
      ]
    },
    {
      "name": "snapshot02",
      "cluster": {
        "name": "cluster02",
        "kubernetesVersion": "v1.20.1",
        "nodePools": [
          {
            "name": "nodepool02",
            "instanceType": "e-medium",
            "nodeCount": 1
          }
        ]
      },
      "expirationTime": "unlimited",
      "description": "memo",
      "resourceVersion": "2576518",
      "createTime": "2019-07-24T00:10:00Z",
      "status": "AVAILABLE",
      "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:snapshot:dc7dd405-0d88-4777-b5d6-533c8eed6874",
      "tags": []
    }
  ]
}