otcextensions.sdk.dws.v1.cluster

The DWS Cluster Class

The Cluster class inherits from Resource.

class otcextensions.sdk.dws.v1.cluster.Cluster(_synchronized=False, connection=None, **attrs)

The base resource

Parameters:

• _synchronized (bool) – This is not intended to be used directly. See new() and existing().

• connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of self._connection in Resource code should protect itself with a check for None.

base_path: str = '/clusters'

The base part of the URI for this resource.

resource_key: ty.Optional[str] = 'cluster'

Singular form of key for resource.

resources_key: ty.Optional[str] = 'clusters'

Plural form of key for resource.

allow_create = True

Allow create operation for this resource.

allow_list = True

Allow list operation for this resource.

allow_commit = True

Allow update operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_patch = True

Allow patch operation for this resource.

action_progress

The key indicates an ongoing task.

availability_zone

Availabilitu Zone of a Cluster

created_at

Cluster creation time.

endpoints

Private network connection information about the cluster.

enterprise_project_id

Enterprise project ID. If no enterprise project is specified for a cluster, the default enterprise project ID 0 is used.

error

Cause of failure. If the parameter is left empty, the cluster is in the normal state.

flavor

Node Type (DWS Flavor).

flavor_id

Node Type ID (DWS Flavor ID).

floating_ip

Floating IP details

guest_agent_version

Guest Agent Version

is_logical_cluster_enabled

Whether logical_cluster has been enabled.

is_logical_cluster_initialed

Whether logical_cluster has been initialed

is_logical_cluster_mode

Whether logical_cluster_mode is set true.

keep_last_manual_snapshot

The number of latest manual snapshots that need to be retained for a cluster.

maintenance_window

Cluster maintenance window.

network_id

Network ID, which is used for configuring cluster network.

nodes

Nodes List.

num_cn

Number of deployed CNs.

num_recent_events

Number of events.

num_free_nodes

number_of_free_node

num_nodes

Number of nodes in a cluster. The value ranges from 3 to 32.

parameter_group

Parameter group details.

plugins

plugins

port

Service port of a cluster. The value ranges from 8000 to 30000. The default value is 8000.

private_ip

List of private network IP addresses.

public_endpoints

Public network connection information about the cluster.

resize_info

Cluster scale-out details.

router_id

Router ID, which is used for configuring cluster network.

status

Cluster status. The value can be one of the following: - CREATING - AVAILABLE - UNAVAILABLE - CREATION FAILED

sub_status

Sub-status of clusters in the AVAILABLE state.

spec_version

spec_version

security_group_id

ID of a security group, which is used for configuring cluster network

task_status

Cluster management task.

tags

Labels in a cluster.

user_name

Administrator username for logging in to a GaussDB(DWS) cluster.

user_pwd

Administrator password for logging in to a GaussDB(DWS) cluster.

updated_at

Last modification time of a cluster.

version

Data warehouse version.

private_domain

Private Domain from endpoints connection_info

public_domain

Public Domain from public_endpoints connection_info

delete(session, keep_last_manual_snapshot=0, ignore_missing=False)

Delete a DWS Cluster.

This function overrides default Resource.delete to enable params

Parameters:

• session (Adapter) – The session to use for making this request.

• keep_last_manual_snapshot (int) – The number of latest manual snapshots that need to be retained for a cluster.

• ignore_missing (bool) – When set to False ResourceNotFound will be raised when the cluster does not exist. When set to True, no exception will be set when attempting to delete a nonexistent cluster.

Returns:

None

restart(session)

Restart the cluster.

scale_out(session, node_count)

Scale Out cluster Nodes.

reset_password(session, new_password)

Reset Admin DB Password.

last updated: UTC - commit: