7f3a778acb
This patch adds the api ref for the agents api. Change-Id: Ie678a23079e4469f43c336e592cb4506d6384992 Closes-Bug: #1639254
178 lines
3.3 KiB
ReStructuredText
178 lines
3.3 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
======
|
|
Agents
|
|
======
|
|
|
|
Lists, shows details for, updates, and deletes agents.
|
|
|
|
List all agents
|
|
===============
|
|
|
|
.. rest_method:: GET /v2.0/agents
|
|
|
|
Shows details for an agent.
|
|
|
|
Use the ``fields`` query parameter to control which fields are
|
|
returned in the response body. For information, see `Filtering and
|
|
Column Selection <http://specs.openstack.org/openstack/neutron-
|
|
specs/specs/api/networking_general_api_information.html#filtering-
|
|
and-column-selection>`__.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- admin_state_up: admin_state_up
|
|
- agents: agents
|
|
- agent_type: agent_type
|
|
- alive: alive
|
|
- binary: binary
|
|
- configurations: configurations
|
|
- created_at: created_at
|
|
- description: description
|
|
- heartbeat_timestamp: heartbeat_timestamp
|
|
- host: host
|
|
- id: id
|
|
- started_at: started_at
|
|
- topic: topic
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/agents/agents-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
Show agent details
|
|
==================
|
|
|
|
.. rest_method:: GET /v2.0/agents/{agent_id}
|
|
|
|
Shows details for an agent.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 401, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- agent_id: agent_id-path
|
|
- fields: fields
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- admin_state_up: admin_state_up
|
|
- agent: agent
|
|
- agent_type: agent_type
|
|
- alive: alive
|
|
- binary: binary
|
|
- configurations: configurations
|
|
- created_at: created_at
|
|
- description: description
|
|
- heartbeat_timestamp: heartbeat_timestamp
|
|
- host: host
|
|
- id: id
|
|
- started_at: started_at
|
|
- topic: topic
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/agents/agent-show-response.json
|
|
:language: javascript
|
|
|
|
Update agent
|
|
==============
|
|
|
|
.. rest_method:: PUT /v2.0/agents/{agent_id}
|
|
|
|
Updates an agent.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: 400, 401, 403, 404
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- agent_id: agent_id-path
|
|
- admin_state_up: admin_state_up-request
|
|
- description: description-request
|
|
|
|
Request Example
|
|
---------------
|
|
|
|
.. literalinclude:: samples/agents/agent-update-request.json
|
|
:language: javascript
|
|
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- admin_state_up: admin_state_up
|
|
- agent: agent
|
|
- agent_type: agent_type
|
|
- alive: alive
|
|
- binary: binary
|
|
- configurations: configurations
|
|
- created_at: created_at
|
|
- description: description
|
|
- heartbeat_timestamp: heartbeat_timestamp
|
|
- host: host
|
|
- id: id
|
|
- started_at: started_at
|
|
- topic: topic
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: samples/agents/agent-update-response.json
|
|
:language: javascript
|
|
|
|
Delete agent
|
|
============
|
|
|
|
.. rest_method:: DELETE /v2.0/agents/{agent_id}
|
|
|
|
Agents that won't be used anymore can be removed. Before deleting agents via
|
|
API, the agent should be stopped/disabled.
|
|
|
|
Normal response codes: 204
|
|
|
|
Error response codes: 401, 404, 409
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- agent_id: agent_id-path
|
|
|
|
Response
|
|
--------
|
|
|
|
There is no body content for the response of a successful DELETE request.
|