otcextensions.sdk.dcs.v1.instance

The DMS Instance Class

The Instance class inherits from Resource.

class otcextensions.sdk.dms.v1.instance.Instance(_synchronized=False, connection=None, **attrs)

DMS Instance resource

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.

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

Plural form of key for resource.

base_path: str = '/instances'

The base part of the URI for this resource.

allow_list = True

Allow list operation for this resource.

allow_fetch = True

Allow get operation for this resource.

allow_create = True

Allow create operation for this resource.

allow_delete = True

Allow delete operation for this resource.

allow_commit = True

Allow update operation for this resource.

access_user

Properties The username of an instance.

availability_zones

List of availability zones the instance belongs to

charging_mode

Billing mode

connect_address

IP address of the instance

created_at

Instance creation time

description

Instance description

engine_name

Message engine.

engine_version

Engine version

instance_id

Instance id

is_public

Associate floating IP

is_ssl

Enable SSL

kafka_public_status

Kafka public status

maintenance_end

End time of the maintenance window

maintenance_start

Beginning of the maintenance window

max_partitions

Maximum number of partitions

network_id

Neutron network ID

password

User password

port

Port number of the instance

product_id

Product ID

public_bandwidth

Bandwidth of the public access

retention_policy

Retention policy

router_id

Router ID

router_name

Router name

security_group_id

Security group ID

security_group_name

Security group Name

service_type

Service type

spec

specification of the instance

spec_code

Specification code of the instance: dms.instance.kafka.cluster.c3.min dms.instance.kafka.cluster.c3.small.2 dms.instance.kafka.cluster.c3.middle.2 dms.instance.kafka.cluster.c3.high.2

status

Instance status CREATING, CREATEFAILED, RUNNING, ERROR, STARTING, RESTARTING, CLOSING, FROZEN

storage_resource_id

Storage resource ID

storage_spec_code

Storage I/O specification code

storage_type

Storage type

storage

Storage space GB

total_storage

Total storage space GB

type

Instance type

used_storage

Used storage GB

user_id

User ID

user_name

User name

restart(session)

Restart specified instances

delete_batch(session, id_list)

Delete batch of instances

last updated: UTC - commit: