Update aggregate#

変更可能な内容は以下のとおりです。

集合体(aggregate)の名前
集合体の説明
集合体に含める仮想サーバのID

APIエンドポイント#

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

HTTPメソッドとURI#

PUT

/v4.0/aggregates/{aggregate_id}

HTTPステータスコード#

正常時：200

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

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

名前	In	Type	デフォルト値 /必須指定	Description
X-Auth-Token	header	string	必須	認証のトークン
Content-Type	header	string	必須	「application/json」を指定します。
name	body	string	任意	集合体(aggregate)の名前。半角英数字記号100文字まで空文字を指定した場合、エラーとなります。
description	body	string	任意	集合体の説明。255文字まで空文字を指定した場合、説明文を削除します。
object_list	body	List<string>	任意	集合体に含める仮想サーバのID リスト形式で指定します。空リストを指定した場合、エラーとなります。

name、description、object_list パラメータのいずれかを必ず指定してください。
いずれも指定されていない場合、エラーとなります。
既存の集合体の情報を、指定されたパラメータに基づいて更新します。
指定されていないパラメータの情報は更新されません。
object_list は指定したリストに置換えられます。
現在のリストに仮想サーバを追加したい場合、object_list には既存の仮想サーバのIDと追加したい仮想サーバのIDをすべて記載してください。

レスポンスボディ（正常系）の説明#

名前	Type	Description
id	string	集合体(aggregate)のID
name	string	集合体(aggregate)の名前
description	string	集合体の説明
object_list	List<string>	集合体に含まれる仮想サーバのID リスト形式で表示されます。

リクエスト例#

curl -X PUT -H "Content-Type: application/json" \
-H "X-Auth-Token: ImFkbWluVVJMIjogImh0dHA6Ly8xMC4x..." \
-d <リクエストボディ> "https://telemetry.jp-west-3.cloud.global.fujitsu.com/v4.0/aggregates/c3f0e684-a685-3781-5f51-e5324d923d6b"

リクエストボディ(JSON形式)の例

{
  "aggregate": {
    "object_list": [
      "22c91117-08de-4894-9aa9-6ef382400985",
      "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
      "a37e2c27-08eb-f049-9a3a-496cae13739e"
    ]
  }
}

レスポンス例#

{
  "aggregate": {
    "id": "c3f0e684-a685-3781-5f51-e5324d923d6b",
    "name": "web-servers",
    "description": "aggregates for web servers",
    "object_list": [
      "22c91117-08de-4894-9aa9-6ef382400985",
      "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
      "a37e2c27-08eb-f049-9a3a-496cae13739e"
    ]
  }
}