Oracle Cloud Infrastructure Python SDK

Warnings

• gotcha When performing 'list' operations (e.g., `list_instances`, `list_buckets`), methods typically return only the first page of results. To retrieve all items, you must explicitly use paginators.
  Fix: Use `oci.pagination.list_call_get_all_results()` or the `.all()` method on the response object (where available) to iterate through all pages. Example: `for item in oci.pagination.list_call_get_all_results(client.list_resources, compartment_id=ocid).data:`
• gotcha The most common issue is misconfiguration of the OCI SDK. This includes missing `~/.oci/config` file, incorrect profile name, invalid API key paths, or incorrect tenancy/user OCIDs.
  Fix: Ensure `~/.oci/config` is correctly set up with the required `user`, `fingerprint`, `key_file`, `tenancy`, and `region` properties. Verify permissions for the API key and ensure the profile name matches what's used in `oci.config.from_file()`.
• gotcha OCI API calls can raise `oci.exceptions.ServiceError` for issues like authentication failures, permission errors, or invalid parameters. Not catching this specific exception can lead to unhandled runtime errors.
  Fix: Wrap your OCI API calls in `try...except oci.exceptions.ServiceError as e:` blocks to handle specific error codes (e.g., `e.code == "NotAuthenticated"`) gracefully and provide user-friendly feedback.
• breaking The default retry strategy for API calls changed from a fixed retry count to an exponential backoff strategy in versions greater than 2.24.0. This might alter the retry behavior of existing applications.
  Fix: If your application relies on specific retry behavior, explicitly configure a `retry_strategy` when initializing clients (e.g., `identity_client = oci.identity.IdentityClient(config, retry_strategy=oci.retry.NoneRetryStrategy())`) or update your code to account for the new default exponential backoff.

Install

• pip install oci Install latest version

Imports

• config

  import oci.config

  The 'config' module is typically imported directly as oci.config, not from the top-level 'oci' package.
• IdentityClient

  from oci.identity import IdentityClient

• ObjectStorageClient

  from oci.object_storage import ObjectStorageClient

• ServiceError

  from oci.exceptions import ServiceError

• Paginators

  import oci.pagination

Quickstart

This quickstart initializes an OCI IdentityClient using configuration loaded from the default `~/.oci/config` file. It then attempts to fetch the current authenticated user's details to verify connectivity and authentication. A missing configuration file or authentication failure will lead to an error message and exit, guiding the user on how to resolve it.

import oci
import os

try:
    # Load configuration from the default location (~/.oci/config)
    # The 'DEFAULT' profile is used if not explicitly specified.
    config = oci.config.from_file()
    # You can specify a different profile or file:
    # config = oci.config.from_file(file_location="~/.oci/config", profile_name="MY_PROFILE")
except oci.exceptions.ConfigFileNotFound:
    print("WARNING: OCI config file not found.")
    print("Please ensure your OCI config file is set up at ~/.oci/config and contains a 'DEFAULT' profile.")
    print("Alternatively, provide credentials via environment variables (e.g., OCI_CONFIG_FILE, OCI_PROFILE) or use Instance Principals for OCI instances.")
    exit(1) # Cannot proceed without configuration

# Initialize the IdentityClient for interacting with Identity services
identity_client = oci.identity.IdentityClient(config)

try:
    # The 'user' OCID is part of the loaded config (from the API key details).
    user_ocid = config["user"]
    
    # Get the current authenticated user's details
    user = identity_client.get_user(user_ocid).data
    print(f"Successfully authenticated as user: {user.name} (OCID: {user.id})")
    print(f"Region: {config['region']}")

    # Example of another common operation: List the root compartment details
    # root_compartment = identity_client.get_compartment(config["tenancy"]).data
    # print(f"Root Compartment: {root_compartment.name} (OCID: {root_compartment.id})")

except oci.exceptions.ServiceError as e:
    print(f"OCI Service Error encountered (Code: {e.code}): {e.message}")
    if e.code == "NotAuthenticated":
        print("Authentication failed. Please check your OCI configuration (~/.oci/config), API key, or credentials.")
    elif e.code == "InvalidParameter":
        print(f"The user OCID '{user_ocid}' might be invalid or you lack permissions to view it.")
    print("To troubleshoot, ensure the user OCID in your config file is correct and the API key is valid.")
    exit(1)
except Exception as e:
    print(f"An unexpected error occurred: {e}")
    exit(1)