openstack
/
deb-senlin
Code Issues Proposed changes

Merge "Update node API doc"

This commit is contained in:
Jenkins 2017-07-25 02:09:42 +00:00 committed by Gerrit Code Review
parent 9f1f917f6c 7295e6ee3b
commit 0a01df361e
7 changed files with 46 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
api-ref/source/nodes.inc
View File

@ -40,6 +40,9 @@ Request Parameters
- name: name_query
- status: status_query
The sorting keys include ``name``, ``index``, ``status``, ``init_at``,
``created_at`` and ``updated_at``.
Response Parameters
-------------------
@ -50,6 +53,7 @@ Response Parameters
- cluster_id: cluster_id
- created_at: created_at
- data: node_data
- dependents: dependents
- domain: domain
- id: node_id
- index: index
@ -124,6 +128,7 @@ Response Parameters
- cluster_id: cluster_id
- created_at: created_at
- data: node_data
- dependents: dependents
- domain: domain
- id: node_id
- index: index
@ -156,6 +161,8 @@ Adopt node
Adopts a node.
This API is only available since API microversion 1.7.
Response Codes
--------------
@ -231,6 +238,8 @@ Adopt node (preview)
Preview a node adoption.
This API is only available since API microversion 1.7.
Response Codes
--------------
@ -322,6 +331,7 @@ Response Parameters
- cluster_id: cluster_id
- created_at: created_at
- data: node_data
- dependents: dependents
- domain: domain
- id: node_id
- index: index
@ -397,6 +407,7 @@ Response Parameters
- cluster_id: cluster_id
- created_at: created_at
- data: node_data
- dependents: dependents
- domain: domain
- id: node_id
- index: index
@ -504,6 +515,14 @@ Response Parameters
- X-OpenStack-Request-ID: request_id
- Location: location
- action: action_action
Response Example
----------------
.. literalinclude:: samples/node-action-response.json
:language: javascript
Recover a Node to Healthy Status
@ -560,6 +579,13 @@ Response Parameters
- X-OpenStack-Request-ID: request_id
- Location: location
- action: action_action
Response Example
----------------
.. literalinclude:: samples/node-action-response.json
:language: javascript
Perform an Operation on a Node
@ -609,3 +635,10 @@ Response Parameters
- X-OpenStack-Request-ID: request_id
- Location: location
- action: action_action
Response Example
----------------
.. literalinclude:: samples/node-action-response.json
:language: javascript

3
api-ref/source/samples/node-action-response.json Normal file
View File

@ -0,0 +1,3 @@
{
"action": "7f760b61-7b15-4a50-af05-319922fa3229"
}

1
api-ref/source/samples/node-adopt-request.json
View File

@ -1,5 +1,4 @@
{
"cluster": null,
"identity": "65e27958-d6dc-4b0e-87bf-78e8f5536cbc",
"metadata": {},
"name": "node009",

2
api-ref/source/samples/node-adopt-response.json
View File

@ -6,7 +6,7 @@
"domain": null,
"id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
"index": -1,
"init_at": "2015-03-05T08:53:15",
"init_at": "2015-03-05T08:53:15Z",
"metadata": {},
"name": "node009",
"physical_id": "65e27958-d6dc-4b0e-87bf-78e8f5536cbc",

3
api-ref/source/samples/node-create-response.json
View File

@ -3,10 +3,11 @@
"cluster_id": null,
"created_at": null,
"data": {},
"dependents": {},
"domain": null,
"id": "0df0931b-e251-4f2e-8719-4ebfda3627ba",
"index": -1,
"init_at": "2015-03-05T08:53:15",
"init_at": "2015-03-05T08:53:15Z",
"metadata": {},
"name": "node009",
"physical_id": "",

7
api-ref/source/samples/node-list-response.json
View File

@ -2,18 +2,19 @@
"nodes": [
{
"cluster_id": "e395be1e-8d8e-43bb-bd6c-943eccf76a6d",
"created_at": "2016-05-13T07:02:20",
"created_at": "2016-05-13T07:02:20Z",
"data": {},
"dependents": {},
"domain": null,
"id": "82fe28e0-9fcb-42ca-a2fa-6eb7dddd75a1",
"index": 2,
"init_at": "2016-05-13T07:02:04",
"init_at": "2016-05-13T07:02:04Z",
"metadata": {},
"name": "node-e395be1e-002",
"physical_id": "66a81d68-bf48-4af5-897b-a3bfef7279a8",
"profile_id": "d8a48377-f6a3-4af4-bbbb-6e8bcaa0cbc0",
"profile_name": "pcirros",
"project": "eee0b7c083e84501bdd50fb269d2a10e",
"project_id": "eee0b7c083e84501bdd50fb269d2a10e",
"role": "",
"status": "ACTIVE",
"status_reason": "Creation succeeded",

5
api-ref/source/samples/node-show-response.json
View File

@ -1,8 +1,9 @@
{
"node": {
"cluster_id": null,
"created_at": "2015-02-10T12:03:16",
"created_at": "2015-02-10T12:03:16Z",
"data": {},
"dependents": {},
"domain": null,
"id": "d5779bb0-f0a0-49c9-88cc-6f078adb5a0b",
"index": -1,
@ -16,7 +17,7 @@
"role": null,
"status": "ACTIVE",
"status_reason": "Creation succeeded",
"updated_at": "2015-03-04T04:58:27",
"updated_at": "2015-03-04T04:58:27Z",
"user": "5e5bf8027826429c96af157f68dc9072"
}
}