6.228. タグ
システム内のタグのコレクションを管理するサービスを表します。
名前 | 概要 |
---|---|
| システムに新しいタグを追加します。 |
| システム内のタグを一覧表示します。 |
6.228.1. add POST
システムに新しいタグを追加します。
たとえば、mytag
という名前の新しいタグをシステムに追加するには、以下のようなリクエストを送信します。
POST /ovirt-engine/api/tags
リクエスト本文は以下のようになります。
<tag> <name>mytag</name> </tag>
root タグは、親タグが指定されていない場合にデフォルトの親タグと見なされる特別な疑似タグになります。root タグを削除したり、親タグを割り当てたりすることはできません。
特定の親タグを持つ新しいタグを作成するには、以下のようなリクエスト本文を送信します。
<tag> <name>mytag</name> <parent> <name>myparenttag</name> </parent> </tag>
名前 | タイプ | 方向 | 概要 |
---|---|---|---|
| In/Out | 追加されたタグ。 |
6.228.2. list GET
システム内のタグを一覧表示します。
たとえば、システム内のタグの完全な階層を一覧表示するには、以下のようなリクエストを送信します。
GET /ovirt-engine/api/tags
<tags> <tag href="/ovirt-engine/api/tags/222" id="222"> <name>root2</name> <description>root2</description> <parent href="/ovirt-engine/api/tags/111" id="111"/> </tag> <tag href="/ovirt-engine/api/tags/333" id="333"> <name>root3</name> <description>root3</description> <parent href="/ovirt-engine/api/tags/222" id="222"/> </tag> <tag href="/ovirt-engine/api/tags/111" id="111"> <name>root</name> <description>root</description> </tag> </tags>
前の XML 出力では、以下のようなタグの階層を確認できます。
root: (id: 111) - root2 (id: 222) - root3 (id: 333)
返されるタグ一覧の順序は保証されません。
名前 | タイプ | 方向 | 概要 |
---|---|---|---|
| In | たどる 必要のある内部リンクを指定します。 | |
| In | 返すタグの最大数を設定します。 | |
| Tag[] | Out | システム内のすべてのタグの一覧。 |
6.228.2.1. follow
たどる 必要のある内部リンクを指定します。これらのリンクで参照されるオブジェクトは、現在の要求の一部としてフェッチされます。詳細は、こちら を参照してください。
6.228.2.2. max
返すタグの最大数を設定します。指定されていない場合は、すべてのタグが返されます。