Update Server#
サーバを更新します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://compute.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://compute.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/v2.1/{project_id}/servers/{server_id}
HTTPステータスコード#
正常時:200
エラー時:400, 401, 403, 404
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
project_id | path | string | 必須 | プロジェクトのUUID |
server_id | path | string | 必須 | サーバのUUID |
accessIPv4 | body | string | 任意 | サーバにアクセスするためのIPv4アドレス |
name | body | string | 任意 | サーバ名 📒注: - サーバ名に日本語を含める場合、UTF8換算で63byte以下になるように指定してください。 - サーバ名に以下の文字は使用しないでください。 - 小なり不等号(<) - 大なり不等号(>) - アンパサンド(&) - シングルクォート(') - ダブルクォート(") - パーセント(%) - アットマーク(@) |
OS-DCF:diskConfig | body | string | 任意 | サーバの作成、再構築、サイズ変更を行う際のディスクパーティショニングモード 「AUTO」または「MANUAL」を指定します。 |
description | body | string | 任意 | サーバの説明 255文字までです。 📒注: 表示するにはマイクロバージョン2.19以上を指定してください。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
server | object | サーバのオブジェクト |
addresses | object | サーバのアドレス |
created | string | リソースの作成日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例は、オフセットの値が「-05:00」です。 |
flavor | object | サーバの作成元のフレーバー情報 |
flavor.id | string | フレーバーのID 📒注: マイクロバージョン2.46までは表示されます。 |
flavor.links | array | フレーバーへのリンク情報 📒注: マイクロバージョン2.46までは表示されます。 |
flavor.vcpus | integer | サーバに割り当てられている仮想CPUの数 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.ram | integer | フレーバーのRAMサイズ(MB単位) 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.disk | integer | ルートディスクのサイズ(GB単位) 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.ephemeral | integer | 揮発性ディスクのサイズ(GB単位) 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.swap | integer | スワップ専用ディスクのサイズ(MB単位) 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.original_name | string | フレーバーの表示名 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.extra_specs | object | フレーバーの拡張仕様のキーと値のペア 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.extra_specs.key | string | フレーバーの拡張仕様のキー 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
flavor.extra_specs.value | string | フレーバーの拡張仕様の値 📒注: 表示するにはマイクロバージョン2.47以上を指定してください。 |
hostId | string | ハッシュされているホストID |
id | string | サーバのUUID |
image | object | サーバのUUIDとリンクURL ボリュームからブートする場合は、「null」です。 |
key_name | string | キーペア名 |
links | array | サーバへのリンクURL |
metadata | object | メタデータのキーと値のペア 最大値は255です。 |
name | string | サーバ名 |
accessIPv4 | string | サーバにアクセスするためのIPv4アドレス |
accessIPv6 | string | サーバにアクセスするためのIPv6アドレス |
OS-DCF:diskConfig | string | サーバの作成、再構築、サイズ変更を行う際のディスクパーティショニングモード 「AUTO」または「MANUAL」を指定します。 |
OS-EXT-AZ:availability_zone | string | アベイラビリティゾーン名 |
OS-EXT-SRV-ATTR:host | string | ホスト名 管理者だけに表示されます。 |
OS-EXT-STS:power_state | integer | 仮想サーバの電源状況 以下のどれかが表示されます。 - 0: NOSTATE - 1: RUNNING - 3: PAUSED - 4: SHUTDOWN - 6: CRASHED - 7: SUSPENDED |
OS-EXT-STS:task_state | string | 仮想サーバのタスク状況 |
OS-EXT-STS:vm_state | string | VMの状況 |
OS-SRV-USG:launched_at | string | サーバの起動日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。 |
OS-SRV-USG:terminated_at | string | サーバの削除日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。 |
progress | integer | ビルド進捗率 |
security_groups | array | セキュリティグループのオブジェクト |
security_group.name | string | セキュリティグループの名前 |
status | string | サーバのステータス |
tenant_id | string | プロジェクトのUUID |
updated | string | サーバの更新日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm 例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。上記の例は、オフセットの値が「-05:00」です。 |
user_id | string | サーバの所有者のユーザーID |
リクエスト例#
{ "server": { "accessIPv4": "1.2.3.4", "accessIPv6": "80fe::", "OS-DCF:diskConfig": "AUTO", "name" : "new-server-test" } }
レスポンス例#
{ "server": { "OS-DCF:diskConfig": "AUTO", "accessIPv4": "1.2.3.4", "accessIPv6": "80fe::", "addresses": { "private": [ { "addr": "192.168.0.3", "version": 4 } ] }, "created": "2012-12-02T02:11:57Z", "description": null, "flavor": { "id": "ce448e97-6b84-4ccb-bcd6-618cea3248fd", "links": [ { "href": "https://compute.jp-east-3.cloud.global.fujitsu.com/6f70656e737461636b20342065766572/flavors/ce448e97-6b84-4ccb-bcd6-618cea3248fd", "rel": "bookmark" } ] }, "hostId": "6e84af987b4e7ec1c039b16d21f508f4a505672bd94fb0218b668d07", "id": "324dfb7d-f4a9-419a-9a19-237df04b443b", "image": { "id": "70a599e0-31e7-49b7-b260-868f441e862b", "links": [ { "href": "http://openstack.example.com/6f70656e737461636b20342065766572/images/70a599e0-31e7-49b7-b260-868f441e862b", "rel": "bookmark" } ] }, "links": [ { "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/servers/324dfb7d-f4a9-419a-9a19-237df04b443b", "rel": "self" }, { "href": "http://openstack.example.com/6f70656e737461636b20342065766572/servers/324dfb7d-f4a9-419a-9a19-237df04b443b", "rel": "bookmark" } ], "metadata": { "My Server Name": "Apache1" }, "name": "new-server-test", "progress": 0, "status": "ACTIVE", "tags": [], "tenant_id": "6f70656e737461636b20342065766572", "updated": "2012-12-02T02:11:58Z", "user_id": "fake" } }