Oracle Cloud Infrastructure Documentation

List Database API Gateway Configurations

    1. Open the navigation menu and select Developer Services. Under Database Tools, select Database API Gateway Configurations.

      The Database API Gateway Configurations list page opens. All configurations in the selected compartment are displayed in a table.

    2. To view the configurations in a different compartment, use the Compartment filter to switch compartments.

      You must have permissions to work in a compartment to see the resources in it. If you are not sure which compartment to use, contact an administrator. For more information, see Understanding Compartments.

    3. Use filters to limit the Database API Gateway configurations in the list. Perform one of the following actions depending on the options that you see:

      • From the Search and Filter box above the list table, select one or more filters and specify the values that you want to use to narrow the list. In general, the filters correspond to the columns shown in the list table, although some filters represent attributes that are not shown in the table. The Compartment filter is always displayed next to Applied filters.

      • On the left side of the list page, select a value from one of the available filters, such as compartment, state, or tags.

      Change the order of the items in the list table by using the sort icons next to the column names.

    4. In the list table, select a configuration to view its details. The available tabs are Details, Global Settings, Pools and Tags.

    5. To perform an action on a selected configuration directly from the list table, select any of the following options from the Actions menu in the row for that connection:

      • View details: Open the details page for the configuration.

      • Move resource: Move the configuration to a different compartment.

      • Copy OCID: Copy the OCID of the configuration to the clipboard.

      • Manage tags: Add one or more tags, or change the value of an existing tag. See Resource Tags.

      • Delete: Delete the configuration.

      To create a Database API Gateway configuration, click Create configuration.

  • Use the oci dbtools database-api-gateway-config get command to view the details for a Database API Gateway configuration. 

    oci dbtools database-api-gateway-config get --database-api-gateway-config-id <config-ocid>

    For a complete list of parameters and values for CLI commands, see the Command Line Interface (CLI).

  • Use the GetDatabaseToolsDatabaseApiGatewayConfig API to view the details for a Database API Gateway configuration.

    For information about using the API and signing requests, see REST API and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.