Uso de la API de base de datos de IA autónoma para DynamoDB

A continuación, se muestra una lista de permisos para claves de acceso:

Crear una clave de acceso

Para crear una clave de acceso y una clave secreta en la base de datos, debe estar conectado como usuario ADMIN o se le ha otorgado el rol PDB_DBA.

Sintaxis y una solicitud de ejemplo para crear una clave de acceso en la base de datos:

Utilice la solicitud de API de punto final de REST POST https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys para generar la clave de acceso y la clave secreta:

Sintaxis

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.
}

Formato de respuesta de ejemplo

{  
  "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  
  ]  
}

Ejemplo: en este ejemplo se muestra cómo enviar una solicitud POST a la API de REST de Oracle Autonomous AI Database para crear una nueva clave de acceso con permisos administrativos. La solicitud especifica el nombre de clave y los permisos necesarios, y la respuesta incluye el ID de clave de acceso, el secreto, el tiempo de caducidad y los permisos recién generados.

# 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"
            ]
        }
    ]
}

Recuperar información clave de acceso

Después de crear una clave de acceso, utilice la solicitud de la API de REST GET /accesskeys para buscar sus detalles, como su nombre, permisos asociados, tiempo de caducidad y otros metadatos relevantes. Esto le permite confirmar mediante programación los derechos de acceso, las credenciales de auditoría o mostrar información de clave de acceso.

Sintaxis y ejemplo para recuperar detalles de clave de acceso:

Sintaxis:

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>

Ejemplo: la siguiente llamada recupera información detallada sobre la clave de acceso especificada. Esto le permite confirmar los atributos y permisos asociados con la clave de acceso:

# 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"
            ]
        }
    ]
}

Parámetros de solicitud:

• database-ocid: identificador único de Oracle Cloud (OCID) de la instancia de Autonomous Database que se está consultando.

• access-key-id: identificador único de la clave de acceso específica cuyos detalles se solicitan.

• AdminUser: nombre de usuario de la base de datos utilizado para la autenticación.

• TestPass#: contraseña del usuario de la base de datos.

• Request-Id: identificador único para esta solicitud de API. Es útil para el registro o la solución de problemas.

• Content-Type: especifica el formato esperado de la respuesta (application o json; definido en la cabecera).

• Accept: especifica el formato de respuesta.

Actualizar una clave de acceso

Después de crear y recuperar la clave de acceso, utilice la API de REST PUT /accesskeys para actualizar los atributos de una clave de acceso existente.

Sintaxis y ejemplo para actualizar una clave de acceso:

Sintaxis

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>
}

Ejemplo: la siguiente solicitud actualiza la clave de acceso para ampliar el tiempo de caducidad en 120 minutos.

# 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"
}

Parámetros de solicitud:

• database-ocid: identificador único de Oracle Cloud (OCID) de la instancia de Autonomous Database que se está consultando.

• access-key-id: identificador único de la clave de acceso específica cuyos detalles se solicitan.

• AdminUser: nombre de usuario de la base de datos utilizado para la autenticación.

• TestPass#: contraseña del usuario de la base de datos.

• Request-Id: identificador único para esta solicitud de API. Es útil para el registro o la solución de problemas.

• Content-Type: especifica el formato esperado de la respuesta (application o json; definido en la cabecera).

• Accept: especifica el formato de respuesta.

• extend_expiration_minutes_by: (cuerpo) número de minutos para ampliar la caducidad de la clave de acceso.

Parámetros para la respuesta:

• access_key_id: identificador único de la clave de acceso actualizada.

• expiration_timestamp: nuevo registro de hora de caducidad para la clave de acceso.

• permissions: matriz que describe los permisos asociados a la clave de acceso.

  • actions: lista de acciones permitidas (ejemplo: "ADMIN_ANY").

• message: mensaje de confirmación que indica la acción realizada.

Suprimir una clave de acceso

Puede suprimir una clave de acceso existente cuando ya no sea necesaria. Puede utilizar la API de REST DELETE /accesskeys para eliminar una clave de acceso de la base de datos.

Sintaxis y ejemplo para eliminar una clave de acceso de la base de datos:

Sintaxis:

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>

Ejemplo: la siguiente solicitud elimina la clave de acceso especificada de la base de datos de IA autónoma. Una vez suprimida, la clave ya no se puede utilizar para la autenticación o el acceso a la base de datos. Una supresión correcta devuelve un código de estado HTTP de 204 No Content o 200 OK, sin cuerpo de respuesta.

# 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"
}

Parámetros de solicitud:

• database-ocid: identificador único de Oracle Cloud (OCID) de la instancia de Autonomous Database que se está consultando.

• access-key-id: identificador único de la clave de acceso específica cuyos detalles se solicitan.

• AdminUser: nombre de usuario de la base de datos utilizado para la autenticación.

• TestPass#: contraseña del usuario de la base de datos.

• Request-Id: identificador único para esta solicitud de API. Es útil para el registro o la solución de problemas.

• Content-Type: especifica el formato esperado de la respuesta (application o json; definido en la cabecera).

Parámetros para la respuesta:

• message: mensaje de confirmación que indica el resultado de la operación de supresión.

• access_key_id: identificador único de la clave de acceso actualizada.

• status: estado final de la clave de acceso después de la eliminación (por ejemplo, "DELETED").

Siga estos pasos para configurar el cliente DynamoDB para llamar a la API de base de datos de IA autónoma para DynamoDB.

Configuración de DynamoDbClient con punto final compatible con Autonomous AI Database DynamoDB

Actualizar archivo de credenciales de 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>

Actualice el código de cliente DynamoDB para utilizar el punto final de la base de datos de IA autónoma.

Por ejemplo, el siguiente código configura el cliente DynamoDB mediante el SDK de Java para que apunte al punto final de la base de datos de IA autónoma:

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();

En este ejemplo, se sustituye el punto final por defecto para que el cliente apunte al punto final de REST compatible con la base de datos de IA autónoma DynamoDB.

Elementos de código:

• DynamoDbClient.builder(): inicializa una nueva instancia DynamoDbClient.Builder. Este creador forma parte del SDK de AWS para Java y se utiliza para crear instancias de cliente DynamoDB.

• region(Region region): especifica la región de AWS en la que opera el cliente. Tenga en cuenta que este nombre de región es opcional y se sustituirá por el valor de región especificado en el punto final de la API de REST.

• endpointOverride(URI endpoint): configura el cliente para que se comunique con un punto final HTTP compatible con DynamoDB especificado, en lugar del punto final de servicio de AWS predeterminado.

• build(): finaliza la configuración del creador y crea una nueva instancia DynamoDbClient con los valores especificados.

También puede configurar o sustituir el punto final de cliente DynamoDB mediante otros lenguajes de programación y sus respectivos SDK de AWS, como Python (con Boto3), C++.

Llamada a una API compatible con DynamoDB en tu base de datos de IA autónoma

En el siguiente código se muestra cómo crear una tabla compatible con DynamoDB movie y realizar operaciones básicas: describir, mostrar, insertar, actualizar y suprimir elementos mediante el SDK de AWS Java v2 con un punto final personalizado.

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()
        );
    }
}

Notas de Uso

Limitaciones