Oracle Cloud Infrastructure Documentation

Creating an Object Storage API Key for a Cluster

Create an API key to connect a Big Data Service cluster to Object Storage.

    1. On the Clusters list page, select the cluster that you want to work with. If you need help finding the list page or the cluster, see Listing Clusters in a Compartment.
    2. On the Cluster details page, under Resources select API keys.
    3. Select Create key.
    4. In the Create API key panel, enter a key alias to uniquely identify this key in the cluster.
    5. Enter the OCID of the user that can use this API key.
      • To retrieve the user OCID for tenancies in regions that don't use identity domains:
        1. Open the navigation menu, and select Identity & Security.
        2. Select Users, and then select the username.
        3. By the OCID field, select Copy.
      • To retrieve the user OCID for IAM with identity domains:
        1. Open the navigation menu, and select Identity & Security.
        2. Select Domains, and then select the name of the domain that lists the user.
        3. Select Users, and then select the username.
        4. By the OCID field, select Copy.
    6. Enter and confirm a passphrase. This passphrase is used to encrypt the API key and can't be changed later.
    7. Select a default region that's used to establish the Object Storage endpoint name.
    8. Select Create.
    The API key is listed in the Object Storage API keys page. When the API key is successfully created, its status changes to Active.

  • Use the oci bds bds-api-key create command and required parameters to create an Object Storage API key.

    oci bds bds-api-key create --bds-instance-id <bds_instance_id> --key-alias <key_alias> --passphrase <passphrase> --user-id <user_id> [OPTIONS]

    For a complete list of flags and variable options for CLI commands, see the Command Line Reference for Big Data.

  • Use the CreateBdsApiKey operation to create an Object Storage API key.