V2 API bindings
exoscale.api.v2
provides a low-level client targeting Exoscale’s
OpenAPI-based V2 API. This client is dynamically generated from the OpenAPI
definition shipped with the package.
Examples
Creating a client targeting one of the available zones:
>>> from exoscale.api.v2 import Client
>>> c = Client("api-key", "api-secret", zone="de-fra-1")
>>> c.list_instances()
{'instances': []}
Creating a client targeting an endpoint specifically:
>>> from exoscale.api.v2 import Client
>>> c = Client("api-key", "api-secret", url="https://api-ch-gva-2.exoscale.com/v2")
>>> c.list_instances()
{'instances': []}
Waiting for an asynchronous operation to complete:
>>> from exoscale.api.v2 import Client
>>> c = Client("api-key", "api-secret", zone="ch-gva-2")
>>> version = c.list_sks_cluster_versions()["sks-cluster-versions"][0]
>>> operation = c.create_sks_cluster(
... cni="cilium",
... name="my-cluster",
... level="starter",
... version=version,
... )
>>> c.wait(operation["id"])
{'id': 'e2047130-b86e-11ef-83b3-0d8312b2c2d7',
'state': 'success',
'reference': {
'id': '8561ee34-09f0-42da-a765-abde807f944b',
'link': '/v2/sks-cluster/8561ee34-09f0-42da-a765-abde807f944b',
'command': 'get-sks-cluster'}}
- class exoscale.api.v2.Client(key, secret, url=None, **kwargs)
Create an API client.
- Parameters:
key (str) – Exoscale API key.
secret (str) – Exoscale API secret.
url (str) – Endpoint URL to use. Defaults to
'https://api-{zone}.exoscale.com/v2'
.zone (str) – one of
'at-vie-1'
,'at-vie-2'
,'bg-sof-1'
,'ch-dk-2'
,'ch-gva-2'
,'de-fra-1'
,'de-muc-1'
. Defaults to'ch-gva-2'
.
- Returns:
A configured API client.
- Return type:
- add_external_source_to_security_group(*args, **kwargs)
Add an external source as a member of a Security Group
- Parameters:
id (str)
cidr (str) – CIDR-formatted network to add.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- add_instance_protection(*args, **kwargs)
Set instance destruction protection
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- add_rule_to_security_group(*args, **kwargs)
Create a Security Group rule
- Parameters:
id (str)
flow_direction (str) – Network flow direction to match. Must be one of
'egress'
,'ingress'
.description (str) – Security Group rule description.
network (str) – CIDR-formatted network allowed.
security_group (dict) – Security Group allowed.
protocol (str) – Network protocol. Must be one of
'ah'
,'esp'
,'gre'
,'icmp'
,'icmpv6'
,'ipip'
,'tcp'
,'udp'
.icmp (dict) – ICMP details (default: -1 (ANY)).
start_port (int) – Start port of the range.
end_port (int) – End port of the range.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- add_service_to_load_balancer(*args, **kwargs)
Add a Load Balancer Service
- Parameters:
id (str)
name (str) – Load Balancer Service name.
description (str) – Load Balancer Service description.
instance_pool (dict) – Instance Pool to forward traffic to.
protocol (str) – Network traffic protocol. Must be one of
'tcp'
,'udp'
.strategy (str) – Load balancing strategy. Must be one of
'maglev-hash'
,'round-robin'
,'source-hash'
.port (int) – Port exposed on the Load Balancer’s public IP.
target_port (int) – Port on which the network traffic will be forwarded to on the receiving instance.
healthcheck (dict) – Healthcheck configuration.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- attach_block_storage_volume_to_instance(*args, **kwargs)
Attach block storage volume to an instance
- Parameters:
id (str)
instance (dict) – Instance to attach to, this can only be done if the volume is not currently attached.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- attach_dbaas_service_to_endpoint(*args, **kwargs)
- Parameters:
source_service_name (str)
dest_endpoint_id (str) – External endpoint id.
type (str) – External endpoint type. Must be one of
'datadog'
,'elasticsearch'
,'opensearch'
,'prometheus'
,'rsyslog'
.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- attach_instance_to_elastic_ip(*args, **kwargs)
Attach a Compute instance to an Elastic IP
- Parameters:
id (str)
instance (dict) – Compute instance.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- attach_instance_to_private_network(*args, **kwargs)
Attach a Compute instance to a Private Network
- Parameters:
id (str)
ip (str) – Static IP address lease for the corresponding network interface.
instance (dict) – Compute instance.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- attach_instance_to_security_group(*args, **kwargs)
Attach a Compute instance to a Security Group
- Parameters:
id (str)
instance (dict) – Compute instance.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- copy_template(*args, **kwargs)
Copy a Template from a zone to another
- Parameters:
id (str)
target_zone (dict) – Target Zone name.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_anti_affinity_group(*args, **kwargs)
Create an Anti-affinity Group
- Parameters:
name (str) – Anti-affinity Group name.
description (str) – Anti-affinity Group description.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_api_key(*args, **kwargs)
Create a new API key
- Parameters:
role_id (str) – IAM API Key Role ID.
name (str) – IAM API Key Name.
- Returns:
IAM API Key. A dictionnary with the following keys:
name (str): IAM API Key name.
key (str): IAM API Key.
secret (str): IAM API Key Secret.
role_id (str): IAM API Key Role ID.
- Return type:
dict
- create_block_storage_snapshot(*args, **kwargs)
Create a block storage snapshot
- Parameters:
id (str)
name (str) – Snapshot name.
labels (dict) – Resource labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_block_storage_volume(*args, **kwargs)
Create a block storage volume
- Parameters:
name (str) – Volume name.
size (int) – Volume size in GiB. When a snapshot ID is supplied, this defaults to the size of the source volume, but can be set to a larger value..
labels (dict) – Resource labels.
block_storage_snapshot (dict) – Block storage snapshot.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_external_endpoint_datadog(*args, **kwargs)
- Parameters:
name (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_external_endpoint_elasticsearch(*args, **kwargs)
- Parameters:
name (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_external_endpoint_opensearch(*args, **kwargs)
- Parameters:
name (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_external_endpoint_prometheus(*args, **kwargs)
- Parameters:
name (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_external_endpoint_rsyslog(*args, **kwargs)
- Parameters:
name (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_integration(*args, **kwargs)
- Parameters:
integration_type (str) – Integration type. Must be one of
'datasource'
,'logs'
,'metrics'
.source_service (str) – A source service.
dest_service (str) – A destination service.
settings (dict) – Integration settings.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_kafka_schema_registry_acl_config(*args, **kwargs)
Add a Kafka Schema Registry ACL entry
- Parameters:
name (str)
id (str) – Kafka ACL ID.
username (str) – Kafka username or username pattern.
resource (str) – Kafka Schema Registry name or pattern.
permission (str) – Kafka Schema Registry permission. Must be one of
'schema_registry_read'
,'schema_registry_write'
.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_kafka_topic_acl_config(*args, **kwargs)
Add a Kafka topic ACL entry
- Parameters:
name (str)
id (str) – Kafka ACL ID.
username (str) – Kafka username or username pattern.
topic (str) – Kafka topic name or pattern.
permission (str) – Kafka permission. Must be one of
'admin'
,'read'
,'readwrite'
,'write'
.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_kafka_user(*args, **kwargs)
Create a DBaaS Kafka user
- Parameters:
service_name (str)
username (str) – Username.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_mysql_database(*args, **kwargs)
Create a DBaaS MySQL database
- Parameters:
service_name (str)
database_name (str) – Service database name.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_mysql_user(*args, **kwargs)
Create a DBaaS MySQL user
- Parameters:
service_name (str)
username (str) – Username.
authentication (str) – Authentication option. Must be one of
'caching_sha2_password'
,'mysql_native_password'
.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_opensearch_user(*args, **kwargs)
Create a DBaaS OpenSearch user
- Parameters:
service_name (str)
username (str) – Username.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_pg_connection_pool(*args, **kwargs)
Create a DBaaS PostgreSQL connection pool
- Parameters:
service_name (str)
name (str) – Connection pool name.
database_name (str) – Service database name.
mode (str) – PGBouncer pool mode. Must be one of
'session'
,'statement'
,'transaction'
.size (int) – Size of PGBouncer’s PostgreSQL side connection pool.
username (str) – Pool username.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_pg_database(*args, **kwargs)
Create a DBaaS Postgres database
- Parameters:
service_name (str)
database_name (str) – Service database name.
lc_collate (str) – Default string sort order (LC_COLLATE) for PostgreSQL database.
lc_ctype (str) – Default character classification (LC_CTYPE) for PostgreSQL database.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_pg_upgrade_check(*args, **kwargs)
- Parameters:
service (str)
target_version (str) – Target version for upgrade. Must be one of
'13'
,'14'
,'15'
,'16'
,'17'
.
- Returns:
dict
- create_dbaas_postgres_user(*args, **kwargs)
Create a DBaaS Postgres user
- Parameters:
service_name (str)
username (str) – Username.
allow_replication (bool)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_redis_user(*args, **kwargs)
Create a DBaaS Redis user
- Parameters:
service_name (str)
username (str) – Username.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_service_grafana(*args, **kwargs)
- Parameters:
name (str)
maintenance (dict) – Automatic maintenance settings.
plan (str) – Subscription plan.
termination_protection (bool) – Service is protected against termination and powering off.
fork_from_service (str) – Service to fork from.
grafana_settings (dict) – Grafana specific settings.
ip_filter (list) – Allowed CIDR address blocks for incoming connections.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_service_kafka(*args, **kwargs)
Create a DBaaS Kafka service
- Parameters:
name (str)
authentication_methods (dict) – Kafka authentication methods.
kafka_rest_enabled (bool) – Enable Kafka-REST service.
kafka_connect_enabled (bool) – Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
schema_registry_settings (dict) – Schema Registry configuration.
kafka_rest_settings (dict) – Kafka REST configuration.
termination_protection (bool) – Service is protected against termination and powering off.
kafka_connect_settings (dict) – Kafka Connect configuration values.
maintenance (dict) – Automatic maintenance settings.
kafka_settings (dict) – Kafka-specific settings.
schema_registry_enabled (bool) – Enable Schema-Registry service.
version (str) – Kafka major version.
plan (str) – Subscription plan.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_service_mysql(*args, **kwargs)
Create a DBaaS MySQL service
- Parameters:
name (str)
backup_schedule (dict)
integrations (list) – Service integrations to be enabled when creating the service..
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
termination_protection (bool) – Service is protected against termination and powering off.
fork_from_service (str) – Service to fork from.
recovery_backup_time (str) – ISO time of a backup to recover from for services that support arbitrary times.
mysql_settings (dict) – MySQL-specific settings.
maintenance (dict) – Automatic maintenance settings.
admin_username (str) – Custom username for admin user. This must be set only when a new service is being created..
version (str) – MySQL major version.
plan (str) – Subscription plan.
admin_password (str) – Custom password for admin user. Defaults to random string. This must be set only when a new service is being created..
migration (dict) – Migrate data from existing server.
binlog_retention_period (int) – The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default for example if using the MySQL Debezium Kafka connector..
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_service_opensearch(*args, **kwargs)
Create a DBaaS OpenSearch service
- Parameters:
name (str)
max_index_count (int) – Maximum number of indexes to keep before deleting the oldest one.
keep_index_refresh_interval (bool) – Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn’t fit your case, you can disable this by setting up this flag to true..
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
termination_protection (bool) – Service is protected against termination and powering off.
fork_from_service (str) – Service to fork from.
index_patterns (list) – Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like ‘logs.?’ and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note ‘logs.?’ does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored..
maintenance (dict) – Automatic maintenance settings.
index_template (dict) – Template settings for all new indexes.
opensearch_settings (dict) – OpenSearch-specific settings.
version (str) – OpenSearch major version.
recovery_backup_name (str) – Name of a backup to recover from for services that support backup names.
plan (str) – Subscription plan.
opensearch_dashboards (dict) – OpenSearch Dashboards settings.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_service_pg(*args, **kwargs)
Create a DBaaS PostgreSQL service
- Parameters:
name (str)
pgbouncer_settings (dict) – PGBouncer connection pooling settings.
backup_schedule (dict)
variant (str) – Variant of the PostgreSQL service, may affect the features that are exposed by default. Must be one of
'aiven'
,'timescale'
.integrations (list) – Service integrations to be enabled when creating the service..
timescaledb_settings (dict) – TimescaleDB extension configuration values.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
termination_protection (bool) – Service is protected against termination and powering off.
fork_from_service (str) – Service to fork from.
synchronous_replication (str) – Synchronous replication type. Note that the service plan also needs to support synchronous replication.. Must be one of
'off'
,'quorum'
.recovery_backup_time (str) – ISO time of a backup to recover from for services that support arbitrary times.
pglookout_settings (dict) – PGLookout settings.
maintenance (dict) – Automatic maintenance settings.
admin_username (str) – Custom username for admin user. This must be set only when a new service is being created..
version (str) – PostgreSQL major version. Must be one of
'13'
,'14'
,'15'
,'16'
,'17'
.plan (str) – Subscription plan.
work_mem (int) – Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB)..
shared_buffers_percentage (int) – Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value..
pg_settings (dict) – PostgreSQL-specific settings.
admin_password (str) – Custom password for admin user. Defaults to random string. This must be set only when a new service is being created..
migration (dict) – Migrate data from existing server.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_service_redis(*args, **kwargs)
Create a DBaaS Redis service
- Parameters:
name (str)
maintenance (dict) – Automatic maintenance settings.
plan (str) – Subscription plan.
termination_protection (bool) – Service is protected against termination and powering off.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
migration (dict) – Migrate data from existing server.
redis_settings (dict) – Redis.conf settings.
fork_from_service (str) – Service to fork from.
recovery_backup_name (str) – Name of a backup to recover from for services that support backup names.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dbaas_task_migration_check(*args, **kwargs)
- Parameters:
service (str)
source_service_uri (str) – Service URI of the source MySQL or PostgreSQL database with admin credentials..
method (str) – The migration method to be used (currently supported only by Redis and MySQL service types). Must be one of
'dump'
,'replication'
.ignore_dbs (str) – Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment).
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_dns_domain(*args, **kwargs)
Create DNS domain
- Parameters:
unicode_name (str) – Domain name.
- Returns:
DNS domain. A dictionnary with the following keys:
id (str): DNS domain ID.
created_at (str): DNS domain creation date.
unicode_name (str): DNS domain unicode name.
- Return type:
dict
- create_dns_domain_record(*args, **kwargs)
Create DNS domain record
- Parameters:
domain_id (str)
name (str) – DNS domain record name.
type (str) – DNS domain record type. Must be one of
'A'
,'AAAA'
,'ALIAS'
,'CAA'
,'CNAME'
,'HINFO'
,'MX'
,'NAPTR'
,'NS'
,'POOL'
,'SPF'
,'SRV'
,'SSHFP'
,'TXT'
,'URL'
.content (str) – DNS domain record content.
ttl (int) – DNS domain record TTL.
priority (int) – DNS domain record priority.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_elastic_ip(*args, **kwargs)
Create an Elastic IP
- Parameters:
addressfamily (str) – Elastic IP address family (default: :inet4). Must be one of
'inet4'
,'inet6'
.description (str) – Elastic IP description.
healthcheck (dict) – Elastic IP healthcheck.
labels (dict) – Resource labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_iam_role(*args, **kwargs)
Create IAM Role
- Parameters:
name (str) – IAM Role name.
description (str) – IAM Role description.
permissions (list) – IAM Role permissions.
editable (bool) – Sets if the IAM Role Policy is editable or not (default: true). This setting cannot be changed after creation.
labels (dict) – IAM Role labels.
policy (dict) – IAM Role policy.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_instance(*args, **kwargs)
Create a Compute instance
- Parameters:
anti_affinity_groups (list) – Instance Anti-affinity Groups.
public_ip_assignment (str) – Assign public IP to the Instance. Must be one of
'dual'
,'inet4'
,'none'
.labels (dict) – Resource labels.
auto_start (bool) – Start Instance on creation (default: true).
security_groups (list) – Instance Security Groups.
name (str) – Instance name.
instance_type (dict) – Instance Type.
template (dict) – Instance Template.
ssh_key (dict) – Instance SSH Key.
user_data (str) – Instance Cloud-init user-data (base64 encoded).
deploy_target (dict) – Instance Deploy Target.
ipv6_enabled (bool) – Enable IPv6. DEPRECATED: use public-ip-assignments..
disk_size (int) – Instance disk size in GiB.
ssh_keys (list) – Instance SSH Keys.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_instance_pool(*args, **kwargs)
Create an Instance Pool
- Parameters:
anti_affinity_groups (list) – Instance Pool Anti-affinity Groups.
description (str) – Instance Pool description.
public_ip_assignment (str) – Determines public IP assignment of the Instances. Type none is final and can’t be changed later on.. Must be one of
'dual'
,'inet4'
,'none'
.labels (dict) – Instance Pool Labels.
security_groups (list) – Instance Pool Security Groups.
elastic_ips (list) – Instances Elastic IPs.
name (str) – Instance Pool name.
instance_type (dict) – Instances type.
min_available (int) – Minimum number of running Instances.
private_networks (list) – Instance Pool Private Networks.
template (dict) – Instances template.
size (int) – Number of Instances.
ssh_key (dict) – Instances SSH key.
instance_prefix (str) – Prefix to apply to Instances names (default: pool).
user_data (str) – Instances Cloud-init user-data.
deploy_target (dict) – Deploy Target to deploy Instances on.
ipv6_enabled (bool) – Enable IPv6. DEPRECATED: use public-ip-assignments..
disk_size (int) – Instances disk size in GiB.
ssh_keys (list) – Instances SSH Keys.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_load_balancer(*args, **kwargs)
Create a Load Balancer
- Parameters:
description (str) – Load Balancer description.
name (str) – Load Balancer name.
labels (dict) – Load balancer labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_private_network(*args, **kwargs)
Create a Private Network
- Parameters:
name (str) – Private Network name.
description (str) – Private Network description.
netmask (str) – Private Network netmask.
start_ip (str) – Private Network start IP address.
end_ip (str) – Private Network end IP address.
labels (dict) – Resource labels.
options (dict) – DHCP options.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_security_group(*args, **kwargs)
Create a Security Group
- Parameters:
name (str) – Security Group name.
description (str) – Security Group description.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_sks_cluster(*args, **kwargs)
Create an SKS cluster
- Parameters:
description (str) – Cluster description.
labels (dict) – Cluster Labels.
cni (str) – Cluster CNI. Must be one of
'calico'
,'cilium'
.auto_upgrade (bool) – Enable auto upgrade of the control plane to the latest patch version available.
oidc (dict) – Cluster OpenID configmap.
name (str) – Cluster name.
level (str) – Cluster service level. Must be one of
'pro'
,'starter'
.addons (list) – Cluster addons.
version (str) – Control plane Kubernetes version.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- create_sks_nodepool(*args, **kwargs)
Create a new SKS Nodepool
- Args:
id (str).
anti_affinity_groups (list): Nodepool Anti-affinity Groups.
description (str): Nodepool description.
public_ip_assignment (str): Configures public IP assignment of the Instances with:
IPv4 (inet4) addressing only (default);
both IPv4 and IPv6 (dual) addressing.. Must be one of
'dual'
,'inet4'
.labels (dict): Nodepool labels.
taints (dict): Nodepool taints.
security_groups (list): Nodepool Security Groups.
name (str): Nodepool name, lowercase only.
instance_type (dict): Nodepool instances type.
private_networks (list): Nodepool Private Networks.
size (int): Number of instances.
kubelet_image_gc (dict): Kubelet image GC options.
instance_prefix (str): Prefix to apply to instances names (default: pool), lowercase only.
deploy_target (dict): Nodepool Deploy Target.
addons (list): Nodepool addons.
disk_size (int): Nodepool instances disk size in GiB.
- Returns:
dict: Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- create_snapshot(*args, **kwargs)
Create a Snapshot of a Compute instance
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_anti_affinity_group(*args, **kwargs)
Delete an Anti-affinity Group
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_api_key(*args, **kwargs)
Delete an API key
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_block_storage_snapshot(*args, **kwargs)
Delete a block storage snapshot, data will be unrecoverable
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_block_storage_volume(*args, **kwargs)
Delete a block storage volume, data will be unrecoverable
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_external_endpoint_datadog(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_external_endpoint_elasticsearch(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_external_endpoint_opensearch(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_external_endpoint_prometheus(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_external_endpoint_rsyslog(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_integration(*args, **kwargs)
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_kafka_schema_registry_acl_config(*args, **kwargs)
Delete a Kafka ACL entry
- Parameters:
name (str)
acl_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_kafka_topic_acl_config(*args, **kwargs)
Delete a Kafka ACL entry
- Parameters:
name (str)
acl_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_kafka_user(*args, **kwargs)
Delete a DBaaS kafka user
- Parameters:
service_name (str)
username (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_mysql_database(*args, **kwargs)
Delete a DBaaS MySQL database
- Parameters:
service_name (str)
database_name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_mysql_user(*args, **kwargs)
Delete a DBaaS MySQL user
- Parameters:
service_name (str)
username (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_opensearch_user(*args, **kwargs)
Delete a DBaaS OpenSearch user
- Parameters:
service_name (str)
username (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_pg_connection_pool(*args, **kwargs)
Delete a DBaaS PostgreSQL connection pool
- Parameters:
service_name (str)
connection_pool_name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_pg_database(*args, **kwargs)
Delete a DBaaS Postgres database
- Parameters:
service_name (str)
database_name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_postgres_user(*args, **kwargs)
Delete a DBaaS Postgres user
- Parameters:
service_name (str)
username (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_redis_user(*args, **kwargs)
Delete a DBaaS Redis user
- Parameters:
service_name (str)
username (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service(*args, **kwargs)
Delete a DBaaS service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service_grafana(*args, **kwargs)
Delete a Grafana service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service_kafka(*args, **kwargs)
Delete a Kafka service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service_mysql(*args, **kwargs)
Delete a MySQL service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service_opensearch(*args, **kwargs)
Delete a OpenSearch service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service_pg(*args, **kwargs)
Delete a Postgres service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dbaas_service_redis(*args, **kwargs)
Delete a Redis service
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dns_domain(*args, **kwargs)
Delete DNS Domain
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_dns_domain_record(*args, **kwargs)
Delete DNS domain record
- Parameters:
domain_id (str)
record_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_elastic_ip(*args, **kwargs)
Delete an Elastic IP
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_iam_role(*args, **kwargs)
Delete IAM Role
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_instance(*args, **kwargs)
Delete a Compute instance
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_instance_pool(*args, **kwargs)
Delete an Instance Pool
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_load_balancer(*args, **kwargs)
Delete a Load Balancer
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_load_balancer_service(*args, **kwargs)
Delete a Load Balancer Service
- Parameters:
id (str)
service_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_private_network(*args, **kwargs)
Delete a Private Network
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_reverse_dns_elastic_ip(*args, **kwargs)
Delete the PTR DNS record for an elastic IP
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_reverse_dns_instance(*args, **kwargs)
Delete the PTR DNS record for an instance
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_rule_from_security_group(*args, **kwargs)
Delete a Security Group rule
- Parameters:
id (str)
rule_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_security_group(*args, **kwargs)
Delete a Security Group
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_sks_cluster(*args, **kwargs)
Delete an SKS cluster
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_sks_nodepool(*args, **kwargs)
Delete an SKS Nodepool
- Parameters:
id (str)
sks_nodepool_id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_snapshot(*args, **kwargs)
Delete a Snapshot
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_ssh_key(*args, **kwargs)
Delete a SSH key
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- delete_template(*args, **kwargs)
Delete a Template
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- detach_block_storage_volume(*args, **kwargs)
Detach block storage volume
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- detach_dbaas_service_from_endpoint(*args, **kwargs)
- Parameters:
source_service_name (str)
integration_id (str) – External Integration ID.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- detach_instance_from_elastic_ip(*args, **kwargs)
Detach a Compute instance from an Elastic IP
- Parameters:
id (str)
instance (dict) – Compute instance.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- detach_instance_from_private_network(*args, **kwargs)
Detach a Compute instance from a Private Network
- Parameters:
id (str)
instance (dict) – Compute instance.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- detach_instance_from_security_group(*args, **kwargs)
Detach a Compute instance from a Security Group
- Parameters:
id (str)
instance (dict) – Compute instance.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- enable_dbaas_mysql_writes(*args, **kwargs)
Temporarily enable writes for MySQL services in read-only mode due to filled up storage
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- evict_instance_pool_members(*args, **kwargs)
Evict Instance Pool members
- Parameters:
id (str)
instances (list)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- evict_sks_nodepool_members(*args, **kwargs)
Evict Nodepool members
- Parameters:
id (str)
sks_nodepool_id (str)
instances (list)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- export_snapshot(*args, **kwargs)
Export a Snapshot
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- generate_sks_cluster_kubeconfig(*args, **kwargs)
Generate a new Kubeconfig file for a SKS cluster
- Parameters:
id (str)
ttl (int) – Validity in seconds of the Kubeconfig user certificate (default: 30 days).
user (str) – User name in the generated Kubeconfig. The certificate present in the Kubeconfig will also have this name set for the CN field..
groups (list) – List of roles. The certificate present in the Kubeconfig will have these roles set in the Org field..
- Returns:
dict
- get_anti_affinity_group(*args, **kwargs)
Retrieve Anti-affinity Group details
- Parameters:
id (str)
- Returns:
Anti-affinity Group. A dictionnary with the following keys:
id (str): Anti-affinity Group ID.
name (str): Anti-affinity Group name.
description (str): Anti-affinity Group description.
instances (list): Anti-affinity Group instances.
- Return type:
dict
- get_api_key(*args, **kwargs)
Get API key
- Parameters:
id (str)
- Returns:
IAM API Key. A dictionnary with the following keys:
name (str): IAM API Key name.
key (str): IAM API Key.
role_id (str): IAM API Key Role ID.
- Return type:
dict
- get_block_storage_snapshot(*args, **kwargs)
Retrieve block storage snapshot details
- Parameters:
id (str)
- Returns:
Block storage snapshot. A dictionnary with the following keys:
id (str): Snapshot ID.
name (str): Snapshot name.
size (int): Snapshot size.
volume_size (int): Original Volume size.
created_at (str): Snapshot creation date.
state (str): Snapshot state. Values are
'allocated'
,'created'
,'creating'
,'destroyed'
,'destroying'
,'error'
,'partially-destroyed'
,'promoting'
.labels (dict): Resource labels.
block_storage_volume (dict): Referenced volume.
- Return type:
dict
- get_block_storage_volume(*args, **kwargs)
Retrieve block storage volume details
- Parameters:
id (str)
- Returns:
Block storage volume. A dictionnary with the following keys:
labels (dict): Resource labels.
instance (dict): Volume attached instance, if any.
name (str): Volume name.
state (str): Volume state. Values are
'attached'
,'attaching'
,'creating'
,'deleted'
,'deleting'
,'detached'
,'detaching'
,'error'
,'snapshotting'
.size (int): Volume size.
blocksize (int): Volume block size.
block_storage_snapshots (list): Volume snapshots, if any.
id (str): Volume ID.
created_at (str): Volume creation date.
- Return type:
dict
- get_console_proxy_url(*args, **kwargs)
Retrieve signed url valid for 60 seconds to connect via console-proxy websocket to VM VNC console.
- Parameters:
id (str)
- Returns:
dict
- get_dbaas_ca_certificate(*args, **kwargs)
Get DBaaS CA Certificate
Args:
- Returns:
dict
- get_dbaas_external_endpoint_datadog(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
dict
- get_dbaas_external_endpoint_elasticsearch(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
dict
- get_dbaas_external_endpoint_opensearch(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
dict
- get_dbaas_external_endpoint_prometheus(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
dict
- get_dbaas_external_endpoint_rsyslog(*args, **kwargs)
- Parameters:
endpoint_id (str)
- Returns:
dict
- get_dbaas_external_integration(*args, **kwargs)
- Parameters:
integration_id (str)
- Returns:
Integrations with other services. A dictionnary with the following keys:
description (str): Description of the integration.
dest_endpoint_name (str): External destination endpoint name.
dest_endpoint_id (str): External destination endpoint id.
integration_id (str): Endpoint integration UUID.
status (str): Integration status.
source_service_name (str): DBaaS source service name.
source_service_type (str): DBaaS service type.
type (str): Integration Type. Values are
'datadog'
,'elasticsearch'
,'opensearch'
,'prometheus'
,'rsyslog'
.
- Return type:
dict
- get_dbaas_external_integration_settings_datadog(*args, **kwargs)
- Parameters:
integration_id (str)
- Returns:
dict
- get_dbaas_integration(*args, **kwargs)
- Parameters:
id (str)
- Returns:
dict
- get_dbaas_kafka_acl_config(*args, **kwargs)
Get DBaaS kafka ACL configuration
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_migration_status(*args, **kwargs)
Get a DBaaS migration status
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_opensearch_acl_config(*args, **kwargs)
Get DBaaS OpenSearch ACL configuration
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_grafana(*args, **kwargs)
Get a DBaaS Grafana service
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_kafka(*args, **kwargs)
Get a DBaaS Kafka service
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_logs(*args, **kwargs)
Get logs of DBaaS service
- Parameters:
service_name (str)
limit (int) – How many log entries to receive at most, up to 500 (default: 100).
sort_order (str) – Sort order for log messages (default: desc). Must be one of
'asc'
,'desc'
.offset (str) – Opaque offset identifier.
- Returns:
dict
- get_dbaas_service_metrics(*args, **kwargs)
Get metrics of DBaaS service
- Parameters:
service_name (str)
period (str) – Metrics time period (default: hour). Must be one of
'day'
,'hour'
,'month'
,'week'
,'year'
.
- Returns:
dict
- get_dbaas_service_mysql(*args, **kwargs)
Get a DBaaS MySQL service
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_opensearch(*args, **kwargs)
Get a DBaaS OpenSearch service
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_pg(*args, **kwargs)
Get a DBaaS PostgreSQL service
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_redis(*args, **kwargs)
Get a DBaaS Redis service
- Parameters:
name (str)
- Returns:
dict
- get_dbaas_service_type(*args, **kwargs)
Get a DBaaS service type
- Parameters:
service_type_name (str)
- Returns:
DBaaS service. A dictionnary with the following keys:
name (str): DbaaS service name.
available_versions (list): DbaaS service available versions.
default_version (str): DbaaS service default version.
description (str): DbaaS service description.
plans (list): DbaaS service plans.
- Return type:
dict
- get_dbaas_settings_grafana(*args, **kwargs)
Get DBaaS Grafana settings
Args:
- Returns:
dict
- get_dbaas_settings_kafka(*args, **kwargs)
Get DBaaS Kafka settings
Args:
- Returns:
dict
- get_dbaas_settings_mysql(*args, **kwargs)
Get DBaaS MySQL settings
Args:
- Returns:
dict
- get_dbaas_settings_opensearch(*args, **kwargs)
Get DBaaS OpenSearch settings
Args:
- Returns:
dict
- get_dbaas_settings_pg(*args, **kwargs)
Get DBaaS PostgreSQL settings
Args:
- Returns:
dict
- get_dbaas_settings_redis(*args, **kwargs)
Get DBaaS Redis settings
Args:
- Returns:
dict
- get_dbaas_task(*args, **kwargs)
Get a DBaaS task
- Parameters:
service (str)
id (str)
- Returns:
dict
- get_deploy_target(*args, **kwargs)
Retrieve Deploy Target details
- Parameters:
id (str)
- Returns:
Deploy target. A dictionnary with the following keys:
id (str): Deploy Target ID.
name (str): Deploy Target name.
type (str): Deploy Target type. Values are
'dedicated'
,'edge'
.description (str): Deploy Target description.
- Return type:
dict
- get_dns_domain(*args, **kwargs)
Retrieve DNS domain details
- Parameters:
id (str)
- Returns:
DNS domain. A dictionnary with the following keys:
id (str): DNS domain ID.
created_at (str): DNS domain creation date.
unicode_name (str): DNS domain unicode name.
- Return type:
dict
- get_dns_domain_record(*args, **kwargs)
Retrieve DNS domain record details
- Parameters:
domain_id (str)
record_id (str)
- Returns:
DNS domain record. A dictionnary with the following keys:
id (str): DNS domain record ID.
priority (int): DNS domain record priority.
content (str): DNS domain record content.
type (str): DNS domain record type. Values are
'A'
,'AAAA'
,'ALIAS'
,'CAA'
,'CNAME'
,'HINFO'
,'MX'
,'NAPTR'
,'NS'
,'POOL'
,'SOA'
,'SPF'
,'SRV'
,'SSHFP'
,'TXT'
,'URL'
.ttl (int): DNS domain record TTL.
name (str): DNS domain record name.
created_at (str): DNS domain record creation date.
updated_at (str): DNS domain record update date.
- Return type:
dict
- get_dns_domain_zone_file(*args, **kwargs)
Retrieve DNS domain zone file
- Parameters:
id (str)
- Returns:
dict
- get_elastic_ip(*args, **kwargs)
Retrieve Elastic IP details
- Parameters:
id (str)
- Returns:
Elastic IP. A dictionnary with the following keys:
id (str): Elastic IP ID.
ip (str): Elastic IP address.
addressfamily (str): Elastic IP address family. Values are
'inet4'
,'inet6'
.cidr (str): Elastic IP cidr.
description (str): Elastic IP description.
healthcheck (dict): Elastic IP healthcheck.
labels (dict): Resource labels.
- Return type:
dict
- get_iam_organization_policy(*args, **kwargs)
Retrieve IAM Organization Policy
Args:
- Returns:
Policy. A dictionnary with the following keys:
default_service_strategy (str): IAM default service strategy. Values are
'allow'
,'deny'
.services (dict): IAM services.
- Return type:
dict
- get_iam_role(*args, **kwargs)
Retrieve IAM Role
- Parameters:
id (str)
- Returns:
IAM Role. A dictionnary with the following keys:
id (str): IAM Role ID.
name (str): IAM Role name.
description (str): IAM Role description.
permissions (list): IAM Role permissions.
labels (dict): IAM Role Labels.
editable (bool): IAM Role mutability.
policy (dict): IAM Role Policy.
- Return type:
dict
- get_instance(*args, **kwargs)
Retrieve Compute instance details
- Parameters:
id (str)
- Returns:
Instance. A dictionnary with the following keys:
anti_affinity_groups (list): Instance Anti-affinity Groups.
public_ip_assignment (str): Instance public IP assignment. Values are
'dual'
,'inet4'
,'none'
.labels (dict): Resource labels.
security_groups (list): Instance Security Groups.
elastic_ips (list): Instance Elastic IPs.
name (str): Instance name.
instance_type (dict): Instance Type.
private_networks (list): Instance Private Networks.
template (dict): Instance Template.
state (str): Instance state. Values are
'destroyed'
,'destroying'
,'error'
,'expunging'
,'migrating'
,'running'
,'starting'
,'stopped'
,'stopping'
.ssh_key (dict): Instance SSH Key.
user_data (str): Instance Cloud-init user-data (base64 encoded).
mac_address (str): Instance MAC address.
manager (dict): Instance manager.
deploy_target (dict): Instance Deploy Target.
ipv6_address (str): Instance IPv6 address.
id (str): Instance ID.
snapshots (list): Instance Snapshots.
disk_size (int): Instance disk size in GiB.
ssh_keys (list): Instance SSH Keys.
created_at (str): Instance creation date.
public_ip (str): Instance public IPv4 address.
- Return type:
dict
- get_instance_pool(*args, **kwargs)
Retrieve Instance Pool details
- Parameters:
id (str)
- Returns:
Instance Pool. A dictionnary with the following keys:
anti_affinity_groups (list): Instance Pool Anti-affinity Groups.
description (str): Instance Pool description.
public_ip_assignment (str): Instance Pool public IP assignment. Values are
'dual'
,'inet4'
,'none'
.labels (dict): Instance Pool Labels.
security_groups (list): Instance Pool Security Groups.
elastic_ips (list): Instances Elastic IPs.
name (str): Instance Pool name.
instance_type (dict): Instances type.
min_available (int): Minimum number of running instances.
private_networks (list): Instance Pool Private Networks.
template (dict): Instances template.
state (str): Instance Pool state. Values are
'creating'
,'destroying'
,'running'
,'scaling-down'
,'scaling-up'
,'suspended'
,'updating'
.size (int): Number of instances.
ssh_key (dict): Instances SSH key.
instance_prefix (str): The instances created by the Instance Pool will be prefixed with this value (default: pool).
user_data (str): Instances Cloud-init user-data.
manager (dict): Instance Pool manager.
instances (list): Instances.
deploy_target (dict): Instance Pool Deploy Target.
ipv6_enabled (bool): Enable IPv6 for instances.
id (str): Instance Pool ID.
disk_size (int): Instances disk size in GiB.
ssh_keys (list): Instances SSH keys.
- Return type:
dict
- get_instance_type(*args, **kwargs)
Retrieve Instance Type details
- Parameters:
id (str)
- Returns:
Compute instance type. A dictionnary with the following keys:
id (str): Instance type ID.
size (str): Instance type size. Values are
'colossus'
,'extra-large'
,'huge'
,'jumbo'
,'large'
,'medium'
,'mega'
,'micro'
,'small'
,'tiny'
,'titan'
.family (str): Instance type family. Values are
'colossus'
,'cpu'
,'gpu'
,'gpu2'
,'gpu3'
,'gpu3080ti'
,'gpua5000'
,'memory'
,'standard'
,'storage'
.cpus (int): CPU count.
gpus (int): GPU count.
authorized (bool): Requires authorization or publicly available.
memory (int): Available memory.
zones (list): Instance Type available zones.
- Return type:
dict
- get_load_balancer(*args, **kwargs)
Retrieve Load Balancer details
- Parameters:
id (str)
- Returns:
Load Balancer. A dictionnary with the following keys:
id (str): Load Balancer ID.
description (str): Load Balancer description.
name (str): Load Balancer name.
state (str): Load Balancer state. Values are
'creating'
,'deleting'
,'error'
,'migrated'
,'migrating'
,'running'
.created_at (str): Load Balancer creation date.
ip (str): Load Balancer public IP.
services (list): Load Balancer Services.
labels (dict): Load Balancer Labels.
- Return type:
dict
- get_load_balancer_service(*args, **kwargs)
Retrieve Load Balancer Service details
- Parameters:
id (str)
service_id (str)
- Returns:
Load Balancer Service. A dictionnary with the following keys:
description (str): Load Balancer Service description.
protocol (str): Network traffic protocol. Values are
'tcp'
,'udp'
.name (str): Load Balancer Service name.
state (str): Load Balancer Service state. Values are
'creating'
,'deleting'
,'error'
,'running'
,'updating'
.target_port (int): Port on which the network traffic will be forwarded to on the receiving instance.
port (int): Port exposed on the Load Balancer’s public IP.
instance_pool (dict): Instance Pool to forward network traffic to.
strategy (str): Load balancing strategy. Values are
'maglev-hash'
,'round-robin'
,'source-hash'
.healthcheck (dict): Healthcheck configuration.
id (str): Load Balancer Service ID.
healthcheck_status (list): Healthcheck status per backend server.
- Return type:
dict
- get_operation(*args, **kwargs)
Retrieve Operation details
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- get_organization(*args, **kwargs)
Retrieve an organization
Args:
- Returns:
Organization. A dictionnary with the following keys:
id (str): Organization ID.
name (str): Organization name.
address (str): Organization address.
postcode (str): Organization postcode.
city (str): Organization city.
country (str): Organization country.
balance (float): Organization balance.
currency (str): Organization currency.
- Return type:
dict
- get_private_network(*args, **kwargs)
Retrieve Private Network details
- Parameters:
id (str)
- Returns:
Private Network. A dictionnary with the following keys:
description (str): Private Network description.
labels (dict): Resource labels.
name (str): Private Network name.
start_ip (str): Private Network start IP address.
leases (list): Private Network leased IP addresses.
id (str): Private Network ID.
vni (int): Private Network VXLAN ID.
netmask (str): Private Network netmask.
options (dict): DHCP options.
end_ip (str): Private Network end IP address.
- Return type:
dict
- get_quota(*args, **kwargs)
Retrieve Resource Quota
- Parameters:
entity (str)
- Returns:
Organization Quota. A dictionnary with the following keys:
resource (str): Resource Name.
usage (int): Resource Usage.
limit (int): Resource Limit. -1 for Unlimited.
- Return type:
dict
- get_reverse_dns_elastic_ip(*args, **kwargs)
Query the PTR DNS records for an elastic IP
- Parameters:
id (str)
- Returns:
dict
- get_reverse_dns_instance(*args, **kwargs)
Query the PTR DNS records for an instance
- Parameters:
id (str)
- Returns:
dict
- get_security_group(*args, **kwargs)
Retrieve Security Group details
- Parameters:
id (str)
- Returns:
Security Group. A dictionnary with the following keys:
id (str): Security Group ID.
name (str): Security Group name.
description (str): Security Group description.
external_sources (list): Security Group external sources.
rules (list): Security Group rules.
- Return type:
dict
- get_sks_cluster(*args, **kwargs)
Retrieve SKS cluster details
- Parameters:
id (str)
- Returns:
SKS Cluster. A dictionnary with the following keys:
description (str): Cluster description.
labels (dict): Cluster labels.
cni (str): Cluster CNI. Values are
'calico'
,'cilium'
.auto_upgrade (bool): Enable auto upgrade of the control plane to the latest patch version available.
name (str): Cluster name.
state (str): Cluster state. Values are
'creating'
,'deleting'
,'error'
,'rotating-ccm-credentials'
,'running'
,'suspending'
,'updating'
,'upgrading'
.nodepools (list): Cluster Nodepools.
level (str): Cluster level. Values are
'pro'
,'starter'
.addons (list): Cluster addons.
id (str): Cluster ID.
version (str): Control plane Kubernetes version.
created_at (str): Cluster creation date.
endpoint (str): Cluster endpoint.
- Return type:
dict
- get_sks_cluster_authority_cert(*args, **kwargs)
Get the certificate for a SKS cluster authority
- Parameters:
id (str)
authority (str)
- Returns:
dict
- get_sks_cluster_inspection(*args, **kwargs)
Get the latest inspection result
- Parameters:
id (str)
- Returns:
dict
- get_sks_nodepool(*args, **kwargs)
Retrieve SKS Nodepool details
- Args:
id (str).
sks_nodepool_id (str).
- Returns:
dict: SKS Nodepool. A dictionnary with the following keys:
anti_affinity_groups (list): Nodepool Anti-affinity Groups.
description (str): Nodepool description.
public_ip_assignment (str): Nodepool public IP assignment of the Instances:
IPv4 (inet4) addressing only;
IPv4 and IPv6 (dual) addressing.. Values are
'dual'
,'inet4'
.labels (dict): Nodepool labels.
taints (dict): Nodepool taints.
security_groups (list): Nodepool Security Groups.
name (str): Nodepool name.
instance_type (dict): Nodepool Instances type.
private_networks (list): Nodepool Private Networks.
template (dict): Nodepool Instance template.
state (str): Nodepool state. Values are
'creating'
,'deleting'
,'error'
,'renewing-token'
,'running'
,'scaling'
,'updating'
.size (int): Number of instances.
kubelet_image_gc (dict): Kubelet image GC options.
instance_pool (dict): Instance Pool managed by the Nodepool.
instance_prefix (str): The instances created by the Nodepool will be prefixed with this value (default: pool).
deploy_target (dict): Instance Pool Deploy Target.
addons (list): Nodepool addons.
id (str): Nodepool ID.
disk_size (int): Nodepool instances disk size in GiB.
version (str): Nodepool version.
created_at (str): Nodepool creation date.
- get_snapshot(*args, **kwargs)
Retrieve Snapshot details
- Parameters:
id (str)
- Returns:
Snapshot. A dictionnary with the following keys:
id (str): Snapshot ID.
name (str): Snapshot name.
created_at (str): Snapshot creation date.
state (str): Snapshot state. Values are
'deleted'
,'deleting'
,'error'
,'exported'
,'exporting'
,'ready'
,'snapshotting'
.size (int): Snapshot size in GiB.
export (dict): Exported snapshot information.
instance (dict): Compute Instance snapshotted.
- Return type:
dict
- get_sos_presigned_url(*args, **kwargs)
Retrieve Presigned Download URL for SOS object
- Parameters:
bucket (str)
key (str)
- Returns:
dict
- get_ssh_key(*args, **kwargs)
Retrieve SSH key details
- Parameters:
name (str)
- Returns:
SSH key. A dictionnary with the following keys:
name (str): SSH key name.
fingerprint (str): SSH key fingerprint.
- Return type:
dict
- get_template(*args, **kwargs)
Retrieve Template details
- Parameters:
id (str)
- Returns:
Instance template. A dictionnary with the following keys:
maintainer (str): Template maintainer.
description (str): Template description.
ssh_key_enabled (bool): Enable SSH key-based login.
family (str): Template family.
name (str): Template name.
default_user (str): Template default user.
size (int): Template size.
password_enabled (bool): Enable password-based login.
build (str): Template build.
checksum (str): Template MD5 checksum.
boot_mode (str): Boot mode (default: legacy). Values are
'legacy'
,'uefi'
.id (str): Template ID.
zones (list): Zones availability.
url (str): Template source URL.
version (str): Template version.
created_at (str): Template creation date.
visibility (str): Template visibility. Values are
'private'
,'public'
.
- Return type:
dict
- list_anti_affinity_groups(*args, **kwargs)
List Anti-affinity Groups
Args:
- Returns:
dict
- list_api_keys(*args, **kwargs)
List API keys
Args:
- Returns:
dict
- list_block_storage_snapshots(*args, **kwargs)
List block storage snapshots
Args:
- Returns:
dict
- list_block_storage_volumes(*args, **kwargs)
List block storage volumes
- Parameters:
instance_id (str)
- Returns:
dict
- list_dbaas_external_endpoint_types(*args, **kwargs)
Args:
- Returns:
dict
- list_dbaas_external_endpoints(*args, **kwargs)
Args:
- Returns:
dict
- list_dbaas_external_integrations(*args, **kwargs)
- Parameters:
service_name (str)
- Returns:
dict
- list_dbaas_integration_settings(*args, **kwargs)
- Parameters:
integration_type (str)
source_type (str)
dest_type (str)
- Returns:
dict
- list_dbaas_integration_types(*args, **kwargs)
Args:
- Returns:
dict
- list_dbaas_service_types(*args, **kwargs)
DBaaS Service Types
Args:
- Returns:
dict
- list_dbaas_services(*args, **kwargs)
List DBaaS services
Args:
- Returns:
dict
- list_deploy_targets(*args, **kwargs)
List Deploy Targets
Args:
- Returns:
dict
- list_dns_domain_records(*args, **kwargs)
List DNS domain records
- Parameters:
domain_id (str)
- Returns:
dict
- list_dns_domains(*args, **kwargs)
List DNS domains
Args:
- Returns:
dict
- list_elastic_ips(*args, **kwargs)
List Elastic IPs
Args:
- Returns:
dict
- list_events(*args, **kwargs)
List Events
- Parameters:
from (str)
to (str)
- Returns:
list
- list_iam_roles(*args, **kwargs)
List IAM Roles
Args:
- Returns:
dict
- list_instance_pools(*args, **kwargs)
List Instance Pools
Args:
- Returns:
dict
- list_instance_types(*args, **kwargs)
List Compute instance Types
Args:
- Returns:
dict
- list_instances(*args, **kwargs)
List Compute instances
- Parameters:
manager_id (str)
manager_type (str)
ip_address (str)
- Returns:
dict
- list_load_balancers(*args, **kwargs)
List Load Balancers
Args:
- Returns:
dict
- list_private_networks(*args, **kwargs)
List Private Networks
Args:
- Returns:
dict
- list_quotas(*args, **kwargs)
List Organization Quotas
Args:
- Returns:
dict
- list_security_groups(*args, **kwargs)
List Security Groups.
- Parameters:
visibility (str)
- Returns:
dict
- list_sks_cluster_deprecated_resources(*args, **kwargs)
Resources that are scheduled to be removed in future kubernetes releases
- Parameters:
id (str)
- Returns:
list
- list_sks_cluster_versions(*args, **kwargs)
List available versions for SKS clusters
- Parameters:
include_deprecated (str)
- Returns:
dict
- list_sks_clusters(*args, **kwargs)
List SKS clusters
Args:
- Returns:
dict
- list_snapshots(*args, **kwargs)
List Snapshots
Args:
- Returns:
dict
- list_sos_buckets_usage(*args, **kwargs)
List SOS Buckets Usage
Args:
- Returns:
dict
- list_ssh_keys(*args, **kwargs)
List SSH keys
Args:
- Returns:
dict
- list_templates(*args, **kwargs)
List Templates
- Parameters:
visibility (str)
family (str)
- Returns:
dict
- list_zones(*args, **kwargs)
List Zones
Args:
- Returns:
dict
- promote_snapshot_to_template(*args, **kwargs)
Promote a Snapshot to a Template
- Parameters:
id (str)
name (str) – Template name.
description (str) – Template description.
default_user (str) – Template default user.
ssh_key_enabled (bool) – Enable SSH key-based login in the template.
password_enabled (bool) – Enable password-based login in the template.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reboot_instance(*args, **kwargs)
Reboot a Compute instance
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- register_ssh_key(*args, **kwargs)
Import SSH key
- Parameters:
name (str) – SSH key name.
public_key (str) – Public key value.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- register_template(*args, **kwargs)
Register a Template
- Parameters:
maintainer (str) – Template maintainer.
description (str) – Template description.
ssh_key_enabled (bool) – Enable SSH key-based login.
name (str) – Template name.
default_user (str) – Template default user.
size (int) – Template size.
password_enabled (bool) – Enable password-based login.
build (str) – Template build.
checksum (str) – Template MD5 checksum.
boot_mode (str) – Boot mode (default: legacy). Must be one of
'legacy'
,'uefi'
.url (str) – Template source URL.
version (str) – Template version.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- remove_external_source_from_security_group(*args, **kwargs)
Remove an external source from a Security Group
- Parameters:
id (str)
cidr (str) – CIDR-formatted network to remove.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- remove_instance_protection(*args, **kwargs)
Remove instance destruction protection
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_dbaas_grafana_user_password(*args, **kwargs)
Reset the credentials of a DBaaS Grafana user
- Parameters:
service_name (str)
username (str)
password (str) – New password.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_dbaas_kafka_user_password(*args, **kwargs)
Reset the credentials of a DBaaS Kafka user
- Parameters:
service_name (str)
username (str)
password (str) – New password.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_dbaas_mysql_user_password(*args, **kwargs)
Reset the credentials of a DBaaS mysql user
- Parameters:
service_name (str)
username (str)
password (str) – New password.
authentication (str) – Authentication method. Must be one of
'caching_sha2_password'
,'mysql_native_password'
.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_dbaas_opensearch_user_password(*args, **kwargs)
Reset the credentials of a DBaaS OpenSearch user
- Parameters:
service_name (str)
username (str)
password (str) – New password.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_dbaas_postgres_user_password(*args, **kwargs)
Reset the credentials of a DBaaS Postgres user
- Parameters:
service_name (str)
username (str)
password (str) – New password.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_dbaas_redis_user_password(*args, **kwargs)
Reset the credentials of a DBaaS Redis user
- Parameters:
service_name (str)
username (str)
password (str) – New password.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_elastic_ip_field(*args, **kwargs)
Reset an Elastic IP field to its default value
- Parameters:
id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_instance(*args, **kwargs)
Reset a Compute instance to a base/target template
- Parameters:
id (str)
template (dict) – Template to recreate Instance from.
disk_size (int) – Instance disk size in GiB.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_instance_field(*args, **kwargs)
Reset Instance field
- Parameters:
id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_instance_password(*args, **kwargs)
Reset a compute instance password
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_instance_pool_field(*args, **kwargs)
Reset an Instance Pool field to its default value
- Parameters:
id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_load_balancer_field(*args, **kwargs)
Reset a Load Balancer field to its default value
- Parameters:
id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_load_balancer_service_field(*args, **kwargs)
Reset a Load Balancer Service field to its default value
- Parameters:
id (str)
service_id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_private_network_field(*args, **kwargs)
Reset Private Network field
- Parameters:
id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_sks_cluster_field(*args, **kwargs)
Reset an SKS cluster field to its default value
- Parameters:
id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reset_sks_nodepool_field(*args, **kwargs)
Reset an SKS Nodepool field to its default value
- Parameters:
id (str)
sks_nodepool_id (str)
field (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- resize_block_storage_volume(*args, **kwargs)
Resize a block storage volume
- Parameters:
id (str)
size (int) – Volume size in GiB.
- Returns:
Block storage volume. A dictionnary with the following keys:
labels (dict): Resource labels.
instance (dict): Volume attached instance, if any.
name (str): Volume name.
state (str): Volume state. Values are
'attached'
,'attaching'
,'creating'
,'deleted'
,'deleting'
,'detached'
,'detaching'
,'error'
,'snapshotting'
.size (int): Volume size.
blocksize (int): Volume block size.
block_storage_snapshots (list): Volume snapshots, if any.
id (str): Volume ID.
created_at (str): Volume creation date.
- Return type:
dict
- resize_instance_disk(*args, **kwargs)
Resize a Compute instance disk
- Parameters:
id (str)
disk_size (int) – Instance disk size in GiB.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- reveal_dbaas_grafana_user_password(*args, **kwargs)
Reveal the secrets of a DBaaS Grafana user
- Parameters:
service_name (str)
username (str)
- Returns:
Grafana User secrets. A dictionnary with the following keys:
username (str): Grafana username.
password (str): Grafana password.
- Return type:
dict
- reveal_dbaas_kafka_connect_password(*args, **kwargs)
Reveal the secrets for DBaaS Kafka Connect
- Parameters:
service_name (str)
- Returns:
Kafka Connect secrets. A dictionnary with the following keys:
username (str): Kafka Connect username.
password (str): Kafka Connect password.
- Return type:
dict
- reveal_dbaas_kafka_user_password(*args, **kwargs)
Reveal the secrets of a DBaaS Kafka user
- Parameters:
service_name (str)
username (str)
- Returns:
Kafka User secrets. A dictionnary with the following keys:
username (str): Kafka username.
password (str): Kafka password.
access_cert (str): Kafka certificate.
access_cert_expiry (str).
access_key (str): Kafka access key.
- Return type:
dict
- reveal_dbaas_mysql_user_password(*args, **kwargs)
Reveal the secrets of a DBaaS MySQL user
- Parameters:
service_name (str)
username (str)
- Returns:
MySQL User secrets. A dictionnary with the following keys:
username (str): MySQL username.
password (str): MySQL password.
- Return type:
dict
- reveal_dbaas_opensearch_user_password(*args, **kwargs)
Reveal the secrets of a DBaaS OpenSearch user
- Parameters:
service_name (str)
username (str)
- Returns:
Opensearch User secrets. A dictionnary with the following keys:
username (str): Opensearch username.
password (str): Opensearch password.
- Return type:
dict
- reveal_dbaas_postgres_user_password(*args, **kwargs)
Reveal the secrets of a DBaaS Postgres user
- Parameters:
service_name (str)
username (str)
- Returns:
Postgres User secrets. A dictionnary with the following keys:
username (str): Postgres username.
password (str): Postgres password.
- Return type:
dict
- reveal_dbaas_redis_user_password(*args, **kwargs)
Reveal the secrets of a DBaaS Redis user
- Parameters:
service_name (str)
username (str)
- Returns:
Redis User secrets. A dictionnary with the following keys:
username (str): Redis username.
password (str): Redis password.
- Return type:
dict
- reveal_instance_password(*args, **kwargs)
Reveal the password used during instance creation or the latest password reset.
- Parameters:
id (str)
- Returns:
Instance password. A dictionnary with the following keys:
password (str): Password.
- Return type:
dict
- revert_instance_to_snapshot(*args, **kwargs)
Revert a snapshot for an instance
- Parameters:
instance_id (str)
id (str) – Snapshot ID.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- rotate_sks_ccm_credentials(*args, **kwargs)
Rotate Exoscale CCM credentials
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- rotate_sks_operators_ca(*args, **kwargs)
Rotate operators certificate authority
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- scale_instance(*args, **kwargs)
Scale a Compute instance to a new Instance Type
- Parameters:
id (str)
instance_type (dict) – Instance Type.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- scale_instance_pool(*args, **kwargs)
Scale an Instance Pool
- Parameters:
id (str)
size (int) – Number of managed Instances.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- scale_sks_nodepool(*args, **kwargs)
Scale a SKS Nodepool
- Parameters:
id (str)
sks_nodepool_id (str)
size (int) – Number of instances.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_dbaas_grafana_maintenance(*args, **kwargs)
Initiate Grafana maintenance update
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_dbaas_kafka_maintenance(*args, **kwargs)
Initiate Kafka maintenance update
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_dbaas_mysql_maintenance(*args, **kwargs)
Initiate MySQL maintenance update
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_dbaas_opensearch_maintenance(*args, **kwargs)
Initiate OpenSearch maintenance update
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_dbaas_pg_maintenance(*args, **kwargs)
Initiate PostgreSQL maintenance update
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_dbaas_redis_maintenance(*args, **kwargs)
Initiate Redis maintenance update
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- start_instance(*args, **kwargs)
Start a Compute instance
- Parameters:
id (str)
rescue_profile (str) – Boot in Rescue Mode, using named profile (supported: netboot, netboot-efi). Must be one of
'netboot'
,'netboot-efi'
.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- stop_dbaas_mysql_migration(*args, **kwargs)
Stop a DBaaS MySQL migration
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- stop_dbaas_pg_migration(*args, **kwargs)
Stop a DBaaS PostgreSQL migration
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- stop_dbaas_redis_migration(*args, **kwargs)
Stop a DBaaS Redis migration
- Parameters:
name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- stop_instance(*args, **kwargs)
Stop a Compute instance
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_block_storage_snapshot(*args, **kwargs)
Update block storage volume snapshot
- Parameters:
id (str)
name (str) – Snapshot name.
labels (dict) – Resource labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_block_storage_volume(*args, **kwargs)
Update block storage volume
- Parameters:
id (str)
name (str) – Volume name.
labels (dict) – Resource labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_external_endpoint_datadog(*args, **kwargs)
- Parameters:
endpoint_id (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_external_endpoint_elasticsearch(*args, **kwargs)
- Parameters:
endpoint_id (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_external_endpoint_opensearch(*args, **kwargs)
- Parameters:
endpoint_id (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_external_endpoint_prometheus(*args, **kwargs)
- Parameters:
endpoint_id (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_external_endpoint_rsyslog(*args, **kwargs)
- Parameters:
endpoint_id (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_external_integration_settings_datadog(*args, **kwargs)
- Parameters:
integration_id (str)
settings (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_integration(*args, **kwargs)
- Parameters:
id (str)
settings (dict) – Integration settings.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_opensearch_acl_config(*args, **kwargs)
Create a DBaaS OpenSearch ACL configuration
- Parameters:
name (str)
acls (list) – List of OpenSearch ACLs.
acl_enabled (bool) – Enable OpenSearch ACLs. When disabled authenticated service users have unrestricted access..
extended_acl_enabled (bool) – Enable to enforce index rules in a limited fashion for requests that use the _mget, _msearch, and _bulk APIs.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_pg_connection_pool(*args, **kwargs)
Update a DBaaS PostgreSQL connection pool
- Parameters:
service_name (str)
connection_pool_name (str)
database_name (str) – Service database name.
mode (str) – PGBouncer pool mode. Must be one of
'session'
,'statement'
,'transaction'
.size (int) – Size of PGBouncer’s PostgreSQL side connection pool.
username (str) – Pool username.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_postgres_allow_replication(*args, **kwargs)
Update access control for one service user
- Parameters:
service_name (str)
username (str)
allow_replication (bool)
- Returns:
dict
- update_dbaas_service_grafana(*args, **kwargs)
Update a DBaaS Grafana service
- Parameters:
name (str)
maintenance (dict) – Automatic maintenance settings.
plan (str) – Subscription plan.
termination_protection (bool) – Service is protected against termination and powering off.
grafana_settings (dict) – Grafana specific settings.
ip_filter (list) – Allowed CIDR address blocks for incoming connections.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_service_kafka(*args, **kwargs)
Update a DBaaS Kafka service
- Parameters:
name (str)
authentication_methods (dict) – Kafka authentication methods.
kafka_rest_enabled (bool) – Enable Kafka-REST service.
kafka_connect_enabled (bool) – Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
schema_registry_settings (dict) – Schema Registry configuration.
kafka_rest_settings (dict) – Kafka REST configuration.
termination_protection (bool) – Service is protected against termination and powering off.
kafka_connect_settings (dict) – Kafka Connect configuration values.
maintenance (dict) – Automatic maintenance settings.
kafka_settings (dict) – Kafka-specific settings.
schema_registry_enabled (bool) – Enable Schema-Registry service.
version (str) – Kafka major version.
plan (str) – Subscription plan.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_service_mysql(*args, **kwargs)
Update a DBaaS MySQL service
- Parameters:
name (str)
maintenance (dict) – Automatic maintenance settings.
plan (str) – Subscription plan.
termination_protection (bool) – Service is protected against termination and powering off.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
mysql_settings (dict) – MySQL-specific settings.
migration (dict) – Migrate data from existing server.
binlog_retention_period (int) – The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default for example if using the MySQL Debezium Kafka connector..
backup_schedule (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_service_opensearch(*args, **kwargs)
Update a DBaaS OpenSearch service
- Parameters:
name (str)
max_index_count (int) – Maximum number of indexes to keep before deleting the oldest one.
keep_index_refresh_interval (bool) – Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn’t fit your case, you can disable this by setting up this flag to true..
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
termination_protection (bool) – Service is protected against termination and powering off.
index_patterns (list) – Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like ‘logs.?’ and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note ‘logs.?’ does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored..
maintenance (dict) – Automatic maintenance settings.
index_template (dict) – Template settings for all new indexes.
opensearch_settings (dict) – OpenSearch-specific settings.
version (str) – Version.
plan (str) – Subscription plan.
opensearch_dashboards (dict) – OpenSearch Dashboards settings.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_service_pg(*args, **kwargs)
Update a DBaaS PostgreSQL service
- Parameters:
name (str)
pgbouncer_settings (dict) – PGBouncer connection pooling settings.
backup_schedule (dict)
variant (str) – Variant of the PostgreSQL service, may affect the features that are exposed by default. Must be one of
'aiven'
,'timescale'
.timescaledb_settings (dict) – TimescaleDB extension configuration values.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
termination_protection (bool) – Service is protected against termination and powering off.
synchronous_replication (str) – Synchronous replication type. Note that the service plan also needs to support synchronous replication.. Must be one of
'off'
,'quorum'
.pglookout_settings (dict) – PGLookout settings.
maintenance (dict) – Automatic maintenance settings.
version (str) – Version.
plan (str) – Subscription plan.
work_mem (int) – Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. Default is 1MB + 0.075% of total RAM (up to 32MB)..
shared_buffers_percentage (int) – Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value..
pg_settings (dict) – PostgreSQL-specific settings.
migration (dict) – Migrate data from existing server.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dbaas_service_redis(*args, **kwargs)
Update a DBaaS Redis service
- Parameters:
name (str)
maintenance (dict) – Automatic maintenance settings.
plan (str) – Subscription plan.
termination_protection (bool) – Service is protected against termination and powering off.
ip_filter (list) – Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’.
migration (dict) – Migrate data from existing server.
redis_settings (dict) – Redis.conf settings.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_dns_domain_record(*args, **kwargs)
Update DNS domain record
- Parameters:
domain_id (str)
record_id (str)
name (str) – DNS domain record name.
content (str) – DNS domain record content.
ttl (int) – DNS domain record TTL.
priority (int) – DNS domain record priority.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_elastic_ip(*args, **kwargs)
Update an Elastic IP
- Parameters:
id (str)
description (str) – Elastic IP description.
healthcheck (dict) – Elastic IP healthcheck.
labels (dict) – Resource labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_iam_organization_policy(*args, **kwargs)
Update IAM Organization Policy
- Parameters:
default_service_strategy (str) – IAM default service strategy. Must be one of
'allow'
,'deny'
.services (dict) – IAM services.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_iam_role(*args, **kwargs)
Update IAM Role
- Parameters:
id (str)
description (str) – IAM Role description.
permissions (list) – IAM Role permissions.
labels (dict) – IAM Role labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_iam_role_policy(*args, **kwargs)
Update IAM Role Policy
- Parameters:
id (str)
default_service_strategy (str) – IAM default service strategy. Must be one of
'allow'
,'deny'
.services (dict) – IAM services.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_instance(*args, **kwargs)
Update a Compute instance
- Parameters:
id (str)
name (str) – Instance name.
user_data (str) – Instance Cloud-init user-data (base64 encoded).
public_ip_assignment (str) – Assign public IP to the Instance. Must be one of
'dual'
,'inet4'
,'none'
.labels (dict) – Resource labels.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_instance_pool(*args, **kwargs)
Update an Instance Pool
- Parameters:
id (str)
anti_affinity_groups (list) – Instance Pool Anti-affinity Groups.
description (str) – Instance Pool description.
public_ip_assignment (str) – Determines public IP assignment of the Instances.. Must be one of
'dual'
,'inet4'
.labels (dict) – Instance Pool Labels.
security_groups (list) – Instance Pool Security Groups.
elastic_ips (list) – Instances Elastic IPs.
name (str) – Instance Pool name.
instance_type (dict) – Instances type.
min_available (int) – Minimum number of running Instances.
private_networks (list) – Instance Pool Private Networks.
template (dict) – Instances template.
ssh_key (dict) – Instances SSH key.
instance_prefix (str) – Prefix to apply to Instances names (default: pool).
user_data (str) – Instances Cloud-init user-data.
deploy_target (dict) – Instance Pool Deploy Target.
ipv6_enabled (bool) – Enable IPv6. DEPRECATED: use public-ip-assignments..
disk_size (int) – Instances disk size in GiB.
ssh_keys (list) – Instances SSH keys.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_load_balancer(*args, **kwargs)
Update a Load Balancer
- Parameters:
id (str)
name (str) – Load Balancer name.
description (str) – Load Balancer description.
labels (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_load_balancer_service(*args, **kwargs)
Update a Load Balancer Service
- Parameters:
id (str)
service_id (str)
name (str) – Load Balancer Service name.
description (str) – Load Balancer Service description.
protocol (str) – Network traffic protocol. Must be one of
'tcp'
,'udp'
.strategy (str) – Load balancing strategy. Must be one of
'maglev-hash'
,'round-robin'
,'source-hash'
.port (int) – Port exposed on the Load Balancer’s public IP.
target_port (int) – Port on which the network traffic will be forwarded to on the receiving instance.
healthcheck (dict) – Healthcheck configuration.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_private_network(*args, **kwargs)
Update a Private Network
- Parameters:
id (str)
name (str) – Private Network name.
description (str) – Private Network description.
netmask (str) – Private Network netmask.
start_ip (str) – Private Network start IP address.
end_ip (str) – Private Network end IP address.
labels (dict) – Resource labels.
options (dict) – DHCP options.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_private_network_instance_ip(*args, **kwargs)
Update the IP address of an instance attached to a managed private network
- Parameters:
id (str)
ip (str) – Static IP address lease for the corresponding network interface.
instance (dict)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_reverse_dns_elastic_ip(*args, **kwargs)
Update/Create the PTR DNS record for an elastic IP
- Parameters:
id (str)
domain_name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_reverse_dns_instance(*args, **kwargs)
Update/Create the PTR DNS record for an instance
- Parameters:
id (str)
domain_name (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_sks_cluster(*args, **kwargs)
Update an SKS cluster
- Parameters:
id (str)
name (str) – Cluster name.
description (str) – Cluster description.
labels (dict) – Cluster labels.
oidc (dict) – Cluster OpenID configmap.
auto_upgrade (bool) – Enable auto upgrade of the control plane to the latest patch version available.
addons (list) – Cluster addons.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- update_sks_nodepool(*args, **kwargs)
Update an SKS Nodepool
- Args:
id (str).
sks_nodepool_id (str).
anti_affinity_groups (list): Nodepool Anti-affinity Groups.
description (str): Nodepool description.
public_ip_assignment (str): Configures public IP assignment of the Instances with:
IPv4 (inet4) addressing only;
both IPv4 and IPv6 (dual) addressing.. Must be one of
'dual'
,'inet4'
.labels (dict): Nodepool labels.
taints (dict): Nodepool taints.
security_groups (list): Nodepool Security Groups.
name (str): Nodepool name, lowercase only.
instance_type (dict): Nodepool instances type.
private_networks (list): Nodepool Private Networks.
instance_prefix (str): Prefix to apply to managed instances names (default: pool), lowercase only.
deploy_target (dict): Nodepool Deploy Target.
disk_size (int): Nodepool instances disk size in GiB.
- Returns:
dict: Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- update_template(*args, **kwargs)
Update template attributes
- Parameters:
id (str)
name (str) – Template name.
description (str) – Template Description.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- upgrade_sks_cluster(*args, **kwargs)
Upgrade an SKS cluster
- Parameters:
id (str)
version (str) – Control plane Kubernetes version.
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- upgrade_sks_cluster_service_level(*args, **kwargs)
Upgrade a SKS cluster to pro
- Parameters:
id (str)
- Returns:
Operation. A dictionnary with the following keys:
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.
- Return type:
dict
- wait(operation_id: str, max_wait_time: int | None = None)
Wait for completion of an asynchronous operation.
- Parameters:
operation_id (str)
max_wait_time (int) – When set, stop waiting after this time in seconds. Defaults to
None
, which waits until operation completion.
- Returns:
Operation. A dictionnary with the following keys:
- Return type:
dict
id (str): Operation ID.
reason (str): Operation failure reason. Values are
'busy'
,'conflict'
,'fault'
,'forbidden'
,'incorrect'
,'interrupted'
,'not-found'
,'partial'
,'unavailable'
,'unknown'
,'unsupported'
.reference (dict): Related resource reference.
message (str): Operation message.
state (str): Operation status. Values are
'failure'
,'pending'
,'success'
,'timeout'
.