Database Management Managed MySql Databases Functions

Package: DBMS_CLOUD_OCI_DM_MANAGED_MY_SQL_DATABASES

GET_MANAGED_MY_SQL_DATABASE Function

Retrieves the general information for a specific MySQL Database.

Syntax

FUNCTION get_managed_my_sql_database (
  managed_my_sql_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_managed_my_sql_databases_get_managed_my_sql_database_response_t;

Parameters

Parameter	Description
`managed_my_sql_database_id`	(required) The OCID of the Managed MySQL Database.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_MY_SQL_FLEET_METRIC Function

Gets the health metrics for a fleet of MySQL Databases in a compartment.

Syntax

FUNCTION get_my_sql_fleet_metric (
  compartment_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  filter_by_metric_names varchar2 DEFAULT NULL,
  filter_by_my_sql_deployment_type_param varchar2 DEFAULT NULL,
  filter_by_mds_deployment_type varchar2 DEFAULT NULL,
  filter_by_my_sql_status varchar2 DEFAULT NULL,
  filter_by_my_sql_database_version varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_managed_my_sql_databases_get_my_sql_fleet_metric_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`filter_by_metric_names`	(optional) The filter used to retrieve a specific set of metrics by passing the desired metric names with a comma separator. Note that, by default, the service returns all supported metrics.
`filter_by_my_sql_deployment_type_param`	(optional) The parameter to filter by MySQL deployment type. Allowed values are: 'ONPREMISE', 'MDS'
`filter_by_mds_deployment_type`	(optional) The parameter to filter by MySQL Database System type. Allowed values are: 'HA', 'HEATWAVE', 'STANDALONE'
`filter_by_my_sql_status`	(optional) The parameter to filter by MySQL Database status. Allowed values are: 'UP', 'DOWN', 'UNKNOWN'
`filter_by_my_sql_database_version`	(optional) The parameter to filter by MySQL database version.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MANAGED_MY_SQL_DATABASE_CONFIGURATION_DATA Function

Retrieves configuration data for a specific MySQL database.

Syntax

FUNCTION list_managed_my_sql_database_configuration_data (
  managed_my_sql_database_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_managed_my_sql_databases_list_managed_my_sql_database_configuration_data_response_t;

Parameters

Parameter	Description
`managed_my_sql_database_id`	(required) The OCID of the Managed MySQL Database.
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Descending order is the default order. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MANAGED_MY_SQL_DATABASE_SQL_DATA Function

Retrieves the SQL performance data for a specific MySQL database.

Syntax

FUNCTION list_managed_my_sql_database_sql_data (
  managed_my_sql_database_id varchar2,
  start_time varchar2,
  end_time varchar2,
  filter_column varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_managed_my_sql_databases_list_managed_my_sql_database_sql_data_response_t;

Parameters

Parameter	Description
`managed_my_sql_database_id`	(required) The OCID of the Managed MySQL Database.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`filter_column`	(optional) The parameter to filter results by key criteria which include : - SUM_TIMER_WAIT - COUNT_STAR - SUM_ERRORS - SUM_ROWS_AFFECTED - SUM_ROWS_SENT - SUM_ROWS_EXAMINED - SUM_CREATED_TMP_TABLES - SUM_NO_INDEX_USED - SUM_NO_GOOD_INDEX_USED - FIRST_SEEN - LAST_SEEN
`opc_request_id`	(optional) The client request ID for tracing.
`limit`	(optional) The maximum number of records returned in the paginated response.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_MANAGED_MY_SQL_DATABASES Function

Gets the list of Managed MySQL Databases in a specific compartment.

Syntax

FUNCTION list_managed_my_sql_databases (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_managed_my_sql_databases_list_managed_my_sql_databases_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`sort_by`	(optional) The field to sort information by. Only one sortOrder can be used. The default sort order for ‘TIMECREATED’ is descending and the default sort order for ‘NAME’ is ascending. The ‘NAME’ sort order is case-sensitive. Allowed values are: 'TIMECREATED', 'NAME'
`sort_order`	(optional) The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_MANAGED_MY_SQL_DATABASE_AVAILABILITY_METRICS Function

Gets the availability metrics for the MySQL Database specified by managedMySqlDatabaseId.

Syntax

FUNCTION summarize_managed_my_sql_database_availability_metrics (
  managed_my_sql_database_id varchar2,
  start_time varchar2,
  end_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dm_managed_my_sql_databases_summarize_managed_my_sql_database_availability_metrics_response_t;

Parameters

Parameter	Description
`managed_my_sql_database_id`	(required) The OCID of the Managed MySQL Database.
`start_time`	(required) The start time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`end_time`	(required) The end time of the time range to retrieve the health metrics of a Managed Database in UTC in ISO-8601 format, which is \"yyyy-MM-dd'T'hh:mm:ss.sss'Z'\".
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page from where the next set of paginated results are retrieved. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of records returned in the paginated response.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://dbmgmt.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

GET_MANAGED_MY_SQL_DATABASE Function

GET_MY_SQL_FLEET_METRIC Function

LIST_MANAGED_MY_SQL_DATABASE_CONFIGURATION_DATA Function

LIST_MANAGED_MY_SQL_DATABASE_SQL_DATA Function

LIST_MANAGED_MY_SQL_DATABASES Function

SUMMARIZE_MANAGED_MY_SQL_DATABASE_AVAILABILITY_METRICS Function