skr

IaaS Archive API: ゾーン内のアーカイブを検索・参照する

Archive API で対象ゾーンのアーカイブを検索し、ID、名前、説明、ディスクプラン、サイズ、タグなどを確認できます。アーカイブをディスクのコピー元として選ぶ場合は、ディスクの作成・変更で作成先のゾーンとディスクプラン、サイズも確認してください。

前提条件

手順

この手順は読み取り専用です。クラウドリソースは作成、変更、削除しません。

1. 対象プロファイルとコマンドを確認する

$ skr config current
$ skr iaas-api archive --help
$ skr iaas-api archive find --help
$ skr iaas-api archive read --help

検索では単一のゾーン名を指定します。--zone all によるゾーン横断検索はできません。

2. OS 種別で公開アーカイブを検索する

$ skr iaas-api archive find --zone ZONE --os-type ubuntu2404 --query 'map({ID,Name,Description,DiskPlanID,DiskPlanName,SizeMB,Tags})'

ZONE は検索対象のゾーンに置き換えます。--os-type には ubuntu2404、debian12、almalinux9 などの公開アーカイブ OS 種別を指定できます。OS 種別の指定では、SDK が提供するアーカイブ OS 種別を使います。

名前またはタグで検索する場合は --os-type を併用できません。名前の検索は Names 配列を JSON で渡します。次を archive-find.json に保存し、ZONE とアーカイブ名を置き換えてください。

{
  "Zone": "ZONE",
  "Names": ["ARCHIVE-NAME"]
}

$ skr iaas-api archive find --request @archive-find.json --query 'map({ID,Name,Description,DiskPlanID,DiskPlanName,SizeMB,Tags})'

タグで検索する場合は --tags にカンマ区切りで指定するか、JSON の Tags 配列を使います。--request と個別フラグは併用できません。

3. アーカイブを ID で参照する

検索結果から確認した ID を使い、同じゾーンのアーカイブ情報を取得します。

$ skr iaas-api archive read --zone ZONE --id ARCHIVE-ID

ZONE と ARCHIVE-ID は実際の値に置き換えます。検索結果と参照結果は JSON で出力されます。検索結果を必要なフィールドだけの配列で表示するには、map({ID,Name,DiskPlanID,DiskPlanName,SizeMB,Tags}) を --query に指定します。参照結果を必要なフィールドだけのオブジェクトで表示するには、{ID,Name,DiskPlanID,DiskPlanName,SizeMB,Tags} を指定します。

クリーンアップ

この手順は読み取り専用の検索・参照です。削除するリソースはありません。

参考資料