diff options
author | Zuul <zuul@review.opendev.org> | 2021-08-29 08:39:44 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2021-08-29 08:39:44 +0000 |
commit | d5f22c6652b6323f44d717074243623a6a1d381e (patch) | |
tree | 23019c604f9e0e9e923fbd8f24b8f7c757b66e7c /api-ref | |
parent | 244a75fd6b79ff33e93442eb8ff0d48392818b21 (diff) | |
parent | ec44fc89997624c692635d5fae8fba4ca5d9aa02 (diff) | |
download | cinder-d5f22c6652b6323f44d717074243623a6a1d381e.tar.gz |
Merge "Expose volume & snapshot use_quota field"
Diffstat (limited to 'api-ref')
21 files changed, 316 insertions, 27 deletions
diff --git a/api-ref/source/v3/parameters.yaml b/api-ref/source/v3/parameters.yaml index 3551f3301..cf806829d 100644 --- a/api-ref/source/v3/parameters.yaml +++ b/api-ref/source/v3/parameters.yaml @@ -214,6 +214,18 @@ detail: in: query required: false type: boolean +filter_consumes_quota: + description: | + Filters results by ``consumes_quota`` field. Resources that don't use + quotas are usually temporary internal resources created to perform an + operation. Default is to not filter by it. Filtering by this option may + not be always possible in a cloud, see + :ref:`List Resource Filters <resource-filters>` to determine whether this + filter is available in your cloud. + in: query + required: false + type: boolean + min_version: 3.65 filter_created_at: description: | Filters reuslts by a time that resources are created at with time @@ -841,6 +853,15 @@ consumer: in: body required: false type: string +consumes_quota: + description: | + Whether this resource consumes quota or not. Resources that not counted + for quota usage are usually temporary internal resources created to perform + an operation. + in: body + required: false + type: boolean + min_version: 3.65 container: description: | The container name or null. diff --git a/api-ref/source/v3/resource-filters.inc b/api-ref/source/v3/resource-filters.inc index b5064e965..37f662c75 100644 --- a/api-ref/source/v3/resource-filters.inc +++ b/api-ref/source/v3/resource-filters.inc @@ -1,5 +1,7 @@ .. -*- rst -*- +.. _resource-filters: + Resource Filters (resource_filters) =================================== diff --git a/api-ref/source/v3/samples/snapshots/snapshot-create-response.json b/api-ref/source/v3/samples/snapshots/snapshot-create-response.json index 8819dd94a..e19e407c8 100644 --- a/api-ref/source/v3/samples/snapshots/snapshot-create-response.json +++ b/api-ref/source/v3/samples/snapshots/snapshot-create-response.json @@ -12,4 +12,4 @@ "updated_at": null, "volume_id": "d291b81c-6e40-4525-8231-90aa1588121e" } -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/samples/snapshots/snapshot-show-response.json b/api-ref/source/v3/samples/snapshots/snapshot-show-response.json index da7e68da1..b4979f368 100644 --- a/api-ref/source/v3/samples/snapshots/snapshot-show-response.json +++ b/api-ref/source/v3/samples/snapshots/snapshot-show-response.json @@ -14,4 +14,4 @@ "updated_at": null, "volume_id": "b72c48f1-64b7-4cd8-9745-b12e0be82d37" } -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/samples/snapshots/snapshot-update-response.json b/api-ref/source/v3/samples/snapshots/snapshot-update-response.json index 5d9c9bb4d..d69a8aedc 100644 --- a/api-ref/source/v3/samples/snapshots/snapshot-update-response.json +++ b/api-ref/source/v3/samples/snapshots/snapshot-update-response.json @@ -12,4 +12,4 @@ "updated_at": null, "volume_id": "070c942d-9909-42e9-a467-7a781f150c58" } -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/samples/snapshots/snapshots-list-detailed-response.json b/api-ref/source/v3/samples/snapshots/snapshots-list-detailed-response.json index 9c452f387..a73af2094 100644 --- a/api-ref/source/v3/samples/snapshots/snapshots-list-detailed-response.json +++ b/api-ref/source/v3/samples/snapshots/snapshots-list-detailed-response.json @@ -16,4 +16,4 @@ "volume_id": "7acd675e-4e06-4653-af9f-2ecd546342d6" } ] -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/samples/snapshots/v3.65/snapshot-create-response.json b/api-ref/source/v3/samples/snapshots/v3.65/snapshot-create-response.json new file mode 100644 index 000000000..b38d66242 --- /dev/null +++ b/api-ref/source/v3/samples/snapshots/v3.65/snapshot-create-response.json @@ -0,0 +1,18 @@ +{ + "snapshot": { + "created_at": "2019-03-11T16:24:34.469003", + "description": "Daily backup", + "id": "b36476e5-d18b-47f9-ac69-4818cb43ee21", + "metadata": { + "key": "v3" + }, + "name": "snap-001", + "size": 10, + "status": "creating", + "updated_at": null, + "volume_id": "d291b81c-6e40-4525-8231-90aa1588121e", + "group_snapshot_id": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "consumes_quota": true + } +} diff --git a/api-ref/source/v3/samples/snapshots/v3.65/snapshot-show-response.json b/api-ref/source/v3/samples/snapshots/v3.65/snapshot-show-response.json new file mode 100644 index 000000000..69be72e98 --- /dev/null +++ b/api-ref/source/v3/samples/snapshots/v3.65/snapshot-show-response.json @@ -0,0 +1,20 @@ +{ + "snapshot": { + "created_at": "2019-03-12T04:42:00.809352", + "description": "Daily backup", + "id": "4a584cae-e4ce-429b-9154-d4c9eb8fda4c", + "metadata": { + "key": "v3" + }, + "name": "snap-001", + "os-extended-snapshot-attributes:progress": "0%", + "os-extended-snapshot-attributes:project_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3", + "size": 10, + "status": "creating", + "updated_at": null, + "volume_id": "b72c48f1-64b7-4cd8-9745-b12e0be82d37", + "group_snapshot_id": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "consumes_quota": true + } +} diff --git a/api-ref/source/v3/samples/snapshots/v3.65/snapshot-update-response.json b/api-ref/source/v3/samples/snapshots/v3.65/snapshot-update-response.json new file mode 100644 index 000000000..c097889d2 --- /dev/null +++ b/api-ref/source/v3/samples/snapshots/v3.65/snapshot-update-response.json @@ -0,0 +1,18 @@ +{ + "snapshot": { + "created_at": "2019-03-12T04:53:53.426591", + "description": "This is yet, another snapshot.", + "id": "43666194-8e72-451a-b7bb-54fef763b2b8", + "metadata": { + "key": "v3" + }, + "name": "snap-002", + "size": 10, + "status": "creating", + "updated_at": null, + "volume_id": "070c942d-9909-42e9-a467-7a781f150c58", + "group_snapshot_id": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "consumes_quota": true + } +} diff --git a/api-ref/source/v3/samples/snapshots/v3.65/snapshots-list-detailed-response.json b/api-ref/source/v3/samples/snapshots/v3.65/snapshots-list-detailed-response.json new file mode 100644 index 000000000..7c9e8d476 --- /dev/null +++ b/api-ref/source/v3/samples/snapshots/v3.65/snapshots-list-detailed-response.json @@ -0,0 +1,22 @@ +{ + "snapshots": [ + { + "created_at": "2019-03-11T16:24:36.464445", + "description": "Daily backup", + "id": "d0083dc5-8795-4c1a-bc9c-74f70006c205", + "metadata": { + "key": "v3" + }, + "name": "snap-001", + "os-extended-snapshot-attributes:progress": "0%", + "os-extended-snapshot-attributes:project_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3", + "size": 10, + "status": "creating", + "updated_at": null, + "volume_id": "7acd675e-4e06-4653-af9f-2ecd546342d6", + "group_snapshot_id": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "consumes_quota": true + } + ] +} diff --git a/api-ref/source/v3/samples/versions/version-show-response.json b/api-ref/source/v3/samples/versions/version-show-response.json index 5e34efae7..1d79bf38f 100644 --- a/api-ref/source/v3/samples/versions/version-show-response.json +++ b/api-ref/source/v3/samples/versions/version-show-response.json @@ -21,8 +21,8 @@ ], "min_version": "3.0", "status": "CURRENT", - "updated": "2021-05-30T00:00:00Z", - "version": "3.64" + "updated": "2021-08-25T00:00:00Z", + "version": "3.65" } ] } diff --git a/api-ref/source/v3/samples/versions/versions-response.json b/api-ref/source/v3/samples/versions/versions-response.json index 529ca5d21..dd7b843d1 100644 --- a/api-ref/source/v3/samples/versions/versions-response.json +++ b/api-ref/source/v3/samples/versions/versions-response.json @@ -21,8 +21,8 @@ ], "min_version": "3.0", "status": "CURRENT", - "updated": "2021-05-30T00:00:00Z", - "version": "3.64" + "updated": "2021-08-25T00:00:00Z", + "version": "3.65" } ] } diff --git a/api-ref/source/v3/samples/volumes/v3.65/volume-create-response.json b/api-ref/source/v3/samples/volumes/v3.65/volume-create-response.json new file mode 100644 index 000000000..4dc4775ff --- /dev/null +++ b/api-ref/source/v3/samples/volumes/v3.65/volume-create-response.json @@ -0,0 +1,41 @@ +{ + "volume": { + "attachments": [], + "availability_zone": "nova", + "bootable": "false", + "consistencygroup_id": null, + "created_at": "2018-11-28T06:21:12.715987", + "description": null, + "encrypted": false, + "id": "2b955850-f177-45f7-9f49-ecb2c256d161", + "links": [ + { + "href": "http://127.0.0.1:33951/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/2b955850-f177-45f7-9f49-ecb2c256d161", + "rel": "self" + }, + { + "href": "http://127.0.0.1:33951/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/2b955850-f177-45f7-9f49-ecb2c256d161", + "rel": "bookmark" + } + ], + "metadata": {}, + "migration_status": null, + "multiattach": false, + "name": null, + "replication_status": null, + "size": 10, + "snapshot_id": null, + "source_volid": null, + "status": "creating", + "updated_at": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "volume_type": "__DEFAULT__", + "group_id": null, + "provider_id": null, + "service_uuid": null, + "shared_targets": true, + "cluster_name": null, + "volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d", + "consumes_quota": true + } +} diff --git a/api-ref/source/v3/samples/volumes/v3.65/volume-show-response.json b/api-ref/source/v3/samples/volumes/v3.65/volume-show-response.json new file mode 100644 index 000000000..690bb228b --- /dev/null +++ b/api-ref/source/v3/samples/volumes/v3.65/volume-show-response.json @@ -0,0 +1,45 @@ +{ + "volume": { + "attachments": [], + "availability_zone": "nova", + "bootable": "false", + "consistencygroup_id": null, + "created_at": "2018-11-29T06:50:07.770785", + "description": null, + "encrypted": false, + "id": "f7223234-1afc-4d19-bfa3-d19deb6235ef", + "links": [ + { + "href": "http://127.0.0.1:45839/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/f7223234-1afc-4d19-bfa3-d19deb6235ef", + "rel": "self" + }, + { + "href": "http://127.0.0.1:45839/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/f7223234-1afc-4d19-bfa3-d19deb6235ef", + "rel": "bookmark" + } + ], + "metadata": {}, + "migration_status": null, + "multiattach": false, + "name": null, + "os-vol-host-attr:host": null, + "os-vol-mig-status-attr:migstat": null, + "os-vol-mig-status-attr:name_id": null, + "os-vol-tenant-attr:tenant_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3", + "replication_status": null, + "size": 10, + "snapshot_id": null, + "source_volid": null, + "status": "creating", + "updated_at": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "volume_type": "__DEFAULT__", + "provider_id": null, + "group_id": null, + "service_uuid": null, + "shared_targets": true, + "cluster_name": null, + "volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d", + "consumes_quota": true + } +} diff --git a/api-ref/source/v3/samples/volumes/v3.65/volume-update-response.json b/api-ref/source/v3/samples/volumes/v3.65/volume-update-response.json new file mode 100644 index 000000000..3d8f20926 --- /dev/null +++ b/api-ref/source/v3/samples/volumes/v3.65/volume-update-response.json @@ -0,0 +1,43 @@ +{ + "volume": { + "attachments": [], + "availability_zone": "nova", + "bootable": "false", + "consistencygroup_id": null, + "created_at": "2018-11-29T06:59:23.679903", + "description": "This is yet, another volume.", + "encrypted": false, + "id": "8b2459d1-0059-4e14-a89f-dfa73a452af6", + "links": [ + { + "href": "http://127.0.0.1:41467/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/8b2459d1-0059-4e14-a89f-dfa73a452af6", + "rel": "self" + }, + { + "href": "http://127.0.0.1:41467/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/8b2459d1-0059-4e14-a89f-dfa73a452af6", + "rel": "bookmark" + } + ], + "metadata": { + "name": "metadata0" + }, + "migration_status": null, + "multiattach": false, + "name": "vol-003", + "replication_status": null, + "size": 10, + "snapshot_id": null, + "source_volid": null, + "status": "creating", + "updated_at": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "volume_type": "__DEFAULT__", + "group_id": null, + "provider_id": null, + "service_uuid": null, + "shared_targets": true, + "cluster_name": null, + "volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d", + "consumes_quota": true + } +} diff --git a/api-ref/source/v3/samples/volumes/v3.65/volumes-list-detailed-response.json b/api-ref/source/v3/samples/volumes/v3.65/volumes-list-detailed-response.json new file mode 100644 index 000000000..ceaa39c79 --- /dev/null +++ b/api-ref/source/v3/samples/volumes/v3.65/volumes-list-detailed-response.json @@ -0,0 +1,47 @@ +{ + "volumes": [ + { + "attachments": [], + "availability_zone": "nova", + "bootable": "false", + "consistencygroup_id": null, + "created_at": "2018-11-28T06:25:15.288987", + "description": null, + "encrypted": false, + "id": "cb49b381-9012-40cb-b8ee-80c19a4801b5", + "links": [ + { + "href": "http://127.0.0.1:43543/v3/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/cb49b381-9012-40cb-b8ee-80c19a4801b5", + "rel": "self" + }, + { + "href": "http://127.0.0.1:43543/89afd400-b646-4bbc-b12b-c0a4d63e5bd3/volumes/cb49b381-9012-40cb-b8ee-80c19a4801b5", + "rel": "bookmark" + } + ], + "metadata": {}, + "migration_status": null, + "multiattach": false, + "name": null, + "os-vol-host-attr:host": null, + "os-vol-mig-status-attr:migstat": null, + "os-vol-mig-status-attr:name_id": null, + "os-vol-tenant-attr:tenant_id": "89afd400-b646-4bbc-b12b-c0a4d63e5bd3", + "replication_status": null, + "size": 10, + "snapshot_id": null, + "source_volid": null, + "status": "creating", + "updated_at": null, + "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", + "volume_type": "__DEFAULT__", + "volume_type_id": "5fed9d7c-401d-46e2-8e80-f30c70cb7e1d", + "provider_id": null, + "group_id": null, + "service_uuid": null, + "shared_targets": true, + "cluster_name": null, + "consumes_quota": true + } + ] +} diff --git a/api-ref/source/v3/samples/volumes/volume-create-response.json b/api-ref/source/v3/samples/volumes/volume-create-response.json index 30feb2ac6..4bd8a6e0f 100644 --- a/api-ref/source/v3/samples/volumes/volume-create-response.json +++ b/api-ref/source/v3/samples/volumes/volume-create-response.json @@ -31,4 +31,4 @@ "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", "volume_type": "__DEFAULT__" } -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/samples/volumes/volume-show-response.json b/api-ref/source/v3/samples/volumes/volume-show-response.json index 186411e90..faf9be288 100644 --- a/api-ref/source/v3/samples/volumes/volume-show-response.json +++ b/api-ref/source/v3/samples/volumes/volume-show-response.json @@ -35,4 +35,4 @@ "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", "volume_type": "__DEFAULT__" } -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/samples/volumes/volume-update-response.json b/api-ref/source/v3/samples/volumes/volume-update-response.json index 4a587f679..a41d41fba 100644 --- a/api-ref/source/v3/samples/volumes/volume-update-response.json +++ b/api-ref/source/v3/samples/volumes/volume-update-response.json @@ -33,4 +33,4 @@ "user_id": "c853ca26-e8ea-4797-8a52-ee124a013d0e", "volume_type": "__DEFAULT__" } -}
\ No newline at end of file +} diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index c7a63793f..f3d660857 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -67,6 +67,7 @@ Request - offset: offset - marker: marker - with_count: with_count + - consumes_quota: filter_consumes_quota Response Parameters @@ -89,11 +90,12 @@ Response Parameters - updated_at: updated_at - snapshots_links: links_snap - group_snapshot_id: group_snapshot_id_3_14 + - consumes_quota: consumes_quota -Response Example (v3.41) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/snapshots/v3.41/snapshots-list-detailed-response.json +.. literalinclude:: ./samples/snapshots/v3.65/snapshots-list-detailed-response.json :language: javascript @@ -149,11 +151,12 @@ Response Parameters - size: size - updated_at: updated_at - group_snapshot_id: group_snapshot_id_3_14 + - consumes_quota: consumes_quota -Response Example (v3.41) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/snapshots/v3.41/snapshot-create-response.json +.. literalinclude:: ./samples/snapshots/v3.65/snapshot-create-response.json :language: javascript @@ -189,6 +192,7 @@ Request - limit: limit - offset: offset - marker: marker + - consumes_quota: filter_consumes_quota - with_count: with_count @@ -388,11 +392,12 @@ Response Parameters - metadata: metadata - updated_at: updated_at - group_snapshot_id: group_snapshot_id_3_14 + - consumes_quota: consumes_quota -Response Example (v3.41) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/snapshots/v3.41/snapshot-show-response.json +.. literalinclude:: ./samples/snapshots/v3.65/snapshot-show-response.json :language: javascript @@ -446,11 +451,12 @@ Response Parameters - user_id: user_id_min - metadata: metadata - group_snapshot_id: group_snapshot_id_3_14 + - consumes_quota: consumes_quota -Response Example (v3.41) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/snapshots/v3.41/snapshot-update-response.json +.. literalinclude:: ./samples/snapshots/v3.65/snapshot-update-response.json :language: javascript diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index f40b38606..2d7d8f4d3 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -98,6 +98,7 @@ Request - with_count: with_count - created_at: filter_created_at - updated_at: filter_updated_at + - consumes_quota: filter_consumes_quota Response Parameters @@ -140,13 +141,14 @@ Response Parameters - service_uuid: service_uuid - shared_targets: shared_targets - cluster_name: cluster_name + - consumes_quota: consumes_quota - count: count -Response Example (v3.63) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/volumes/v3.63/volumes-list-detailed-response.json +.. literalinclude:: ./samples/volumes/v3.65/volumes-list-detailed-response.json :language: javascript @@ -258,11 +260,12 @@ Response Parameters - service_uuid: service_uuid - shared_targets: shared_targets - cluster_name: cluster_name + - consumes_quota: consumes_quota -Response Example (v3.63) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/volumes/v3.63/volume-create-response.json +.. literalinclude:: ./samples/volumes/v3.65/volume-create-response.json :language: javascript @@ -301,6 +304,7 @@ Request - marker: marker - with_count: with_count - created_at: filter_created_at + - consumes_quota: filter_consumes_quota - updated_at: filter_updated_at @@ -394,12 +398,13 @@ Response Parameters - cluster_name: cluster_name - provider_id: provider_id - group_id: group_id_optional + - consumes_quota: consumes_quota -Response Example (v3.63) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/volumes/v3.63/volume-show-response.json +.. literalinclude:: ./samples/volumes/v3.65/volume-show-response.json :language: javascript @@ -473,12 +478,13 @@ Response Parameters - service_uuid: service_uuid - shared_targets: shared_targets - cluster_name: cluster_name + - consumes_quota: consumes_quota -Response Example (v3.63) +Response Example (v3.65) ------------------------ -.. literalinclude:: ./samples/volumes/v3.63/volume-update-response.json +.. literalinclude:: ./samples/volumes/v3.65/volume-update-response.json :language: javascript |