He Jie Xu
469771a3b5
* Add notes for API bug: update return string type's agent id * Fix the parameters for create agent * Fix the description of agent id in the update url. Part of bp:api-ref-in-rst Change-Id: I5c102ef8a08123089ec4a85dde5716eda12fb8c7
160 lines
3.4 KiB
ReStructuredText
160 lines
3.4 KiB
ReStructuredText
.. -*- rst -*-
|
|
|
|
==========================
|
|
Guest agents (os-agents)
|
|
==========================
|
|
|
|
Creates, lists, updates, and deletes guest agent builds. Use guest
|
|
agents to access files on the disk, configure networking, or run other
|
|
applications or scripts in the guest while the agent runs. This
|
|
hypervisor-specific extension is not currently enabled for KVM. Use of
|
|
guest agents is possible only if the underlying service provider uses
|
|
the Xen driver.
|
|
|
|
Create Agent Build
|
|
==================
|
|
|
|
.. rest_method:: POST /v2.1/{tenant_id}/os-agents
|
|
|
|
Creates an agent build.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- hypervisor: hypervisor
|
|
- architecture: architecture
|
|
- os: os
|
|
- url: url
|
|
- md5hash: md5hash
|
|
- version: version
|
|
|
|
**Example Create Agent Build: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- hypervisor: hypervisor
|
|
- architecture: architecture
|
|
- os: os
|
|
- url: url
|
|
- md5hash: md5hash
|
|
- version: version
|
|
- agent_id: agent_id
|
|
|
|
**Example Create Agent Build: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-agents/agent-post-resp.json
|
|
:language: javascript
|
|
|
|
List Agent Builds
|
|
=================
|
|
|
|
.. rest_method:: GET /v2.1/{tenant_id}/os-agents
|
|
|
|
Lists agent builds.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- agent_id: agent_id
|
|
- architecture: architecture
|
|
- hypervisor: hypervisor
|
|
- url: url
|
|
- md5hash: md5hash
|
|
- version: version
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Agent Builds: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-agents/agents-get-resp.json
|
|
:language: javascript
|
|
|
|
Delete Agent Build
|
|
==================
|
|
|
|
.. rest_method:: DELETE /v2.1/{tenant_id}/os-agents
|
|
|
|
Deletes an existing agent build.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
|
|
Response
|
|
--------
|
|
|
|
Update Agent Build
|
|
==================
|
|
|
|
.. rest_method:: PUT /v2.1/{tenant_id}/os-agents/{agent_build_id}
|
|
|
|
Updates an agent build.
|
|
|
|
Normal response codes: 200
|
|
|
|
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
|
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- tenant_id: tenant_id
|
|
- agent_build_id: agent_build_id
|
|
- url: url
|
|
- md5hash: md5hash
|
|
- version: version
|
|
|
|
**Example Update Agent Build: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-put-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- agent_id: agent_id_str
|
|
- url: url
|
|
- md5hash: md5hash
|
|
- version: version
|
|
|
|
**Example Update Agent Build: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/os-agents/agent-update-put-resp.json
|
|
:language: javascript
|
|
|