Replace remaining reference to policy.json

The json format of policy files was deprecated long ago and is being
removed completely. Mention policy.yaml instead.

Change-Id: I9f6f11fd563d39a4fc1b940c67084292de7c56e3
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
This commit is contained in:
Takashi Kajinami
2025-12-12 01:22:16 +09:00
parent 23b462d77d
commit 56e31f8d4e
27 changed files with 77 additions and 83 deletions
+1 -1
View File
@@ -14,7 +14,7 @@ Show Server Diagnostics
Shows basic usage data for a server.
Policy defaults enable only users with the administrative role. Cloud
providers can change these permissions through the ``policy.json``
providers can change these permissions through the ``policy.yaml``
file.
Normal response codes: 200
+1 -1
View File
@@ -226,7 +226,7 @@ This API is available starting with microversion 2.55.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 200
+1 -1
View File
@@ -23,7 +23,7 @@ server. By default, operators provide pre-built operating system images.
You can also create custom images. See: `Create Image Action
<https://docs.openstack.org/api-ref/compute/#create-image-createimage-action>`__.
By default, the ``policy.json`` file authorizes all users to view the
By default, the ``policy.yaml`` file authorizes all users to view the
image size in the ``OS-EXT-IMG-SIZE:size`` extended attribute.
List Images
+2 -2
View File
@@ -16,7 +16,7 @@ Lists IP addresses that are assigned to an instance.
Policy defaults enable only users with the administrative role or the owner of
the server to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -53,7 +53,7 @@ Shows IP addresses details for a network label of a server instance.
Policy defaults enable only users with the administrative role or the owner of
the server to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
Normal response codes: 200
+6 -6
View File
@@ -17,7 +17,7 @@ List All Metadata
Lists all metadata for a server.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -54,7 +54,7 @@ Creates any metadata items that do not already exist in the server, replaces
exists metadata items that match keys. Does not modify items that are not in
the request.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -96,7 +96,7 @@ Replaces one or more metadata items for a server.
Creates any metadata items that do not already exist in the server. Removes and completely replaces any metadata items that already exist in the server with the metadata items in the request.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -136,7 +136,7 @@ Show Metadata Item Details
Shows details for a metadata item, by key, for a server.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -173,7 +173,7 @@ Creates or replaces a metadata item, by key, for a server.
Creates a metadata item that does not already exist in the server. Replaces
existing metadata items that match keys with the metadata item in the request.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -213,7 +213,7 @@ Delete Metadata Item
Deletes a metadata item, by key, from a server.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 204
+1 -1
View File
@@ -52,7 +52,7 @@ Get Detailed Availability Zone Information
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.
Cloud providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
+1 -1
View File
@@ -26,7 +26,7 @@ Lists floating IP pools.
Policy defaults enable only users with the administrative role or user
who is authorized to operate on tenant <tenant_id> to perform this
operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
Normal response codes: 200
+4 -4
View File
@@ -46,7 +46,7 @@ Lists floating IP addresses associated with the tenant or account.
Policy defaults enable only users with the administrative role
or the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -82,7 +82,7 @@ If more than one floating IP address pool is available, use the
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -127,7 +127,7 @@ Shows details for a floating IP address, by ID, that is associated with the tena
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -171,7 +171,7 @@ it is automatically disassociated from that instance.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
+2 -2
View File
@@ -34,7 +34,7 @@ Specify the ``include`` and ``exclude`` query parameters to filter the results.
Policy defaults enable only users with the administrative role or the
owner of the server to perform this operation. Cloud providers can
change these permissions through the ``policy.json`` file.
change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -77,7 +77,7 @@ Runs the fping utility to ping an instance and reports whether the instance is a
Policy defaults enable only users with the administrative role or the
owner of the server to perform this operation. Cloud providers can
change these permissions through the ``policy.json`` file.
change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
+1 -1
View File
@@ -20,7 +20,7 @@ matrix <https://docs.openstack.org/nova/latest/user/support-matrix.html>`__
Policy defaults enable only users with the administrative role to perform
all os-hosts related operations. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
List Hosts
==========
+7 -7
View File
@@ -22,7 +22,7 @@ Lists hypervisors.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
Normal response codes: 200
@@ -75,7 +75,7 @@ Lists hypervisors details.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
Normal response codes: 200
@@ -160,7 +160,7 @@ Shows summary statistics for all enabled hypervisors over all compute nodes.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
.. note::
@@ -209,7 +209,7 @@ Shows details for a given hypervisor.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
.. note::
@@ -301,7 +301,7 @@ Shows the uptime for a given hypervisor.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
Normal response codes: 200
@@ -353,7 +353,7 @@ Search hypervisor by a given hypervisor host name or portion of it.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
Normal response code: 200
@@ -398,7 +398,7 @@ a given hypervisor host name or portion of it.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the ``policy.json`` file.
the ``policy.yaml`` file.
Normal response code: 200
+2 -2
View File
@@ -18,7 +18,7 @@ starting with microversion 2.21.
Policy defaults enable only users with the administrative role or the owner of
the server to perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 200
@@ -75,7 +75,7 @@ than microversion 2.21.
Policy defaults enable only users with the administrative role or the owner of
the server to perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 200
@@ -10,7 +10,7 @@ where usage auditing is required.
Policy defaults enable only users with the administrative role to perform
all os-instance-usage-audit-log related operations. Cloud providers can change
these permissions through the ``policy.json`` file.
these permissions through the ``policy.yaml`` file.
List Server Usage Audits
========================
+1 -1
View File
@@ -15,7 +15,7 @@ Lists migrations.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
Starting from microversion 2.59, the response is sorted by ``created_at``
and ``id`` in descending order.
+9 -9
View File
@@ -31,7 +31,7 @@ List Networks
Lists networks for the project.
Policy defaults enable all users to perform this operation. Cloud
providers can change these permissions through the ``policy.json`` file.
providers can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -54,7 +54,7 @@ Creates a network.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the ``policy.json`` file.
these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -86,7 +86,7 @@ Adds a network to a project.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
Normal response codes: 202
@@ -112,7 +112,7 @@ Show Network Details
Shows details for a network.
Policy defaults enable all users to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -142,7 +142,7 @@ Deletes a network.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the ``policy.json`` file.
these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -172,7 +172,7 @@ Specify the ``associate_host`` action in the request body.
Policy defaults enable only users with the administrative role or the owner
of the network to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -208,7 +208,7 @@ Specify the ``disassociate`` action in the request body.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the ``policy.json`` file.
these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -243,7 +243,7 @@ Specify the ``disassociate_host`` action in the request body.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the ``policy.json`` file.
these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -279,7 +279,7 @@ Specify the ``disassociate_project`` action in the request body.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the ``policy.json`` file.
these permissions through the ``policy.yaml`` file.
Normal response codes: 202
+2 -2
View File
@@ -24,7 +24,7 @@ read the password.
Policy defaults enable only users with the administrative role or the owner
of the server to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -61,7 +61,7 @@ This action does not actually change the instance server password.
Policy defaults enable only users with the administrative role or the owner
of the server to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
Normal response codes: 204
+4 -4
View File
@@ -23,7 +23,7 @@ Lists all project networks.
Policy defaults enable only users with the administrative role or
the owner of the network to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -51,7 +51,7 @@ Creates a project network.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 200
@@ -80,7 +80,7 @@ Shows details for a project network.
Policy defaults enable only users with the administrative role or
the owner of the network to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -116,7 +116,7 @@ Deletes a project network.
Policy defaults enable only users with the administrative role or
the owner of the network to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
+1 -1
View File
@@ -30,7 +30,7 @@ Lists the virtual interfaces for an instance.
Policy defaults enable only users with the administrative role or the owner of
the server to perform this operation. Change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
Normal response codes: 200
+5 -5
View File
@@ -2710,7 +2710,7 @@ event_host:
Policy defaults enable only users with the administrative role to see
an instance action event host. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
in: body
required: false
type: string
@@ -2790,7 +2790,7 @@ event_traceback:
Policy defaults enable only users with the administrative role to see
an instance action event traceback. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
in: body
required: true
type: string
@@ -4145,7 +4145,7 @@ instance_action_events_2_50:
Policy defaults enable only users with the administrative role to see
instance action event information. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
in: body
required: false
type: array
@@ -4156,7 +4156,7 @@ instance_action_events_2_51:
Policy defaults enable only users with the administrative role or the owner
of the server to see instance action event information. Cloud providers can
change these permissions through the ``policy.json`` file.
change these permissions through the ``policy.yaml`` file.
in: body
required: true
type: array
@@ -5798,7 +5798,7 @@ pool:
are available, the call returns the ``400`` response code with an informational
message. Policy defaults enable only users with the administrative role or the
owner of the server to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
in: body
required: false
type: string
+4 -4
View File
@@ -17,7 +17,7 @@ Lists in-progress live migrations for a given server.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
Normal response codes: 200
@@ -72,7 +72,7 @@ Show details for an in-progress live migration for a given server.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
Normal response codes: 200
@@ -135,7 +135,7 @@ Specify the ``force_complete`` action in the request body.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
**Preconditions**
@@ -202,7 +202,7 @@ Abort an in-progress live migration.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
``policy.json`` file.
``policy.yaml`` file.
**Preconditions**
+1 -1
View File
@@ -16,7 +16,7 @@ Shows NUMA topology information for a server.
Policy defaults enable only users with the administrative role or the owners
of the server to perform this operation. Cloud providers can change these
permissions through the ``policy.json`` file.
permissions through the ``policy.yaml`` file.
Normal response codes: 200
@@ -11,7 +11,7 @@ Specify the ``forceDelete`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -49,7 +49,7 @@ Specify the ``restore`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
+2 -2
View File
@@ -17,7 +17,7 @@ Specify the ``addFixedIp`` action and the network ID in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -59,7 +59,7 @@ Specify the ``removeFixedIp`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
+3 -3
View File
@@ -11,7 +11,7 @@ Specify the ``shelve`` action in the request body.
All associated data and resources are kept but anything still in memory is not retained. To restore a shelved instance, use the ``unshelve`` action. To remove a shelved instance, use the ``shelveOffload`` action.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
**Preconditions**
@@ -66,7 +66,7 @@ Specify the ``shelveOffload`` action in the request body.
Data and resource associations are deleted. If an instance is no longer needed, you can remove that instance from the hypervisor to minimize resource usage.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
**Preconditions**
@@ -117,7 +117,7 @@ Unshelves, or restores, a shelved server.
Specify the ``unshelve`` action in the request body.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file.
Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.yaml`` file.
**Preconditions**
+8 -8
View File
@@ -126,7 +126,7 @@ Specify the ``changePassword`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers can
change these permissions through the ``policy.json`` file.
change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -230,7 +230,7 @@ Specify the ``createBackup`` action in the request body.
Policy defaults enable only users with the administrative role or the
owner of the server to perform this operation. Cloud providers can
change these permissions through the ``policy.json`` file.
change these permissions through the ``policy.yaml`` file.
.. note::
Starting from version 2.39 the image quota enforcement with Nova `metadata`
@@ -403,7 +403,7 @@ the `Show Server Details API
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Administrators can overwrite owner's lock.
Normal response codes: 202
@@ -447,7 +447,7 @@ Specify the ``pause`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -899,7 +899,7 @@ Specify the ``resume`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -1090,7 +1090,7 @@ Specify the ``suspend`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -1127,7 +1127,7 @@ Specify the ``unlock`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
@@ -1163,7 +1163,7 @@ Specify the ``unpause`` action in the request body.
Policy defaults enable only users with the administrative role or
the owner of the server to perform this operation. Cloud providers
can change these permissions through the ``policy.json`` file.
can change these permissions through the ``policy.yaml`` file.
Normal response codes: 202
+5 -5
View File
@@ -23,7 +23,7 @@ Specify the ``injectNetworkInfo`` action in the request body.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
.. warning:: There is very limited support on this API, For more information,
see `nova virt support matrix
@@ -78,7 +78,7 @@ automatically confirms the migrate operation after the configured interval.
There are two different policies for this action, depending on whether the host
parameter is set. Both defaults enable only users with the administrative role
to perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 202
@@ -130,7 +130,7 @@ migration.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Starting from REST API version 2.34 pre-live-migration checks are done
asynchronously, results of these checks are available in ``instance-actions``.
@@ -189,7 +189,7 @@ Specify the ``resetNetwork`` action in the request body.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 202
@@ -227,7 +227,7 @@ Specify the ``os-resetState`` action and the ``state`` in the request body.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the ``policy.json`` file.
through the ``policy.yaml`` file.
Normal response codes: 202