Merge "Update cluster APIs doc"
This commit is contained in:
commit
9f1f917f6c
@ -40,7 +40,8 @@ Request Parameters
|
|||||||
- name: name_query
|
- name: name_query
|
||||||
- status: status_query
|
- status: status_query
|
||||||
|
|
||||||
The sorting key is ``enabled``.
|
The sorting keys include ``name``, ``status``, ``init_at``, ``created_at``,
|
||||||
|
and ``updated_at``.
|
||||||
|
|
||||||
Response Parameters
|
Response Parameters
|
||||||
-------------------
|
-------------------
|
||||||
@ -50,7 +51,9 @@ Response Parameters
|
|||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- clusters: clusters
|
- clusters: clusters
|
||||||
- created_at: created_at
|
- created_at: created_at
|
||||||
|
- config: cluster_config
|
||||||
- data: cluster_data
|
- data: cluster_data
|
||||||
|
- dependents: dependents
|
||||||
- desired_capacity: desired_capacity
|
- desired_capacity: desired_capacity
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- id: cluster_id
|
- id: cluster_id
|
||||||
@ -105,6 +108,7 @@ Request Parameters
|
|||||||
.. rest_parameters:: parameters.yaml
|
.. rest_parameters:: parameters.yaml
|
||||||
|
|
||||||
- OpenStack-API-Version: microversion
|
- OpenStack-API-Version: microversion
|
||||||
|
- config: cluster_config_req
|
||||||
- cluster: cluster
|
- cluster: cluster
|
||||||
- name: cluster_name
|
- name: cluster_name
|
||||||
- desired_capacity: desired_capacity
|
- desired_capacity: desired_capacity
|
||||||
@ -129,8 +133,10 @@ Response Parameters
|
|||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
- cluster: cluster
|
- cluster: cluster
|
||||||
|
- config: cluster_config
|
||||||
- created_at: created_at
|
- created_at: created_at
|
||||||
- data: cluster_data
|
- data: cluster_data
|
||||||
|
- dependents: dependents
|
||||||
- desired_capacity: desired_capacity
|
- desired_capacity: desired_capacity
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- id: cluster_id
|
- id: cluster_id
|
||||||
@ -194,8 +200,10 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- cluster: cluster
|
- cluster: cluster
|
||||||
|
- config: cluster_config
|
||||||
- created_at: created_at
|
- created_at: created_at
|
||||||
- data: cluster_data
|
- data: cluster_data
|
||||||
|
- dependents: dependents
|
||||||
- desired_capacity: desired_capacity
|
- desired_capacity: desired_capacity
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- id: cluster_id
|
- id: cluster_id
|
||||||
@ -252,6 +260,7 @@ Request Parameters
|
|||||||
- OpenStack-API-Version: microversion
|
- OpenStack-API-Version: microversion
|
||||||
- cluster_id: cluster_id_url
|
- cluster_id: cluster_id_url
|
||||||
- cluster: cluster
|
- cluster: cluster
|
||||||
|
- config: cluster_config_req
|
||||||
- name: name_req
|
- name: name_req
|
||||||
- profile_id: profile_identity
|
- profile_id: profile_identity
|
||||||
- timeout: timeout_req
|
- timeout: timeout_req
|
||||||
@ -273,8 +282,10 @@ Response Parameters
|
|||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
- cluster: cluster
|
- cluster: cluster
|
||||||
|
- config: cluster_config
|
||||||
- created_at: created_at
|
- created_at: created_at
|
||||||
- data: cluster_data
|
- data: cluster_data
|
||||||
|
- dependents: dependents
|
||||||
- desired_capacity: desired_capacity
|
- desired_capacity: desired_capacity
|
||||||
- domain: domain
|
- domain: domain
|
||||||
- id: cluster_id
|
- id: cluster_id
|
||||||
@ -397,6 +408,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Scale-in a Cluster
|
Scale-in a Cluster
|
||||||
@ -447,6 +465,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Scale-out a Cluster
|
Scale-out a Cluster
|
||||||
@ -497,6 +522,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Add nodes to a Cluster
|
Add nodes to a Cluster
|
||||||
@ -547,6 +579,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Remove nodes from a Cluster
|
Remove nodes from a Cluster
|
||||||
@ -598,6 +637,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Replace nodes in a Cluster
|
Replace nodes in a Cluster
|
||||||
@ -650,6 +696,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Attach a Policy to a Cluster
|
Attach a Policy to a Cluster
|
||||||
@ -685,7 +738,7 @@ Request Parameters
|
|||||||
- policy_id: policy_identity
|
- policy_id: policy_identity
|
||||||
- enabled: cluster_policy_enabled
|
- enabled: cluster_policy_enabled
|
||||||
|
|
||||||
The ``action_name`` in the request body has to be ``attach_policy``.
|
The ``action_name`` in the request body has to be ``policy_attach``.
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -700,6 +753,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Detach a Policy from a Cluster
|
Detach a Policy from a Cluster
|
||||||
@ -734,7 +794,7 @@ Request Parameters
|
|||||||
- action: action_request
|
- action: action_request
|
||||||
- policy_id: policy_identity
|
- policy_id: policy_identity
|
||||||
|
|
||||||
The ``action_name`` in the request body has to be ``detach_policy``.
|
The ``action_name`` in the request body has to be ``policy_detach``.
|
||||||
|
|
||||||
Request Example
|
Request Example
|
||||||
---------------
|
---------------
|
||||||
@ -749,6 +809,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Update a Policy on a Cluster
|
Update a Policy on a Cluster
|
||||||
@ -799,6 +866,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Collect Attributes Across a Cluster
|
Collect Attributes Across a Cluster
|
||||||
@ -891,6 +965,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Recover a Cluster to a Healthy Status
|
Recover a Cluster to a Healthy Status
|
||||||
@ -953,6 +1034,13 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
|
||||||
|
|
||||||
Perform an Operation on a Cluster
|
Perform an Operation on a Cluster
|
||||||
@ -1002,3 +1090,10 @@ Response Parameters
|
|||||||
|
|
||||||
- X-OpenStack-Request-ID: request_id
|
- X-OpenStack-Request-ID: request_id
|
||||||
- Location: location
|
- Location: location
|
||||||
|
- action: action_action
|
||||||
|
|
||||||
|
Response Example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
.. literalinclude:: samples/cluster-action-response.json
|
||||||
|
:language: javascript
|
||||||
|
@ -511,6 +511,20 @@ cluster_attributes:
|
|||||||
A list of dictionaries each containing the node ID and the corresponding
|
A list of dictionaries each containing the node ID and the corresponding
|
||||||
attribute value.
|
attribute value.
|
||||||
|
|
||||||
|
cluster_config:
|
||||||
|
type: object
|
||||||
|
in: body
|
||||||
|
required: True
|
||||||
|
description: |
|
||||||
|
The structured config associated with the cluster.
|
||||||
|
|
||||||
|
cluster_config_req:
|
||||||
|
type: object
|
||||||
|
in: body
|
||||||
|
required: False
|
||||||
|
description: |
|
||||||
|
The structured config associated with the cluster.
|
||||||
|
|
||||||
cluster_data:
|
cluster_data:
|
||||||
type: object
|
type: object
|
||||||
in: body
|
in: body
|
||||||
@ -662,6 +676,14 @@ depended_by:
|
|||||||
description: |
|
description: |
|
||||||
A list of UUIDs of the actions that depend on the current action.
|
A list of UUIDs of the actions that depend on the current action.
|
||||||
|
|
||||||
|
dependents:
|
||||||
|
type: object
|
||||||
|
in: body
|
||||||
|
required: True
|
||||||
|
description: |
|
||||||
|
A dict contains dependency information between nova server, heat stack
|
||||||
|
cluster and container cluster.
|
||||||
|
|
||||||
depends_on:
|
depends_on:
|
||||||
type: array
|
type: array
|
||||||
in: body
|
in: body
|
||||||
|
3
api-ref/source/samples/cluster-action-response.json
Normal file
3
api-ref/source/samples/cluster-action-response.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"action": "2a0ff107-e789-4660-a122-3816c43af703"
|
||||||
|
}
|
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"attach_policy": {
|
"policy_attach": {
|
||||||
"policy_id": "dp01",
|
"policy_id": "dp01",
|
||||||
"enabled": false
|
"enabled": false
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"cluster": {
|
"cluster": {
|
||||||
|
"config": {},
|
||||||
"desired_capacity": 0,
|
"desired_capacity": 0,
|
||||||
"max_size": -1,
|
"max_size": -1,
|
||||||
"metadata": {},
|
"metadata": {},
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
{
|
{
|
||||||
"cluster": {
|
"cluster": {
|
||||||
|
"config": {},
|
||||||
"created_at": null,
|
"created_at": null,
|
||||||
"data": {},
|
"data": {},
|
||||||
|
"dependents": {},
|
||||||
"desired_capacity": 4,
|
"desired_capacity": 4,
|
||||||
"domain": null,
|
"domain": null,
|
||||||
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
|
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"detach_policy": {
|
"policy_detach": {
|
||||||
"policy_id": "5630fb31",
|
"policy_id": "5630fb31"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"scale_out": {
|
"scale_in": {
|
||||||
"count": 2
|
"count": 2
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
{
|
{
|
||||||
"cluster": {
|
"cluster": {
|
||||||
"created_at": "2015-02-11T15:13:20",
|
"config": {},
|
||||||
|
"created_at": "2015-02-11T15:13:20Z",
|
||||||
"data": {},
|
"data": {},
|
||||||
|
"dependents": {},
|
||||||
"desired_capacity": 0,
|
"desired_capacity": 0,
|
||||||
"domain": null,
|
"domain": null,
|
||||||
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
|
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
|
||||||
|
@ -1,7 +1,9 @@
|
|||||||
{
|
{
|
||||||
"cluster": {
|
"cluster": {
|
||||||
"created_at": "2015-02-11T15:13:20",
|
"config": {},
|
||||||
|
"created_at": "2015-02-11T15:13:20Z",
|
||||||
"data": {},
|
"data": {},
|
||||||
|
"dependents": {},
|
||||||
"desired_capacity": 0,
|
"desired_capacity": 0,
|
||||||
"domain": null,
|
"domain": null,
|
||||||
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
|
"id": "45edadcb-c73b-4920-87e1-518b2f29f54b",
|
||||||
|
@ -1,8 +1,10 @@
|
|||||||
{
|
{
|
||||||
"clusters": [
|
"clusters": [
|
||||||
{
|
{
|
||||||
"created_at": "2015-02-10T14:26:14",
|
"config": {},
|
||||||
|
"created_at": "2015-02-10T14:26:14Z",
|
||||||
"data": {},
|
"data": {},
|
||||||
|
"dependents": {},
|
||||||
"desired_capacity": 4,
|
"desired_capacity": 4,
|
||||||
"domain": null,
|
"domain": null,
|
||||||
"id": "7d85f602-a948-4a30-afd4-e84f47471c15",
|
"id": "7d85f602-a948-4a30-afd4-e84f47471c15",
|
||||||
|
Loading…
Reference in New Issue
Block a user