ReplicasClient¶

class oci.mysql.ReplicasClient(config, **kwargs)¶

The API for the MySQL Database Service

Methods

`__init__`(config, **kwargs)	Creates a new service client
`create_replica`(create_replica_details, **kwargs)	Creates a DB System read replica.
`delete_replica`(replica_id, **kwargs)	Deletes the specified read replica.
`get_replica`(replica_id, **kwargs)	Gets the full details of the specified read replica.
`list_replicas`(compartment_id, **kwargs)	Lists all the read replicas that match the specified filters.
`update_replica`(replica_id, …)	Updates the properties of the specified read replica.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

create_replica(create_replica_details, **kwargs)¶

Creates a DB System read replica.

Parameters:	create_replica_details (oci.mysql.models.CreateReplicaDetails) – (required) The parameters of the request to create the read replica. opc_request_id (str) – (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Replica`
Return type:	`Response`
Example:

Click here to see an example of how to use create_replica API.

delete_replica(replica_id, **kwargs)¶

Deletes the specified read replica.

Parameters:	replica_id (str) – (required) The Replica OCID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the If-Match header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_replica API.

get_replica(replica_id, **kwargs)¶

Gets the full details of the specified read replica.

Parameters:	replica_id (str) – (required) The Replica OCID. opc_request_id (str) – (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. if_none_match (str) – (optional) For conditional requests. In the GET call for a resource, set the If-None-Match header to the value of the ETag from a previous GET (or POST or PUT) response for that resource. The server will return with either a 304 Not Modified response if the resource has not changed, or a 200 OK response with the updated representation. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Replica`
Return type:	`Response`
Example:

Click here to see an example of how to use get_replica API.

list_replicas(compartment_id, **kwargs)¶

Lists all the read replicas that match the specified filters.

Parameters:	compartment_id (str) – (required) The compartment OCID. opc_request_id (str) – (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. limit (int) – (optional) The maximum number of items to return in a paginated list call. For information about pagination, see List Pagination. page (str) – (optional) The value of the opc-next-page or opc-prev-page response header from the previous list call. For information about pagination, see List Pagination. display_name (str) – (optional) A filter to return only the resource matching the given display name exactly. db_system_id (str) – (optional) The DB System OCID. lifecycle_state (str) – (optional) The LifecycleState of the read replica. Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “FAILED” replica_id (str) – (optional) The read replica OCID. configuration_id (str) – (optional) The requested Configuration instance. is_up_to_date (bool) – (optional) Filter instances if they are using the latest revision of the Configuration they are associated with. sort_by (str) – (optional) The field to sort by. You can sort by one field only. By default, the Time field is sorted in descending order and the Display Name field in ascending order. Allowed values are: “timeCreated”, “displayName” sort_order (str) – (optional) The sort order to use (ASC or DESC). Allowed values are: “ASC”, “DESC” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `ReplicaSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_replicas API.

update_replica(replica_id, update_replica_details, **kwargs)¶

Updates the properties of the specified read replica.

Parameters:	replica_id (str) – (required) The Replica OCID. update_replica_details (oci.mysql.models.UpdateReplicaDetails) – (required) The parameters of the request to update the read replica. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the If-Match header to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Customer-defined unique identifier for the request. If you need to contact Oracle about a specific request, please provide the request ID that you supplied in this header with the request. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_replica API.