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

ListDisks

処理概要

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

リクエストURL

GET /v1/disks

指定するパラメーター

クエリパラメーター

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

応答フィールド

フィールド (項目)	型	説明
disks[]	object[]
␣name	string	ディスク名
␣description	string	メモ
␣type	string	ディスクタイプ
␣size	integer	ディスクサイズ
␣availability_zone	string	ディスクのゾーン情報
␣cluster	object
␣␣name	string	ディスク接続しているクラスター名
␣tags[]	object[]
␣␣id	string	タグID
␣␣key	string	タグキー
␣␣value	string	タグ値
␣attachments[]	object[]
␣␣nodeName	string	接続しているノード名
␣␣attachTime	string	ノードに接続した日時
␣␣devicePath	string	ディスクの接続デバイス
␣␣status	string	ディスク接続ステータス 値: ATTACHING (接続処理中) ATTACHED (接続中) DETACHING (切断処理中)
␣status	string	ディスクのステータス 値: CREATING (作成中) READY (利用可能) DELETING (削除中) RESIZING (サイズ変更中) FAILED (エラー)
␣createTime	string	ディスクの作成日時
␣nrn	string	NRN

リクエストサンプル

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

  

応答サンプル

    {
  "disks": [
    {
      "name": "disk01",
      "description": "memo",
      "type": "standard-flash-a",
      "size": 100,
      "availabilityZone": "east-11",
      "cluster": {
        "name": "cluster01"
      },
      "tags": [
        {
          "id": "d630411f-d567-48de-be1b-3f9e5d82d53b",
          "key": "key01",
          "value": "value01"
        }
      ],
      "attachments": [
        {
          "nodeName": "node01",
          "attachTime": "",
          "devicePath": "",
          "status": "ATTACHED"
        }
      ],
      "status": "READY",
      "createTime": "2019-07-24T00:00:00Z",
      "nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:disk:48dd7202-e5fe-4d71-9073-969b6dd46a7d",
    }
  ]
}