Utiliser l'API Autonomous AI Database pour DynamoDB

Voici la liste des autorisations pour les clés d'accès :

Créer une clé d'accès

Pour créer une clé d'accès et une clé secrète dans votre base de données, vous devez être connecté en tant qu'utilisateur ADMIN ou disposer du rôle PDB_DBA.

Syntaxe et exemple de demande de création d'une clé d'accès dans la base de données :

Utilisez la demande d'API d'adresse REST POST https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys pour générer la clé d'accès et la clé secrète :

Syntaxe

POST "https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys"
{
  "name"          : "{<access_key_name>}",         // Required. The name you assign to the access key.
  "description"   : "{<access_key_description>}",  // Optional. A description for the access key.
  "permissions"   : [                             // Optional. Array of permission objects.
    {
      "actions"   : [<List of permissions>],      // Required. List of permitted actions (e.g., "read", "write").
      "resources" : [<List of Tables>]            // Optional. Only applicable for permissions that get applied on Table.
    }
    // ... additional permission objects as needed
  ],
  "expiration_minutes": 120                       // Optional. The key's expiration time in minutes.
}

Exemple de format de réponse

{  
  "name": "<access_key_name>",  
  "description": "<access_key_description>",  
  "access_key_id": "<access_key_id>",  
  "secret_access_key": "<generated secret>",  
  "expiration_timestamp": "<access_key_expiration_timestamp>",  
  "permissions": [  
    {  
      "actions"  : [<permissions list>],  
      "resources": [<optional DynamoDb table list>]  
    }  
    // ...more permission objects  
  ]  
}

Exemple : cet exemple montre comment envoyer une demande POST à l'API REST Oracle Autonomous AI Database pour créer une clé d'accès avec des droits d'administration. La demande indique le nom de la clé et les droits d'accès requis, et la réponse inclut l'ID de clé d'accès, la clé secrète, le délai d'expiration et les droits d'accès nouvellement générés.

# Request
curl -X POST 'https://dataaccess.adb.us-phoenix-1.oraclecloudapps.com/adb/auth/v1/databases/OCID1.AUTONOMOUSDATABASE.OC1.PHX.ANYHQLJRGDV...EXAMPLE/accesskeys'\
--user "AdminUser:TestPass#" \
--header 'Request-Id: 8g89mz8qnet9ufxg4dwrus8m' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "adminkey",
    "permissions": [
        {
            "actions": [
                "ADMIN_ANY"
            ]
        }
    ],
    "expiration_minutes": 120
}'

# Sample Response
{
    "access_key_id": "ak_og67ZI8bdS.....BiHCda7l",
    "secret_access_key": "NzYwZDE5M2E4NDVjZ.....FmMzBiNQ>>",
    "expiration_time": "2025-12-07T03:35:12Z",
    "permissions": [
        {
            "actions": [
                "ADMIN_ANY"
            ]
        }
    ]
}

Extraire les informations de clé d'accès

Une fois que vous avez créé une clé d'accès, utilisez la demande d'API REST GET /accesskeys pour rechercher ses détails, tels que son nom, les droits d'accès associés, le délai d'expiration et d'autres métadonnées pertinentes. Vous pouvez ainsi confirmer par programmation les droits d'accès, les informations d'identification d'audit ou les informations de clé d'accès.

Syntaxe et exemple pour extraire les détails de la clé d'accès :

Syntaxe :

GET https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys/{access_key_id}
    Authorization: Basic <Base64-encoded
    database username and password>request-id: <optional request-id>

Exemple : l'appel suivant extrait des informations détaillées sur la clé d'accès spécifiée. Cela vous permet de confirmer les attributs et les autorisations associés à la clé d'accès :

