From c9f5ad3bcf06d22661fd73dc8f98bf752784abff Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Thu, 2 Jun 2016 08:50:03 -0400 Subject: [PATCH] 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 --- api-ref/source/diagnostics.inc | 4 +- api-ref/source/extensions.inc | 11 +-- api-ref/source/flavors.inc | 18 +--- api-ref/source/images.inc | 44 +++------ api-ref/source/index.rst | 1 + api-ref/source/ips.inc | 8 +- api-ref/source/limits.inc | 10 +- api-ref/source/metadata.inc | 24 ++--- api-ref/source/os-agents.inc | 16 ++-- api-ref/source/os-aggregates.inc | 31 ++----- .../source/os-assisted-volume-snapshots.inc | 8 +- api-ref/source/os-availability-zone.inc | 19 +--- api-ref/source/os-baremetal-nodes.inc | 11 +-- api-ref/source/os-cells.inc | 25 +---- api-ref/source/os-certificates.inc | 13 +-- api-ref/source/os-cloudpipe.inc | 16 +--- api-ref/source/os-consoles.inc | 20 ++-- api-ref/source/os-fixed-ips.inc | 8 +- api-ref/source/os-flavor-access.inc | 12 +-- api-ref/source/os-flavor-extra-specs.inc | 20 ++-- api-ref/source/os-floating-ip-dns.inc | 27 ++---- api-ref/source/os-floating-ip-pools.inc | 18 +--- api-ref/source/os-floating-ips-bulk.inc | 19 +--- api-ref/source/os-floating-ips.inc | 19 +--- api-ref/source/os-fping.inc | 8 +- api-ref/source/os-hosts.inc | 27 ++---- api-ref/source/os-hypervisors.inc | 39 ++------ api-ref/source/os-instance-actions.inc | 8 +- .../source/os-instance-usage-audit-log.inc | 15 +-- api-ref/source/os-interface.inc | 16 ++-- api-ref/source/os-keypairs.inc | 19 +--- api-ref/source/os-migrations.inc | 4 +- api-ref/source/os-networks.inc | 39 ++------ api-ref/source/os-quota-sets.inc | 22 ++--- .../os-security-group-default-rules.inc | 18 +--- api-ref/source/os-security-group-rules.inc | 8 +- api-ref/source/os-security-groups.inc | 39 ++++---- api-ref/source/os-server-external-events.inc | 4 +- api-ref/source/os-server-groups.inc | 20 +--- api-ref/source/os-server-password.inc | 8 +- api-ref/source/os-services.inc | 25 ++--- api-ref/source/os-simple-tenant-usage.inc | 11 +-- api-ref/source/os-tenant-network.inc | 25 +---- api-ref/source/os-virtual-interfaces.inc | 4 +- api-ref/source/os-volume-attachments.inc | 20 ++-- api-ref/source/os-volumes.inc | 54 ++--------- api-ref/source/parameters.yaml | 2 +- .../source/servers-action-console-output.inc | 4 +- api-ref/source/servers-action-crash-dump.inc | 4 +- .../source/servers-action-deferred-delete.inc | 8 +- api-ref/source/servers-action-evacuate.inc | 4 +- api-ref/source/servers-action-fixed-ip.inc | 8 +- .../source/servers-action-remote-consoles.inc | 16 ++-- api-ref/source/servers-action-shelve.inc | 12 +-- api-ref/source/servers-actions.inc | 91 +++++++++---------- api-ref/source/servers-admin-action.inc | 24 ++--- api-ref/source/servers-multiple-create.inc | 8 +- api-ref/source/servers.inc | 26 +++--- api-ref/source/urls.inc | 26 ++++++ api-ref/source/versions.inc | 6 +- 60 files changed, 380 insertions(+), 694 deletions(-) create mode 100644 api-ref/source/urls.inc diff --git a/api-ref/source/diagnostics.inc b/api-ref/source/diagnostics.inc index 0a03876efe8..f2403a76212 100644 --- a/api-ref/source/diagnostics.inc +++ b/api-ref/source/diagnostics.inc @@ -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 diff --git a/api-ref/source/extensions.inc b/api-ref/source/extensions.inc index f47e8d824b3..077db4e9b34 100644 --- a/api-ref/source/extensions.inc +++ b/api-ref/source/extensions.inc @@ -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 diff --git a/api-ref/source/flavors.inc b/api-ref/source/flavors.inc index 14fe35ed7fb..07682d3de75 100644 --- a/api-ref/source/flavors.inc +++ b/api-ref/source/flavors.inc @@ -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 diff --git a/api-ref/source/images.inc b/api-ref/source/images.inc index 9edfe5b289a..0dc1bef578a 100644 --- a/api-ref/source/images.inc +++ b/api-ref/source/images.inc @@ -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 --------- \ No newline at end of file +-------- diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 711dc0d3257..c8e30a5a7fc 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -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 diff --git a/api-ref/source/ips.inc b/api-ref/source/ips.inc index 9a8d995edd3..feb64b3cc9b 100644 --- a/api-ref/source/ips.inc +++ b/api-ref/source/ips.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 diff --git a/api-ref/source/limits.inc b/api-ref/source/limits.inc index bcf280a2200..efffdf33a36 100644 --- a/api-ref/source/limits.inc +++ b/api-ref/source/limits.inc @@ -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 - diff --git a/api-ref/source/metadata.inc b/api-ref/source/metadata.inc index 61cd28e2ed8..19430a4cfa2 100644 --- a/api-ref/source/metadata.inc +++ b/api-ref/source/metadata.inc @@ -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 diff --git a/api-ref/source/os-agents.inc b/api-ref/source/os-agents.inc index 12a707c5802..c37efcc566d 100644 --- a/api-ref/source/os-agents.inc +++ b/api-ref/source/os-agents.inc @@ -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 diff --git a/api-ref/source/os-aggregates.inc b/api-ref/source/os-aggregates.inc index 191a319a7c5..d223afbddc3 100644 --- a/api-ref/source/os-aggregates.inc +++ b/api-ref/source/os-aggregates.inc @@ -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 - diff --git a/api-ref/source/os-assisted-volume-snapshots.inc b/api-ref/source/os-assisted-volume-snapshots.inc index 3743fd6de5b..321f90672b9 100644 --- a/api-ref/source/os-assisted-volume-snapshots.inc +++ b/api-ref/source/os-assisted-volume-snapshots.inc @@ -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 diff --git a/api-ref/source/os-availability-zone.inc b/api-ref/source/os-availability-zone.inc index 9dd4d203931..e3c8e5ccbc3 100644 --- a/api-ref/source/os-availability-zone.inc +++ b/api-ref/source/os-availability-zone.inc @@ -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 - diff --git a/api-ref/source/os-baremetal-nodes.inc b/api-ref/source/os-baremetal-nodes.inc index 2c0e79edbda..7c05566ea16 100644 --- a/api-ref/source/os-baremetal-nodes.inc +++ b/api-ref/source/os-baremetal-nodes.inc @@ -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 diff --git a/api-ref/source/os-cells.inc b/api-ref/source/os-cells.inc index 8476047a590..c6cac28e19e 100644 --- a/api-ref/source/os-cells.inc +++ b/api-ref/source/os-cells.inc @@ -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 - diff --git a/api-ref/source/os-certificates.inc b/api-ref/source/os-certificates.inc index b644ab5fbcc..6832f5e15f0 100644 --- a/api-ref/source/os-certificates.inc +++ b/api-ref/source/os-certificates.inc @@ -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 - diff --git a/api-ref/source/os-cloudpipe.inc b/api-ref/source/os-cloudpipe.inc index bde44517440..675087f4eae 100644 --- a/api-ref/source/os-cloudpipe.inc +++ b/api-ref/source/os-cloudpipe.inc @@ -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 -------- - diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc index efc320928c5..f6bc8fa0246 100644 --- a/api-ref/source/os-consoles.inc +++ b/api-ref/source/os-consoles.inc @@ -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 | diff --git a/api-ref/source/os-fixed-ips.inc b/api-ref/source/os-fixed-ips.inc index 583213b87a0..39b9b9a144c 100644 --- a/api-ref/source/os-fixed-ips.inc +++ b/api-ref/source/os-fixed-ips.inc @@ -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** diff --git a/api-ref/source/os-flavor-access.inc b/api-ref/source/os-flavor-access.inc index b4dead0da13..48b69accbeb 100644 --- a/api-ref/source/os-flavor-access.inc +++ b/api-ref/source/os-flavor-access.inc @@ -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 Adds flavor access to a tenant and flavor. @@ -62,7 +62,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id - addTenantAccess: addTenantAccess - tenant: tenant_id_body @@ -89,7 +89,7 @@ Response Remove Flavor Access From Tenant (removeTenantAccess Action) ============================================================ -.. rest_method:: POST /v2.1/{tenant_id}/flavors/{flavor_id}/action +.. rest_method:: POST /flavors/{flavor_id}/action Removes flavor access from a tenant and flavor. @@ -105,7 +105,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id - removeTenantAccess: removeTenantAccess - tenant: tenant_id_body diff --git a/api-ref/source/os-flavor-extra-specs.inc b/api-ref/source/os-flavor-extra-specs.inc index 8b2754125ec..3866c7cd36b 100644 --- a/api-ref/source/os-flavor-extra-specs.inc +++ b/api-ref/source/os-flavor-extra-specs.inc @@ -13,7 +13,7 @@ flavor. List Extra Specs For A Flavor ============================= -.. rest_method:: GET /v2.1/{tenant_id}/flavors/{flavor_id}/os-extra_specs +.. rest_method:: GET /flavors/{flavor_id}/os-extra_specs Lists all extra specs for a flavor, by ID. @@ -26,7 +26,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id Response @@ -40,7 +40,7 @@ Response Create Extra Specs For A Flavor =============================== -.. rest_method:: POST /v2.1/{tenant_id}/flavors/{flavor_id}/os-extra_specs +.. rest_method:: POST /flavors/{flavor_id}/os-extra_specs Creates extra specs for a flavor, by ID. @@ -53,7 +53,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id **Example Create Extra Specs For A Flavor: JSON request** @@ -72,7 +72,7 @@ Response Show An Extra Spec For A Flavor =============================== -.. rest_method:: GET /v2.1/{tenant_id}/flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key} +.. rest_method:: GET /flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key} Shows an extra spec, by key, for a flavor, by ID. @@ -85,7 +85,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id - flavor_extra_spec_key: flavor_extra_spec_key @@ -100,7 +100,7 @@ Response Update An Extra Spec For A Flavor ================================= -.. rest_method:: PUT /v2.1/{tenant_id}/flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key} +.. rest_method:: PUT /flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key} Updates an extra spec, by key, for a flavor, by ID. @@ -114,7 +114,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id - flavor_extra_spec_key: flavor_extra_spec_key @@ -134,7 +134,7 @@ Response Delete An Extra Spec For A Flavor ================================= -.. rest_method:: DELETE /v2.1/{tenant_id}/flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key} +.. rest_method:: DELETE /flavors/{flavor_id}/os-extra_specs/{flavor_extra_spec_key} Deletes an extra spec, by key, for a flavor, by ID. @@ -147,7 +147,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - flavor_id: flavor_id - flavor_extra_spec_key: flavor_extra_spec_key diff --git a/api-ref/source/os-floating-ip-dns.inc b/api-ref/source/os-floating-ip-dns.inc index 4a18b5544f3..60fca454f5b 100644 --- a/api-ref/source/os-floating-ip-dns.inc +++ b/api-ref/source/os-floating-ip-dns.inc @@ -13,7 +13,7 @@ dispatches requests to a DNS driver that is selected at startup. List Dns Domains ================ -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns +.. rest_method:: GET /os-floating-ip-dns Lists registered DNS domains published by the DNS drivers. @@ -21,13 +21,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403), notImplemented(501) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -39,7 +32,7 @@ Response Create Or Update Dns Domain =========================== -.. rest_method:: PUT /v2.1/{tenant_id}/os-floating-ip-dns/{domain} +.. rest_method:: PUT /os-floating-ip-dns/{domain} Creates or updates a DNS domain. @@ -53,7 +46,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - domain: domain **Example Create Or Update Dns Domain: JSON request** @@ -72,7 +64,7 @@ Response Delete Dns Domain ================= -.. rest_method:: DELETE /v2.1/{tenant_id}/os-floating-ip-dns/{domain} +.. rest_method:: DELETE /os-floating-ip-dns/{domain} Deletes a DNS domain and all associated host entries. @@ -86,7 +78,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - domain: domain Response @@ -95,7 +86,7 @@ Response List Dns Entries ================ -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{ip} +.. rest_method:: GET /os-floating-ip-dns/{domain}/entries/{ip} Lists DNS entries for a domain and IP. @@ -109,7 +100,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - domain: domain - ip: ip @@ -124,7 +114,7 @@ Response Find Unique Dns Entry ===================== -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name} +.. rest_method:: GET /os-floating-ip-dns/{domain}/entries/{name} Finds a unique DNS entry for a domain and name. @@ -138,7 +128,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - domain: domain - name: name @@ -153,7 +142,7 @@ Response Create Or Update Dns Entry ========================== -.. rest_method:: PUT /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name} +.. rest_method:: PUT /os-floating-ip-dns/{domain}/entries/{name} Creates or updates a DNS entry. @@ -166,7 +155,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - domain: domain - name: name @@ -186,7 +174,7 @@ Response Delete Dns Entry ================ -.. rest_method:: DELETE /v2.1/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name} +.. rest_method:: DELETE /os-floating-ip-dns/{domain}/entries/{name} Deletes a DNS entry. @@ -200,7 +188,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - domain: domain - name: name diff --git a/api-ref/source/os-floating-ip-pools.inc b/api-ref/source/os-floating-ip-pools.inc index 7997f0fd704..5a82a197d53 100644 --- a/api-ref/source/os-floating-ip-pools.inc +++ b/api-ref/source/os-floating-ip-pools.inc @@ -9,36 +9,28 @@ Manages groups of floating IPs. List Floating Ip Pools ====================== -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ip-pools +.. rest_method:: GET /os-floating-ip-pools Lists floating IP pools. -Policy defaults enable only users with the administrative role or user -who is authorized to operate on tenant to perform this -operation. Cloud providers can change these permissions through the +Policy defaults enable only users with the administrative role or user +who is authorized to operate on tenant to perform this +operation. Cloud providers can change these permissions through the ``policy.json`` file. Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- .. rest_parameters:: parameters.yaml - floating_ip_pools: floating_ip_pools - - name: floating_ip_pool_name + - name: floating_ip_pool_name **Example List Floating Ip Pools: JSON response** .. literalinclude:: ../../doc/api_samples/os-floating-ip-pools/floatingippools-list-resp.json :language: javascript - diff --git a/api-ref/source/os-floating-ips-bulk.inc b/api-ref/source/os-floating-ips-bulk.inc index 1e4c6baf980..605200bf41a 100644 --- a/api-ref/source/os-floating-ips-bulk.inc +++ b/api-ref/source/os-floating-ips-bulk.inc @@ -15,7 +15,7 @@ To view available pools, use the ``os-floating-ip-pools`` extension. List Floating Ips ================= -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ips-bulk +.. rest_method:: GET /os-floating-ips-bulk Lists all floating IPs. @@ -23,13 +23,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -41,7 +34,7 @@ Response Create Floating Ips =================== -.. rest_method:: POST /v2.1/{tenant_id}/os-floating-ips-bulk +.. rest_method:: POST /os-floating-ips-bulk Bulk-creates floating IPs. @@ -54,7 +47,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - ip_range: ip_range **Example Create Floating Ips: JSON request** @@ -73,7 +65,7 @@ Response Bulk-Delete Floating Ips ======================== -.. rest_method:: PUT /v2.1/{tenant_id}/os-floating-ips-bulk/delete +.. rest_method:: PUT /os-floating-ips-bulk/delete Bulk-deletes floating IPs. @@ -86,7 +78,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - ip_range: ip_range **Example Bulk-Delete Floating Ips: JSON request** @@ -105,7 +96,7 @@ Response List Floating Ips By Host ========================= -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ips-bulk/{host_name} +.. rest_method:: GET /os-floating-ips-bulk/{host_name} Lists all floating IPs for a host. @@ -118,7 +109,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - host_name: host_name Response @@ -128,4 +118,3 @@ Response .. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json :language: javascript - diff --git a/api-ref/source/os-floating-ips.inc b/api-ref/source/os-floating-ips.inc index ab3be0db907..fc19f3d65ca 100644 --- a/api-ref/source/os-floating-ips.inc +++ b/api-ref/source/os-floating-ips.inc @@ -33,7 +33,7 @@ for a project, you can: List Floating Ip Addresses ========================== -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ips +.. rest_method:: GET /os-floating-ips Lists floating IP addresses associated with the tenant or account. @@ -45,13 +45,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -63,7 +56,7 @@ Response Create (Allocate) Floating Ip Address ===================================== -.. rest_method:: POST /v2.1/{tenant_id}/os-floating-ips +.. rest_method:: POST /os-floating-ips Creates, or allocates, a floating IP address for the current project. By default, the floating IP address is allocated from the public pool. @@ -84,7 +77,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - pool: pool **Example Create (Allocate) Floating Ip Address: JSON request** @@ -103,7 +95,7 @@ Response Show Floating Ip Address Details ================================ -.. rest_method:: GET /v2.1/{tenant_id}/os-floating-ips/{floating_ip_id} +.. rest_method:: GET /os-floating-ips/{floating_ip_id} Shows details for a floating IP address, by ID, that is associated with the tenant or account. @@ -120,7 +112,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - floating_ip_id: floating_ip_id Response @@ -134,7 +125,7 @@ Response Delete (Deallocate) Floating Ip Address ======================================= -.. rest_method:: DELETE /v2.1/{tenant_id}/os-floating-ips/{floating_ip_id} +.. rest_method:: DELETE /os-floating-ips/{floating_ip_id} Deletes, or deallocates, a floating IP address from the current project and returns it to the pool from which it was allocated. @@ -156,9 +147,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - floating_ip_id: floating_ip_id Response -------- - diff --git a/api-ref/source/os-fping.inc b/api-ref/source/os-fping.inc index 2fbd7617535..21c53917a35 100644 --- a/api-ref/source/os-fping.inc +++ b/api-ref/source/os-fping.inc @@ -9,7 +9,7 @@ Pings instances and reports which instances are alive. Ping Instances ============== -.. rest_method:: GET /v2.1/{tenant_id}/os-fping +.. rest_method:: GET /os-fping Runs the fping utility to ping instances and reports which instances are alive. @@ -38,7 +38,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - all_tenants: all_tenants - include: include - exclude: exclude @@ -63,7 +63,7 @@ Response Ping An Instance ================ -.. rest_method:: GET /v2.1/{tenant_id}/os-fping/{instance_id} +.. rest_method:: GET /os-fping/{instance_id} Runs the fping utility to ping an instance and reports whether the instance is alive. @@ -81,7 +81,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - instance_id: instance_id Response diff --git a/api-ref/source/os-hosts.inc b/api-ref/source/os-hosts.inc index 815ff3e3f96..e1b1f40f886 100644 --- a/api-ref/source/os-hosts.inc +++ b/api-ref/source/os-hosts.inc @@ -15,7 +15,7 @@ through the ``policy.json`` file. List Hosts ========== -.. rest_method:: GET /v2.1/{tenant_id}/os-hosts +.. rest_method:: GET /os-hosts Lists hosts. @@ -23,13 +23,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -48,7 +41,7 @@ Response Show Host Details ================= -.. rest_method:: GET /v2.1/{tenant_id}/os-hosts/{host_name} +.. rest_method:: GET /os-hosts/{host_name} Shows details for a host. @@ -61,7 +54,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - host_name: host_name Response @@ -85,7 +77,7 @@ Response Update Host status ================== -.. rest_method:: PUT /v2.1/{tenant_id}/os-hosts/{host_name} +.. rest_method:: PUT /os-hosts/{host_name} Enables, disables a host or put a host in maintenance or normal mode. @@ -99,7 +91,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - host_name: host_name - status: host_status_body_in - maintenance_mode: host_maintenance_mode_in @@ -115,7 +106,7 @@ Response .. rest_parameters:: parameters.yaml - host: host_name_body - - status: host_status_body + - status: host_status_body - maintenance_mode: host_maintenance_mode **Example Enable Host** @@ -126,7 +117,7 @@ Response Reboot Host =========== -.. rest_method:: GET /v2.1/{tenant_id}/os-hosts/{host_name}/reboot +.. rest_method:: GET /os-hosts/{host_name}/reboot Reboots a host. @@ -140,7 +131,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - host_name: host_name Response @@ -159,7 +149,7 @@ Response Shut Down Host ============== -.. rest_method:: GET /v2.1/{tenant_id}/os-hosts/{host_name}/shutdown +.. rest_method:: GET /os-hosts/{host_name}/shutdown Shuts down a host. @@ -173,7 +163,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - host_name: host_name Response @@ -192,7 +181,7 @@ Response Start Host ========== -.. rest_method:: GET /v2.1/{tenant_id}/os-hosts/{host_name}/startup +.. rest_method:: GET /os-hosts/{host_name}/startup Starts a host. @@ -206,7 +195,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - host_name: host_name Response @@ -221,4 +209,3 @@ Response .. literalinclude:: ../../doc/api_samples/os-hosts/host-get-startup.json :language: javascript - diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc index abc55ffe2ed..fe343df0dd3 100644 --- a/api-ref/source/os-hypervisors.inc +++ b/api-ref/source/os-hypervisors.inc @@ -14,7 +14,7 @@ for a hypervisor. List Hypervisors ================ -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors +.. rest_method:: GET /os-hypervisors Lists hypervisors. @@ -24,13 +24,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -42,7 +35,7 @@ Response List Hypervisors Details ======================== -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/detail +.. rest_method:: GET /os-hypervisors/detail Lists hypervisors details. @@ -52,13 +45,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -70,7 +56,7 @@ Response Show Hypervisor Statistics ========================== -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/statistics +.. rest_method:: GET /os-hypervisors/statistics Shows summary statistics for all hypervisors over all compute nodes. @@ -80,13 +66,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -98,7 +77,7 @@ Response Show Hypervisor Details ======================= -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id} +.. rest_method:: GET /os-hypervisors/{hypervisor_id} Shows details for a hypervisor. @@ -114,7 +93,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - hypervisor_id: hypervisor_id Response @@ -128,7 +106,7 @@ Response Show Hypervisor Uptime ====================== -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/uptime +.. rest_method:: GET /os-hypervisors/{hypervisor_id}/uptime Shows the uptime for a hypervisor. @@ -144,7 +122,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - hypervisor_id: hypervisor_id Response @@ -158,7 +135,7 @@ Response Search Hypervisor ================= -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/search +.. rest_method:: GET /os-hypervisors/{hypervisor_id}/search Search hypervisor by given hypervisor id. @@ -174,7 +151,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - hypervisor_id: hypervisor_id Response @@ -188,7 +164,7 @@ Response List Hypervisor Servers ======================= -.. rest_method:: GET /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/servers +.. rest_method:: GET /os-hypervisors/{hypervisor_id}/servers List all servers belong to given hypervisor. @@ -204,7 +180,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - hypervisor_id: hypervisor_id Response diff --git a/api-ref/source/os-instance-actions.inc b/api-ref/source/os-instance-actions.inc index 6a491222283..20ac6b75dff 100644 --- a/api-ref/source/os-instance-actions.inc +++ b/api-ref/source/os-instance-actions.inc @@ -12,7 +12,7 @@ All users can list available actions for a server. List Actions For Server ======================= -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions +.. rest_method:: GET /servers/{server_id}/os-instance-actions Lists actions for a server. @@ -29,7 +29,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id Response @@ -43,7 +43,7 @@ Response Show Server Action Details ========================== -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions/{request_id} +.. rest_method:: GET /servers/{server_id}/os-instance-actions/{request_id} Shows details for a server action. @@ -59,7 +59,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - request_id: request_id diff --git a/api-ref/source/os-instance-usage-audit-log.inc b/api-ref/source/os-instance-usage-audit-log.inc index 3891de72b09..a4760d669e5 100644 --- a/api-ref/source/os-instance-usage-audit-log.inc +++ b/api-ref/source/os-instance-usage-audit-log.inc @@ -4,12 +4,12 @@ Server usage audit log (os-instance-usage-audit-log) ======================================================== -Administrator only. Audit server usage of a tenant. +Administrator only. Audit server usage of a tenant. List Server Usage Audits For An Tenant ======================================== -.. rest_method:: GET /v2.1/{tenant_id}/os-instance_usage_audit_log +.. rest_method:: GET /os-instance_usage_audit_log Lists usage audits for all servers on the given tenant. @@ -17,13 +17,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -35,7 +28,7 @@ Response List Usage Audits Before Specified Time ======================================= -.. rest_method:: GET /v2.1/{tenant_id}/os-instance_usage_audit_log/{before_timestamp} +.. rest_method:: GET /os-instance_usage_audit_log/{before_timestamp} Lists usage audits that occurred before a specified time. @@ -48,7 +41,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - before_timestamp: before_timestamp Response @@ -58,4 +50,3 @@ Response .. literalinclude:: ../../doc/api_samples/os-instance-usage-audit-log/inst-usage-audit-log-show-get-resp.json :language: javascript - diff --git a/api-ref/source/os-interface.inc b/api-ref/source/os-interface.inc index c0f571e9e22..ccaa8956efc 100644 --- a/api-ref/source/os-interface.inc +++ b/api-ref/source/os-interface.inc @@ -12,7 +12,7 @@ and shows details for a port interface. List Port Interfaces ==================== -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-interface +.. rest_method:: GET /servers/{server_id}/os-interface Lists port interfaces that are attached to a server. @@ -26,7 +26,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path Response @@ -51,7 +51,7 @@ Response Create Interface ================ -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/os-interface +.. rest_method:: POST /servers/{server_id}/os-interface Creates a port interface and uses it to attach a port to a server instance. @@ -65,7 +65,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - interfaceAttachment: interfaceAttachment - port_id: port_id @@ -107,7 +107,7 @@ Response Show Port Interface Details =========================== -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-interface/{port_id} +.. rest_method:: GET /servers/{server_id}/os-interface/{port_id} Shows details for a port interface that is attached to a server. @@ -120,7 +120,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - port_id: port_id_path @@ -146,7 +146,7 @@ Response Detach Interface ================ -.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-interface/{port_id} +.. rest_method:: DELETE /servers/{server_id}/os-interface/{port_id} Detaches a port interface. @@ -160,7 +160,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - port_id: port_id_path diff --git a/api-ref/source/os-keypairs.inc b/api-ref/source/os-keypairs.inc index 1a745eebb4d..771a9e2b22b 100644 --- a/api-ref/source/os-keypairs.inc +++ b/api-ref/source/os-keypairs.inc @@ -12,7 +12,7 @@ Generates, imports, and deletes SSH keys. List Keypairs ============= -.. rest_method:: GET /v2.1/{tenant_id}/os-keypairs +.. rest_method:: GET /os-keypairs Lists keypairs that are associated with the account. @@ -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 Create Or Import Keypair ======================== -.. rest_method:: POST /v2.1/{tenant_id}/os-keypairs +.. rest_method:: POST /os-keypairs Generates or imports a keypair. @@ -51,7 +44,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - name: name - public_key: public_key @@ -71,7 +63,7 @@ Response Show Keypair Details ==================== -.. rest_method:: GET /v2.1/{tenant_id}/os-keypairs/{keypair_name} +.. rest_method:: GET /os-keypairs/{keypair_name} Shows details for a keypair that is associated with the account. @@ -84,7 +76,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - keypair_name: keypair_name Response @@ -98,7 +89,7 @@ Response Delete Keypair ============== -.. rest_method:: DELETE /v2.1/{tenant_id}/os-keypairs/{keypair_name} +.. rest_method:: DELETE /os-keypairs/{keypair_name} Deletes a keypair. @@ -111,9 +102,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - keypair_name: keypair_name Response -------- - diff --git a/api-ref/source/os-migrations.inc b/api-ref/source/os-migrations.inc index 94b2414d9b9..a0cda635dc8 100644 --- a/api-ref/source/os-migrations.inc +++ b/api-ref/source/os-migrations.inc @@ -12,7 +12,7 @@ Shows data on migrations. List Migrations =============== -.. rest_method:: GET /v2.1/{tenant_id}/os-migrations +.. rest_method:: GET /os-migrations Lists in-progress migrations. @@ -29,7 +29,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - status: migration_status - host: migration_host - source_compute: migration_source_compute diff --git a/api-ref/source/os-networks.inc b/api-ref/source/os-networks.inc index 85657304193..ab507da4b4f 100644 --- a/api-ref/source/os-networks.inc +++ b/api-ref/source/os-networks.inc @@ -28,7 +28,7 @@ Associates host with and disassociates host from a network. List Networks ============= -.. rest_method:: GET /v2.1/{tenant_id}/os-networks +.. rest_method:: GET /os-networks Lists networks for the project. @@ -39,13 +39,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -57,7 +50,7 @@ Response Create Network ============== -.. rest_method:: POST /v2.1/{tenant_id}/os-networks +.. rest_method:: POST /os-networks Creates a network. @@ -72,10 +65,6 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), confli Request ------- -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - **Example Create Network: JSON request** .. literalinclude:: ../../doc/api_samples/os-networks/network-create-req.json @@ -92,7 +81,7 @@ Response Add Network =========== -.. rest_method:: POST /v2.1/{tenant_id}/os-networks/add +.. rest_method:: POST /os-networks/add Adds a network to a project. @@ -107,10 +96,6 @@ Error response codes: badRequest(400), unauthorized(401), forbidden(403), NotImp Request ------- -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - **Example Add Network: JSON request** .. literalinclude:: ../../doc/api_samples/os-networks/network-add-req.json @@ -122,7 +107,7 @@ Response Show Network Details ==================== -.. rest_method:: GET /v2.1/{tenant_id}/os-networks/{network_id} +.. rest_method:: GET /os-networks/{network_id} Shows details for a network. @@ -138,7 +123,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - network_id: network_id Response @@ -152,7 +136,7 @@ Response Delete Network ============== -.. rest_method:: DELETE /v2.1/{tenant_id}/os-networks/{network_id} +.. rest_method:: DELETE /os-networks/{network_id} Deletes a network. @@ -169,7 +153,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - network_id: network_id Response @@ -180,7 +163,7 @@ There is no body content for the response of a successful DELETE query. Associate Host (DEPRECATED) =========================== -.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action +.. rest_method:: POST /os-networks/{network_id}/action .. warning:: This API is only available with ``nova-network`` which is @@ -203,7 +186,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - network_id: network_id - associate_host: associate_host @@ -220,7 +202,7 @@ There is no body content for the response of a successful POST query. Disassociate Network (DEPRECATED) ================================= -.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action +.. rest_method:: POST /os-networks/{network_id}/action .. warning:: This API is only available with ``nova-network`` which is @@ -243,7 +225,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - network_id: network_id **Example Disassociate Network: JSON request** @@ -259,7 +240,7 @@ There is no body content for the response of a successful POST query. Disassociate Host (DEPRECATED) ============================== -.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action +.. rest_method:: POST /os-networks/{network_id}/action .. warning:: This API is only available with ``nova-network`` which is @@ -282,7 +263,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - network_id: network_id **Example Disassociate Host from Network: JSON request** @@ -299,7 +279,7 @@ There is no body content for the response of a successful POST query. Disassociate Project (DEPRECATED) ================================= -.. rest_method:: POST /v2.1/{tenant_id}/os-networks/{network_id}/action +.. rest_method:: POST /os-networks/{network_id}/action .. warning:: This API is only available with ``nova-network`` which is @@ -322,7 +302,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - network_id: network_id **Example Disassociate Project from Network: JSON request** diff --git a/api-ref/source/os-quota-sets.inc b/api-ref/source/os-quota-sets.inc index 53e39257093..329cffd1417 100644 --- a/api-ref/source/os-quota-sets.inc +++ b/api-ref/source/os-quota-sets.inc @@ -13,12 +13,10 @@ the quotas for a project or a project and user. Show A Quota ============ -.. rest_method:: GET /v2.1/{admin_tenant_id}/os-quota-sets/{tenant_id} +.. rest_method:: GET /os-quota-sets/{tenant_id} Show the quota for a project or a project and a user. -In the request URI, you specify both the ID of the administrative project and the ID of the project for which you want to show quota. - To show a quota for a project and a user, specify the ``user_id`` query parameter. Normal response codes: 200 @@ -30,7 +28,6 @@ Request .. rest_parameters:: parameters.yaml - - admin_tenant_id: admin_tenant_id - tenant_id: tenant_id - user_id: user_id_query_quota @@ -64,7 +61,7 @@ Response Update Quotas ============= -.. rest_method:: PUT /v2.1/{admin_tenant_id}/os-quota-sets/{tenant_id} +.. rest_method:: PUT /os-quota-sets/{tenant_id} Update the quotas for a project or a project and a user. @@ -83,7 +80,6 @@ Request .. rest_parameters:: parameters.yaml - - admin_tenant_id: admin_tenant_id - tenant_id: tenant_id - user_id: user_id_query_set_quota - quota_set: quota_set @@ -137,7 +133,7 @@ Response Revert Quotas To Defaults ========================= -.. rest_method:: DELETE /v2.1/{admin_tenant_id}/os-quota-sets/{tenant_id} +.. rest_method:: DELETE /os-quota-sets/{tenant_id} Reverts the quotas to default values for a project or a project and a user. @@ -152,8 +148,8 @@ Request .. rest_parameters:: parameters.yaml - - admin_tenant_id: admin_tenant_id - tenant_id: tenant_id + - user_id: user_id_query_quota_delete Response @@ -162,12 +158,10 @@ Response List Default Quotas For Tenant ============================== -.. rest_method:: GET /v2.1/{admin_tenant_id}/os-quota-sets/{tenant_id}/defaults +.. rest_method:: GET /os-quota-sets/{tenant_id}/defaults Lists the default quotas for a project. -In the request URI, you specify both the ID of the administrative project and the ID of the project for which you want to show default quotas. These project IDs can match. - Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) @@ -177,7 +171,6 @@ Request .. rest_parameters:: parameters.yaml - - admin_tenant_id: admin_tenant_id - tenant_id: tenant_id Response @@ -210,12 +203,10 @@ Response Show The Detail of Quota ======================== -.. rest_method:: GET /v2.1/{admin_tenant_id}/os-quota-sets/{tenant_id}/detail +.. rest_method:: GET /os-quota-sets/{tenant_id}/detail Show the detail of quota for a project or a project and a user. -In the request URI, you specify both the ID of the administrative project and the ID of the project for which you want to show the detail of quota. - To show a quota for a project and a user, specify the ``user_id`` query parameter. Normal response codes: 200 @@ -227,7 +218,6 @@ Request .. rest_parameters:: parameters.yaml - - admin_tenant_id: admin_tenant_id - tenant_id: tenant_id - user_id: user_id_query_quota diff --git a/api-ref/source/os-security-group-default-rules.inc b/api-ref/source/os-security-group-default-rules.inc index dad841cb87e..04c22dd00d0 100644 --- a/api-ref/source/os-security-group-default-rules.inc +++ b/api-ref/source/os-security-group-default-rules.inc @@ -12,7 +12,7 @@ Lists, shows information for, and creates default security group rules. List Default Security Group Rules ================================= -.. rest_method:: GET /v2.1/{tenant_id}/os-security-group-default-rules +.. rest_method:: GET /os-security-group-default-rules Lists default security group rules. @@ -20,13 +20,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), notImplemented(501) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -47,7 +40,7 @@ Response Show Default Security Group Rule Details ======================================== -.. rest_method:: GET /v2.1/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id} +.. rest_method:: GET /os-security-group-default-rules/{security_group_default_rule_id} Shows details for a security group rule. @@ -60,7 +53,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - security_group_default_rule_id: security_group_default_rule_id Response @@ -83,7 +75,7 @@ Response Create Default Security Group Rule ================================== -.. rest_method:: POST /v2.1/{tenant_id}/os-security-group-default-rules +.. rest_method:: POST /os-security-group-default-rules Creates a default security group rule. @@ -99,7 +91,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - id: id - ip_protocol: ip_protocol - from_port: from_port @@ -131,7 +122,7 @@ Response Delete Default Security Group Rule ================================== -.. rest_method:: DELETE /v2.1/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id} +.. rest_method:: DELETE /os-security-group-default-rules/{security_group_default_rule_id} Deletes a security group rule. @@ -144,7 +135,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - security_group_default_rule_id: security_group_default_rule_id Response diff --git a/api-ref/source/os-security-group-rules.inc b/api-ref/source/os-security-group-rules.inc index ab6c958535a..45fc6de3c99 100644 --- a/api-ref/source/os-security-group-rules.inc +++ b/api-ref/source/os-security-group-rules.inc @@ -11,7 +11,7 @@ Creates and deletes security group rules. Create Security Group Rule ========================== -.. rest_method:: POST /v2.1/{tenant_id}/os-security-group-rules +.. rest_method:: POST /os-security-group-rules Creates a rule for a security group. Either ``cidr`` or ``group_id`` must be specified when creating a rule. @@ -29,7 +29,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - security_group_rule: security_group_rule - parent_group_id: parent_group_id - ip_protocol: ip_protocol @@ -74,7 +74,7 @@ The ``ip_range`` is empty if ``cidr`` was not provided on the request. Delete Security Group Rule ========================== -.. rest_method:: DELETE /v2.1/{tenant_id}/os-security-group-rules/{security_group_rule_id} +.. rest_method:: DELETE /os-security-group-rules/{security_group_rule_id} Deletes a security group rule. @@ -87,7 +87,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - security_group_rule_id: security_group_rule_id Response diff --git a/api-ref/source/os-security-groups.inc b/api-ref/source/os-security-groups.inc index 22b49071f43..fc250041674 100644 --- a/api-ref/source/os-security-groups.inc +++ b/api-ref/source/os-security-groups.inc @@ -12,7 +12,7 @@ Lists, shows information for, creates, updates and deletes security groups. List Security Groups ==================== -.. rest_method:: GET /v2.1/{tenant_id}/os-security-groups +.. rest_method:: GET /os-security-groups Lists security groups. @@ -20,13 +20,6 @@ Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) -Request -------- - -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - Response -------- @@ -37,7 +30,8 @@ Response - id: id - name: name - rules: rules - - tenant_id: tenant_id + - tenant_id: tenant_id_body + **Example List security groups: JSON response** @@ -47,7 +41,7 @@ Response Create Security Group ===================== -.. rest_method:: POST /v2.1/{tenant_id}/os-security-groups +.. rest_method:: POST /os-security-groups Creates a security group. @@ -60,7 +54,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - security_group: security_group - name: name - description: description @@ -80,7 +73,8 @@ Response - id: id - name: name - rules: rules - - tenant_id: tenant_id + - tenant_id: tenant_id_body + **Example Create security group: JSON response** @@ -90,7 +84,7 @@ Response Show Security Group Details =========================== -.. rest_method:: GET /v2.1/{tenant_id}/os-security-groups/{security_group_id} +.. rest_method:: GET /os-security-groups/{security_group_id} Shows details for a security group. @@ -103,7 +97,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - security_group_id: security_group_id Response @@ -116,7 +109,8 @@ Response - id: id - name: name - rules: rules - - tenant_id: tenant_id + - tenant_id: tenant_id_body + **Example Show security group: JSON response** @@ -126,7 +120,7 @@ Response Update Security Group ===================== -.. rest_method:: PUT /v2.1/{tenant_id}/os-security-groups/{security_group_id} +.. rest_method:: PUT /os-security-groups/{security_group_id} Updates a security group. @@ -139,7 +133,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - security_group_id: security_group_id - name: name - description: description @@ -159,7 +152,8 @@ Response - id: id - name: name - rules: rules - - tenant_id: tenant_id + - tenant_id: tenant_id_body + **Example Update security group: JSON response** @@ -169,7 +163,7 @@ Response Delete Security Group ===================== -.. rest_method:: DELETE /v2.1/{tenant_id}/os-security-groups/{security_group_id} +.. rest_method:: DELETE /os-security-groups/{security_group_id} Deletes a security group. @@ -182,7 +176,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - security_group_id: security_group_id Response @@ -193,7 +186,7 @@ There is no body content for the response of a successful DELETE query. List Security Groups By Server ============================== -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-security-groups +.. rest_method:: GET /servers/{server_id}/os-security-groups Lists security groups for a server. @@ -206,7 +199,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - server_id: server_id Response @@ -219,7 +211,8 @@ Response - id: id - name: name - rules: rules - - tenant_id: tenant_id + - tenant_id: tenant_id_body + **Example List security groups by server: JSON response** diff --git a/api-ref/source/os-server-external-events.inc b/api-ref/source/os-server-external-events.inc index c652f3299bc..95eefe67521 100644 --- a/api-ref/source/os-server-external-events.inc +++ b/api-ref/source/os-server-external-events.inc @@ -20,7 +20,7 @@ server instance. Run Events ========== -.. rest_method:: POST /v2.1/{tenant_id}/os-server-external-events +.. rest_method:: POST /os-server-external-events Creates one or more external events, which the API dispatches to the host a server is assigned to. If the server is not currently assigned @@ -43,7 +43,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - events: events - name: event_name - server_uuid: server_uuid diff --git a/api-ref/source/os-server-groups.inc b/api-ref/source/os-server-groups.inc index 250c1365287..3998fff5da0 100644 --- a/api-ref/source/os-server-groups.inc +++ b/api-ref/source/os-server-groups.inc @@ -11,7 +11,7 @@ Lists, shows information for, creates, and deletes server groups. List Server Groups ================== -.. rest_method:: GET /v2.1/{tenant_id}/os-server-groups +.. rest_method:: GET /os-server-groups Lists all server groups for the tenant. @@ -24,13 +24,6 @@ Error response codes: unauthorized(401), forbidden(403) Request ------- -.. rest_parameters:: parameters.yaml - - - tenant_id: tenant_id - -Query Parameters -~~~~~~~~~~~~~~~~ - .. rest_parameters:: parameters.yaml - all_projects: all_projects @@ -57,7 +50,7 @@ Response Create Server Group =================== -.. rest_method:: POST /v2.1/{tenant_id}/os-server-groups +.. rest_method:: POST /os-server-groups Creates a server group. @@ -70,7 +63,6 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - name: name - policies: policies @@ -101,7 +93,7 @@ Response Show Server Group Details ========================= -.. rest_method:: GET /v2.1/{tenant_id}/os-server-groups/{server_group_id} +.. rest_method:: GET /os-server-groups/{server_group_id} Shows details for a server group. @@ -114,7 +106,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_group_id: server_group_id Response @@ -139,7 +131,7 @@ Response Delete Server Group =================== -.. rest_method:: DELETE /v2.1/{tenant_id}/os-server-groups/{server_group_id} +.. rest_method:: DELETE /os-server-groups/{server_group_id} Deletes a server group. @@ -152,9 +144,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id - server_group_id: server_group_id Response -------- - diff --git a/api-ref/source/os-server-password.inc b/api-ref/source/os-server-password.inc index 572384def7f..5b4a7a6b94a 100644 --- a/api-ref/source/os-server-password.inc +++ b/api-ref/source/os-server-password.inc @@ -11,7 +11,7 @@ server. Show Server Password ==================== -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-server-password +.. rest_method:: GET /servers/{server_id}/os-server-password Shows the administrative password for a server. @@ -35,7 +35,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id Response @@ -53,7 +53,7 @@ Response Clear Admin Password ==================== -.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id}/os-server-password +.. rest_method:: DELETE /servers/{server_id}/os-server-password Clears the encrypted administrative password for a server, which removes it from the database. @@ -73,7 +73,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id Response diff --git a/api-ref/source/os-services.inc b/api-ref/source/os-services.inc index 4da3bb2c044..d91eb5a6ec9 100644 --- a/api-ref/source/os-services.inc +++ b/api-ref/source/os-services.inc @@ -17,7 +17,7 @@ Compute `__ console for a server. @@ -22,7 +22,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-getRDPConsole: os-getRDPConsole @@ -42,7 +42,7 @@ Response Get Serial Console (os-getSerialConsole Action) =============================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Gets a serial console for a server. @@ -58,7 +58,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-getSerialConsole: os-getSerialConsole @@ -78,7 +78,7 @@ Response Get Spice Console (os-getSPICEConsole Action) ============================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Gets a SPICE console for a server. @@ -94,7 +94,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-getSPICEConsole: os-getSPICEConsole @@ -114,7 +114,7 @@ Response Get Vnc Console (os-getVNCConsole Action) ========================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Gets a VNC console for a server. @@ -130,7 +130,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-getVNCConsole: os-getVNCConsole diff --git a/api-ref/source/servers-action-shelve.inc b/api-ref/source/servers-action-shelve.inc index 08d85222410..dfe6513d463 100644 --- a/api-ref/source/servers-action-shelve.inc +++ b/api-ref/source/servers-action-shelve.inc @@ -3,7 +3,7 @@ Shelve Server (shelve Action) ============================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Shelves a server. @@ -38,7 +38,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - shelve: shelve @@ -59,7 +59,7 @@ No body is returned on successful request. Shelf-Offload (Remove) Server (shelveOffload Action) ==================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Shelf-offloads, or removes, a shelved server. @@ -92,7 +92,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - shelveOffload: shelveOffload @@ -113,7 +113,7 @@ No body is returned on successful request. Unshelve (Restore) Shelved Server (unshelve Action) =================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Unshelves, or restores, a shelved server. @@ -146,7 +146,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - unshelve: unshelve diff --git a/api-ref/source/servers-actions.inc b/api-ref/source/servers-actions.inc index 302d5c542e5..e87ea6b728f 100644 --- a/api-ref/source/servers-actions.inc +++ b/api-ref/source/servers-actions.inc @@ -28,7 +28,7 @@ You can get an RDP, serial, SPICE, or VNC console for a server. Add (Associate) Floating Ip (addFloatingIp Action) ================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Adds a floating IP address to a server, which associates that address with the server. @@ -61,7 +61,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - addFloatingIp: addFloatingIp - address: address @@ -79,7 +79,7 @@ Response Add Security Group To A Server (addSecurityGroup Action) ======================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Adds a security group to a server. @@ -95,7 +95,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - addSecurityGroup: addSecurityGroup - name: name @@ -111,7 +111,7 @@ Response Change Administrative Password (changePassword Action) ====================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Changes the administrative password for a server. @@ -131,7 +131,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - changePassword: changePassword @@ -146,7 +146,7 @@ Response Confirm Resized Server (confirmResize Action) ============================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Confirms a pending resize action for a server. @@ -183,7 +183,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - confirmResize: confirmResize @@ -198,7 +198,7 @@ Response Create Image (createImage Action) ================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Creates an image from a server. @@ -247,7 +247,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - createImage: createImage @@ -262,7 +262,7 @@ Response Lock Server (lock Action) ========================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Locks a server. @@ -281,7 +281,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - lock: lock @@ -296,7 +296,7 @@ Response Pause Server (pause Action) =========================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Pauses a server. Changes its status to ``PAUSED``. @@ -316,7 +316,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - pause: pause @@ -331,7 +331,7 @@ Response Reboot Server (reboot Action) ============================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Reboots a server. @@ -347,7 +347,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - reboot: reboot @@ -362,7 +362,7 @@ Response Rebuild Server (rebuild Action) =============================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Rebuilds a server. @@ -381,7 +381,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - rebuild: rebuild - imageRef: imageRef @@ -409,7 +409,7 @@ Response Remove (Disassociate) Floating Ip (removeFloatingIp Action) =========================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Removes, or disassociates, a floating IP address from a server. @@ -430,7 +430,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - removeFloatingIp: removeFloatingIp - address: address @@ -447,7 +447,7 @@ Response Remove Security Group From A Server (removeSecurityGroup Action) ================================================================ -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Removes a security group from a server. @@ -463,7 +463,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - removeSecurityGroup: removeSecurityGroup - name: name @@ -479,7 +479,7 @@ Response Rescue Server (rescue Action) ============================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Puts a server in rescue mode and changes its status to ``RESCUE``. @@ -491,9 +491,8 @@ reference, the base image reference is used by default. Asynchronous Postconditions -After you successfully rescue a server and make a -``GET /v2.1/​{tenant_id}​/servers/​{server_id}​`` -request, its status changes to ``RESCUE``. +After you successfully rescue a server and make a ``GET +/servers/​{server_id}​`` request, its status changes to ``RESCUE``. Normal response codes: 202 @@ -505,7 +504,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - rescue: rescue - adminPass: adminPass_rescue @@ -531,7 +530,7 @@ Response Resize Server (resize Action) ============================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Resizes a server. @@ -560,7 +559,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - resize: resize @@ -575,7 +574,7 @@ Response Resume Suspended Server (resume Action) ======================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Resumes a suspended server and changes its status to ``ACTIVE``. @@ -595,7 +594,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - resume: resume @@ -610,7 +609,7 @@ Response Revert Resized Server (revertResize Action) =========================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Cancels and reverts a pending resize action for a server. @@ -648,7 +647,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - revertResize: revertResize @@ -663,7 +662,7 @@ Response Start Server (os-start Action) ============================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Starts a stopped server and changes its status to ``ACTIVE``. @@ -698,7 +697,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-start: os-start @@ -713,7 +712,7 @@ Response Stop Server (os-stop Action) ============================ -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Stops a running server and changes its status to ``SHUTOFF``. @@ -742,7 +741,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-stop: os-stop @@ -757,7 +756,7 @@ Response Suspend Server (suspend Action) =============================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Suspends a server and changes its status to ``SUSPENDED``. @@ -777,7 +776,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - suspend: suspend @@ -792,7 +791,7 @@ Response Unlock Server (unlock Action) ============================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Unlocks a locked server. @@ -811,7 +810,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - unlock: unlock @@ -826,7 +825,7 @@ Response Unpause Server (unpause Action) =============================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Unpauses a paused server and changes its status to ``ACTIVE``. @@ -846,7 +845,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - unpause: unpause @@ -861,7 +860,7 @@ Response Unrescue Server (unrescue Action) ================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Unrescues a server. Changes status to ``ACTIVE``. @@ -876,7 +875,7 @@ You can only unrescue a server when its status is ``RESCUE``. Asynchronous Postconditions After you successfully unrescue a server and make a -``GET /v2.1/​{tenant_id}​/servers/​{server_id}​`` +``GET /servers/​{server_id}​`` request, its status changes to ``ACTIVE``. Normal response codes: 202 @@ -889,7 +888,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - unrescue: unrescue diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc index 8f534694be3..0cc08265bf9 100644 --- a/api-ref/source/servers-admin-action.inc +++ b/api-ref/source/servers-admin-action.inc @@ -16,7 +16,7 @@ of a server. Create Server Back Up (createBackup Action) =========================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Creates a back up of a server. @@ -36,7 +36,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - createBackup: createBackup - name: backup_name @@ -58,7 +58,7 @@ will be returned. Inject Network Information (injectNetworkInfo Action) ===================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Injects network information into a server. @@ -81,7 +81,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - injectNetworkInfo: injectNetworkInfo @@ -98,7 +98,7 @@ On success no body is returned. Migrate Server (migrate Action) =============================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Migrates a server to a host. The scheduler chooses the host. @@ -118,7 +118,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - migrate: migrate @@ -135,7 +135,7 @@ On success no body is returned. Live-Migrate Server (os-migrateLive Action) =========================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Live-migrates a server to a new host without rebooting. @@ -165,7 +165,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - host: host_migration - block_migration: block_migration @@ -184,7 +184,7 @@ On success no body is returned. Reset Networking On A Server (resetNetwork Action) ================================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Resets networking on a server. @@ -209,7 +209,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - resetNetwork: resetNetwork @@ -226,7 +226,7 @@ On success no body is returned. Reset Server State (os-resetState Action) ========================================= -.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action +.. rest_method:: POST /servers/{server_id}/action Resets the state of a server. @@ -245,7 +245,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id - os-resetState: os-resetState - os-resetState.state: os-resetState_state diff --git a/api-ref/source/servers-multiple-create.inc b/api-ref/source/servers-multiple-create.inc index 8dac49003f0..e5ca393d673 100644 --- a/api-ref/source/servers-multiple-create.inc +++ b/api-ref/source/servers-multiple-create.inc @@ -18,7 +18,7 @@ shows only the reservation ID. Create Multiple Servers ======================= -.. rest_method:: POST /v2.1/{tenant_id}/servers +.. rest_method:: POST /servers Creates one or more servers. @@ -32,7 +32,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - security_groups: security_groups - user_data: user_data - os-availability-zone:availability_zone: os-availability-zone:availability_zone @@ -84,7 +84,7 @@ Response Create Multiple Servers With Reservation Id =========================================== -.. rest_method:: POST /v2.1/{tenant_id}/servers +.. rest_method:: POST /servers Creates one or more servers with a reservation ID. @@ -100,7 +100,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - security_groups: security_groups - user_data: user_data - os-availability-zone:availability_zone: os-availability-zone:availability_zone diff --git a/api-ref/source/servers.inc b/api-ref/source/servers.inc index 55432bc3be4..8ff39d53b3a 100644 --- a/api-ref/source/servers.inc +++ b/api-ref/source/servers.inc @@ -98,7 +98,7 @@ access the server directly. List Servers ============ -.. rest_method:: GET /v2.1/{tenant_id}/servers +.. rest_method:: GET /servers Lists IDs, names, and links for all servers. @@ -156,7 +156,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - limit: limit - marker: marker - sort_key: sort_key @@ -195,7 +195,7 @@ Response Create Server ============= -.. rest_method:: POST /v2.1/{tenant_id}/servers +.. rest_method:: POST /servers Creates a server. @@ -277,7 +277,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server: server - name: server_name - flavorRef: flavorRef @@ -360,7 +360,7 @@ Response List Servers Detailed ===================== -.. rest_method:: GET /v2.1/​{tenant_id}​/servers/detail +.. rest_method:: GET /servers/detail For each server, shows server details including configuration drive, extended status, and server usage information. @@ -387,7 +387,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - limit: limit - marker: marker - sort_key: sort_key @@ -455,7 +455,7 @@ Response Show Server Details =================== -.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id} +.. rest_method:: GET /servers/{server_id} Shows details for a server. @@ -483,7 +483,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path Response @@ -534,7 +534,7 @@ Response Update Server ============= -.. rest_method:: PUT /v2.1/{tenant_id}/servers/{server_id} +.. rest_method:: PUT /servers/{server_id} Updates the editable attributes of an existing server. @@ -548,7 +548,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path - accessIPv4: accessIPv4_in - accessIPv6: accessIPv6_in @@ -609,7 +609,7 @@ Response - security_group.name: name - status: server_status - host_status: host_status - - tenant_id: tenant_id + - tenant_id: tenant_id_body - updated: updated - user_id: user_id @@ -621,7 +621,7 @@ Response Delete Server ============= -.. rest_method:: DELETE /v2.1/{tenant_id}/servers/{server_id} +.. rest_method:: DELETE /servers/{server_id} Deletes a server. @@ -671,7 +671,7 @@ Request .. rest_parameters:: parameters.yaml - - tenant_id: tenant_id + - server_id: server_id_path Response diff --git a/api-ref/source/urls.inc b/api-ref/source/urls.inc new file mode 100644 index 00000000000..fe867dd44fb --- /dev/null +++ b/api-ref/source/urls.inc @@ -0,0 +1,26 @@ +.. -*- rst -*- + +============== + Service URLs +============== + +All API calls through the rest of this document require authentication +with the OpenStack Identity service. They also required a base +``service url`` that is extracted from the Identity token of type +``compute``. This will be the root url that every call below will be +added to build a full path. + +For instance, if the ``service url`` is +``http://mycompute.pvt/compute/v2.1`` then the full API call for +``/servers`` is ``http://mycompute.pvt/compute/v2.1/servers``. + +Depending on the deployment the compute service url might be http or +https, a custom port, a custom path, and include your tenant id. The +only way to know the urls for your deployment is by using the service +catalog. The compute URL should never be hard coded in applications, +even if they are only expected to work at a single site. It should +always be discovered from the Identity token. + +As such, for the rest of this document we will be using short hand +where ``GET /servers`` really means ``GET +{your_compute_service_url}/servers``. diff --git a/api-ref/source/versions.inc b/api-ref/source/versions.inc index 652ab078c36..850af3013cd 100644 --- a/api-ref/source/versions.inc +++ b/api-ref/source/versions.inc @@ -4,9 +4,6 @@ API Versions ============== -Concepts -======== - In order to bring new features to users over time, the Nova API supports versioning. There are two kinds of versions in Nova. @@ -19,6 +16,9 @@ For more detail about Microversion, please reference: `Microversions `_ +The Version APIs work differently from other APIs as they *do not* +require authentication. + List All Major Versions =======================