get

Description

Get the specified retention rule.

Usage

oci os retention-rule get [OPTIONS]

Required Parameters

--bucket-name, --bucket, -bn [text]

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

--retention-rule-id [text]

The ID of the retention rule.

Optional Parameters

--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

--namespace-name, --namespace, -ns [text]

The Object Storage namespace used for the request. If not provided, this parameter will be obtained internally using a call to ‘oci os ns get’

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 bucket_name=<substitute-value-of-bucket_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/os/retention-rule/create.html#cmdoption-bucket-name

    retention_rule_id=$(oci os retention-rule create --bucket-name $bucket_name --query data.id --raw-output)

    oci os retention-rule get --bucket-name $bucket_name --retention-rule-id $retention_rule_id

Other Examples

Description

Get the specified retention rule in the specified bucket

Command

 oci os retention-rule get -bn bucket-client --retention-rule-id 72b6e778-04b1-40d3-8828-0a05220bff39

Output

{
 "data": {
      "display-name": "RetentionRule20221215124200",
      "duration": {
           "time-amount": 5,
           "time-unit": "DAYS"
      },
      "etag": "c9719532-9df7-4935-9f0d-7c8d039d9638",
      "id": "72b6e778-04b1-40d3-8828-0a05220bff39",
      "time-created": "2022-12-15T12:42:00.017000+00:00",
      "time-modified": "2022-12-15T12:42:00.017000+00:00",
      "time-rule-locked": null
 },
 "etag": "c9719532-9df7-4935-9f0d-7c8d039d9638"
}

Description

Get the specified retention rule in the specified namespace

Command

 oci os retention-rule get -bn bucket-client --retention-rule-id 72b6e778-04b1-40d3-8828-0a05220bff39 -ns bmcostests

Output

{
 "data": {
      "display-name": "RetentionRule20221215124200",
      "duration": {
           "time-amount": 5,
           "time-unit": "DAYS"
      },
      "etag": "c9719532-9df7-4935-9f0d-7c8d039d9638",
      "id": "72b6e778-04b1-40d3-8828-0a05220bff39",
      "time-created": "2022-12-15T12:42:00.017000+00:00",
      "time-modified": "2022-12-15T12:42:00.017000+00:00",
      "time-rule-locked": null
 },
 "etag": "c9719532-9df7-4935-9f0d-7c8d039d9638"
}