summarize-external-db-system-availability-metrics

Description

Gets availability metrics for the components present in the external DB system specified by externalDbSystemId.

Usage

oci database-management external-db-system summarize-external-db-system-availability-metrics [OPTIONS]

Required Parameters

--end-time [text]

The end of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’.

--external-db-system-id [text]

The OCID of the external DB system.

--start-time [text]

The beginning of the time range set to retrieve metric data for the DB system and its members. Expressed in UTC in ISO-8601 format, which is yyyy-MM-dd’T’hh:mm:ss.sss’Z’.

Optional Parameters

--filter-by-component-types [text]

The filter used to retrieve metrics for a specific set of component types by passing the desired component types separated by a comma. Note that, by default, the service returns metrics for all DB system component types.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--limit [integer]

The maximum number of records returned in the paginated response.

--page [text]

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.

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/external-db-system/create.html#cmdoption-compartment-id
    export db_system_discovery_id=<substitute-value-of-db_system_discovery_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/external-db-system/create.html#cmdoption-db-system-discovery-id
    export end_time=<substitute-value-of-end_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/external-db-system/summarize-external-db-system-availability-metrics.html#cmdoption-end-time
    export start_time=<substitute-value-of-start_time> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/external-db-system/summarize-external-db-system-availability-metrics.html#cmdoption-start-time

    external_db_system_id=$(oci database-management external-db-system create --compartment-id $compartment_id --db-system-discovery-id $db_system_discovery_id --query data.id --raw-output)

    oci database-management external-db-system summarize-external-db-system-availability-metrics --end-time $end_time --external-db-system-id $external_db_system_id --start-time $start_time