Get all aggregates#

集合体(aggregate)を取得します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://telemetry.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://telemetry.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v3.0/aggregates

HTTPステータスコード#

正常時:200

エラー時:400,401,404,500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
X-Auth-Token header string 必須 認証のトークン
X-Auth-Type header string 必須 認証のプラットフォーム
「openstack」を指定します。

レスポンスボディ(正常系)の説明#

名前 Type Description
Name string 集合体(aggregate)の名前
Id string 集合体(aggregate)のID
ObjectList List<string> 集合体に含む対象のID
リスト形式で表示されます。
Type string 対象の種別
「instance」が表示されます。
Metadata string 集合体の付帯情報
Source string 作成元種別
ObjectMap object ※不要な項目

リクエスト例#

curl -H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \
-H "X-Auth-Type: openstack" \
https://<host>:<port>/v3.0/aggregates"

レスポンス例#

{
  "Aggregates": [
    {
      "Aggregate": {
        "ObjectMap": {},
        "Name": "aggregate_name",
        "Source": "user",
        "ObjectList": [
          "instance_id_01",
          "instance_id_02"
        ],
        "Type": "instance",
        "Id": "aggregate_id",
        "Metadata": "Optional setting"
      }
    }
  ]
}