director-sdk

cloudera-director-python-client

Software-defined EDH clusters on cloud infrastructure

This Python package is automatically generated by the Swagger Codegen project:

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import cloudera.director 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import cloudera.director

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = cloudera.director.AuthenticationApi()
login = cloudera.director.Login() # Login | 

try:
    # Log in to the API
    api_response = api_instance.login(login)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->login: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost

Class Method HTTP request Description
AuthenticationApi login POST /api/d6.2/login Log in to the API
AuthenticationApi logout POST /api/d6.2/logout Log out from the API
ClustersApi collect_diagnostic_data POST /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/diagnosticData Collects diagnostic data
ClustersApi create POST /api/d6.2/environments/{environment}/deployments/{deployment}/clusters Create a new cluster
ClustersApi delete DELETE /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster} Delete a cluster by name
ClustersApi export_cluster_configuration GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/config Exports the cluster configuration for this cluster
ClustersApi get_administration_settings GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/settings Get administration settings for a cluster
ClustersApi get_history GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/history Get history of updates for a cluster
ClustersApi get_metrics GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/metrics Get cluster metrics by name
ClustersApi get_redacted GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster} Get a cluster by name
ClustersApi get_status GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/status Get a cluster status by name
ClustersApi get_template_redacted GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/template Get a cluster template by name
ClustersApi list GET /api/d6.2/environments/{environment}/deployments/{deployment}/clusters List all clusters
ClustersApi update PUT /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster} Update an existing cluster
ClustersApi update_administration_settings PUT /api/d6.2/environments/{environment}/deployments/{deployment}/clusters/{cluster}/settings Update administration settings for a cluster
DatabaseServersApi create POST /api/d6.2/environments/{environment}/databaseServers Create a new external database server
DatabaseServersApi delete DELETE /api/d6.2/environments/{environment}/databaseServers/{externalDatabaseServer} Delete an external database server by name
DatabaseServersApi get_database_server_usage GET /api/d6.2/environments/{environment}/databaseServers/{externalDatabaseServer}/usage Get an external database server usage by name
DatabaseServersApi get_redacted GET /api/d6.2/environments/{environment}/databaseServers/{externalDatabaseServer} Get an external database server by name
DatabaseServersApi get_status GET /api/d6.2/environments/{environment}/databaseServers/{externalDatabaseServer}/status Get an external database server status by name
DatabaseServersApi get_template_redacted GET /api/d6.2/environments/{environment}/databaseServers/{externalDatabaseServer}/template Get an external database server template by name
DatabaseServersApi list GET /api/d6.2/environments/{environment}/databaseServers List all externalDatabaseServers
DatabaseServersApi update PUT /api/d6.2/environments/{environment}/databaseServers/{externalDatabaseServer} Update an existing external database server (unsupported)
DeploymentsApi collect_diagnostic_data POST /api/d6.2/environments/{environment}/deployments/{deployment}/diagnosticData Collects diagnostic data
DeploymentsApi create POST /api/d6.2/environments/{environment}/deployments Create a new deployment
DeploymentsApi delete DELETE /api/d6.2/environments/{environment}/deployments/{deployment} Delete a deployment by name
DeploymentsApi get_redacted GET /api/d6.2/environments/{environment}/deployments/{deployment} Get a deployment by name
DeploymentsApi get_status GET /api/d6.2/environments/{environment}/deployments/{deployment}/status Get a deployment status by name
DeploymentsApi get_template_redacted GET /api/d6.2/environments/{environment}/deployments/{deployment}/template Get a deployment template by name
DeploymentsApi list GET /api/d6.2/environments/{environment}/deployments List all deployments
DeploymentsApi update PUT /api/d6.2/environments/{environment}/deployments/{deployment} Update an existing deployment template
DeploymentsApi update_metering_setting PUT /api/d6.2/environments/{environment}/deployments/{deployment}/metering Update billing ID for an existing deployment
EnvironmentsApi create POST /api/d6.2/environments Create a new environment
EnvironmentsApi delete DELETE /api/d6.2/environments/{name} Delete an environment by name
EnvironmentsApi get_redacted GET /api/d6.2/environments/{name} Get an environment by name
EnvironmentsApi list GET /api/d6.2/environments List all environments
EnvironmentsApi update PUT /api/d6.2/environments/{name} Update an existing environment
EnvironmentsApi update_provider_credentials PUT /api/d6.2/environments/{name}/provider/credentials Update provider credentials for a specific environment
EulaApi get GET /api/d6.2/eula Get the EULA
EulaApi update PUT /api/d6.2/eula Update the EULA
ImportClientConfigApi convert_simple POST /api/d6.2/import/clientConfig/convertSimple Convert Simple Configuration
ImportClientConfigApi import_client_config POST /api/d6.2/import Import Client Config
ImportClientConfigApi validate POST /api/d6.2/import/clientConfig/validate Validate Client Config
InstanceTemplatesApi create POST /api/d6.2/environments/{environment}/templates/instances Create a new instance template
InstanceTemplatesApi delete DELETE /api/d6.2/environments/{environment}/templates/instances/{template} Delete an instance template by name
InstanceTemplatesApi get GET /api/d6.2/environments/{environment}/templates/instances/{template} Get an instance template by name
InstanceTemplatesApi list GET /api/d6.2/environments/{environment}/templates/instances List all instance templates
InstanceTemplatesApi update PUT /api/d6.2/environments/{environment}/templates/instances/{template} Update an existing instance template
MarketplacesApi get_cdh_images GET /api/d6.2/marketplaces/images/CDH Get CDH marketplace images
MarketplacesApi get_cm_images GET /api/d6.2/marketplaces/images/CM Get CM marketplace images
NotificationsApi get GET /api/d6.2/notifications Get system notification messages
ProviderMetadataApi get GET /api/d6.2/metadata/providers/{providerId} Get a provider by name
ProviderMetadataApi list GET /api/d6.2/metadata/providers List all provider metadata
ServerConfigApi get GET /api/d6.2/serverConfigs Get server configuration
ServerConfigApi metadata GET /api/d6.2/serverConfigs/metadata Retrieves the metadata for server configuration
ServerConfigApi update_configs POST /api/d6.2/serverConfigs Get server configuration
UsersApi create POST /api/d6.2/users Create a new user
UsersApi current_redacted GET /api/d6.2/users/current Get the current user
UsersApi delete DELETE /api/d6.2/users/{username} Delete a user by username
UsersApi get_redacted GET /api/d6.2/users/{username} Get a user by username
UsersApi get_user_management_status GET /api/d6.2/users/managementStatus Gets user management status
UsersApi list GET /api/d6.2/users List all users
UsersApi update PUT /api/d6.2/users/{username} Update an existing user
UsersApi update_password PUT /api/d6.2/users/{username}/password Update the password of an existing user

Documentation For Models

Documentation For Authorization

basic

Author