otcextensions.sdk.rds.v1.instance

The Instance Class

The Instance class inherits from Resource.

class otcextensions.sdk.rds.v1.instance.Instance(_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 = '/instances'

The base part of the URI for this resource.

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

Singular form of key for resource.

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

Plural form of key for resource.

allow_create = True

Allow create operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_list = True

Allow list operation for this resource.

id

Instance id

status

Instance status

name: ty.Union[Body, URI]

Instance name

flavor

Flavor information Type: dict

datastore

Data store information Type: dict

region

Region

tenante_id

Tenant_id Type: str

volume

Volume information Type: dict

hostname

Host name of the instance Type:str

created

Instance created time Type:str

updated

Instance updated time Type:str

fault

Fault, only validate if fault Type:dict

replicas

Replicas Type:dict

configuration

Configuration Type:dict

locality

Locality Not supported in RDS Type:str

local_storage_used

Used local Storage Not supported in RDS

password

Password The password of the database root user(i.e. the administrative user).

cluster_id

Cluster id

shard_id

Shard id

server_id

Server id The ID of the underlying Nova instance for an instance. Type:str

volume_id

Volume id The ID of a volume. Type:str

encrypted_rpc_messaging

encrypted_rpc_messaging Whether the instance is using encrypted rpm messaging feature or not. Type:bool

users

Users Type:list

flavorRef

Flavor ID Type:uuid

modules

Modules Type:dict

availability_zone

Availability Zone The availability zone of the instance. Type:str

nics

Nics interface list Type:dict

replica_of

Id of the master Type:str

replica_count

Replica of the instance Type:int

region_name

region name Type:str

databases

Databases object Type:list

type

Instance type readreplica/master/slave

vpc

Private cloud id

security_group

Security group Type: dict

backup_strategy

Backup Strategy Type: dict

ha

HA information Type: dict

restore_point

Restore Point, create new instance from restore Type: dict

dbRtPd

Root password

configurationStatus

Status of configuration

paramsGroupId

Id of configuration

subnetid

Id of subnet

role

Instance role

internalSubnetId

Internal subnet id

group

Group of instance

securegroup

Secure group id

azcode

Az code

dbuser

DB user

storeEngine

Storage Engine

payModel

Pay model

slave_of

Slave of instance

restart(session)

Restart the database instance

Returns:

None

resize(session, flavor_reference)

Resize the database instance flavor

Returns:

None

resize_volume(session, volume_size)

Resize the volume attached to the instance

Returns:

None

restore(session, backupRef)

Restores database to the given backup rference

Returns:

None