skr

IaaS Disk API: ディスクを作成・確認・削除する

ディスクは、サーバ作成時に同時に作成するほか、単独で作成して後からサーバへ接続できます。このチュートリアルでは is1b ゾーンにサーバ未接続のディスクを作成し、検索、参照、名前の更新、削除までを扱います。サーバへの接続やディスク内のデータ操作は行いません。

[!WARNING] ディスク作成・更新・削除は選択中のプロジェクトに影響します。対象プロファイル、プロジェクト、ゾーン、ディスクプラン、サイズを確認し、必要な承認を得てから実行してください。ディスクの料金はプラン、サイズ、ゾーンによって異なります。削除したディスクは復旧できません（ディスクの作成/削除/変更）。

前提条件

作成するリソースと順序

作成するのは is1b の SSD プランであるディスク1個です。Connection は virtio、サイズは 20 GB とし、サーバには接続しません。SDK の DiskPlanID、Connection、SizeGB はディスク作成リクエストのフィールドです（Disk API、DiskPlan API）。

Step 1: 対象環境とヘルプを確認する

$ skr config current
$ skr iaas-api --help
$ skr iaas-api disk --help
$ skr iaas-api disk find --help
$ skr iaas-api disk read --help
$ skr iaas-api disk create --help
$ skr iaas-api disk update --help
$ skr iaas-api disk delete --help

意図したプロファイル、プロジェクト、認証情報を確認します。作成と更新では単純な値を個別フラグで指定でき、複雑な値は --request にインライン JSON または @ファイル名 で指定できます。両方の入力経路は併用できません。作成の DistantFrom と EditParameter、更新の EditParameter は JSON で指定します。タグは個別フラグではカンマ区切り、JSON では Tags の文字列配列で指定できます。API の結果は JSON で出力し、--query で必要な項目を抽出できます。

検索では対象のゾーンを明示してください。

Step 2: ディスク作成の入力を用意する

TEST-DISK-NAME を対象プロジェクト内で重複しないテスト専用名に置き換えてください。DiskPlanID 4 は is1b の SSD プラン、SizeGB 20 はそのプランで利用できるサイズです。これらの値は対象ゾーンとプランに合わせてください。

単純な入力には個別フラグを使えます。Zone、Name、DiskPlanID、Connection、SizeGB は必須です。Tags や Description などの独立したスカラー値も指定できます。

$ skr iaas-api disk create \
    --zone is1b \
    --name TEST-DISK-NAME \
    --disk-plan-id 4 \
    --connection virtio \
    --size-gb 20 \
    --tags tutorial

同じ値は JSON リクエストでも指定できます。JSON の Tags は文字列配列です。複雑な入力が必要な場合は JSON ファイルを使ってください。

次の内容を disk-create.json として保存してください。

{
  "Zone": "is1b",
  "Name": "TEST-DISK-NAME",
  "DiskPlanID": 4,
  "Connection": "virtio",
  "SizeGB": 20,
  "Tags": ["tutorial"]
}

この例ではディスクの内容のコピー元やサーバ ID を指定していないため、サーバ未接続のディスクを作成します。個別フラグと JSON は同じリクエストを組み立てますが、1回のコマンドでは併用できません。作成時の DistantFrom と EditParameter は JSON で指定します。既存ディスクやアーカイブからコピーする場合は、disk create --help にある SourceDiskID または SourceArchiveID などを指定してください。コピー元、サイズ、プランの組み合わせは作成前に確認してください。

Step 3: ディスクを作成し、検索・参照する

Step 2 のフラグ例、または次の JSON 入力例のどちらか一方を使います。

$ skr iaas-api disk create --request @disk-create.json

成功すると Disk の情報が出力されます。2つの入力例からは同じフィールドを持つリクエストが作られます。以降の操作で使う ID を控えてください。123456789012 は仮の値です。作成結果の ID に置き換えて検索・参照してください。

$ skr iaas-api disk find --request='{"Zone":"is1b","Names":["TEST-DISK-NAME"],"Tags":["tutorial"]}' --query 'map({ID,Name,SizeMB})'
$ skr iaas-api disk find --zone is1b --tags tutorial --query 'map({ID,Name,SizeMB})'

--request を使う検索では Tags を JSON の文字列配列で指定できます。上の1行目のように名前とタグの両方で検索する場合は JSON を使います。2行目のようにタグだけで検索する場合は、--tags にカンマ区切りで指定できます。--request と個別フラグは併用できません。

次は CLI テストで確認した出力形式の例です。ID と名前は置き換えています。

[
  {
    "ID": 123456789012,
    "Name": "TEST-DISK-NAME",
    "SizeMB": 20480
  }
]

$ skr iaas-api disk read --zone is1b --id 123456789012

検索結果と参照結果の ID、Name、SizeMB が作成したディスクに一致することを確認してください。

Step 4: 名前を更新する

ID と UPDATED-TEST-DISK-NAME を実際の値に置き換えて、名前をフラグで更新します。更新する項目だけを指定し、省略した項目は変更しません。

$ skr iaas-api disk update --zone is1b --id 123456789012 --name UPDATED-TEST-DISK-NAME

JSON を使う場合は、次の内容を disk-update.json として保存します。タグなどの配列を更新する場合も JSON を利用できます。

{
  "Zone": "is1b",
  "ID": 123456789012,
  "Name": "UPDATED-TEST-DISK-NAME"
}

JSON 入力を使う場合は、次のコマンドで更新します。

$ skr iaas-api disk update --request @disk-update.json

フラグ例または JSON 入力例のどちらかで更新した後、名前が変わったことを次のコマンドで確認します。

$ skr iaas-api disk read --zone is1b --id 123456789012

再度参照し、Name が更新後の値であることを確認してください。

Step 5: ディスクを削除する

削除前に read で ID と名前を確認してください。サーバに接続中のディスクは削除できません。削除は復旧できないため、対象を取り違えないようにしてください。

$ skr iaas-api disk delete --zone is1b --id 123456789012 --fail-if-not-found
$ skr iaas-api disk find --request='{"Zone":"is1b","Names":["UPDATED-TEST-DISK-NAME"]}' --query 'map({ID,Name})'

削除成功時、delete は標準出力に何も出しません。検索結果に削除した ID が含まれないことを確認してください。

[]

参考情報