starlingx/config
Code Issues Proposed changes

Update API document for Storage Backends

Browse Source 
An error occurred while using the API interface
(/v1/storage_backend/usage) in the API documentation.
After analysis, I found that the submission
https://review.opendev.org/#/c/650619/ deleted the URL,
so the URL does not exist in the code, so please update
the API part of the document.

Closes-Bug:#1899138

Change-Id: I557d72507d367c7611102290b4d92419c1f5e9fb
Signed-off-by: XinxinShen<shenxinxin@inspur.com>
This commit is contained in:
XinxinShen 2020-10-09 16:59:38 +08:00
parent 06839f3cbe
commit 66195f0439
1 changed files with 0 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
api-ref/source/api-ref-sysinv-v1-config.rst
View File

@ -8404,55 +8404,6 @@ itemNotFound (404)
This operation does not accept a request body.
*********************************
List the storage backends usage
*********************************
.. rest_method:: GET /v1/storage_backend/usage
**Normal response codes**
200
**Error response codes**
computeFault (400, 500, ...), serviceUnavailable (503), badRequest (400),
unauthorized (401), forbidden (403), badMethod (405), overLimit (413),
itemNotFound (404)
**Response parameters**
.. csv-table::
:header: "Parameter", "Style", "Type", "Description"
:widths: 20, 20, 20, 60
"service_name (Optional)", "plain", "xsd:string", "The name of the storage service."
"name (Optional)", "plain", "xsd:string", "The name of the storage backend."
"backend (Optional)", "plain", "xsd:string", "The type of the storage backend."
"free_capacity (Optional)", "plain", "xsd:decimal", "The free storage capacity in GiB."
"total_capacity (Optional)", "plain", "xsd:decimal", "The total capacity in GiB."
::
[
{
"free_capacity": 7.48,
"service_name": "glance",
"total_capacity": 7.84,
"name": "file-store",
"backend": "file"
},
{
"free_capacity": 6.9,
"service_name": "cinder",
"total_capacity": 6.9,
"name": "lvm-store",
"backend": "lvm"
}
]
This operation does not accept a request body.
***************************
List LVM storage backends
***************************