List Server Groups
サーバグループを一覧表示します。
APIエンドポイント
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://compute.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://compute.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI
GET
/v2.1/{project_id}/os-server-groups
HTTPステータスコード
正常時:200
エラー時:401, 403
リクエストパラメータの説明
名前 | In | Type |
デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
project_id | path | string | 必須 | プロジェクトのUUID |
all_projects | query | string | 任意 | すべてのプロジェクトのサーバグループを表示します。クエリ―に管理者でないユーザーのプロジェクトを指定する場合は、そのプロジェクトのサーバグループを表示します。 |
limit | query | integer | 任意 | offsetと組み合わせて、項目の一部分を表示します。limitは表示する項目の最大数です。省略する場合、またはmax_limitより高い値を表示する場合は、max_limitが指定されます。 |
offset | query | integer | 任意 | limitと組み合わせて、項目の一部分を表示します。offsetは表示するリストの開始位置です。 |
レスポンスボディ(正常系)の説明
名前 | Type | Description |
---|---|---|
server_groups | array | サーバグループ |
id | string | サーバグループのUUID |
name | string | サーバグループ名 |
policies | array |
サーバグループに関連付けるポリシー 「anti-affinity」または「affinity」のどちらかです。 ポリシーについては、機能説明書の「サーバグループ機能」を参照してください。 注: マイクロバージョン2.63までは表示されます。
|
members | array | サーバグループのメンバー |
metadata | object |
メタデータのキーと値のペア 最大値は255です。 注: マイクロバージョン2.63までは表示されます。
|
project_id | string |
サーバグループの所有者のプロジェクトID
注: 表示するにはマイクロバージョン2.13以上を指定してください。
|
user_id | string |
サーバグループの所有者のユーザーID
注: 表示するにはマイクロバージョン2.13以上を指定してください。
|
レスポンス例
{
"server_groups": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "test",
"policies": ["anti-affinity"],
"members": [],
"metadata": {}
}
]
}