# Request
curl -X GET 'https://dataaccess.adb.us-phoenix-1.oraclecloudapps.com/adb/auth/v1/databases/OCID1.AUTONOMOUSDATABASE.OC1.PHX.ANYHQLJRGDV...EXAMPLE/accesskeys/ak_og67ZI8bdS.....BiHCda7l' \
--user "AdminUser:TestPass#" \
--header 'Request-Id: xcz5efdb7rfrbsfkkwwl7d38' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json'

# Sample Response
{
    "access_key_id": "ak_og67ZI8bdS.....BiHCda7l",
    "expiration_timestamp": "2025-12-07T03:35:12.751Z",
    "permissions": [
        {
            "actions": [
                "ADMIN_ANY"
            ]
        }
    ]
}

Paramètres de la demande :

• database-ocid : identificateur Oracle Cloud (OCID) unique de l'instance Autonomous Database en cours d'interrogation.

• access-key-id : identificateur unique de la clé d'accès spécifique dont les détails sont demandés.

• AdminUser : nom utilisateur de base de données utilisé pour l'authentification.

• TestPass# : mot de passe de l'utilisateur de base de données.

• Request-Id : identificateur unique de cette demande d'API, utile pour la journalisation ou le dépannage.

• Content-Type : indique le format attendu de la réponse (application ou json ; défini dans l'en-tête).

• Accept : indique le format de réponse.

Mettre à jour une clé d'accès

Une fois la clé d'accès créée et extraite, vous utilisez l'API REST PUT /accesskeys pour mettre à jour les attributs d'une clé d'accès existante.

Syntaxe et exemple pour mettre à jour une clé d'accès :

Syntaxe

PUT https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys/{access_key_id}
    Authorization: Basic <Base64-encoded database username and password>
    request-id: <optional request-id>
    Content-Type: application/json

{
  "permissions": [<permissions array>],
  "extend_expiration_minutes_by": <integer>
}

Exemple : la demande suivante met à jour la clé d'accès pour prolonger le délai d'expiration de 120 minutes.

# Request
curl -X PUT 'https://dataaccess.adb.us-phoenix-1.oraclecloudapps.com/adb/auth/v1/databases/OCID1.AUTONOMOUSDATABASE.OC1.PHX.ANYHQLJRGDV...EXAMPLE/accesskeys/ak_og67ZI8bdS.....BiHCda7l' \
--user "AdminUser:TestPass#" \
--header 'Request-Id: xzpqvei6e7x52ri94odpv0a4' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "extend_expiration_minutes_by" : 120
}'

# Sample Response

{
    "access_key_id": "ak_og67ZI8bdS.....BiHCda7l",
    "expiration_timestamp": "2025-12-07T05:35:12.751Z",
    "permissions": [
        {
            "actions": [
                "ADMIN_ANY"
            ]
        }
    ],
    "message": "Expiration extended by 120 min"
}

Paramètres de demande:

• database-ocid : identificateur Oracle Cloud (OCID) unique de l'instance Autonomous Database en cours d'interrogation.

• access-key-id : identificateur unique de la clé d'accès spécifique dont les détails sont demandés.

• AdminUser : nom utilisateur de base de données utilisé pour l'authentification.

• TestPass# : mot de passe de l'utilisateur de base de données.

• Request-Id : identificateur unique de cette demande d'API, utile pour la journalisation ou le dépannage.

