Utiliser l'API Autonomous AI Database pour DynamoDB

Voici une liste d'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 avoir le 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 REST de point d'extrémité 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 nouvelle clé d'accès avec des autorisations d'administration. La demande spécifie le nom de la clé et les autorisations requises, et la réponse inclut l'ID clé d'accès, la clé secrète, le délai d'expiration et les autorisations 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 sur la clé d'accès

Après avoir créé une clé d'accès, utilisez la demande d'API REST GET /accesskeys pour consulter ses détails, tels que son nom, les autorisations associées, le délai d'expiration et d'autres métadonnées pertinentes. Cela vous permet de confirmer par programmation les droits d'accès, les données d'identification de vérification ou d'afficher 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 demande :

• database-ocid : Identificateur Oracle Cloud unique (OCID) de la base de données 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 d'utilisateur de base de données utilisé pour l'authentification.

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

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

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

• Accept : Spécifie le format de réponse.

Mettre à jour une clé d'accès

Après avoir créé et extrait votre clé d'accès, 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 unique (OCID) de la base de données 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 d'utilisateur de base de données utilisé pour l'authentification.

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

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

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

• Accept : Spécifie 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 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 autorisations associées à la clé d'accès.

  • actions : Liste des actions autorisées (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 supprimer une clé d'accès de votre 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 supprime la clé d'accès spécifiée de votre base de données d'intelligence artificielle autonome. 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 retourne un 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 unique (OCID) de la base de données 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 d'utilisateur de base de données utilisé pour l'authentification.

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

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

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

Paramètres de 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 : Statut final de la clé d'accès après la suppression (par exemple, " DELETED ").

Suivez ces étapes pour configurer votre client DynamoDB pour appeler l'API de base de données du service d'intelligence artificielle autonome pour DynamoDB.

Configurer DynamoDbClient avec le point d'extrémité compatible avec la base de données d'intelligence artificielle autonome DynamoDB

Mettre à jour le fichier de données 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 le point d'extrémité Autonomous AI Database.

Par exemple, le code suivant configure le client DynamoDB à l'aide de la trousse SDK Java pour pointer vers votre point d'extrémité de base de données d'intelligence artificielle autonome :

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 le point d'extrémité par défaut afin que le client pointe vers le point d'extrémité REST compatible avec la base de données d'intelligence artificielle autonome DynamoDB.

Éléments de code :

• DynamoDbClient.builder() : Initialise une nouvelle instance DynamoDbClient.Builder. Ce générateur fait partie de la trousse SDK AWS pour Java et est utilisé pour construire des instances de client DynamoDB.

• region(Region region) : Spécifie la région AWS dans laquelle le client opère. Notez que ce nom de région est facultatif et qu'il sera remplacé par la valeur de région spécifiée dans le point d'extrémité de l'API REST.

• endpointOverride(URI endpoint) : Configure le client pour qu'il communique avec un point d'extrémité HTTP compatible avec DynamoDB spécifié, au lieu du point d'extrémité de service AWS par défaut.

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

Vous pouvez également configurer ou remplacer le point d'extrémité du client DynamoDB à l'aide d'autres langages de programmation et des trousses SDK AWS correspondantes, telles que Python (avec Boto3), C++.

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

Le code suivant montre comment créer une table compatible DynamoDB movie et effectuer des opérations de base : décrire, lister, insérer, mettre à jour et supprimer des éléments à l'aide de la trousse SDK Java AWS v2 avec un point d'extrémité personnalisé.

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