list-associated-databases

Description

Usage

oci database-management associated-database-summary list-associated-databases [OPTIONS]

Required Parameters

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the compartment.

The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the Database Management private endpoint.

Optional Parameters

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

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

The maximum number of records returned in the paginated response.

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.

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

The option to sort databases using a specific Database Management private endpoint.

Accepted values are:

timeRegistered

The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order.

Accepted values are:

ASC, DESC

Global Parameters

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --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, -i, -v

Examples

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> 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/private-endpoint/create.html#cmdoption-compartment-id
    export name=<substitute-value-of-name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/private-endpoint/create.html#cmdoption-name
    export subnet_id=<substitute-value-of-subnet_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/database-management/private-endpoint/create.html#cmdoption-subnet-id
    private_endpoint_id=$(oci database-management private-endpoint create --compartment-id $compartment_id --name $name --subnet-id $subnet_id --query data.id --raw-output)
    oci database-management associated-database-summary list-associated-databases --compartment-id $compartment_id --private-endpoint-id $private_endpoint_id