kubevim-client 1.0.0a1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- kubevim_client-1.0.0a1/PKG-INFO +298 -0
- kubevim_client-1.0.0a1/README.md +281 -0
- kubevim_client-1.0.0a1/kubevim_client/__init__.py +220 -0
- kubevim_client-1.0.0a1/kubevim_client/api/__init__.py +9 -0
- kubevim_client-1.0.0a1/kubevim_client/api/compute_service_api.py +5407 -0
- kubevim_client-1.0.0a1/kubevim_client/api/flavour_service_api.py +1118 -0
- kubevim_client-1.0.0a1/kubevim_client/api/image_service_api.py +1657 -0
- kubevim_client-1.0.0a1/kubevim_client/api/network_service_api.py +2781 -0
- kubevim_client-1.0.0a1/kubevim_client/api/storage_service_api.py +3437 -0
- kubevim_client-1.0.0a1/kubevim_client/api_client.py +842 -0
- kubevim_client-1.0.0a1/kubevim_client/api_response.py +21 -0
- kubevim_client-1.0.0a1/kubevim_client/configuration.py +654 -0
- kubevim_client-1.0.0a1/kubevim_client/exceptions.py +218 -0
- kubevim_client-1.0.0a1/kubevim_client/models/__init__.py +98 -0
- kubevim_client-1.0.0a1/kubevim_client/models/attach_volume_request.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/basic_auth.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/models/compute.py +164 -0
- kubevim_client-1.0.0a1/kubevim_client/models/compute_operation.py +49 -0
- kubevim_client-1.0.0a1/kubevim_client/models/compute_running_state.py +50 -0
- kubevim_client-1.0.0a1/kubevim_client/models/compute_snapshot.py +108 -0
- kubevim_client-1.0.0a1/kubevim_client/models/compute_update.py +101 -0
- kubevim_client-1.0.0a1/kubevim_client/models/container_format.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/cpu_architecture.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/cpu_topology.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_compute_request.py +109 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_compute_snapshot_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_flavour_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_image_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_network_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_placement_group_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_subnet_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_volume_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/create_volume_snapshot_request.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/detach_volume_request.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/disk_bus.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/disk_format.py +46 -0
- kubevim_client-1.0.0a1/kubevim_client/models/firmware.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/flavour.py +115 -0
- kubevim_client-1.0.0a1/kubevim_client/models/glance_source.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/http_source.py +100 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image.py +153 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source.py +193 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_glance.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_http.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_local.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_registry.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_s3.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_type.py +48 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_source_upload.py +92 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_status.py +47 -0
- kubevim_client-1.0.0a1/kubevim_client/models/image_update.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/models/import_policy.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/ip_address_pool.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/models/ip_assignment.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/ip_version.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/local_source.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/migrate_volume_request.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/network.py +121 -0
- kubevim_client-1.0.0a1/kubevim_client/models/network_interface_data.py +102 -0
- kubevim_client-1.0.0a1/kubevim_client/models/network_type.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/network_update.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/models/nic_model.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/operate_compute_request.py +89 -0
- kubevim_client-1.0.0a1/kubevim_client/models/operational_state.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/placement_enforcement.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/placement_group.py +107 -0
- kubevim_client-1.0.0a1/kubevim_client/models/placement_scope.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/placement_type.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/problem_details.py +96 -0
- kubevim_client-1.0.0a1/kubevim_client/models/registry_source.py +103 -0
- kubevim_client-1.0.0a1/kubevim_client/models/registry_source_pull_method.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/s3_access_key.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/models/s3_source.py +98 -0
- kubevim_client-1.0.0a1/kubevim_client/models/scale_compute_request.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/scale_volume_request.py +88 -0
- kubevim_client-1.0.0a1/kubevim_client/models/snapshot_status.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/subnet.py +102 -0
- kubevim_client-1.0.0a1/kubevim_client/models/subnet_data.py +106 -0
- kubevim_client-1.0.0a1/kubevim_client/models/subnet_update.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/models/type_of_storage.py +44 -0
- kubevim_client-1.0.0a1/kubevim_client/models/type_virtual_nic.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/upload_source.py +99 -0
- kubevim_client-1.0.0a1/kubevim_client/models/user_data.py +91 -0
- kubevim_client-1.0.0a1/kubevim_client/models/user_data_transportation_method.py +45 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_cpu.py +97 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_cpu_data.py +103 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_cpu_pinning.py +89 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_cpu_pinning_data.py +89 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_cpu_pinning_policy.py +43 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_memory.py +94 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_memory_data.py +94 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_network_interface.py +115 -0
- kubevim_client-1.0.0a1/kubevim_client/models/virtual_storage_data.py +95 -0
- kubevim_client-1.0.0a1/kubevim_client/models/volume.py +117 -0
- kubevim_client-1.0.0a1/kubevim_client/models/volume_snapshot.py +108 -0
- kubevim_client-1.0.0a1/kubevim_client/models/volume_update.py +90 -0
- kubevim_client-1.0.0a1/kubevim_client/py.typed +0 -0
- kubevim_client-1.0.0a1/kubevim_client/rest.py +334 -0
- kubevim_client-1.0.0a1/kubevim_client.egg-info/PKG-INFO +298 -0
- kubevim_client-1.0.0a1/kubevim_client.egg-info/SOURCES.txt +105 -0
- kubevim_client-1.0.0a1/kubevim_client.egg-info/dependency_links.txt +1 -0
- kubevim_client-1.0.0a1/kubevim_client.egg-info/requires.txt +4 -0
- kubevim_client-1.0.0a1/kubevim_client.egg-info/top_level.txt +1 -0
- kubevim_client-1.0.0a1/pyproject.toml +93 -0
- kubevim_client-1.0.0a1/setup.cfg +7 -0
- kubevim_client-1.0.0a1/setup.py +47 -0
|
@@ -0,0 +1,298 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: kubevim_client
|
|
3
|
+
Version: 1.0.0a1
|
|
4
|
+
Summary: Kube-VIM API
|
|
5
|
+
Home-page:
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: OpenAPI Generator Community <team@openapitools.org>
|
|
8
|
+
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
9
|
+
Keywords: OpenAPI,OpenAPI-Generator,Kube-VIM API
|
|
10
|
+
Requires-Python: >=3.10
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
Requires-Dist: urllib3<3.0.0,>=2.7.0
|
|
13
|
+
Requires-Dist: python-dateutil>=2.8.2
|
|
14
|
+
Requires-Dist: pydantic>=2.11
|
|
15
|
+
Requires-Dist: typing-extensions>=4.7.1
|
|
16
|
+
Dynamic: author
|
|
17
|
+
|
|
18
|
+
# kubevim-client
|
|
19
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
20
|
+
|
|
21
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
22
|
+
|
|
23
|
+
- API version: 1.0.0-alpha.1
|
|
24
|
+
- Package version: 1.0.0a1
|
|
25
|
+
- Generator version: 7.26.0
|
|
26
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
27
|
+
|
|
28
|
+
## Requirements.
|
|
29
|
+
|
|
30
|
+
Python 3.10+
|
|
31
|
+
|
|
32
|
+
Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
|
|
33
|
+
Install the package with `python -m pip install .`; install development dependencies
|
|
34
|
+
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
|
|
35
|
+
`python -m pip install --group dev`. The latter installs the group, not the package.
|
|
36
|
+
|
|
37
|
+
## Installation & Usage
|
|
38
|
+
### pip install
|
|
39
|
+
|
|
40
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
44
|
+
```
|
|
45
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
46
|
+
|
|
47
|
+
Then import the package:
|
|
48
|
+
```python
|
|
49
|
+
import kubevim_client
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Setuptools
|
|
53
|
+
|
|
54
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
python setup.py install --user
|
|
58
|
+
```
|
|
59
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
60
|
+
|
|
61
|
+
Then import the package:
|
|
62
|
+
```python
|
|
63
|
+
import kubevim_client
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Tests
|
|
67
|
+
|
|
68
|
+
Execute `pytest` to run the tests.
|
|
69
|
+
|
|
70
|
+
## Getting Started
|
|
71
|
+
|
|
72
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
73
|
+
|
|
74
|
+
```python
|
|
75
|
+
|
|
76
|
+
import kubevim_client
|
|
77
|
+
from kubevim_client.rest import ApiException
|
|
78
|
+
from pprint import pprint
|
|
79
|
+
|
|
80
|
+
# Defining the host is optional and defaults to http://localhost
|
|
81
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
82
|
+
configuration = kubevim_client.Configuration(
|
|
83
|
+
host = "http://localhost"
|
|
84
|
+
)
|
|
85
|
+
|
|
86
|
+
# The client must configure the authentication and authorization parameters
|
|
87
|
+
# in accordance with the API server security policy.
|
|
88
|
+
# Examples for each auth method are provided below, use the example that
|
|
89
|
+
# satisfies your auth use case.
|
|
90
|
+
|
|
91
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
# Enter a context with an instance of the API client
|
|
95
|
+
with kubevim_client.ApiClient(configuration) as api_client:
|
|
96
|
+
# Create an instance of the API class
|
|
97
|
+
api_instance = kubevim_client.ComputeServiceApi(api_client)
|
|
98
|
+
compute_id = 'compute_id_example' # str | Identifier of the compute resource.
|
|
99
|
+
attach_volume_request = kubevim_client.AttachVolumeRequest() # AttachVolumeRequest |
|
|
100
|
+
|
|
101
|
+
try:
|
|
102
|
+
# Attaches a volume to a compute resource.
|
|
103
|
+
api_response = api_instance.attach_volume(compute_id, attach_volume_request)
|
|
104
|
+
print("The response of ComputeServiceApi->attach_volume:\n")
|
|
105
|
+
pprint(api_response)
|
|
106
|
+
except ApiException as e:
|
|
107
|
+
print("Exception when calling ComputeServiceApi->attach_volume: %s\n" % e)
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Documentation for API Endpoints
|
|
112
|
+
|
|
113
|
+
All URIs are relative to *http://localhost*
|
|
114
|
+
|
|
115
|
+
Class | Method | HTTP request | Description
|
|
116
|
+
------------ | ------------- | ------------- | -------------
|
|
117
|
+
*ComputeServiceApi* | [**attach_volume**](docs/ComputeServiceApi.md#attach_volume) | **POST** /compute/v1/computes/{compute_id}/attachVolume | Attaches a volume to a compute resource.
|
|
118
|
+
*ComputeServiceApi* | [**create_compute**](docs/ComputeServiceApi.md#create_compute) | **POST** /compute/v1/computes | Creates a compute resource.
|
|
119
|
+
*ComputeServiceApi* | [**create_compute_snapshot**](docs/ComputeServiceApi.md#create_compute_snapshot) | **POST** /compute/v1/computes/{compute_id}/snapshots | Creates a snapshot of a compute resource.
|
|
120
|
+
*ComputeServiceApi* | [**create_placement_group**](docs/ComputeServiceApi.md#create_placement_group) | **POST** /compute/v1/placementGroups | Creates a placement group.
|
|
121
|
+
*ComputeServiceApi* | [**delete_compute**](docs/ComputeServiceApi.md#delete_compute) | **DELETE** /compute/v1/computes/{compute_id} | Deletes a compute resource with its boot disk and the disks from its flavour. Attached volumes are detached and kept unless delete_volumes is set; snapshots are kept.
|
|
122
|
+
*ComputeServiceApi* | [**delete_compute_snapshot**](docs/ComputeServiceApi.md#delete_compute_snapshot) | **DELETE** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id} | Deletes a snapshot of a compute resource.
|
|
123
|
+
*ComputeServiceApi* | [**delete_placement_group**](docs/ComputeServiceApi.md#delete_placement_group) | **DELETE** /compute/v1/placementGroups/{placement_group_id} | Deletes a placement group that has no members.
|
|
124
|
+
*ComputeServiceApi* | [**detach_volume**](docs/ComputeServiceApi.md#detach_volume) | **POST** /compute/v1/computes/{compute_id}/detachVolume | Detaches a volume from a compute resource.
|
|
125
|
+
*ComputeServiceApi* | [**get_compute**](docs/ComputeServiceApi.md#get_compute) | **GET** /compute/v1/computes/{compute_id} | Returns one compute resource.
|
|
126
|
+
*ComputeServiceApi* | [**get_compute_snapshot**](docs/ComputeServiceApi.md#get_compute_snapshot) | **GET** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id} | Returns one snapshot of a compute resource, also after the compute resource is deleted.
|
|
127
|
+
*ComputeServiceApi* | [**get_placement_group**](docs/ComputeServiceApi.md#get_placement_group) | **GET** /compute/v1/placementGroups/{placement_group_id} | Returns one placement group.
|
|
128
|
+
*ComputeServiceApi* | [**list_compute_snapshots**](docs/ComputeServiceApi.md#list_compute_snapshots) | **GET** /compute/v1/computes/{compute_id}/snapshots | Returns the snapshots of a compute resource, or of all compute resources with compute_id \"-\".
|
|
129
|
+
*ComputeServiceApi* | [**list_computes**](docs/ComputeServiceApi.md#list_computes) | **GET** /compute/v1/computes | Returns the compute resources matching a filter.
|
|
130
|
+
*ComputeServiceApi* | [**list_placement_groups**](docs/ComputeServiceApi.md#list_placement_groups) | **GET** /compute/v1/placementGroups | Returns the placement groups.
|
|
131
|
+
*ComputeServiceApi* | [**migrate_compute**](docs/ComputeServiceApi.md#migrate_compute) | **POST** /compute/v1/computes/{compute_id}/migrate | Moves a running compute resource to another host (live migration).
|
|
132
|
+
*ComputeServiceApi* | [**operate_compute**](docs/ComputeServiceApi.md#operate_compute) | **POST** /compute/v1/computes/{compute_id}/operate | Changes the running state of a compute resource, e.g. start, stop or reboot.
|
|
133
|
+
*ComputeServiceApi* | [**revert_compute_snapshot**](docs/ComputeServiceApi.md#revert_compute_snapshot) | **POST** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id}/revert | Reverts a stopped compute resource to a snapshot; not possible once the compute resource is deleted.
|
|
134
|
+
*ComputeServiceApi* | [**scale_compute**](docs/ComputeServiceApi.md#scale_compute) | **POST** /compute/v1/computes/{compute_id}/scale | Changes the flavour of a compute resource; live where KubeVirt can hotplug, otherwise restart_required is set. Disks that are larger in the new flavour are grown; shrinking a disk or changing the number, type, boot flag or storage class of the disks is rejected.
|
|
135
|
+
*ComputeServiceApi* | [**update_compute**](docs/ComputeServiceApi.md#update_compute) | **PATCH** /compute/v1/computes/{compute_id} | Updates a compute resource: its name and metadata, and adds or removes network interfaces.
|
|
136
|
+
*FlavourServiceApi* | [**create_flavour**](docs/FlavourServiceApi.md#create_flavour) | **POST** /flavour/v1/flavours | Creates a compute flavour.
|
|
137
|
+
*FlavourServiceApi* | [**delete_flavour**](docs/FlavourServiceApi.md#delete_flavour) | **DELETE** /flavour/v1/flavours/{flavour_id} | Deletes a compute flavour. Compute resources already created from it are not affected.
|
|
138
|
+
*FlavourServiceApi* | [**get_flavour**](docs/FlavourServiceApi.md#get_flavour) | **GET** /flavour/v1/flavours/{flavour_id} | Returns one compute flavour.
|
|
139
|
+
*FlavourServiceApi* | [**list_flavours**](docs/FlavourServiceApi.md#list_flavours) | **GET** /flavour/v1/flavours | Returns the compute flavours matching a filter.
|
|
140
|
+
*ImageServiceApi* | [**create_image**](docs/ImageServiceApi.md#create_image) | **POST** /image/v1/images | Adds a software image to the image repository managed by the VIM.
|
|
141
|
+
*ImageServiceApi* | [**delete_image**](docs/ImageServiceApi.md#delete_image) | **DELETE** /image/v1/images/{image_id} | Deletes a software image and its imported copies; compute resources created from it keep their disks.
|
|
142
|
+
*ImageServiceApi* | [**get_image**](docs/ImageServiceApi.md#get_image) | **GET** /image/v1/images/{image_id} | Returns one software image.
|
|
143
|
+
*ImageServiceApi* | [**list_image_sources**](docs/ImageServiceApi.md#list_image_sources) | **GET** /image/v1/imageSources | Returns the image source types this VIM accepts.
|
|
144
|
+
*ImageServiceApi* | [**list_images**](docs/ImageServiceApi.md#list_images) | **GET** /image/v1/images | Returns the software images matching a filter, including images of catalog backends.
|
|
145
|
+
*ImageServiceApi* | [**update_image**](docs/ImageServiceApi.md#update_image) | **PATCH** /image/v1/images/{image_id} | Updates the name and metadata of a software image.
|
|
146
|
+
*NetworkServiceApi* | [**create_network**](docs/NetworkServiceApi.md#create_network) | **POST** /network/v1/networks | Creates a network.
|
|
147
|
+
*NetworkServiceApi* | [**create_subnet**](docs/NetworkServiceApi.md#create_subnet) | **POST** /network/v1/subnets | Creates a subnet.
|
|
148
|
+
*NetworkServiceApi* | [**delete_network**](docs/NetworkServiceApi.md#delete_network) | **DELETE** /network/v1/networks/{network_id} | Deletes a network and its subnets; may fail with RESOURCE_IN_USE while interfaces use the network.
|
|
149
|
+
*NetworkServiceApi* | [**delete_subnet**](docs/NetworkServiceApi.md#delete_subnet) | **DELETE** /network/v1/subnets/{subnet_id} | Deletes a subnet: one IP version of a network. May fail with RESOURCE_IN_USE while interfaces use the network; the last subnet of a Kube-OVN network cannot be deleted (delete the network instead).
|
|
150
|
+
*NetworkServiceApi* | [**get_network**](docs/NetworkServiceApi.md#get_network) | **GET** /network/v1/networks/{network_id} | Returns one network.
|
|
151
|
+
*NetworkServiceApi* | [**get_subnet**](docs/NetworkServiceApi.md#get_subnet) | **GET** /network/v1/subnets/{subnet_id} | Returns one subnet.
|
|
152
|
+
*NetworkServiceApi* | [**list_networks**](docs/NetworkServiceApi.md#list_networks) | **GET** /network/v1/networks | Returns the networks matching a filter.
|
|
153
|
+
*NetworkServiceApi* | [**list_subnets**](docs/NetworkServiceApi.md#list_subnets) | **GET** /network/v1/subnets | Returns the subnets matching a filter.
|
|
154
|
+
*NetworkServiceApi* | [**update_network**](docs/NetworkServiceApi.md#update_network) | **PATCH** /network/v1/networks/{network_id} | Updates the name and metadata of a network.
|
|
155
|
+
*NetworkServiceApi* | [**update_subnet**](docs/NetworkServiceApi.md#update_subnet) | **PATCH** /network/v1/subnets/{subnet_id} | Updates the name and metadata of a subnet.
|
|
156
|
+
*StorageServiceApi* | [**create_volume**](docs/StorageServiceApi.md#create_volume) | **POST** /storage/v1/volumes | Creates a volume.
|
|
157
|
+
*StorageServiceApi* | [**create_volume_snapshot**](docs/StorageServiceApi.md#create_volume_snapshot) | **POST** /storage/v1/volumes/{volume_id}/snapshots | Creates a snapshot of a volume.
|
|
158
|
+
*StorageServiceApi* | [**delete_volume**](docs/StorageServiceApi.md#delete_volume) | **DELETE** /storage/v1/volumes/{volume_id} | Deletes a volume; may fail with RESOURCE_IN_USE while the volume is attached. Snapshots are kept.
|
|
159
|
+
*StorageServiceApi* | [**delete_volume_snapshot**](docs/StorageServiceApi.md#delete_volume_snapshot) | **DELETE** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id} | Deletes a snapshot of a volume.
|
|
160
|
+
*StorageServiceApi* | [**get_volume**](docs/StorageServiceApi.md#get_volume) | **GET** /storage/v1/volumes/{volume_id} | Returns one volume.
|
|
161
|
+
*StorageServiceApi* | [**get_volume_snapshot**](docs/StorageServiceApi.md#get_volume_snapshot) | **GET** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id} | Returns one snapshot of a volume, also after the volume is deleted.
|
|
162
|
+
*StorageServiceApi* | [**list_volume_snapshots**](docs/StorageServiceApi.md#list_volume_snapshots) | **GET** /storage/v1/volumes/{volume_id}/snapshots | Returns the snapshots of a volume, or of all volumes with volume_id \"-\".
|
|
163
|
+
*StorageServiceApi* | [**list_volumes**](docs/StorageServiceApi.md#list_volumes) | **GET** /storage/v1/volumes | Returns the volumes matching a filter; the own disks of compute resources are not volumes (see Compute.disks).
|
|
164
|
+
*StorageServiceApi* | [**migrate_volume**](docs/StorageServiceApi.md#migrate_volume) | **POST** /storage/v1/volumes/{volume_id}/migrate | Moves a volume to another storage class.
|
|
165
|
+
*StorageServiceApi* | [**revert_volume_snapshot**](docs/StorageServiceApi.md#revert_volume_snapshot) | **POST** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id}/revert | Reverts a volume that no running compute resource uses to a snapshot; not possible once the volume is deleted.
|
|
166
|
+
*StorageServiceApi* | [**scale_volume**](docs/StorageServiceApi.md#scale_volume) | **POST** /storage/v1/volumes/{volume_id}/scale | Grows a volume.
|
|
167
|
+
*StorageServiceApi* | [**update_volume**](docs/StorageServiceApi.md#update_volume) | **PATCH** /storage/v1/volumes/{volume_id} | Updates the name and metadata of a volume.
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
## Documentation For Models
|
|
171
|
+
|
|
172
|
+
- [AttachVolumeRequest](docs/AttachVolumeRequest.md)
|
|
173
|
+
- [BasicAuth](docs/BasicAuth.md)
|
|
174
|
+
- [Compute](docs/Compute.md)
|
|
175
|
+
- [ComputeOperation](docs/ComputeOperation.md)
|
|
176
|
+
- [ComputeRunningState](docs/ComputeRunningState.md)
|
|
177
|
+
- [ComputeSnapshot](docs/ComputeSnapshot.md)
|
|
178
|
+
- [ComputeUpdate](docs/ComputeUpdate.md)
|
|
179
|
+
- [ContainerFormat](docs/ContainerFormat.md)
|
|
180
|
+
- [CpuArchitecture](docs/CpuArchitecture.md)
|
|
181
|
+
- [CpuTopology](docs/CpuTopology.md)
|
|
182
|
+
- [CreateComputeRequest](docs/CreateComputeRequest.md)
|
|
183
|
+
- [CreateComputeSnapshotRequest](docs/CreateComputeSnapshotRequest.md)
|
|
184
|
+
- [CreateFlavourRequest](docs/CreateFlavourRequest.md)
|
|
185
|
+
- [CreateImageRequest](docs/CreateImageRequest.md)
|
|
186
|
+
- [CreateNetworkRequest](docs/CreateNetworkRequest.md)
|
|
187
|
+
- [CreatePlacementGroupRequest](docs/CreatePlacementGroupRequest.md)
|
|
188
|
+
- [CreateSubnetRequest](docs/CreateSubnetRequest.md)
|
|
189
|
+
- [CreateVolumeRequest](docs/CreateVolumeRequest.md)
|
|
190
|
+
- [CreateVolumeSnapshotRequest](docs/CreateVolumeSnapshotRequest.md)
|
|
191
|
+
- [DetachVolumeRequest](docs/DetachVolumeRequest.md)
|
|
192
|
+
- [DiskBus](docs/DiskBus.md)
|
|
193
|
+
- [DiskFormat](docs/DiskFormat.md)
|
|
194
|
+
- [Firmware](docs/Firmware.md)
|
|
195
|
+
- [Flavour](docs/Flavour.md)
|
|
196
|
+
- [GlanceSource](docs/GlanceSource.md)
|
|
197
|
+
- [HttpSource](docs/HttpSource.md)
|
|
198
|
+
- [Image](docs/Image.md)
|
|
199
|
+
- [ImageSource](docs/ImageSource.md)
|
|
200
|
+
- [ImageSourceGlance](docs/ImageSourceGlance.md)
|
|
201
|
+
- [ImageSourceHttp](docs/ImageSourceHttp.md)
|
|
202
|
+
- [ImageSourceLocal](docs/ImageSourceLocal.md)
|
|
203
|
+
- [ImageSourceRegistry](docs/ImageSourceRegistry.md)
|
|
204
|
+
- [ImageSourceS3](docs/ImageSourceS3.md)
|
|
205
|
+
- [ImageSourceType](docs/ImageSourceType.md)
|
|
206
|
+
- [ImageSourceUpload](docs/ImageSourceUpload.md)
|
|
207
|
+
- [ImageStatus](docs/ImageStatus.md)
|
|
208
|
+
- [ImageUpdate](docs/ImageUpdate.md)
|
|
209
|
+
- [ImportPolicy](docs/ImportPolicy.md)
|
|
210
|
+
- [IpAddressPool](docs/IpAddressPool.md)
|
|
211
|
+
- [IpAssignment](docs/IpAssignment.md)
|
|
212
|
+
- [IpVersion](docs/IpVersion.md)
|
|
213
|
+
- [LocalSource](docs/LocalSource.md)
|
|
214
|
+
- [MigrateVolumeRequest](docs/MigrateVolumeRequest.md)
|
|
215
|
+
- [Network](docs/Network.md)
|
|
216
|
+
- [NetworkInterfaceData](docs/NetworkInterfaceData.md)
|
|
217
|
+
- [NetworkType](docs/NetworkType.md)
|
|
218
|
+
- [NetworkUpdate](docs/NetworkUpdate.md)
|
|
219
|
+
- [NicModel](docs/NicModel.md)
|
|
220
|
+
- [OperateComputeRequest](docs/OperateComputeRequest.md)
|
|
221
|
+
- [OperationalState](docs/OperationalState.md)
|
|
222
|
+
- [PlacementEnforcement](docs/PlacementEnforcement.md)
|
|
223
|
+
- [PlacementGroup](docs/PlacementGroup.md)
|
|
224
|
+
- [PlacementScope](docs/PlacementScope.md)
|
|
225
|
+
- [PlacementType](docs/PlacementType.md)
|
|
226
|
+
- [ProblemDetails](docs/ProblemDetails.md)
|
|
227
|
+
- [RegistrySource](docs/RegistrySource.md)
|
|
228
|
+
- [RegistrySourcePullMethod](docs/RegistrySourcePullMethod.md)
|
|
229
|
+
- [S3AccessKey](docs/S3AccessKey.md)
|
|
230
|
+
- [S3Source](docs/S3Source.md)
|
|
231
|
+
- [ScaleComputeRequest](docs/ScaleComputeRequest.md)
|
|
232
|
+
- [ScaleVolumeRequest](docs/ScaleVolumeRequest.md)
|
|
233
|
+
- [SnapshotStatus](docs/SnapshotStatus.md)
|
|
234
|
+
- [Subnet](docs/Subnet.md)
|
|
235
|
+
- [SubnetData](docs/SubnetData.md)
|
|
236
|
+
- [SubnetUpdate](docs/SubnetUpdate.md)
|
|
237
|
+
- [TypeOfStorage](docs/TypeOfStorage.md)
|
|
238
|
+
- [TypeVirtualNic](docs/TypeVirtualNic.md)
|
|
239
|
+
- [UploadSource](docs/UploadSource.md)
|
|
240
|
+
- [UserData](docs/UserData.md)
|
|
241
|
+
- [UserDataTransportationMethod](docs/UserDataTransportationMethod.md)
|
|
242
|
+
- [VirtualCpu](docs/VirtualCpu.md)
|
|
243
|
+
- [VirtualCpuData](docs/VirtualCpuData.md)
|
|
244
|
+
- [VirtualCpuPinning](docs/VirtualCpuPinning.md)
|
|
245
|
+
- [VirtualCpuPinningData](docs/VirtualCpuPinningData.md)
|
|
246
|
+
- [VirtualCpuPinningPolicy](docs/VirtualCpuPinningPolicy.md)
|
|
247
|
+
- [VirtualMemory](docs/VirtualMemory.md)
|
|
248
|
+
- [VirtualMemoryData](docs/VirtualMemoryData.md)
|
|
249
|
+
- [VirtualNetworkInterface](docs/VirtualNetworkInterface.md)
|
|
250
|
+
- [VirtualStorageData](docs/VirtualStorageData.md)
|
|
251
|
+
- [Volume](docs/Volume.md)
|
|
252
|
+
- [VolumeSnapshot](docs/VolumeSnapshot.md)
|
|
253
|
+
- [VolumeUpdate](docs/VolumeUpdate.md)
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<a id="documentation-for-authorization"></a>
|
|
257
|
+
## Documentation For Authorization
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
Authentication schemes defined for the API:
|
|
261
|
+
<a id="oauth2"></a>
|
|
262
|
+
### oauth2
|
|
263
|
+
|
|
264
|
+
- **Type**: OAuth
|
|
265
|
+
- **Flow**: application
|
|
266
|
+
- **Authorization URL**:
|
|
267
|
+
- **Scopes**:
|
|
268
|
+
- **compute:v1:allocate**: Allocate compute resources
|
|
269
|
+
- **compute:v1:migrate**: Migrate compute resources
|
|
270
|
+
- **compute:v1:operate**: Operate compute resources
|
|
271
|
+
- **compute:v1:query**: Query compute resources
|
|
272
|
+
- **compute:v1:scale**: Scale compute resources
|
|
273
|
+
- **compute:v1:terminate**: Terminate compute resources
|
|
274
|
+
- **compute:v1:update**: Update compute resources and attach or detach volumes
|
|
275
|
+
- **flavour:v1:create**: Create compute flavours
|
|
276
|
+
- **flavour:v1:delete**: Delete compute flavours
|
|
277
|
+
- **flavour:v1:query**: Query compute flavours
|
|
278
|
+
- **image:v1:add**: Add software images
|
|
279
|
+
- **image:v1:delete**: Delete software images
|
|
280
|
+
- **image:v1:query**: Query software images
|
|
281
|
+
- **image:v1:update**: Update software images
|
|
282
|
+
- **network:v1:allocate**: Allocate network resources
|
|
283
|
+
- **network:v1:query**: Query network resources
|
|
284
|
+
- **network:v1:terminate**: Terminate network resources
|
|
285
|
+
- **network:v1:update**: Update network resources
|
|
286
|
+
- **storage:v1:allocate**: Allocate volumes
|
|
287
|
+
- **storage:v1:migrate**: Migrate volumes
|
|
288
|
+
- **storage:v1:operate**: Snapshot volumes
|
|
289
|
+
- **storage:v1:query**: Query volumes
|
|
290
|
+
- **storage:v1:scale**: Resize volumes
|
|
291
|
+
- **storage:v1:terminate**: Terminate volumes
|
|
292
|
+
- **storage:v1:update**: Update volumes
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
## Author
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
# kubevim-client
|
|
2
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
3
|
+
|
|
4
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
5
|
+
|
|
6
|
+
- API version: 1.0.0-alpha.1
|
|
7
|
+
- Package version: 1.0.0a1
|
|
8
|
+
- Generator version: 7.26.0
|
|
9
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
10
|
+
|
|
11
|
+
## Requirements.
|
|
12
|
+
|
|
13
|
+
Python 3.10+
|
|
14
|
+
|
|
15
|
+
Packaging uses standard `[project]` metadata and `[dependency-groups]` (PEP 621/735).
|
|
16
|
+
Install the package with `python -m pip install .`; install development dependencies
|
|
17
|
+
with Poetry 2.2 or newer using `poetry install`, or pip 25.1 or newer using
|
|
18
|
+
`python -m pip install --group dev`. The latter installs the group, not the package.
|
|
19
|
+
|
|
20
|
+
## Installation & Usage
|
|
21
|
+
### pip install
|
|
22
|
+
|
|
23
|
+
If the python package is hosted on a repository, you can install directly using:
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
27
|
+
```
|
|
28
|
+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
|
|
29
|
+
|
|
30
|
+
Then import the package:
|
|
31
|
+
```python
|
|
32
|
+
import kubevim_client
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Setuptools
|
|
36
|
+
|
|
37
|
+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
python setup.py install --user
|
|
41
|
+
```
|
|
42
|
+
(or `sudo python setup.py install` to install the package for all users)
|
|
43
|
+
|
|
44
|
+
Then import the package:
|
|
45
|
+
```python
|
|
46
|
+
import kubevim_client
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Tests
|
|
50
|
+
|
|
51
|
+
Execute `pytest` to run the tests.
|
|
52
|
+
|
|
53
|
+
## Getting Started
|
|
54
|
+
|
|
55
|
+
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
|
|
59
|
+
import kubevim_client
|
|
60
|
+
from kubevim_client.rest import ApiException
|
|
61
|
+
from pprint import pprint
|
|
62
|
+
|
|
63
|
+
# Defining the host is optional and defaults to http://localhost
|
|
64
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
65
|
+
configuration = kubevim_client.Configuration(
|
|
66
|
+
host = "http://localhost"
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
# The client must configure the authentication and authorization parameters
|
|
70
|
+
# in accordance with the API server security policy.
|
|
71
|
+
# Examples for each auth method are provided below, use the example that
|
|
72
|
+
# satisfies your auth use case.
|
|
73
|
+
|
|
74
|
+
configuration.access_token = os.environ["ACCESS_TOKEN"]
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
# Enter a context with an instance of the API client
|
|
78
|
+
with kubevim_client.ApiClient(configuration) as api_client:
|
|
79
|
+
# Create an instance of the API class
|
|
80
|
+
api_instance = kubevim_client.ComputeServiceApi(api_client)
|
|
81
|
+
compute_id = 'compute_id_example' # str | Identifier of the compute resource.
|
|
82
|
+
attach_volume_request = kubevim_client.AttachVolumeRequest() # AttachVolumeRequest |
|
|
83
|
+
|
|
84
|
+
try:
|
|
85
|
+
# Attaches a volume to a compute resource.
|
|
86
|
+
api_response = api_instance.attach_volume(compute_id, attach_volume_request)
|
|
87
|
+
print("The response of ComputeServiceApi->attach_volume:\n")
|
|
88
|
+
pprint(api_response)
|
|
89
|
+
except ApiException as e:
|
|
90
|
+
print("Exception when calling ComputeServiceApi->attach_volume: %s\n" % e)
|
|
91
|
+
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Documentation for API Endpoints
|
|
95
|
+
|
|
96
|
+
All URIs are relative to *http://localhost*
|
|
97
|
+
|
|
98
|
+
Class | Method | HTTP request | Description
|
|
99
|
+
------------ | ------------- | ------------- | -------------
|
|
100
|
+
*ComputeServiceApi* | [**attach_volume**](docs/ComputeServiceApi.md#attach_volume) | **POST** /compute/v1/computes/{compute_id}/attachVolume | Attaches a volume to a compute resource.
|
|
101
|
+
*ComputeServiceApi* | [**create_compute**](docs/ComputeServiceApi.md#create_compute) | **POST** /compute/v1/computes | Creates a compute resource.
|
|
102
|
+
*ComputeServiceApi* | [**create_compute_snapshot**](docs/ComputeServiceApi.md#create_compute_snapshot) | **POST** /compute/v1/computes/{compute_id}/snapshots | Creates a snapshot of a compute resource.
|
|
103
|
+
*ComputeServiceApi* | [**create_placement_group**](docs/ComputeServiceApi.md#create_placement_group) | **POST** /compute/v1/placementGroups | Creates a placement group.
|
|
104
|
+
*ComputeServiceApi* | [**delete_compute**](docs/ComputeServiceApi.md#delete_compute) | **DELETE** /compute/v1/computes/{compute_id} | Deletes a compute resource with its boot disk and the disks from its flavour. Attached volumes are detached and kept unless delete_volumes is set; snapshots are kept.
|
|
105
|
+
*ComputeServiceApi* | [**delete_compute_snapshot**](docs/ComputeServiceApi.md#delete_compute_snapshot) | **DELETE** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id} | Deletes a snapshot of a compute resource.
|
|
106
|
+
*ComputeServiceApi* | [**delete_placement_group**](docs/ComputeServiceApi.md#delete_placement_group) | **DELETE** /compute/v1/placementGroups/{placement_group_id} | Deletes a placement group that has no members.
|
|
107
|
+
*ComputeServiceApi* | [**detach_volume**](docs/ComputeServiceApi.md#detach_volume) | **POST** /compute/v1/computes/{compute_id}/detachVolume | Detaches a volume from a compute resource.
|
|
108
|
+
*ComputeServiceApi* | [**get_compute**](docs/ComputeServiceApi.md#get_compute) | **GET** /compute/v1/computes/{compute_id} | Returns one compute resource.
|
|
109
|
+
*ComputeServiceApi* | [**get_compute_snapshot**](docs/ComputeServiceApi.md#get_compute_snapshot) | **GET** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id} | Returns one snapshot of a compute resource, also after the compute resource is deleted.
|
|
110
|
+
*ComputeServiceApi* | [**get_placement_group**](docs/ComputeServiceApi.md#get_placement_group) | **GET** /compute/v1/placementGroups/{placement_group_id} | Returns one placement group.
|
|
111
|
+
*ComputeServiceApi* | [**list_compute_snapshots**](docs/ComputeServiceApi.md#list_compute_snapshots) | **GET** /compute/v1/computes/{compute_id}/snapshots | Returns the snapshots of a compute resource, or of all compute resources with compute_id \"-\".
|
|
112
|
+
*ComputeServiceApi* | [**list_computes**](docs/ComputeServiceApi.md#list_computes) | **GET** /compute/v1/computes | Returns the compute resources matching a filter.
|
|
113
|
+
*ComputeServiceApi* | [**list_placement_groups**](docs/ComputeServiceApi.md#list_placement_groups) | **GET** /compute/v1/placementGroups | Returns the placement groups.
|
|
114
|
+
*ComputeServiceApi* | [**migrate_compute**](docs/ComputeServiceApi.md#migrate_compute) | **POST** /compute/v1/computes/{compute_id}/migrate | Moves a running compute resource to another host (live migration).
|
|
115
|
+
*ComputeServiceApi* | [**operate_compute**](docs/ComputeServiceApi.md#operate_compute) | **POST** /compute/v1/computes/{compute_id}/operate | Changes the running state of a compute resource, e.g. start, stop or reboot.
|
|
116
|
+
*ComputeServiceApi* | [**revert_compute_snapshot**](docs/ComputeServiceApi.md#revert_compute_snapshot) | **POST** /compute/v1/computes/{compute_id}/snapshots/{snapshot_id}/revert | Reverts a stopped compute resource to a snapshot; not possible once the compute resource is deleted.
|
|
117
|
+
*ComputeServiceApi* | [**scale_compute**](docs/ComputeServiceApi.md#scale_compute) | **POST** /compute/v1/computes/{compute_id}/scale | Changes the flavour of a compute resource; live where KubeVirt can hotplug, otherwise restart_required is set. Disks that are larger in the new flavour are grown; shrinking a disk or changing the number, type, boot flag or storage class of the disks is rejected.
|
|
118
|
+
*ComputeServiceApi* | [**update_compute**](docs/ComputeServiceApi.md#update_compute) | **PATCH** /compute/v1/computes/{compute_id} | Updates a compute resource: its name and metadata, and adds or removes network interfaces.
|
|
119
|
+
*FlavourServiceApi* | [**create_flavour**](docs/FlavourServiceApi.md#create_flavour) | **POST** /flavour/v1/flavours | Creates a compute flavour.
|
|
120
|
+
*FlavourServiceApi* | [**delete_flavour**](docs/FlavourServiceApi.md#delete_flavour) | **DELETE** /flavour/v1/flavours/{flavour_id} | Deletes a compute flavour. Compute resources already created from it are not affected.
|
|
121
|
+
*FlavourServiceApi* | [**get_flavour**](docs/FlavourServiceApi.md#get_flavour) | **GET** /flavour/v1/flavours/{flavour_id} | Returns one compute flavour.
|
|
122
|
+
*FlavourServiceApi* | [**list_flavours**](docs/FlavourServiceApi.md#list_flavours) | **GET** /flavour/v1/flavours | Returns the compute flavours matching a filter.
|
|
123
|
+
*ImageServiceApi* | [**create_image**](docs/ImageServiceApi.md#create_image) | **POST** /image/v1/images | Adds a software image to the image repository managed by the VIM.
|
|
124
|
+
*ImageServiceApi* | [**delete_image**](docs/ImageServiceApi.md#delete_image) | **DELETE** /image/v1/images/{image_id} | Deletes a software image and its imported copies; compute resources created from it keep their disks.
|
|
125
|
+
*ImageServiceApi* | [**get_image**](docs/ImageServiceApi.md#get_image) | **GET** /image/v1/images/{image_id} | Returns one software image.
|
|
126
|
+
*ImageServiceApi* | [**list_image_sources**](docs/ImageServiceApi.md#list_image_sources) | **GET** /image/v1/imageSources | Returns the image source types this VIM accepts.
|
|
127
|
+
*ImageServiceApi* | [**list_images**](docs/ImageServiceApi.md#list_images) | **GET** /image/v1/images | Returns the software images matching a filter, including images of catalog backends.
|
|
128
|
+
*ImageServiceApi* | [**update_image**](docs/ImageServiceApi.md#update_image) | **PATCH** /image/v1/images/{image_id} | Updates the name and metadata of a software image.
|
|
129
|
+
*NetworkServiceApi* | [**create_network**](docs/NetworkServiceApi.md#create_network) | **POST** /network/v1/networks | Creates a network.
|
|
130
|
+
*NetworkServiceApi* | [**create_subnet**](docs/NetworkServiceApi.md#create_subnet) | **POST** /network/v1/subnets | Creates a subnet.
|
|
131
|
+
*NetworkServiceApi* | [**delete_network**](docs/NetworkServiceApi.md#delete_network) | **DELETE** /network/v1/networks/{network_id} | Deletes a network and its subnets; may fail with RESOURCE_IN_USE while interfaces use the network.
|
|
132
|
+
*NetworkServiceApi* | [**delete_subnet**](docs/NetworkServiceApi.md#delete_subnet) | **DELETE** /network/v1/subnets/{subnet_id} | Deletes a subnet: one IP version of a network. May fail with RESOURCE_IN_USE while interfaces use the network; the last subnet of a Kube-OVN network cannot be deleted (delete the network instead).
|
|
133
|
+
*NetworkServiceApi* | [**get_network**](docs/NetworkServiceApi.md#get_network) | **GET** /network/v1/networks/{network_id} | Returns one network.
|
|
134
|
+
*NetworkServiceApi* | [**get_subnet**](docs/NetworkServiceApi.md#get_subnet) | **GET** /network/v1/subnets/{subnet_id} | Returns one subnet.
|
|
135
|
+
*NetworkServiceApi* | [**list_networks**](docs/NetworkServiceApi.md#list_networks) | **GET** /network/v1/networks | Returns the networks matching a filter.
|
|
136
|
+
*NetworkServiceApi* | [**list_subnets**](docs/NetworkServiceApi.md#list_subnets) | **GET** /network/v1/subnets | Returns the subnets matching a filter.
|
|
137
|
+
*NetworkServiceApi* | [**update_network**](docs/NetworkServiceApi.md#update_network) | **PATCH** /network/v1/networks/{network_id} | Updates the name and metadata of a network.
|
|
138
|
+
*NetworkServiceApi* | [**update_subnet**](docs/NetworkServiceApi.md#update_subnet) | **PATCH** /network/v1/subnets/{subnet_id} | Updates the name and metadata of a subnet.
|
|
139
|
+
*StorageServiceApi* | [**create_volume**](docs/StorageServiceApi.md#create_volume) | **POST** /storage/v1/volumes | Creates a volume.
|
|
140
|
+
*StorageServiceApi* | [**create_volume_snapshot**](docs/StorageServiceApi.md#create_volume_snapshot) | **POST** /storage/v1/volumes/{volume_id}/snapshots | Creates a snapshot of a volume.
|
|
141
|
+
*StorageServiceApi* | [**delete_volume**](docs/StorageServiceApi.md#delete_volume) | **DELETE** /storage/v1/volumes/{volume_id} | Deletes a volume; may fail with RESOURCE_IN_USE while the volume is attached. Snapshots are kept.
|
|
142
|
+
*StorageServiceApi* | [**delete_volume_snapshot**](docs/StorageServiceApi.md#delete_volume_snapshot) | **DELETE** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id} | Deletes a snapshot of a volume.
|
|
143
|
+
*StorageServiceApi* | [**get_volume**](docs/StorageServiceApi.md#get_volume) | **GET** /storage/v1/volumes/{volume_id} | Returns one volume.
|
|
144
|
+
*StorageServiceApi* | [**get_volume_snapshot**](docs/StorageServiceApi.md#get_volume_snapshot) | **GET** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id} | Returns one snapshot of a volume, also after the volume is deleted.
|
|
145
|
+
*StorageServiceApi* | [**list_volume_snapshots**](docs/StorageServiceApi.md#list_volume_snapshots) | **GET** /storage/v1/volumes/{volume_id}/snapshots | Returns the snapshots of a volume, or of all volumes with volume_id \"-\".
|
|
146
|
+
*StorageServiceApi* | [**list_volumes**](docs/StorageServiceApi.md#list_volumes) | **GET** /storage/v1/volumes | Returns the volumes matching a filter; the own disks of compute resources are not volumes (see Compute.disks).
|
|
147
|
+
*StorageServiceApi* | [**migrate_volume**](docs/StorageServiceApi.md#migrate_volume) | **POST** /storage/v1/volumes/{volume_id}/migrate | Moves a volume to another storage class.
|
|
148
|
+
*StorageServiceApi* | [**revert_volume_snapshot**](docs/StorageServiceApi.md#revert_volume_snapshot) | **POST** /storage/v1/volumes/{volume_id}/snapshots/{snapshot_id}/revert | Reverts a volume that no running compute resource uses to a snapshot; not possible once the volume is deleted.
|
|
149
|
+
*StorageServiceApi* | [**scale_volume**](docs/StorageServiceApi.md#scale_volume) | **POST** /storage/v1/volumes/{volume_id}/scale | Grows a volume.
|
|
150
|
+
*StorageServiceApi* | [**update_volume**](docs/StorageServiceApi.md#update_volume) | **PATCH** /storage/v1/volumes/{volume_id} | Updates the name and metadata of a volume.
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
## Documentation For Models
|
|
154
|
+
|
|
155
|
+
- [AttachVolumeRequest](docs/AttachVolumeRequest.md)
|
|
156
|
+
- [BasicAuth](docs/BasicAuth.md)
|
|
157
|
+
- [Compute](docs/Compute.md)
|
|
158
|
+
- [ComputeOperation](docs/ComputeOperation.md)
|
|
159
|
+
- [ComputeRunningState](docs/ComputeRunningState.md)
|
|
160
|
+
- [ComputeSnapshot](docs/ComputeSnapshot.md)
|
|
161
|
+
- [ComputeUpdate](docs/ComputeUpdate.md)
|
|
162
|
+
- [ContainerFormat](docs/ContainerFormat.md)
|
|
163
|
+
- [CpuArchitecture](docs/CpuArchitecture.md)
|
|
164
|
+
- [CpuTopology](docs/CpuTopology.md)
|
|
165
|
+
- [CreateComputeRequest](docs/CreateComputeRequest.md)
|
|
166
|
+
- [CreateComputeSnapshotRequest](docs/CreateComputeSnapshotRequest.md)
|
|
167
|
+
- [CreateFlavourRequest](docs/CreateFlavourRequest.md)
|
|
168
|
+
- [CreateImageRequest](docs/CreateImageRequest.md)
|
|
169
|
+
- [CreateNetworkRequest](docs/CreateNetworkRequest.md)
|
|
170
|
+
- [CreatePlacementGroupRequest](docs/CreatePlacementGroupRequest.md)
|
|
171
|
+
- [CreateSubnetRequest](docs/CreateSubnetRequest.md)
|
|
172
|
+
- [CreateVolumeRequest](docs/CreateVolumeRequest.md)
|
|
173
|
+
- [CreateVolumeSnapshotRequest](docs/CreateVolumeSnapshotRequest.md)
|
|
174
|
+
- [DetachVolumeRequest](docs/DetachVolumeRequest.md)
|
|
175
|
+
- [DiskBus](docs/DiskBus.md)
|
|
176
|
+
- [DiskFormat](docs/DiskFormat.md)
|
|
177
|
+
- [Firmware](docs/Firmware.md)
|
|
178
|
+
- [Flavour](docs/Flavour.md)
|
|
179
|
+
- [GlanceSource](docs/GlanceSource.md)
|
|
180
|
+
- [HttpSource](docs/HttpSource.md)
|
|
181
|
+
- [Image](docs/Image.md)
|
|
182
|
+
- [ImageSource](docs/ImageSource.md)
|
|
183
|
+
- [ImageSourceGlance](docs/ImageSourceGlance.md)
|
|
184
|
+
- [ImageSourceHttp](docs/ImageSourceHttp.md)
|
|
185
|
+
- [ImageSourceLocal](docs/ImageSourceLocal.md)
|
|
186
|
+
- [ImageSourceRegistry](docs/ImageSourceRegistry.md)
|
|
187
|
+
- [ImageSourceS3](docs/ImageSourceS3.md)
|
|
188
|
+
- [ImageSourceType](docs/ImageSourceType.md)
|
|
189
|
+
- [ImageSourceUpload](docs/ImageSourceUpload.md)
|
|
190
|
+
- [ImageStatus](docs/ImageStatus.md)
|
|
191
|
+
- [ImageUpdate](docs/ImageUpdate.md)
|
|
192
|
+
- [ImportPolicy](docs/ImportPolicy.md)
|
|
193
|
+
- [IpAddressPool](docs/IpAddressPool.md)
|
|
194
|
+
- [IpAssignment](docs/IpAssignment.md)
|
|
195
|
+
- [IpVersion](docs/IpVersion.md)
|
|
196
|
+
- [LocalSource](docs/LocalSource.md)
|
|
197
|
+
- [MigrateVolumeRequest](docs/MigrateVolumeRequest.md)
|
|
198
|
+
- [Network](docs/Network.md)
|
|
199
|
+
- [NetworkInterfaceData](docs/NetworkInterfaceData.md)
|
|
200
|
+
- [NetworkType](docs/NetworkType.md)
|
|
201
|
+
- [NetworkUpdate](docs/NetworkUpdate.md)
|
|
202
|
+
- [NicModel](docs/NicModel.md)
|
|
203
|
+
- [OperateComputeRequest](docs/OperateComputeRequest.md)
|
|
204
|
+
- [OperationalState](docs/OperationalState.md)
|
|
205
|
+
- [PlacementEnforcement](docs/PlacementEnforcement.md)
|
|
206
|
+
- [PlacementGroup](docs/PlacementGroup.md)
|
|
207
|
+
- [PlacementScope](docs/PlacementScope.md)
|
|
208
|
+
- [PlacementType](docs/PlacementType.md)
|
|
209
|
+
- [ProblemDetails](docs/ProblemDetails.md)
|
|
210
|
+
- [RegistrySource](docs/RegistrySource.md)
|
|
211
|
+
- [RegistrySourcePullMethod](docs/RegistrySourcePullMethod.md)
|
|
212
|
+
- [S3AccessKey](docs/S3AccessKey.md)
|
|
213
|
+
- [S3Source](docs/S3Source.md)
|
|
214
|
+
- [ScaleComputeRequest](docs/ScaleComputeRequest.md)
|
|
215
|
+
- [ScaleVolumeRequest](docs/ScaleVolumeRequest.md)
|
|
216
|
+
- [SnapshotStatus](docs/SnapshotStatus.md)
|
|
217
|
+
- [Subnet](docs/Subnet.md)
|
|
218
|
+
- [SubnetData](docs/SubnetData.md)
|
|
219
|
+
- [SubnetUpdate](docs/SubnetUpdate.md)
|
|
220
|
+
- [TypeOfStorage](docs/TypeOfStorage.md)
|
|
221
|
+
- [TypeVirtualNic](docs/TypeVirtualNic.md)
|
|
222
|
+
- [UploadSource](docs/UploadSource.md)
|
|
223
|
+
- [UserData](docs/UserData.md)
|
|
224
|
+
- [UserDataTransportationMethod](docs/UserDataTransportationMethod.md)
|
|
225
|
+
- [VirtualCpu](docs/VirtualCpu.md)
|
|
226
|
+
- [VirtualCpuData](docs/VirtualCpuData.md)
|
|
227
|
+
- [VirtualCpuPinning](docs/VirtualCpuPinning.md)
|
|
228
|
+
- [VirtualCpuPinningData](docs/VirtualCpuPinningData.md)
|
|
229
|
+
- [VirtualCpuPinningPolicy](docs/VirtualCpuPinningPolicy.md)
|
|
230
|
+
- [VirtualMemory](docs/VirtualMemory.md)
|
|
231
|
+
- [VirtualMemoryData](docs/VirtualMemoryData.md)
|
|
232
|
+
- [VirtualNetworkInterface](docs/VirtualNetworkInterface.md)
|
|
233
|
+
- [VirtualStorageData](docs/VirtualStorageData.md)
|
|
234
|
+
- [Volume](docs/Volume.md)
|
|
235
|
+
- [VolumeSnapshot](docs/VolumeSnapshot.md)
|
|
236
|
+
- [VolumeUpdate](docs/VolumeUpdate.md)
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<a id="documentation-for-authorization"></a>
|
|
240
|
+
## Documentation For Authorization
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
Authentication schemes defined for the API:
|
|
244
|
+
<a id="oauth2"></a>
|
|
245
|
+
### oauth2
|
|
246
|
+
|
|
247
|
+
- **Type**: OAuth
|
|
248
|
+
- **Flow**: application
|
|
249
|
+
- **Authorization URL**:
|
|
250
|
+
- **Scopes**:
|
|
251
|
+
- **compute:v1:allocate**: Allocate compute resources
|
|
252
|
+
- **compute:v1:migrate**: Migrate compute resources
|
|
253
|
+
- **compute:v1:operate**: Operate compute resources
|
|
254
|
+
- **compute:v1:query**: Query compute resources
|
|
255
|
+
- **compute:v1:scale**: Scale compute resources
|
|
256
|
+
- **compute:v1:terminate**: Terminate compute resources
|
|
257
|
+
- **compute:v1:update**: Update compute resources and attach or detach volumes
|
|
258
|
+
- **flavour:v1:create**: Create compute flavours
|
|
259
|
+
- **flavour:v1:delete**: Delete compute flavours
|
|
260
|
+
- **flavour:v1:query**: Query compute flavours
|
|
261
|
+
- **image:v1:add**: Add software images
|
|
262
|
+
- **image:v1:delete**: Delete software images
|
|
263
|
+
- **image:v1:query**: Query software images
|
|
264
|
+
- **image:v1:update**: Update software images
|
|
265
|
+
- **network:v1:allocate**: Allocate network resources
|
|
266
|
+
- **network:v1:query**: Query network resources
|
|
267
|
+
- **network:v1:terminate**: Terminate network resources
|
|
268
|
+
- **network:v1:update**: Update network resources
|
|
269
|
+
- **storage:v1:allocate**: Allocate volumes
|
|
270
|
+
- **storage:v1:migrate**: Migrate volumes
|
|
271
|
+
- **storage:v1:operate**: Snapshot volumes
|
|
272
|
+
- **storage:v1:query**: Query volumes
|
|
273
|
+
- **storage:v1:scale**: Resize volumes
|
|
274
|
+
- **storage:v1:terminate**: Terminate volumes
|
|
275
|
+
- **storage:v1:update**: Update volumes
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
## Author
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|