fusion.TenantsApi

All URIs are relative to https://api.pure1.purestorage.com/fusion/api/1.2

Method	HTTP request	Description
create_tenant	POST /tenants	Creates a Tenant.
delete_tenant	DELETE /tenants/{tenant_name}	Deletes a specific Tenant.
get_tenant	GET /tenants/{tenant_name}	Gets a specific Tenant.
get_tenant_by_id	GET /resources/tenants/{tenant_id}	Gets a specific Tenant.
get_tenant_performance	GET /tenants/{tenant_name}/performance	Gets performance metrics of a specific Tenant.
get_tenants_space	GET /tenants/{tenant_name}/space	Gets space metrics of a specific Tenant.
list_tenants	GET /tenants	Gets a list of all Tenants.
query_tenants	GET /resources/tenants	Get all Tenants in the org. Provide a filter to search for specific Tenants.
update_tenant	PATCH /tenants/{tenant_name}	Updates a Tenant.

create_tenant

Operation create_tenant(body, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Creates a Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
body = fusion.TenantPost() # TenantPost | 
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Creates a Tenant.
    api_response = api_instance.create_tenant(body, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->create_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	TenantPost
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_tenant

Operation delete_tenant(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Deletes a specific Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Deletes a specific Tenant.
    api_response = api_instance.delete_tenant(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->delete_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tenant

Tenant get_tenant(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets a specific Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets a specific Tenant.
    api_response = api_instance.get_tenant(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->get_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Tenant

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tenant_by_id

Tenant get_tenant_by_id(tenant_id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets a specific Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
tenant_id = 'tenant_id_example' # str | The Tenant ID
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets a specific Tenant.
    api_response = api_instance.get_tenant_by_id(tenant_id, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->get_tenant_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_id	str	The Tenant ID
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Tenant

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tenant_performance

Performance get_tenant_performance(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets performance metrics of a specific Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets performance metrics of a specific Tenant.
    api_response = api_instance.get_tenant_performance(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->get_tenant_performance: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Performance

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tenants_space

Space get_tenants_space(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Gets space metrics of a specific Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
tenant_name = 'tenant_name_example' # str | The Tenant name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Gets space metrics of a specific Tenant.
    api_response = api_instance.get_tenants_space(tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->get_tenants_space: %s\n" % e)

Parameters

Name	Type	Description	Notes
tenant_name	str	The Tenant name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Space

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_tenants

TenantList list_tenants(x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id, filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name)

Gets a list of all Tenants.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)
filter = 'filter_example' # str | filter should use expression language for filtering (optional)
sort = 'sort_example' # str | Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. \"sort=size-,name\") (optional)
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
id = 'id_example' # str |  (optional)
name = 'name_example' # str |  (optional)
display_name = 'display_name_example' # str |  (optional)

try:
    # Gets a list of all Tenants.
    api_response = api_instance.list_tenants(x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id, filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->list_tenants: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]
filter	str	filter should use expression language for filtering	[optional]
sort	str	Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. "sort=size-,name")	[optional]
limit	int		[optional]
offset	int		[optional]
id	str		[optional]
name	str		[optional]
display_name	str		[optional]

Return type

TenantList

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

query_tenants

TenantList query_tenants(filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Get all Tenants in the org. Provide a filter to search for specific Tenants.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
filter = 'filter_example' # str | filter should use expression language for filtering (optional)
sort = 'sort_example' # str | Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. \"sort=size-,name\") (optional)
limit = 56 # int |  (optional)
offset = 56 # int |  (optional)
id = 'id_example' # str |  (optional)
name = 'name_example' # str |  (optional)
display_name = 'display_name_example' # str |  (optional)
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Get all Tenants in the org. Provide a filter to search for specific Tenants.
    api_response = api_instance.query_tenants(filter=filter, sort=sort, limit=limit, offset=offset, id=id, name=name, display_name=display_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->query_tenants: %s\n" % e)

Parameters

Name	Type	Description	Notes
filter	str	filter should use expression language for filtering	[optional]
sort	str	Returns the response items in the order specified. Set sort to the field(s) in the response by which to sort. Sorting can be performed on any of the fields in the response, and the items can be sorted in ascending or descending order by these fields. By default, the response items are sorted in ascending order. To sort in descending order, append the minus sign (-) to the field. A single request can be sorted on multiple fields. For example, you can sort all volumes from largest to smallest volume size, and then sort volumes of the same size in ascending order by volume name. To sort on multiple fields, list the fields as comma-separated values. (E.g. "sort=size-,name")	[optional]
limit	int		[optional]
offset	int		[optional]
id	str		[optional]
name	str		[optional]
display_name	str		[optional]
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

TenantList

Authorization

accessToken, oauth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_tenant

Operation update_tenant(body, tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)

Updates a Tenant.

Example

from __future__ import print_function
import time
import fusion
from fusion.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
configuration = fusion.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = fusion.TenantsApi(fusion.ApiClient(configuration))
body = fusion.TenantPatch() # TenantPatch | 
tenant_name = 'tenant_name_example' # str | The Tenant name
x_request_id = 'x_request_id_example' # str | The Request ID supplied with the request, used to perform operations idempotently. (optional)
authorization = 'authorization_example' # str | Access token (in JWT format) required to use any API endpoint. (optional)
x_correlation_id = 'x_correlation_id_example' # str | The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow. (optional)

try:
    # Updates a Tenant.
    api_response = api_instance.update_tenant(body, tenant_name, x_request_id=x_request_id, authorization=authorization, x_correlation_id=x_correlation_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TenantsApi->update_tenant: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	TenantPatch
tenant_name	str	The Tenant name
x_request_id	str	The Request ID supplied with the request, used to perform operations idempotently.	[optional]
authorization	str	Access token (in JWT format) required to use any API endpoint.	[optional]
x_correlation_id	str	The Correlation ID provided will be added to log messages and can be used for support. The same Correlation ID may be used for separate requests, to track a higher level workflow.	[optional]

Return type

Operation

Authorization

accessToken, oauth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

TenantsApi.md

Latest commit

History

TenantsApi.md

File metadata and controls

fusion.TenantsApi

create_tenant

Example

Parameters

Return type

Authorization

HTTP request headers

delete_tenant

Example

Parameters

Return type

Authorization

HTTP request headers

get_tenant

Example

Parameters

Return type

Authorization

HTTP request headers

get_tenant_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

get_tenant_performance

Example

Parameters

Return type

Authorization

HTTP request headers

get_tenants_space

Example

Parameters

Return type

Authorization

HTTP request headers

list_tenants

Example

Parameters

Return type

Authorization

HTTP request headers

query_tenants

Example

Parameters

Return type

Authorization

HTTP request headers

update_tenant

Example

Parameters

Return type

Authorization

HTTP request headers