ExternalAccountsResourceApi

All URIs are relative to /api/v58

Method	HTTP request	Description
createAccount	POST /externalAccounts/create
deleteAccount	DELETE /externalAccounts/delete/{name}
externalAccountCommandByName	POST /externalAccounts/account/{name}/commands/{commandName}
getSupportedCategories	GET /externalAccounts/supportedCategories
getSupportedTypes	GET /externalAccounts/supportedTypes/{categoryName}
listExternalAccountCommands	GET /externalAccounts/typeInfo/{typeName}/commandsByName
readAccount	GET /externalAccounts/account/{name}
readAccountByDisplayName	GET /externalAccounts/accountByDisplayName/{displayName}
readAccountCredentials	GET /externalAccounts/account/{name}/credentials
readAccounts	GET /externalAccounts/type/{typeName}
readConfig	GET /externalAccounts/account/{name}/config
updateAccount	PUT /externalAccounts/update
updateConfig	PUT /externalAccounts/account/{name}/config

createAccount

ApiExternalAccount createAccount(body)

Create a new external account. Account names and display names must be unique, i.e. they must not share names or display names with an existing account. Server generates an account ID for the requested account.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
ApiExternalAccount body = new ApiExternalAccount(); // ApiExternalAccount | 
try {
    ApiExternalAccount result = apiInstance.createAccount(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#createAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ApiExternalAccount		[optional]

Return type

ApiExternalAccount

Authorization

HTTP request headers

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

deleteAccount

ApiExternalAccount deleteAccount(name)

Delete an external account, specifying its name.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String name = "name_example"; // String | 
try {
    ApiExternalAccount result = apiInstance.deleteAccount(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#deleteAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String

Return type

ApiExternalAccount

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

externalAccountCommandByName

ApiCommand externalAccountCommandByName(commandName, name)

Executes a command on the external account specified by name.

Available since API v16.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String commandName = "commandName_example"; // String | The command name.
String name = "name_example"; // String | The external account name.
try {
    ApiCommand result = apiInstance.externalAccountCommandByName(commandName, name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#externalAccountCommandByName");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
commandName	String	The command name.
name	String	The external account name.

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSupportedCategories

ApiExternalAccountCategoryList getSupportedCategories()

List of external account categories supported by this Cloudera Manager.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
try {
    ApiExternalAccountCategoryList result = apiInstance.getSupportedCategories();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#getSupportedCategories");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiExternalAccountCategoryList

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSupportedTypes

ApiExternalAccountTypeList getSupportedTypes(categoryName)

List of external account types supported by this Cloudera Manager by category.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String categoryName = "categoryName_example"; // String | 
try {
    ApiExternalAccountTypeList result = apiInstance.getSupportedTypes(categoryName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#getSupportedTypes");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
categoryName	String

Return type

ApiExternalAccountTypeList

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

listExternalAccountCommands

ApiCommandMetadataList listExternalAccountCommands(typeName)

Lists all the commands that can be executed by name on the provided external account type.

Available since API v16.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String typeName = "typeName_example"; // String | The external account type name
try {
    ApiCommandMetadataList result = apiInstance.listExternalAccountCommands(typeName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#listExternalAccountCommands");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
typeName	String	The external account type name

Return type

ApiCommandMetadataList

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAccount

ApiExternalAccount readAccount(name, view)

Get a single external account by account name.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String name = "name_example"; // String | 
String view = "view_example"; // String | 
try {
    ApiExternalAccount result = apiInstance.readAccount(name, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#readAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String
view	String		[optional] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiExternalAccount

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAccountByDisplayName

ApiExternalAccount readAccountByDisplayName(displayName, view)

Get a single external account by display name.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String displayName = "displayName_example"; // String | 
String view = "view_example"; // String | 
try {
    ApiExternalAccount result = apiInstance.readAccountByDisplayName(displayName, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#readAccountByDisplayName");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
displayName	String
view	String		[optional] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiExternalAccount

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAccountCredentials

ApiConfigList readAccountCredentials(name)

Get un-redacted credentials of an external account for the given account name, currently supported only for ALTUS accounts.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String name = "name_example"; // String | The external account name
try {
    ApiConfigList result = apiInstance.readAccountCredentials(name);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#readAccountCredentials");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	The external account name

Return type

ApiConfigList

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

readAccounts

ApiExternalAccountList readAccounts(typeName, view)

Get a list of external accounts for a specific account type.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String typeName = "typeName_example"; // String | 
String view = "view_example"; // String | 
try {
    ApiExternalAccountList result = apiInstance.readAccounts(typeName, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#readAccounts");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
typeName	String
view	String		[optional] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiExternalAccountList

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

readConfig

ApiConfigList readConfig(name, view)

Get configs of external account for the given account name.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String name = "name_example"; // String | The external account name
String view = "summary"; // String | The view to materialize, either \"summary\" or \"full\".
try {
    ApiConfigList result = apiInstance.readConfig(name, view);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#readConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	The external account name
view	String	The view to materialize, either "summary" or "full".	[optional] [default to summary] [enum: EXPORT, EXPORT_REDACTED, FULL, FULL_WITH_HEALTH_CHECK_EXPLANATION, FULL_WITH_NO_HEALTH_CHECK, SUMMARY, SUMMARY_WITH_NO_HEALTH_CHECK]

Return type

ApiConfigList

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

updateAccount

ApiExternalAccount updateAccount(body)

Update an external account.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
ApiExternalAccount body = new ApiExternalAccount(); // ApiExternalAccount | 
try {
    ApiExternalAccount result = apiInstance.updateAccount(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#updateAccount");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	ApiExternalAccount		[optional]

Return type

ApiExternalAccount

Authorization

HTTP request headers

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

updateConfig

ApiConfigList updateConfig(name, body, message)

Upadate configs of external account for the given account name.

Example

// Import classes:
//import com.cloudera.api.swagger.client.ApiClient;
//import com.cloudera.api.swagger.client.ApiException;
//import com.cloudera.api.swagger.client.Configuration;
//import com.cloudera.api.swagger.client.auth.*;
//import com.cloudera.api.swagger.ExternalAccountsResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

ExternalAccountsResourceApi apiInstance = new ExternalAccountsResourceApi();
String name = "name_example"; // String | The external account name
ApiConfigList body = new ApiConfigList(); // ApiConfigList | Settings to update.
String message = "message_example"; // String | Optional message describing the changes.
try {
    ApiConfigList result = apiInstance.updateConfig(name, body, message);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsResourceApi#updateConfig");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	The external account name
body	ApiConfigList	Settings to update.	[optional]
message	String	Optional message describing the changes.	[optional]

Return type

ApiConfigList

Authorization

HTTP request headers

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