api-guide: Fix available info in handling down cells

Add the 'security_groups' parameter as available infomation
in the "List Servers Detailed" API (GET /servers/detail)
when there is a down cell.

Change-Id: I9653a46478c80b343a5a5f8d6b1607688538b1d5
CLoses-Bug: #1846559
This commit is contained in:
Takashi NATSUME 2019-10-04 12:44:30 +09:00
parent 27818dd607
commit 9a5da92524

View File

@ -68,6 +68,7 @@ behavior are described below:
- tenant_id: The tenant_id to which the server belongs to.
- created: The time of server creation.
- links: Links to the servers in question.
- security_groups: One or more security groups. (Optional)
A sample response for a GET /servers/details request that includes
one result each from an unreachable and a healthy part of the
@ -79,9 +80,14 @@ behavior are described below:
"servers": [
{
"created": "2018-06-29T15:07:29Z",
"id": "bcc6c6dd-3d0a-4633-9586-60878fd68edb",
"status": "UNKNOWN",
"tenant_id": "940f47b984034c7f8f9624ab28f5643c",
"id": "bcc6c6dd-3d0a-4633-9586-60878fd68edb",
"security_groups": [
{
"name": "default"
}
],
"links": [
{
"href": "http://openstack.example.com/v2.1/6f70656e737461636b20342065766572/servers/bcc6c6dd-3d0a-4633-9586-60878fd68edb",