-
Notifications
You must be signed in to change notification settings - Fork 72
CoreV1Api
Tomasz Prus edited this page Oct 28, 2021
·
2 revisions
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| connect_delete_namespaced_pod_proxy | DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_delete_namespaced_pod_proxy_with_path | DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_delete_namespaced_service_proxy | DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_delete_namespaced_service_proxy_with_path | DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_delete_node_proxy | DELETE /api/v1/nodes/{name}/proxy | |
| connect_delete_node_proxy_with_path | DELETE /api/v1/nodes/{name}/proxy/{path} | |
| connect_get_namespaced_pod_attach | GET /api/v1/namespaces/{namespace}/pods/{name}/attach | |
| connect_get_namespaced_pod_exec | GET /api/v1/namespaces/{namespace}/pods/{name}/exec | |
| connect_get_namespaced_pod_portforward | GET /api/v1/namespaces/{namespace}/pods/{name}/portforward | |
| connect_get_namespaced_pod_proxy | GET /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_get_namespaced_pod_proxy_with_path | GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_get_namespaced_service_proxy | GET /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_get_namespaced_service_proxy_with_path | GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_get_node_proxy | GET /api/v1/nodes/{name}/proxy | |
| connect_get_node_proxy_with_path | GET /api/v1/nodes/{name}/proxy/{path} | |
| connect_head_namespaced_pod_proxy | HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_head_namespaced_pod_proxy_with_path | HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_head_namespaced_service_proxy | HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_head_namespaced_service_proxy_with_path | HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_head_node_proxy | HEAD /api/v1/nodes/{name}/proxy | |
| connect_head_node_proxy_with_path | HEAD /api/v1/nodes/{name}/proxy/{path} | |
| connect_options_namespaced_pod_proxy | OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_options_namespaced_pod_proxy_with_path | OPTIONS /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_options_namespaced_service_proxy | OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_options_namespaced_service_proxy_with_path | OPTIONS /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_options_node_proxy | OPTIONS /api/v1/nodes/{name}/proxy | |
| connect_options_node_proxy_with_path | OPTIONS /api/v1/nodes/{name}/proxy/{path} | |
| connect_patch_namespaced_pod_proxy | PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_patch_namespaced_pod_proxy_with_path | PATCH /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_patch_namespaced_service_proxy | PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_patch_namespaced_service_proxy_with_path | PATCH /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_patch_node_proxy | PATCH /api/v1/nodes/{name}/proxy | |
| connect_patch_node_proxy_with_path | PATCH /api/v1/nodes/{name}/proxy/{path} | |
| connect_post_namespaced_pod_attach | POST /api/v1/namespaces/{namespace}/pods/{name}/attach | |
| connect_post_namespaced_pod_exec | POST /api/v1/namespaces/{namespace}/pods/{name}/exec | |
| connect_post_namespaced_pod_portforward | POST /api/v1/namespaces/{namespace}/pods/{name}/portforward | |
| connect_post_namespaced_pod_proxy | POST /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_post_namespaced_pod_proxy_with_path | POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_post_namespaced_service_proxy | POST /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_post_namespaced_service_proxy_with_path | POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_post_node_proxy | POST /api/v1/nodes/{name}/proxy | |
| connect_post_node_proxy_with_path | POST /api/v1/nodes/{name}/proxy/{path} | |
| connect_put_namespaced_pod_proxy | PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy | |
| connect_put_namespaced_pod_proxy_with_path | PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path} | |
| connect_put_namespaced_service_proxy | PUT /api/v1/namespaces/{namespace}/services/{name}/proxy | |
| connect_put_namespaced_service_proxy_with_path | PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path} | |
| connect_put_node_proxy | PUT /api/v1/nodes/{name}/proxy | |
| connect_put_node_proxy_with_path | PUT /api/v1/nodes/{name}/proxy/{path} | |
| create_namespace | POST /api/v1/namespaces | |
| create_namespaced_binding | POST /api/v1/namespaces/{namespace}/bindings | |
| create_namespaced_config_map | POST /api/v1/namespaces/{namespace}/configmaps | |
| create_namespaced_endpoints | POST /api/v1/namespaces/{namespace}/endpoints | |
| create_namespaced_event | POST /api/v1/namespaces/{namespace}/events | |
| create_namespaced_limit_range | POST /api/v1/namespaces/{namespace}/limitranges | |
| create_namespaced_persistent_volume_claim | POST /api/v1/namespaces/{namespace}/persistentvolumeclaims | |
| create_namespaced_pod | POST /api/v1/namespaces/{namespace}/pods | |
| create_namespaced_pod_binding | POST /api/v1/namespaces/{namespace}/pods/{name}/binding | |
| create_namespaced_pod_eviction | POST /api/v1/namespaces/{namespace}/pods/{name}/eviction | |
| create_namespaced_pod_template | POST /api/v1/namespaces/{namespace}/podtemplates | |
| create_namespaced_replication_controller | POST /api/v1/namespaces/{namespace}/replicationcontrollers | |
| create_namespaced_resource_quota | POST /api/v1/namespaces/{namespace}/resourcequotas | |
| create_namespaced_secret | POST /api/v1/namespaces/{namespace}/secrets | |
| create_namespaced_service | POST /api/v1/namespaces/{namespace}/services | |
| create_namespaced_service_account | POST /api/v1/namespaces/{namespace}/serviceaccounts | |
| create_namespaced_service_account_token | POST /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token | |
| create_node | POST /api/v1/nodes | |
| create_persistent_volume | POST /api/v1/persistentvolumes | |
| delete_collection_namespaced_config_map | DELETE /api/v1/namespaces/{namespace}/configmaps | |
| delete_collection_namespaced_endpoints | DELETE /api/v1/namespaces/{namespace}/endpoints | |
| delete_collection_namespaced_event | DELETE /api/v1/namespaces/{namespace}/events | |
| delete_collection_namespaced_limit_range | DELETE /api/v1/namespaces/{namespace}/limitranges | |
| delete_collection_namespaced_persistent_volume_claim | DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims | |
| delete_collection_namespaced_pod | DELETE /api/v1/namespaces/{namespace}/pods | |
| delete_collection_namespaced_pod_template | DELETE /api/v1/namespaces/{namespace}/podtemplates | |
| delete_collection_namespaced_replication_controller | DELETE /api/v1/namespaces/{namespace}/replicationcontrollers | |
| delete_collection_namespaced_resource_quota | DELETE /api/v1/namespaces/{namespace}/resourcequotas | |
| delete_collection_namespaced_secret | DELETE /api/v1/namespaces/{namespace}/secrets | |
| delete_collection_namespaced_service_account | DELETE /api/v1/namespaces/{namespace}/serviceaccounts | |
| delete_collection_node | DELETE /api/v1/nodes | |
| delete_collection_persistent_volume | DELETE /api/v1/persistentvolumes | |
| delete_namespace | DELETE /api/v1/namespaces/{name} | |
| delete_namespaced_config_map | DELETE /api/v1/namespaces/{namespace}/configmaps/{name} | |
| delete_namespaced_endpoints | DELETE /api/v1/namespaces/{namespace}/endpoints/{name} | |
| delete_namespaced_event | DELETE /api/v1/namespaces/{namespace}/events/{name} | |
| delete_namespaced_limit_range | DELETE /api/v1/namespaces/{namespace}/limitranges/{name} | |
| delete_namespaced_persistent_volume_claim | DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | |
| delete_namespaced_pod | DELETE /api/v1/namespaces/{namespace}/pods/{name} | |
| delete_namespaced_pod_template | DELETE /api/v1/namespaces/{namespace}/podtemplates/{name} | |
| delete_namespaced_replication_controller | DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | |
| delete_namespaced_resource_quota | DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name} | |
| delete_namespaced_secret | DELETE /api/v1/namespaces/{namespace}/secrets/{name} | |
| delete_namespaced_service | DELETE /api/v1/namespaces/{namespace}/services/{name} | |
| delete_namespaced_service_account | DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name} | |
| delete_node | DELETE /api/v1/nodes/{name} | |
| delete_persistent_volume | DELETE /api/v1/persistentvolumes/{name} | |
| get_api_resources | GET /api/v1/ | |
| list_component_status | GET /api/v1/componentstatuses | |
| list_config_map_for_all_namespaces | GET /api/v1/configmaps | |
| list_endpoints_for_all_namespaces | GET /api/v1/endpoints | |
| list_event_for_all_namespaces | GET /api/v1/events | |
| list_limit_range_for_all_namespaces | GET /api/v1/limitranges | |
| list_namespace | GET /api/v1/namespaces | |
| list_namespaced_config_map | GET /api/v1/namespaces/{namespace}/configmaps | |
| list_namespaced_endpoints | GET /api/v1/namespaces/{namespace}/endpoints | |
| list_namespaced_event | GET /api/v1/namespaces/{namespace}/events | |
| list_namespaced_limit_range | GET /api/v1/namespaces/{namespace}/limitranges | |
| list_namespaced_persistent_volume_claim | GET /api/v1/namespaces/{namespace}/persistentvolumeclaims | |
| list_namespaced_pod | GET /api/v1/namespaces/{namespace}/pods | |
| list_namespaced_pod_template | GET /api/v1/namespaces/{namespace}/podtemplates | |
| list_namespaced_replication_controller | GET /api/v1/namespaces/{namespace}/replicationcontrollers | |
| list_namespaced_resource_quota | GET /api/v1/namespaces/{namespace}/resourcequotas | |
| list_namespaced_secret | GET /api/v1/namespaces/{namespace}/secrets | |
| list_namespaced_service | GET /api/v1/namespaces/{namespace}/services | |
| list_namespaced_service_account | GET /api/v1/namespaces/{namespace}/serviceaccounts | |
| list_node | GET /api/v1/nodes | |
| list_persistent_volume | GET /api/v1/persistentvolumes | |
| list_persistent_volume_claim_for_all_namespaces | GET /api/v1/persistentvolumeclaims | |
| list_pod_for_all_namespaces | GET /api/v1/pods | |
| list_pod_template_for_all_namespaces | GET /api/v1/podtemplates | |
| list_replication_controller_for_all_namespaces | GET /api/v1/replicationcontrollers | |
| list_resource_quota_for_all_namespaces | GET /api/v1/resourcequotas | |
| list_secret_for_all_namespaces | GET /api/v1/secrets | |
| list_service_account_for_all_namespaces | GET /api/v1/serviceaccounts | |
| list_service_for_all_namespaces | GET /api/v1/services | |
| patch_namespace | PATCH /api/v1/namespaces/{name} | |
| patch_namespace_status | PATCH /api/v1/namespaces/{name}/status | |
| patch_namespaced_config_map | PATCH /api/v1/namespaces/{namespace}/configmaps/{name} | |
| patch_namespaced_endpoints | PATCH /api/v1/namespaces/{namespace}/endpoints/{name} | |
| patch_namespaced_event | PATCH /api/v1/namespaces/{namespace}/events/{name} | |
| patch_namespaced_limit_range | PATCH /api/v1/namespaces/{namespace}/limitranges/{name} | |
| patch_namespaced_persistent_volume_claim | PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | |
| patch_namespaced_persistent_volume_claim_status | PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | |
| patch_namespaced_pod | PATCH /api/v1/namespaces/{namespace}/pods/{name} | |
| patch_namespaced_pod_status | PATCH /api/v1/namespaces/{namespace}/pods/{name}/status | |
| patch_namespaced_pod_template | PATCH /api/v1/namespaces/{namespace}/podtemplates/{name} | |
| patch_namespaced_replication_controller | PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | |
| patch_namespaced_replication_controller_scale | PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | |
| patch_namespaced_replication_controller_status | PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | |
| patch_namespaced_resource_quota | PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name} | |
| patch_namespaced_resource_quota_status | PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | |
| patch_namespaced_secret | PATCH /api/v1/namespaces/{namespace}/secrets/{name} | |
| patch_namespaced_service | PATCH /api/v1/namespaces/{namespace}/services/{name} | |
| patch_namespaced_service_account | PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name} | |
| patch_namespaced_service_status | PATCH /api/v1/namespaces/{namespace}/services/{name}/status | |
| patch_node | PATCH /api/v1/nodes/{name} | |
| patch_node_status | PATCH /api/v1/nodes/{name}/status | |
| patch_persistent_volume | PATCH /api/v1/persistentvolumes/{name} | |
| patch_persistent_volume_status | PATCH /api/v1/persistentvolumes/{name}/status | |
| read_component_status | GET /api/v1/componentstatuses/{name} | |
| read_namespace | GET /api/v1/namespaces/{name} | |
| read_namespace_status | GET /api/v1/namespaces/{name}/status | |
| read_namespaced_config_map | GET /api/v1/namespaces/{namespace}/configmaps/{name} | |
| read_namespaced_endpoints | GET /api/v1/namespaces/{namespace}/endpoints/{name} | |
| read_namespaced_event | GET /api/v1/namespaces/{namespace}/events/{name} | |
| read_namespaced_limit_range | GET /api/v1/namespaces/{namespace}/limitranges/{name} | |
| read_namespaced_persistent_volume_claim | GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | |
| read_namespaced_persistent_volume_claim_status | GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | |
| read_namespaced_pod | GET /api/v1/namespaces/{namespace}/pods/{name} | |
| read_namespaced_pod_log | GET /api/v1/namespaces/{namespace}/pods/{name}/log | |
| read_namespaced_pod_status | GET /api/v1/namespaces/{namespace}/pods/{name}/status | |
| read_namespaced_pod_template | GET /api/v1/namespaces/{namespace}/podtemplates/{name} | |
| read_namespaced_replication_controller | GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | |
| read_namespaced_replication_controller_scale | GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | |
| read_namespaced_replication_controller_status | GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | |
| read_namespaced_resource_quota | GET /api/v1/namespaces/{namespace}/resourcequotas/{name} | |
| read_namespaced_resource_quota_status | GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | |
| read_namespaced_secret | GET /api/v1/namespaces/{namespace}/secrets/{name} | |
| read_namespaced_service | GET /api/v1/namespaces/{namespace}/services/{name} | |
| read_namespaced_service_account | GET /api/v1/namespaces/{namespace}/serviceaccounts/{name} | |
| read_namespaced_service_status | GET /api/v1/namespaces/{namespace}/services/{name}/status | |
| read_node | GET /api/v1/nodes/{name} | |
| read_node_status | GET /api/v1/nodes/{name}/status | |
| read_persistent_volume | GET /api/v1/persistentvolumes/{name} | |
| read_persistent_volume_status | GET /api/v1/persistentvolumes/{name}/status | |
| replace_namespace | PUT /api/v1/namespaces/{name} | |
| replace_namespace_finalize | PUT /api/v1/namespaces/{name}/finalize | |
| replace_namespace_status | PUT /api/v1/namespaces/{name}/status | |
| replace_namespaced_config_map | PUT /api/v1/namespaces/{namespace}/configmaps/{name} | |
| replace_namespaced_endpoints | PUT /api/v1/namespaces/{namespace}/endpoints/{name} | |
| replace_namespaced_event | PUT /api/v1/namespaces/{namespace}/events/{name} | |
| replace_namespaced_limit_range | PUT /api/v1/namespaces/{namespace}/limitranges/{name} | |
| replace_namespaced_persistent_volume_claim | PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name} | |
| replace_namespaced_persistent_volume_claim_status | PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status | |
| replace_namespaced_pod | PUT /api/v1/namespaces/{namespace}/pods/{name} | |
| replace_namespaced_pod_status | PUT /api/v1/namespaces/{namespace}/pods/{name}/status | |
| replace_namespaced_pod_template | PUT /api/v1/namespaces/{namespace}/podtemplates/{name} | |
| replace_namespaced_replication_controller | PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name} | |
| replace_namespaced_replication_controller_scale | PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale | |
| replace_namespaced_replication_controller_status | PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status | |
| replace_namespaced_resource_quota | PUT /api/v1/namespaces/{namespace}/resourcequotas/{name} | |
| replace_namespaced_resource_quota_status | PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status | |
| replace_namespaced_secret | PUT /api/v1/namespaces/{namespace}/secrets/{name} | |
| replace_namespaced_service | PUT /api/v1/namespaces/{namespace}/services/{name} | |
| replace_namespaced_service_account | PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name} | |
| replace_namespaced_service_status | PUT /api/v1/namespaces/{namespace}/services/{name}/status | |
| replace_node | PUT /api/v1/nodes/{name} | |
| replace_node_status | PUT /api/v1/nodes/{name}/status | |
| replace_persistent_volume | PUT /api/v1/persistentvolumes/{name} | |
| replace_persistent_volume_status | PUT /api/v1/persistentvolumes/{name}/status |
str connect_delete_namespaced_pod_proxy(name, namespace, path=path)
connect DELETE requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_delete_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_delete_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_delete_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect DELETE requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_delete_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_delete_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_delete_namespaced_service_proxy(name, namespace, path=path)
connect DELETE requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_delete_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_delete_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_delete_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect DELETE requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_delete_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_delete_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_delete_node_proxy(name, path=path)
connect DELETE requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_delete_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_delete_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_delete_node_proxy_with_path(name, path, path2=path2)
connect DELETE requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_delete_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_delete_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_pod_attach(name, namespace, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
connect GET requests to attach of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodAttachOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
container = 'container_example' # str | The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional)
stderr = True # bool | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional)
stdin = True # bool | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional)
stdout = True # bool | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional)
tty = True # bool | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional)
try:
api_response = api_instance.connect_get_namespaced_pod_attach(name, namespace, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_pod_attach: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodAttachOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| container | str | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | [optional] |
| stderr | bool | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | [optional] |
| stdin | bool | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | [optional] |
| stdout | bool | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | [optional] |
| tty | bool | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_pod_exec(name, namespace, command=command, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
connect GET requests to exec of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodExecOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
command = 'command_example' # str | Command is the remote command to execute. argv array. Not executed within a shell. (optional)
container = 'container_example' # str | Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional)
stderr = True # bool | Redirect the standard error stream of the pod for this call. Defaults to true. (optional)
stdin = True # bool | Redirect the standard input stream of the pod for this call. Defaults to false. (optional)
stdout = True # bool | Redirect the standard output stream of the pod for this call. Defaults to true. (optional)
tty = True # bool | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional)
try:
api_response = api_instance.connect_get_namespaced_pod_exec(name, namespace, command=command, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_pod_exec: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodExecOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| command | str | Command is the remote command to execute. argv array. Not executed within a shell. | [optional] |
| container | str | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | [optional] |
| stderr | bool | Redirect the standard error stream of the pod for this call. Defaults to true. | [optional] |
| stdin | bool | Redirect the standard input stream of the pod for this call. Defaults to false. | [optional] |
| stdout | bool | Redirect the standard output stream of the pod for this call. Defaults to true. | [optional] |
| tty | bool | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_pod_portforward(name, namespace, ports=ports)
connect GET requests to portforward of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodPortForwardOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
ports = 56 # int | List of ports to forward Required when using WebSockets (optional)
try:
api_response = api_instance.connect_get_namespaced_pod_portforward(name, namespace, ports=ports)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_pod_portforward: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodPortForwardOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| ports | int | List of ports to forward Required when using WebSockets | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_pod_proxy(name, namespace, path=path)
connect GET requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_get_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect GET requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_get_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_service_proxy(name, namespace, path=path)
connect GET requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_get_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect GET requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_get_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_node_proxy(name, path=path)
connect GET requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_get_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_get_node_proxy_with_path(name, path, path2=path2)
connect GET requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_get_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_get_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_head_namespaced_pod_proxy(name, namespace, path=path)
connect HEAD requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_head_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_head_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_head_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect HEAD requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_head_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_head_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_head_namespaced_service_proxy(name, namespace, path=path)
connect HEAD requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_head_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_head_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_head_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect HEAD requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_head_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_head_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_head_node_proxy(name, path=path)
connect HEAD requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_head_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_head_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_head_node_proxy_with_path(name, path, path2=path2)
connect HEAD requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_head_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_head_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_options_namespaced_pod_proxy(name, namespace, path=path)
connect OPTIONS requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_options_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_options_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_options_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect OPTIONS requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_options_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_options_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_options_namespaced_service_proxy(name, namespace, path=path)
connect OPTIONS requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_options_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_options_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_options_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect OPTIONS requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_options_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_options_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_options_node_proxy(name, path=path)
connect OPTIONS requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_options_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_options_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_options_node_proxy_with_path(name, path, path2=path2)
connect OPTIONS requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_options_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_options_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_patch_namespaced_pod_proxy(name, namespace, path=path)
connect PATCH requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_patch_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_patch_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_patch_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect PATCH requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_patch_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_patch_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_patch_namespaced_service_proxy(name, namespace, path=path)
connect PATCH requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_patch_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_patch_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_patch_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect PATCH requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_patch_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_patch_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_patch_node_proxy(name, path=path)
connect PATCH requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_patch_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_patch_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_patch_node_proxy_with_path(name, path, path2=path2)
connect PATCH requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_patch_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_patch_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_pod_attach(name, namespace, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
connect POST requests to attach of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodAttachOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
container = 'container_example' # str | The container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional)
stderr = True # bool | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. (optional)
stdin = True # bool | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. (optional)
stdout = True # bool | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. (optional)
tty = True # bool | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. (optional)
try:
api_response = api_instance.connect_post_namespaced_pod_attach(name, namespace, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_pod_attach: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodAttachOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| container | str | The container in which to execute the command. Defaults to only container if there is only one container in the pod. | [optional] |
| stderr | bool | Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true. | [optional] |
| stdin | bool | Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false. | [optional] |
| stdout | bool | Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true. | [optional] |
| tty | bool | TTY if true indicates that a tty will be allocated for the attach call. This is passed through the container runtime so the tty is allocated on the worker node by the container runtime. Defaults to false. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_pod_exec(name, namespace, command=command, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
connect POST requests to exec of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodExecOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
command = 'command_example' # str | Command is the remote command to execute. argv array. Not executed within a shell. (optional)
container = 'container_example' # str | Container in which to execute the command. Defaults to only container if there is only one container in the pod. (optional)
stderr = True # bool | Redirect the standard error stream of the pod for this call. Defaults to true. (optional)
stdin = True # bool | Redirect the standard input stream of the pod for this call. Defaults to false. (optional)
stdout = True # bool | Redirect the standard output stream of the pod for this call. Defaults to true. (optional)
tty = True # bool | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. (optional)
try:
api_response = api_instance.connect_post_namespaced_pod_exec(name, namespace, command=command, container=container, stderr=stderr, stdin=stdin, stdout=stdout, tty=tty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_pod_exec: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodExecOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| command | str | Command is the remote command to execute. argv array. Not executed within a shell. | [optional] |
| container | str | Container in which to execute the command. Defaults to only container if there is only one container in the pod. | [optional] |
| stderr | bool | Redirect the standard error stream of the pod for this call. Defaults to true. | [optional] |
| stdin | bool | Redirect the standard input stream of the pod for this call. Defaults to false. | [optional] |
| stdout | bool | Redirect the standard output stream of the pod for this call. Defaults to true. | [optional] |
| tty | bool | TTY if true indicates that a tty will be allocated for the exec call. Defaults to false. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_pod_portforward(name, namespace, ports=ports)
connect POST requests to portforward of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodPortForwardOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
ports = 56 # int | List of ports to forward Required when using WebSockets (optional)
try:
api_response = api_instance.connect_post_namespaced_pod_portforward(name, namespace, ports=ports)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_pod_portforward: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodPortForwardOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| ports | int | List of ports to forward Required when using WebSockets | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_pod_proxy(name, namespace, path=path)
connect POST requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_post_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect POST requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_post_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_service_proxy(name, namespace, path=path)
connect POST requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_post_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect POST requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_post_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_node_proxy(name, path=path)
connect POST requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_post_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_post_node_proxy_with_path(name, path, path2=path2)
connect POST requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_post_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_post_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_put_namespaced_pod_proxy(name, namespace, path=path)
connect PUT requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_put_namespaced_pod_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_put_namespaced_pod_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_put_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
connect PUT requests to proxy of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to pod. (optional)
try:
api_response = api_instance.connect_put_namespaced_pod_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_put_namespaced_pod_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to pod. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_put_namespaced_service_proxy(name, namespace, path=path)
connect PUT requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_put_namespaced_service_proxy(name, namespace, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_put_namespaced_service_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_put_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
connect PUT requests to proxy of Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ServiceProxyOptions
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. (optional)
try:
api_response = api_instance.connect_put_namespaced_service_proxy_with_path(name, namespace, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_put_namespaced_service_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ServiceProxyOptions | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| path | str | path to the resource | |
| path2 | str | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_put_node_proxy(name, path=path)
connect PUT requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_put_node_proxy(name, path=path)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_put_node_proxy: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str connect_put_node_proxy_with_path(name, path, path2=path2)
connect PUT requests to proxy of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the NodeProxyOptions
path = 'path_example' # str | path to the resource
path2 = 'path_example' # str | Path is the URL path to use for the current proxy request to node. (optional)
try:
api_response = api_instance.connect_put_node_proxy_with_path(name, path, path2=path2)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->connect_put_node_proxy_with_path: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the NodeProxyOptions | |
| path | str | path to the resource | |
| path2 | str | Path is the URL path to use for the current proxy request to node. | [optional] |
str
- Content-Type: Not defined
- Accept: /
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Namespace create_namespace(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a Namespace
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
body = kubernetes_asyncio.client.V1Namespace() # V1Namespace |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespace(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespace: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1Namespace | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Binding create_namespaced_binding(namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
create a Binding
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Binding() # V1Binding |
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
try:
api_response = api_instance.create_namespaced_binding(namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_binding: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Binding | ||
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ConfigMap create_namespaced_config_map(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a ConfigMap
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1ConfigMap() # V1ConfigMap |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_config_map(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_config_map: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1ConfigMap | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Endpoints create_namespaced_endpoints(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create Endpoints
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Endpoints() # V1Endpoints |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_endpoints(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_endpoints: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Endpoints | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Event create_namespaced_event(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create an Event
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Event() # V1Event |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_event(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_event: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Event | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1LimitRange create_namespaced_limit_range(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a LimitRange
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1LimitRange() # V1LimitRange |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_limit_range(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_limit_range: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1LimitRange | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1PersistentVolumeClaim create_namespaced_persistent_volume_claim(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a PersistentVolumeClaim
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1PersistentVolumeClaim() # V1PersistentVolumeClaim |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_persistent_volume_claim(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_persistent_volume_claim: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1PersistentVolumeClaim | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Pod create_namespaced_pod(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Pod() # V1Pod |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_pod(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_pod: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Pod | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Binding create_namespaced_pod_binding(name, namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
create binding of a Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Binding
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Binding() # V1Binding |
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
try:
api_response = api_instance.create_namespaced_pod_binding(name, namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_pod_binding: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Binding | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Binding | ||
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1beta1Eviction create_namespaced_pod_eviction(name, namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
create eviction of a Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Eviction
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1beta1Eviction() # V1beta1Eviction |
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
try:
api_response = api_instance.create_namespaced_pod_eviction(name, namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_pod_eviction: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Eviction | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1beta1Eviction | ||
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1PodTemplate create_namespaced_pod_template(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a PodTemplate
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1PodTemplate() # V1PodTemplate |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_pod_template(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_pod_template: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1PodTemplate | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ReplicationController create_namespaced_replication_controller(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a ReplicationController
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1ReplicationController() # V1ReplicationController |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_replication_controller(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_replication_controller: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1ReplicationController | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ResourceQuota create_namespaced_resource_quota(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a ResourceQuota
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1ResourceQuota() # V1ResourceQuota |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_resource_quota(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_resource_quota: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1ResourceQuota | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Secret create_namespaced_secret(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a Secret
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Secret() # V1Secret |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_secret(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_secret: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Secret | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Service create_namespaced_service(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a Service
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1Service() # V1Service |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_service(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_service: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1Service | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ServiceAccount create_namespaced_service_account(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a ServiceAccount
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1ServiceAccount() # V1ServiceAccount |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_namespaced_service_account(namespace, body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_service_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1ServiceAccount | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1TokenRequest create_namespaced_service_account_token(name, namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
create token of a ServiceAccount
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the TokenRequest
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
body = kubernetes_asyncio.client.V1TokenRequest() # V1TokenRequest |
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
try:
api_response = api_instance.create_namespaced_service_account_token(name, namespace, body, dry_run=dry_run, field_manager=field_manager, pretty=pretty)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_namespaced_service_account_token: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the TokenRequest | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| body | V1TokenRequest | ||
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Node create_node(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
body = kubernetes_asyncio.client.V1Node() # V1Node |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_node(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1Node | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1PersistentVolume create_persistent_volume(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
create a PersistentVolume
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
body = kubernetes_asyncio.client.V1PersistentVolume() # V1PersistentVolume |
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_manager = 'field_manager_example' # str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. (optional)
try:
api_response = api_instance.create_persistent_volume(body, pretty=pretty, dry_run=dry_run, field_manager=field_manager)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->create_persistent_volume: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | V1PersistentVolume | ||
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_manager | str | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 201 | Created | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_config_map(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of ConfigMap
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_config_map(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_config_map: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_endpoints(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of Endpoints
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_endpoints(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_endpoints: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_event(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of Event
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_event(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_event: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_limit_range(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of LimitRange
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_limit_range(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_limit_range: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_persistent_volume_claim(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of PersistentVolumeClaim
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_persistent_volume_claim(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_persistent_volume_claim: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_pod(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_pod(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_pod: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_pod_template(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of PodTemplate
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_pod_template(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_pod_template: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_replication_controller(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of ReplicationController
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_replication_controller(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_replication_controller: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_resource_quota(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of ResourceQuota
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_resource_quota(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_resource_quota: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_secret(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of Secret
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_secret(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_secret: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_namespaced_service_account(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of ServiceAccount
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_namespaced_service_account(namespace, pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_namespaced_service_account: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_node(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of Node
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_node(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_node: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_collection_persistent_volume(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
delete collection of PersistentVolume
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
_continue = '_continue_example' # str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
limit = 56 # int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
resource_version = 'resource_version_example' # str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
timeout_seconds = 56 # int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_collection_persistent_volume(pretty=pretty, _continue=_continue, dry_run=dry_run, field_selector=field_selector, grace_period_seconds=grace_period_seconds, label_selector=label_selector, limit=limit, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, resource_version=resource_version, timeout_seconds=timeout_seconds, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_collection_persistent_volume: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| _continue | str | The continue option should be set when retrieving more results from the server. Since this value is server defined, kubernetes_asyncio.clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the kubernetes_asyncio.client needs a consistent list, it must restart their list without the continue field. Otherwise, the kubernetes_asyncio.client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| field_selector | str | A selector to restrict the list of returned objects by their fields. Defaults to everything. | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| label_selector | str | A selector to restrict the list of returned objects by their labels. Defaults to everything. | [optional] |
| limit | int | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and kubernetes_asyncio.clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, kubernetes_asyncio.clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a kubernetes_asyncio.client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| resource_version | str | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. | [optional] |
| timeout_seconds | int | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespace(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a Namespace
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Namespace
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespace(name, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespace: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Namespace | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespaced_config_map(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a ConfigMap
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ConfigMap
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_config_map(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_config_map: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ConfigMap | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespaced_endpoints(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete Endpoints
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Endpoints
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_endpoints(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_endpoints: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Endpoints | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespaced_event(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete an Event
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Event
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_event(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_event: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Event | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespaced_limit_range(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a LimitRange
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the LimitRange
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_limit_range(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_limit_range: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the LimitRange | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1PersistentVolumeClaim delete_namespaced_persistent_volume_claim(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a PersistentVolumeClaim
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PersistentVolumeClaim
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_persistent_volume_claim(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_persistent_volume_claim: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PersistentVolumeClaim | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Pod delete_namespaced_pod(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a Pod
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Pod
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_pod(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_pod: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Pod | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1PodTemplate delete_namespaced_pod_template(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a PodTemplate
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the PodTemplate
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_pod_template(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_pod_template: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the PodTemplate | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespaced_replication_controller(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a ReplicationController
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ReplicationController
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_replication_controller(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_replication_controller: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ReplicationController | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1ResourceQuota delete_namespaced_resource_quota(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a ResourceQuota
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the ResourceQuota
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_resource_quota(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_resource_quota: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the ResourceQuota | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 202 | Accepted | - |
| 401 | Unauthorized | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
V1Status delete_namespaced_secret(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
delete a Secret
- Api Key Authentication (BearerToken):
from __future__ import print_function
import time
import kubernetes_asyncio.client
from kubernetes_asyncio.client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost"
)
# The kubernetes_asyncio.client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: BearerToken
configuration = kubernetes_asyncio.client.Configuration(
host = "http://localhost",
api_key = {
'authorization': 'YOUR_API_KEY'
}
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['authorization'] = 'Bearer'
# Enter a context with an instance of the API kubernetes_asyncio.client
with kubernetes_asyncio.client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = kubernetes_asyncio.client.CoreV1Api(api_client)
name = 'name_example' # str | name of the Secret
namespace = 'namespace_example' # str | object name and auth scope, such as for teams and projects
pretty = 'pretty_example' # str | If 'true', then the output is pretty printed. (optional)
dry_run = 'dry_run_example' # str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
grace_period_seconds = 56 # int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
orphan_dependents = True # bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
propagation_policy = 'propagation_policy_example' # str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
body = kubernetes_asyncio.client.V1DeleteOptions() # V1DeleteOptions | (optional)
try:
api_response = api_instance.delete_namespaced_secret(name, namespace, pretty=pretty, dry_run=dry_run, grace_period_seconds=grace_period_seconds, orphan_dependents=orphan_dependents, propagation_policy=propagation_policy, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoreV1Api->delete_namespaced_secret: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| name | str | name of the Secret | |
| namespace | str | object name and auth scope, such as for teams and projects | |
| pretty | str | If 'true', then the output is pretty printed. | [optional] |
| dry_run | str | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | [optional] |
| grace_period_seconds | int | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | [optional] |
| orphan_dependents | bool | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | [optional] |
| propagation_policy | str | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | [optional] |
| body | V1DeleteOptions | [optional] |
- Content-Type: Not defined
- Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf
| Status code | Description | Response headers | |-------------|