request-summarized
¶
Description¶
List Java Runtime usage in a specified Fleet filtered by form parameters.
Usage¶
oci jms jre-usage request-summarized [OPTIONS]
Required Parameters¶
-
--fleet-id
[text]
¶
The OCID of the Fleet.
Optional Parameters¶
-
--application-id
[text]
¶
The ID of the related application.
-
--fields
[complex type]
¶
Additional fields to include into the returned model on top of the required ones. This parameter can also include ‘approximateApplicationCount’, ‘approximateInstallationCount’ and ‘approximateManagedInstanceCount’. For example ‘approximateApplicationCount,approximateManagedInstanceCount’.
This option is a JSON list with items of type SummarizeJreUsageFields. For documentation on SummarizeJreUsageFields please see our API reference: https://docs.cloud.oracle.com/api/#/en/javamanagementservice/20210610/datatypes/SummarizeJreUsageFields. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.
The --generate-param-json-input
option can be used to generate an example of the JSON which must be provided. We recommend storing this example
in a file, modifying it as needed and then passing it back in via the file:// syntax.
-
--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
-
--jre-distribution
[text]
¶
The distribution of the Java Runtime.
-
--jre-vendor
[text]
¶
The vendor of the Java Runtime.
-
--jre-version
[text]
¶
The version of the Java Runtime.
-
--limit
[integer]
¶
The maximum number of items to return.
-
--managed-instance-id
[text]
¶
The OCID of the related managed instance.
-
--page
[text]
¶
The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous list call.
-
--sort-by
[text]
¶
The field to sort Java Runtime views. Only one sort order may be provided. Default order for _timeFirstSeen_, _timeLastSeen_, _version_, _approximateInstallationCount_, _approximateApplicationCount_ and _approximateManagedInstanceCount_ is descending. Default order for _distribution_ and _vendor_ is ascending. If no value is specified _timeLastSeen_ is default.
Accepted values are:
approximateApplicationCount, approximateInstallationCount, approximateManagedInstanceCount, distribution, timeFirstSeen, timeLastSeen, vendor, version
-
--sort-order
[text]
¶
The sort order to use, either ‘asc’ or ‘desc’.
Accepted values are:
ASC, DESC
-
--time-end
[datetime]
¶
The end of the time period during which resources are searched (formatted according to RFC3339). Defaults to current time.
The following datetime formats are supported:
Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00ZFormat: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm" Example: '2017-09-15 17:25'This date will be taken as midnight UTC of that day
Format: YYYY-MM-DD Example: 2017-09-15Example: 1412195400
-
--time-start
[datetime]
¶
The start of the time period during which resources are searched (formatted according to RFC3339). Defaults to current time minus seven days.
The following datetime formats are supported:
Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00ZFormat: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)
Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm" Example: '2017-09-15 17:25'This date will be taken as midnight UTC of that day
Format: YYYY-MM-DD Example: 2017-09-15Example: 1412195400
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-rc-file
, --config-file
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --max-retries
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --query
, --raw-output
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -v
Examples¶
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/jms/fleet/create.html#cmdoption-compartment-id
export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/jms/fleet/create.html#cmdoption-display-name
fleet_id=$(oci jms fleet create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
oci jms jre-usage request-summarized --fleet-id $fleet_id