• Content-Type : indique le format attendu de la réponse (application ou json ; défini dans l'en-tête).

• Accept : indique le format de réponse.

• extend_expiration_minutes_by : (corps) nombre de minutes pour prolonger l'expiration de la clé d'accès.

Paramètres de la réponse :

• access_key_id : identificateur unique de la clé d'accès mise à jour.

• expiration_timestamp : nouvel horodatage d'expiration de la clé d'accès.

• permissions : tableau décrivant les droits d'accès associés à la clé d'accès.

  • actions : liste des actions autorisées (par exemple, "ADMIN_ANY").

• message : message de confirmation indiquant l'action effectuée.

Supprimer une clé d'accès

Vous pouvez supprimer une clé d'accès existante lorsqu'elle n'est plus requise. Vous utilisez l'API REST DELETE /accesskeys pour enlever une clé d'accès de la base de données.

Syntaxe et exemple pour supprimer une clé d'accès de la base de données :

Syntaxe :

DELETE https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys/{access_key_id}
    Authorization: Basic <Base64-encoded database username and password>
    request-id: <optional request-id>

Exemple : la demande suivante enlève la clé d'accès indiquée de votre base de données Autonomous AI. Une fois supprimée, la clé ne peut plus être utilisée pour l'authentification ou l'accès à la base de données. Une suppression réussie renvoie le code de statut HTTP 204 No Content ou 200 OK, sans corps de réponse.

# Request
curl -X DELETE 'https://dataaccess.adb.us-phoenix-1.oraclecloudapps.com/adb/auth/v1/databases/OCID1.AUTONOMOUSDATABASE.OC1.PHX.ANYHQLJRGDV...EXAMPLE/accesskeys/ak_og67ZI8bdS.....BiHCda7l' \
--user "AdminUser:TestPass#" \
--header 'Request-Id: xzpqvei6e7x52ri94odpv0a4' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
# Sample Response

{
    "message": "Access key deleted successfully.",
    "access_key_id": "ak_og67ZI8bdS.....BiHCda7l",
    "status": "DELETED"
}

Paramètres de demande:

• database-ocid : identificateur Oracle Cloud (OCID) unique de l'instance Autonomous Database en cours d'interrogation.

• access-key-id : identificateur unique de la clé d'accès spécifique dont les détails sont demandés.

• AdminUser : nom utilisateur de base de données utilisé pour l'authentification.

• TestPass# : mot de passe de l'utilisateur de base de données.

• Request-Id : identificateur unique de cette demande d'API, utile pour la journalisation ou le dépannage.

• Content-Type : indique le format attendu de la réponse (application ou json ; défini dans l'en-tête).

Paramètres de la réponse :

• message : message de confirmation indiquant le résultat de l'opération de suppression.

• access_key_id : identificateur unique de la clé d'accès mise à jour.

• status : Le statut final de la clé d'accès après suppression (par exemple, "DELETED").

Suivez ces étapes pour configurer le client DynamoDB afin d'appeler l'API Autonomous AI Database pour DynamoDB.

Configuration de DynamoDbClient avec une adresse compatible Autonomous AI Database DynamoDB

Mettre à jour le fichier d'informations d'identification AWS

aws_access_key_id=<Your ADB-S DynamoDB Compatible APIs Access Key ID>
aws_secret_access_key=<Your ADB-S DynamoDB Compatible APIs Secret Access Key>

Mettez à jour le code client DynamoDB pour utiliser l'adresse de base de données Autonomous AI.

Par exemple, le code suivant configure le client DynamoDB à l'aide du kit SDK Java pour qu'il pointe vers votre adresse de base de données Autonomous AI :

import java.net.URI;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;

// Set the appropriate region and endpoint. 
//Region name is optional and will be overridden by the region value specified in the REST API endpoint.
Region region = Region.US_EAST_1;
String endpoint = "https://dataaccess.adb.us-phoenix-1.oraclecloudapps.com/adb/keyvaluestore/v1/OCID1.AUTONOMOUSDATABASE.OC1.PHX.ANYHQLJRGDV...EXAMPLE";

// Build the DynamoDB client using a custom endpoint
DynamoDbClient ddb = DynamoDbClient.builder()
    .region(region)
    .endpointOverride(URI.create(endpoint))
    .build();

Cet exemple remplace l'adresse par défaut de sorte que le client pointe vers l'adresse REST compatible de la base de données Autonomous AI DynamoDB.

Eléments de code :

• DynamoDbClient.builder() : initialise une nouvelle instance DynamoDbClient.Builder. Ce générateur fait partie du kit SDK AWS pour Java et est utilisé pour créer des instances client DynamoDB.

• region(Region region) : indique la région AWS dans laquelle le client opère. Ce nom de région est facultatif et sera remplacé par la valeur de région indiquée dans l'adresse d'API REST.

• endpointOverride(URI endpoint) : configure le client pour qu'il communique avec une adresse HTTP compatible DynamoDB indiquée, au lieu de l'adresse de service AWS par défaut.

• build() : finalise la configuration du générateur et crée une instance DynamoDbClient avec les paramètres indiqués.

Vous pouvez également configurer ou remplacer l'adresse client DynamoDB à l'aide d'autres langages de programmation et de leurs kits SDK AWS respectifs, tels que Python (avec Boto3), C++.

Appeler l'API compatible DynamoDB sur votre base de données d'IA autonome

Le code suivant explique comment créer une table compatible avec DynamoDB movie et effectuer des opérations de base : décrire, répertorier, insérer, mettre à jour et supprimer des éléments à l'aide du kit SDK Java AWS v2 avec une adresse personnalisée.

import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.*;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.model.AttributeValue;
import java.net.URI;
import java.util.Map;

public class DynamoDBMovieExample {
    public static void main(String[] args) {
        // Set the region and endpoint
        //Region name is optional and will be overridden by the region value specified in the REST API endpoint.
        Region region = Region.US_WEST_1;
        String endpoint = "https://region.us-phoenix-1.adb.oraclecloud.com";

        // Build the DynamoDB client using a custom endpoint
        DynamoDbClient ddb = DynamoDbClient.builder()
            .region(region)
            .endpointOverride(URI.create(endpoint))
            .build();

        // Create table
        CreateTableRequest createTableRequest = CreateTableRequest.builder()
            .tableName("movie")
            .keySchema(
                KeySchemaElement.builder().attributeName("PK").keyType(KeyType.HASH).build(),
                KeySchemaElement.builder().attributeName("SK").keyType(KeyType.RANGE).build()
            )
            .attributeDefinitions(
                AttributeDefinition.builder().attributeName("PK").attributeType(ScalarAttributeType.S).build(),
                AttributeDefinition.builder().attributeName("SK").attributeType(ScalarAttributeType.S).build()
            )
            .provisionedThroughput(
                ProvisionedThroughput.builder().readCapacityUnits(5L).writeCapacityUnits(5L).build()
            )
            .build();
        ddb.createTable(createTableRequest);

        // Describe the table
        DescribeTableRequest descRequest = DescribeTableRequest.builder().tableName("movie").build();
        DescribeTableResponse descResponse = ddb.describeTable(descRequest);

        // List all tables
        ListTablesRequest listRequest = ListTablesRequest.builder().build();
        ListTablesResponse listResponse = ddb.listTables(listRequest);

        // Insert (PutItem)
        ddb.putItem(PutItemRequest.builder()
            .tableName("movie")
            .item(Map.of(
                "PK", AttributeValue.builder().s("001").build(),
                "SK", AttributeValue.builder().s("MOVIE").build(),
                "Title", AttributeValue.builder().s("Inception").build()))
            .build()
        );

        // Update (UpdateItem)
        ddb.updateItem(UpdateItemRequest.builder()
            .tableName("movie")
            .key(Map.of(
                "PK", AttributeValue.builder().s("001").build(),
                "SK", AttributeValue.builder().s("MOVIE").build()))
            .updateExpression("SET #T = :t")
            .expressionAttributeNames(Map.of("#T", "Title"))
            .expressionAttributeValues(Map.of(":t", AttributeValue.builder().s("Inception (2010)").build()))
            .build()
        );

        // Delete (DeleteItem)
        ddb.deleteItem(DeleteItemRequest.builder()
            .tableName("movie")
            .key(Map.of(
                "PK", AttributeValue.builder().s("001").build(),
                "SK", AttributeValue.builder().s("MOVIE").build()))
            .build()
        );
    }
}

Notes d'utilisation

Limites