nova/doc/notification_samples/common_payloads/InstancePayload.json
Surya Seetharaman c541ace518 Microversion 2.73: Support adding the reason behind a server lock
This patch adds a new parameter ``locked_reason`` to
``POST /servers/{server_id}/action`` request where the
action is lock. It enables the user to specify a reason when locking
a server.

The locked_reason will be exposed through ``GET servers/{server_id}``,
``GET /servers/detail``, ``POST /servers/{server_id}/action``  where
the action is rebuild and ``PUT servers/{server_id}`` requests' responses.

The InstanceActionNotification will emit the locked_reason
along with the other instance details. This patch hence changes the
payload object to include the "locked_reason" field.

Note that "locked" will be allowed as a valid filtering/sorting parameter
for ``GET /servers/detail`` and ``GET /servers`` from this new microversion.

Implements blueprint add-locked-reason

Change-Id: I46edd595e7417c584106487123774a73c6dbe65e
2019-05-11 21:48:27 +00:00

47 lines
1.5 KiB
JSON

{
"nova_object.data":{
"architecture":"x86_64",
"availability_zone": "nova",
"block_devices": [
{"$ref": "BlockDevicePayload.json#"}
],
"created_at":"2012-10-29T13:42:11Z",
"deleted_at":null,
"display_name":"some-server",
"display_description":"some-server",
"host":"compute",
"host_name":"some-server",
"ip_addresses": [
{"$ref": "IpPayload.json#"}
],
"kernel_id":"",
"key_name": "my-key",
"launched_at":"2012-10-29T13:42:11Z",
"image_uuid": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
"metadata":{},
"locked":false,
"node":"fake-mini",
"os_type":null,
"progress":0,
"ramdisk_id":"",
"reservation_id":"r-npxv0e40",
"state":"active",
"task_state":null,
"power_state":"running",
"tenant_id":"6f70656e737461636b20342065766572",
"terminated_at":null,
"auto_disk_config":"MANUAL",
"flavor": {"$ref": "FlavorPayload.json#"},
"updated_at": "2012-10-29T13:42:11Z",
"user_id":"fake",
"uuid":"178b0921-8f85-4257-88b6-2e743b5a975c",
"request_id": "req-5b6c791d-5709-4f36-8fbe-c3e02869e35d",
"action_initiator_user": "fake",
"action_initiator_project": "6f70656e737461636b20342065766572",
"locked_reason": null
},
"nova_object.name":"InstancePayload",
"nova_object.namespace":"nova",
"nova_object.version":"1.8"
}