remove /v2.1/{tenant_id} from all urls
As discussed at summit, the version part of the URL is not really relevant, or a thing a user should be filling out themselves, this should instead be set by the service catalog and extracted from the token. This removes it's reference in all documented REST urls, and adds a new section describing how one gets the base URL for all calls. Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
This commit is contained in:
parent
cfd64c976b
commit
c9f5ad3bcf
@ -9,7 +9,7 @@ Shows the usage data for a server.
|
||||
Show Server Diagnostics
|
||||
=======================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/diagnostics
|
||||
.. rest_method:: GET /servers/{server_id}/diagnostics
|
||||
|
||||
Shows basic usage data for a server.
|
||||
|
||||
@ -26,7 +26,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
|
||||
Response
|
||||
|
@ -25,7 +25,7 @@ For information about extensions, see `Extensions
|
||||
List Extensions
|
||||
===============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/extensions
|
||||
.. rest_method:: GET /extensions
|
||||
|
||||
Lists all extensions to the API.
|
||||
|
||||
@ -33,12 +33,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -64,7 +58,7 @@ Lists all extensions to the API.
|
||||
Show Extension Details
|
||||
======================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/extensions/{alias}
|
||||
.. rest_method:: GET /extensions/{alias}
|
||||
|
||||
Shows details for an extension, by alias.
|
||||
|
||||
@ -77,7 +71,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- alias: alias
|
||||
|
||||
Response
|
||||
|
@ -13,7 +13,7 @@ allocated to a server built with this flavor.
|
||||
List Flavors
|
||||
============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/flavors
|
||||
.. rest_method:: GET /flavors
|
||||
|
||||
Lists all flavors accessible to your project.
|
||||
|
||||
@ -26,7 +26,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- limit: limit
|
||||
@ -56,7 +55,7 @@ that was not customized by the site operators.
|
||||
Create Flavor
|
||||
=============
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/flavors
|
||||
.. rest_method:: POST /flavors
|
||||
|
||||
Creates a flavor.
|
||||
|
||||
@ -73,7 +72,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- flavor: flavor
|
||||
- name: flavor_name
|
||||
- id: flavor_id_body
|
||||
@ -95,7 +93,6 @@ Response
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- flavor: flavor
|
||||
- name: flavor_name
|
||||
- id: flavor_id_body
|
||||
@ -118,7 +115,7 @@ Response
|
||||
List Flavors With Details
|
||||
=========================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/flavors/detail
|
||||
.. rest_method:: GET /flavors/detail
|
||||
|
||||
Lists flavors with details.
|
||||
|
||||
@ -131,7 +128,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- sort_key: sort_key
|
||||
- sort_dir: sort_dir
|
||||
- limit: limit
|
||||
@ -146,7 +142,6 @@ Response
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- flavors: flavors
|
||||
- name: flavor_name
|
||||
- id: flavor_id_body
|
||||
@ -168,7 +163,7 @@ Response
|
||||
Show Flavor Details
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/flavors/{flavor_id}
|
||||
.. rest_method:: GET /flavors/{flavor_id}
|
||||
|
||||
Shows details for a flavor.
|
||||
|
||||
@ -181,7 +176,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- flavor_id: flavor_id
|
||||
|
||||
Response
|
||||
@ -189,7 +183,6 @@ Response
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- flavor: flavor
|
||||
- name: flavor_name
|
||||
- id: flavor_id_body
|
||||
@ -211,7 +204,7 @@ Response
|
||||
Delete Flavor
|
||||
=============
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/flavors/{flavor_id}
|
||||
.. rest_method:: DELETE /flavors/{flavor_id}
|
||||
|
||||
Deletes a flavor.
|
||||
|
||||
@ -228,7 +221,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- flavor_id: flavor_id
|
||||
|
||||
Response
|
||||
|
@ -20,7 +20,7 @@ image size in the ``OS-EXT-IMG-SIZE:size`` extended attribute.
|
||||
List Images
|
||||
===========
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/images
|
||||
.. rest_method:: GET /images
|
||||
|
||||
List images.
|
||||
|
||||
@ -29,13 +29,6 @@ Normal response codes: 200
|
||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
||||
itemNotFound(404)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -47,7 +40,7 @@ Response
|
||||
List Images With Details
|
||||
========================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/images/detail
|
||||
.. rest_method:: GET /images/detail
|
||||
|
||||
List images with details.
|
||||
|
||||
@ -56,13 +49,6 @@ Normal response codes: 200
|
||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
|
||||
itemNotFound(404)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -75,7 +61,7 @@ Response
|
||||
Show Image Details
|
||||
==================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/images/{image_id}
|
||||
.. rest_method:: GET /images/{image_id}
|
||||
|
||||
Shows details for an image.
|
||||
|
||||
@ -88,7 +74,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
|
||||
Response
|
||||
@ -102,7 +87,7 @@ Response
|
||||
Delete Image
|
||||
============
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/images/{image_id}
|
||||
.. rest_method:: DELETE /images/{image_id}
|
||||
|
||||
Deletes an image.
|
||||
|
||||
@ -115,7 +100,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
|
||||
Response
|
||||
@ -124,7 +108,7 @@ Response
|
||||
List Image Metadata
|
||||
===================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/images/{image_id}/metadata
|
||||
.. rest_method:: GET /images/{image_id}/metadata
|
||||
|
||||
List metadata of an image.
|
||||
|
||||
@ -137,7 +121,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
|
||||
Response
|
||||
@ -151,7 +134,7 @@ Response
|
||||
Create Image Metadata
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/images/{image_id}/metadata
|
||||
.. rest_method:: POST /images/{image_id}/metadata
|
||||
|
||||
Create an image metadata.
|
||||
|
||||
@ -165,7 +148,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
|
||||
**Example Create Image Metadata: JSON request**
|
||||
@ -184,7 +166,7 @@ Response
|
||||
Update Image Metadata
|
||||
=====================
|
||||
|
||||
.. rest_method:: PUT /v2.1/{tenant_id}/images/{image_id}/metadata
|
||||
.. rest_method:: PUT /images/{image_id}/metadata
|
||||
|
||||
Update an image metadata
|
||||
|
||||
@ -198,7 +180,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
|
||||
**Example Update Image Metadata: JSON request**
|
||||
@ -217,7 +198,7 @@ Response
|
||||
Show Image Metadata Item
|
||||
========================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/images/{image_id}/metadata/{key}
|
||||
.. rest_method:: GET /images/{image_id}/metadata/{key}
|
||||
|
||||
Shows metadata item, by key, for an image.
|
||||
|
||||
@ -230,7 +211,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
- key: key
|
||||
|
||||
@ -245,7 +225,7 @@ Response
|
||||
Create Or Update Image Metadata Item
|
||||
====================================
|
||||
|
||||
.. rest_method:: PUT /v2.1/{tenant_id}/images/{image_id}/metadata/{key}
|
||||
.. rest_method:: PUT /images/{image_id}/metadata/{key}
|
||||
|
||||
Creates or updates a metadata item, by key, for an image.
|
||||
|
||||
@ -258,7 +238,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
- key: key
|
||||
|
||||
@ -278,7 +257,7 @@ Response
|
||||
Delete Image Metadata Item
|
||||
==========================
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/images/{image_id}/metadata/{key}
|
||||
.. rest_method:: DELETE /images/{image_id}/metadata/{key}
|
||||
|
||||
Deletes a metadata item, by key, for an image.
|
||||
|
||||
@ -291,9 +270,8 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- image_id: image_id
|
||||
- key: key
|
||||
|
||||
Response
|
||||
--------
|
||||
--------
|
||||
|
@ -7,6 +7,7 @@
|
||||
.. rest_expand_all::
|
||||
|
||||
.. include:: versions.inc
|
||||
.. include:: urls.inc
|
||||
.. include:: servers.inc
|
||||
.. include:: servers-multiple-create.inc
|
||||
.. include:: servers-actions.inc
|
||||
|
@ -11,7 +11,7 @@ address.
|
||||
List Ips
|
||||
========
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/ips
|
||||
.. rest_method:: GET /servers/{server_id}/ips
|
||||
|
||||
Lists IP addresses that are assigned to an instance.
|
||||
|
||||
@ -28,7 +28,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
|
||||
Response
|
||||
@ -49,7 +49,7 @@ Response
|
||||
Show Ip Details
|
||||
===============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/ips/{network_label}
|
||||
.. rest_method:: GET /servers/{server_id}/ips/{network_label}
|
||||
|
||||
Shows IP addresses details for a network label of a server instance.
|
||||
|
||||
@ -66,7 +66,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- network_label: network_label
|
||||
|
||||
|
@ -10,7 +10,7 @@ Shows rate and absolute limits for the tenant.
|
||||
Show Rate And Absolute Limits
|
||||
=============================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/limits
|
||||
.. rest_method:: GET /limits
|
||||
|
||||
Shows rate and absolute limits for the tenant.
|
||||
|
||||
@ -18,13 +18,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401), forbidden(403)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -51,4 +44,3 @@ Response
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/limits/limit-get-resp.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -13,7 +13,7 @@ key, for a server.
|
||||
List All Metadata
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/metadata
|
||||
.. rest_method:: GET /servers/{server_id}/metadata
|
||||
|
||||
Lists all metadata for a server.
|
||||
|
||||
@ -28,7 +28,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
|
||||
Response
|
||||
@ -46,7 +46,7 @@ Response
|
||||
Update Metadata Items
|
||||
=====================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/metadata
|
||||
.. rest_method:: POST /servers/{server_id}/metadata
|
||||
|
||||
Updates one or more metadata items for a server.
|
||||
|
||||
@ -64,7 +64,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- metadata: metadata_object
|
||||
|
||||
@ -88,7 +88,7 @@ Response
|
||||
Create Or Replace Metadata Items
|
||||
================================
|
||||
|
||||
.. rest_method:: PUT /v2.1/{tenant_id}/servers/{server_id}/metadata
|
||||
.. rest_method:: PUT /servers/{server_id}/metadata
|
||||
|
||||
Creates or replaces one or more metadata items for a server.
|
||||
|
||||
@ -106,7 +106,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- metadata: metadata_object
|
||||
|
||||
@ -130,7 +130,7 @@ Response
|
||||
Show Metadata Item Details
|
||||
==========================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/metadata/{key}
|
||||
.. rest_method:: GET /servers/{server_id}/metadata/{key}
|
||||
|
||||
Shows details for a metadata item, by key, for a server.
|
||||
|
||||
@ -145,7 +145,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- key: key
|
||||
|
||||
@ -164,7 +164,7 @@ Response
|
||||
Create Or Update Metadata Item
|
||||
==============================
|
||||
|
||||
.. rest_method:: PUT /v2.1/{tenant_id}/servers/{server_id}/metadata/{key}
|
||||
.. rest_method:: PUT /servers/{server_id}/metadata/{key}
|
||||
|
||||
Creates or replaces a metadata item, by key, for a server.
|
||||
|
||||
@ -182,7 +182,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- key: key
|
||||
|
||||
@ -206,7 +206,7 @@ Response
|
||||
Delete Metadata Item
|
||||
====================
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/metadata/{key}
|
||||
.. rest_method:: DELETE /servers/{server_id}/metadata/{key}
|
||||
|
||||
Deletes a metadata item, by key, from a server.
|
||||
|
||||
@ -221,7 +221,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- key: key
|
||||
|
||||
|
@ -17,7 +17,7 @@ the Xen driver.
|
||||
List Agent Builds
|
||||
=================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-agents
|
||||
.. rest_method:: GET /os-agents
|
||||
|
||||
Lists agent builds.
|
||||
|
||||
@ -30,7 +30,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- agent_id: agent_id
|
||||
- architecture: architecture
|
||||
- hypervisor: hypervisor_type
|
||||
@ -50,7 +50,7 @@ Response
|
||||
Create Agent Build
|
||||
==================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-agents
|
||||
.. rest_method:: POST /os-agents
|
||||
|
||||
Creates an agent build.
|
||||
|
||||
@ -63,7 +63,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- hypervisor: hypervisor_type
|
||||
- architecture: architecture
|
||||
- os: os
|
||||
@ -97,7 +97,7 @@ Response
|
||||
Update Agent Build
|
||||
==================
|
||||
|
||||
.. rest_method:: PUT /v2.1/{tenant_id}/os-agents/{agent_build_id}
|
||||
.. rest_method:: PUT /os-agents/{agent_build_id}
|
||||
|
||||
Updates an agent build.
|
||||
|
||||
@ -110,7 +110,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- agent_build_id: agent_build_id
|
||||
- url: url
|
||||
- md5hash: md5hash
|
||||
@ -139,7 +139,7 @@ Response
|
||||
Delete Agent Build
|
||||
==================
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/os-agents/{agent_build_id}
|
||||
.. rest_method:: DELETE /os-agents/{agent_build_id}
|
||||
|
||||
Deletes an existing agent build.
|
||||
|
||||
@ -152,7 +152,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- agent_build_id: agent_build_id
|
||||
|
||||
Response
|
||||
|
@ -14,7 +14,7 @@ provider.
|
||||
List Aggregates
|
||||
===============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-aggregates
|
||||
.. rest_method:: GET /os-aggregates
|
||||
|
||||
Lists all aggregates. Includes the ID, name, and availability zone for each aggregate.
|
||||
|
||||
@ -22,13 +22,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401), forbidden(403)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -40,7 +33,7 @@ Response
|
||||
Create Aggregate
|
||||
================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-aggregates
|
||||
.. rest_method:: POST /os-aggregates
|
||||
|
||||
Creates an aggregate in an availability zone.
|
||||
|
||||
@ -53,7 +46,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- name: aggregate_name
|
||||
- availability_zone: availability_zone
|
||||
|
||||
@ -73,7 +65,7 @@ Response
|
||||
Show Aggregate Details
|
||||
======================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-aggregates/{aggregate_id}
|
||||
.. rest_method:: GET /os-aggregates/{aggregate_id}
|
||||
|
||||
Shows details for an aggregate. Details include hosts and metadata.
|
||||
|
||||
@ -86,7 +78,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- aggregate_id: aggregate_id
|
||||
|
||||
Response
|
||||
@ -100,7 +91,7 @@ Response
|
||||
Update Aggregate
|
||||
================
|
||||
|
||||
.. rest_method:: PUT /v2.1/{tenant_id}/os-aggregates/{aggregate_id}
|
||||
.. rest_method:: PUT /os-aggregates/{aggregate_id}
|
||||
|
||||
Updates either or both the name and availability zone for an aggregate.
|
||||
|
||||
@ -114,7 +105,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- aggregate_id: aggregate_id
|
||||
|
||||
**Example Update Aggregate: JSON request**
|
||||
@ -133,7 +123,7 @@ Response
|
||||
Delete Aggregate
|
||||
================
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/os-aggregates/{aggregate_id}
|
||||
.. rest_method:: DELETE /os-aggregates/{aggregate_id}
|
||||
|
||||
Deletes an aggregate.
|
||||
|
||||
@ -146,7 +136,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- aggregate_id: aggregate_id
|
||||
|
||||
Response
|
||||
@ -155,7 +144,7 @@ Response
|
||||
Add Host
|
||||
========
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-aggregates/{aggregate_id}/action
|
||||
.. rest_method:: POST /os-aggregates/{aggregate_id}/action
|
||||
|
||||
Adds a host to an aggregate.
|
||||
|
||||
@ -171,7 +160,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- aggregate_id: aggregate_id
|
||||
|
||||
**Example Add Host: JSON request**
|
||||
@ -190,7 +178,7 @@ Response
|
||||
Remove Host
|
||||
===========
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-aggregates/{aggregate_id}/action
|
||||
.. rest_method:: POST /os-aggregates/{aggregate_id}/action
|
||||
|
||||
Removes a host from an aggregate.
|
||||
|
||||
@ -206,7 +194,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- aggregate_id: aggregate_id
|
||||
|
||||
**Example Remove Host: JSON request**
|
||||
@ -225,7 +212,7 @@ Response
|
||||
Create Or Update Aggregate Metadata
|
||||
===================================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-aggregates/{aggregate_id}/action
|
||||
.. rest_method:: POST /os-aggregates/{aggregate_id}/action
|
||||
|
||||
Creates or replaces metadata for an aggregate.
|
||||
|
||||
@ -241,7 +228,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- aggregate_id: aggregate_id
|
||||
|
||||
**Example Create Or Update Aggregate Metadata: JSON request**
|
||||
@ -256,4 +242,3 @@ Response
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/os-aggregates/aggregates-metadata-post-resp.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -16,7 +16,7 @@ an emulator/hypervisor to add the snapshot feature.
|
||||
Create Assisted Volume Snapshots
|
||||
================================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-assisted-volume-snapshots
|
||||
.. rest_method:: POST /os-assisted-volume-snapshots
|
||||
|
||||
Creates an assisted volume snapshot.
|
||||
|
||||
@ -29,7 +29,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- snapshot: snapshot
|
||||
- volume_id: volume_id
|
||||
- create_info: create_info
|
||||
@ -58,7 +58,7 @@ Response
|
||||
Delete Assisted Volume Snapshot
|
||||
===============================
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/os-assisted-volume-snapshots/{snapshot_id}
|
||||
.. rest_method:: DELETE /os-assisted-volume-snapshots/{snapshot_id}
|
||||
|
||||
Deletes an assisted volume snapshot.
|
||||
|
||||
@ -76,7 +76,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- snapshot_id: snapshot_id
|
||||
|
||||
Query Parameters
|
||||
|
@ -12,7 +12,7 @@ Shows availability zone information.
|
||||
Get Availability Zone Information
|
||||
=================================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-availability-zone
|
||||
.. rest_method:: GET /os-availability-zone
|
||||
|
||||
Gets availability zone information.
|
||||
|
||||
@ -20,13 +20,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401), forbidden(403)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -38,7 +31,7 @@ Response
|
||||
Get Detailed Availability Zone Information
|
||||
==========================================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-availability-zone/detail
|
||||
.. rest_method:: GET /os-availability-zone/detail
|
||||
|
||||
Gets detailed availability zone information.
|
||||
Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
|
||||
@ -47,13 +40,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401), forbidden(403)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -61,4 +47,3 @@ Response
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/os-availability-zone/availability-zone-detail-resp.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -14,7 +14,7 @@ Bare metal nodes.
|
||||
List Bare Metal Nodes
|
||||
=====================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-baremetal-nodes
|
||||
.. rest_method:: GET /os-baremetal-nodes
|
||||
|
||||
Lists the bare metal nodes known by the compute environment.
|
||||
|
||||
@ -23,12 +23,6 @@ Normal response codes: 202
|
||||
Error response codes: unauthorized(401), forbidden(403),
|
||||
notImplemented(501)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
@ -52,7 +46,7 @@ Response
|
||||
Show Bare Metal Node Details
|
||||
============================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-baremetal-nodes/{node_id}
|
||||
.. rest_method:: GET /os-baremetal-nodes/{node_id}
|
||||
|
||||
Shows details for a bare metal node.
|
||||
|
||||
@ -66,7 +60,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- node_id: node_id
|
||||
|
||||
Response
|
||||
|
@ -14,7 +14,7 @@ the local cell.
|
||||
List Cells
|
||||
==========
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-cells
|
||||
.. rest_method:: GET /os-cells
|
||||
|
||||
Lists cells.
|
||||
|
||||
@ -23,13 +23,6 @@ Normal response codes: 200
|
||||
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
||||
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), NotImplemented(501)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -41,7 +34,7 @@ Response
|
||||
List Cells With Details
|
||||
=======================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-cells
|
||||
.. rest_method:: GET /os-cells
|
||||
|
||||
Lists cells with details.
|
||||
|
||||
@ -50,13 +43,6 @@ Normal response codes: 200
|
||||
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
|
||||
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404), NotImplemented(501)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -68,7 +54,7 @@ Response
|
||||
Show Cell Data
|
||||
==============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-cells/{cell_id}
|
||||
.. rest_method:: GET /os-cells/{cell_id}
|
||||
|
||||
Shows data for a cell.
|
||||
|
||||
@ -82,7 +68,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- cell_id: cell_id
|
||||
|
||||
Response
|
||||
@ -96,7 +81,7 @@ Response
|
||||
Show Cell Capacities
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-cells/{cell_id}/capacities
|
||||
.. rest_method:: GET /os-cells/{cell_id}/capacities
|
||||
|
||||
Shows capacities for a cell.
|
||||
|
||||
@ -110,7 +95,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- cell_id: cell_id
|
||||
|
||||
Response
|
||||
@ -120,4 +104,3 @@ Response
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/os-cells/cells-capacities-resp.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -12,7 +12,7 @@ Creates and shows details for a root certificate.
|
||||
Create Certificate
|
||||
==================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-certificates
|
||||
.. rest_method:: POST /os-certificates
|
||||
|
||||
Creates a certificate.
|
||||
|
||||
@ -20,13 +20,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: unauthorized(401), forbidden(403)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -38,7 +31,7 @@ Response
|
||||
Show Certificate Details
|
||||
========================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-certificates/{certificate_id}
|
||||
.. rest_method:: GET /os-certificates/{certificate_id}
|
||||
|
||||
Shows details for a certificate.
|
||||
|
||||
@ -52,7 +45,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- certificate_id: certificate_id
|
||||
|
||||
Response
|
||||
@ -62,4 +54,3 @@ Response
|
||||
|
||||
.. literalinclude:: ../../doc/api_samples/os-certificates/certificate-get-root-resp.json
|
||||
:language: javascript
|
||||
|
||||
|
@ -12,7 +12,7 @@ Manages virtual VPNs for projects.
|
||||
List Cloudpipes
|
||||
===============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-cloudpipe
|
||||
.. rest_method:: GET /os-cloudpipe
|
||||
|
||||
Lists cloudpipes.
|
||||
|
||||
@ -20,13 +20,6 @@ Normal response codes: 200
|
||||
|
||||
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound (404)
|
||||
|
||||
Request
|
||||
-------
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
@ -38,7 +31,7 @@ Response
|
||||
Create Cloudpipe
|
||||
================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-cloudpipe
|
||||
.. rest_method:: POST /os-cloudpipe
|
||||
|
||||
Creates a cloudpipe.
|
||||
|
||||
@ -51,7 +44,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- project_id: project_id
|
||||
|
||||
**Example Create Cloudpipe: JSON request**
|
||||
@ -70,7 +62,7 @@ Response
|
||||
Update Cloudpipe
|
||||
================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-cloudpipe/configure-project
|
||||
.. rest_method:: POST /os-cloudpipe/configure-project
|
||||
|
||||
Updates the virtual private network (VPN) IP address and port for a cloudpipe instance.
|
||||
|
||||
@ -83,7 +75,6 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
- vpn_ip: vpn_ip
|
||||
- vpn_port: vpn_port
|
||||
|
||||
@ -94,4 +85,3 @@ Request
|
||||
|
||||
Response
|
||||
--------
|
||||
|
||||
|
@ -9,7 +9,7 @@ Manages server consoles.
|
||||
Lists Consoles
|
||||
==============
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/consoles
|
||||
.. rest_method:: GET /servers/{server_id}/consoles
|
||||
|
||||
Lists all consoles for a server instance.
|
||||
|
||||
@ -22,7 +22,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
|
||||
|
||||
@ -47,7 +47,7 @@ Response
|
||||
Create Console
|
||||
==============
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/consoles
|
||||
.. rest_method:: POST /servers/{server_id}/consoles
|
||||
|
||||
Creates a console for a server instance.
|
||||
|
||||
@ -60,7 +60,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
|
||||
|
||||
@ -73,7 +73,7 @@ No body content is returned on a successful POST.
|
||||
Show Console Details
|
||||
====================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/consoles/{console_id}
|
||||
.. rest_method:: GET /servers/{server_id}/consoles/{console_id}
|
||||
|
||||
Shows console details for a server instance.
|
||||
|
||||
@ -86,7 +86,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- console_id: console_id
|
||||
|
||||
@ -115,7 +115,7 @@ Response
|
||||
Delete Console
|
||||
==============
|
||||
|
||||
.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/consoles/{console_id}
|
||||
.. rest_method:: DELETE /servers/{server_id}/consoles/{console_id}
|
||||
|
||||
Deletes a console for a server instance.
|
||||
|
||||
@ -128,7 +128,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
- id: console_id
|
||||
|
||||
@ -141,7 +141,7 @@ No body content is returned on a successful DELETE.
|
||||
Show Console Authentication Token
|
||||
=================================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-console-auth-token
|
||||
.. rest_method:: GET /servers/{server_id}/os-console-auth-token
|
||||
|
||||
Given the console authentication token for a server instance,
|
||||
shows the related connection information.
|
||||
@ -157,7 +157,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- server_id: server_id
|
||||
|
||||
|
|
||||
|
@ -13,7 +13,7 @@ reserves and releases a fixed IP address.
|
||||
Show Fixed Ip Details
|
||||
=====================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/os-fixed-ips/{fixed_ip}
|
||||
.. rest_method:: GET /os-fixed-ips/{fixed_ip}
|
||||
|
||||
Shows details for a fixed IP address.
|
||||
|
||||
@ -26,7 +26,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- fixed_ip: fixed_ip
|
||||
|
||||
Response
|
||||
@ -40,7 +40,7 @@ Response
|
||||
Reserve Or Release A Fixed Ip
|
||||
=============================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/os-fixed-ips/{fixed_ip}/action
|
||||
.. rest_method:: POST /os-fixed-ips/{fixed_ip}/action
|
||||
|
||||
Reserves or releases a fixed IP.
|
||||
|
||||
@ -55,7 +55,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- fixed_ip: fixed_ip
|
||||
|
||||
**Example Reserve Or Release A Fixed Ip: JSON request**
|
||||
|
@ -13,7 +13,7 @@ flavor has ``is_public`` set to ``false`` while a public flavor has
|
||||
List Flavor Access Information For Given Flavor
|
||||
===============================================
|
||||
|
||||
.. rest_method:: GET /v2.1/{tenant_id}/flavors/{flavor_id}/os-flavor-access
|
||||
.. rest_method:: GET /flavors/{flavor_id}/os-flavor-access
|
||||
|
||||
Lists flavor access information.
|
||||
|
||||
@ -26,7 +26,7 @@ Request
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- tenant_id: tenant_id
|
||||
|
||||
- flavor_id: flavor_id
|
||||
|
||||
Response
|
||||
@ -46,7 +46,7 @@ Response
|
||||
Add Flavor Access To Tenant (addTenantAccess Action)
|
||||
====================================================
|
||||
|
||||
.. rest_method:: POST /v2.1/{tenant_id}/flavors/{flavor_id}/action
|
||||
.. rest_method:: POST /flavors/{flavor_id}/action
|
||||