Usar a API do Autonomous AI Database para DynamoDB

Veja a seguir uma lista de permissões para chaves de acesso:

Criar uma chave de acesso

Para criar uma Chave de Acesso e uma Chave Secreta no seu banco de dados, você deve estar conectado como o usuário ADMIN ou ter recebido a atribuição PDB_DBA.

Sintaxe e uma solicitação de amostra para criar uma chave de acesso no banco de dados:

Use a solicitação da API do ponto final REST POST https://dataaccess.adb.{oci-region-name}.oraclecloudapps.com/adb/auth/v1/databases/{database-ocid}/accesskeys para gerar a Chave de Acesso e a Chave Secreta:

Sintaxe

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 resposta de amostra

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

Exemplo: Este exemplo demonstra como enviar uma solicitação POST à API REST do Oracle Autonomous AI Database para criar uma nova chave de acesso com permissões administrativas. A solicitação especifica o nome da chave e as permissões necessárias, e a resposta inclui o ID da chave de acesso recém-gerado, o segredo, o tempo de expiração e as permissões.

# 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 Informações da Chave de Acesso

Depois de criar uma chave de acesso, use a solicitação da API REST GET /accesskeys para procurar seus detalhes, como nome, permissões associadas, tempo de expiração e outros metadados relevantes. Isso permite que você confirme programaticamente direitos de acesso, audite credenciais ou mostre informações de chave de acesso.

Sintaxe e exemplo para recuperar detalhes da chave de acesso:

Sintaxe:

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>

Exemplo: A chamada a seguir recupera informações detalhadas sobre a chave de acesso especificada. Isso permite confirmar os atributos e permissões associados à chave de acesso:

# 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 Solicitação:

• database-ocid: O OCID (Oracle Cloud Identifier) exclusivo do Autonomous Database que está sendo consultado.

• access-key-id: O identificador exclusivo da chave de acesso específica cujos detalhes são solicitados.

• AdminUser: O nome de usuário do banco de dados usado para autenticação.

• TestPass#: A senha do usuário do banco de dados.

• Request-Id: Identificador exclusivo para esta solicitação de API., útil para log ou solução de problemas.

• Content-Type: Especifica o formato esperado da resposta (application ou json; definido no cabeçalho).

• Accept: Especifica o formato de resposta.

Atualizar uma chave de acesso

Depois de criar e recuperar sua chave de acesso, use a API REST PUT /accesskeys para atualizar os atributos de uma chave de acesso existente.

Sintaxe e exemplo para atualizar uma chave de acesso:

Sintaxe

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

Exemplo: A solicitação a seguir atualiza a chave de acesso para estender o tempo de expiração em 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 solicitação:

• database-ocid: O OCID (Oracle Cloud Identifier) exclusivo do Autonomous Database que está sendo consultado.

• access-key-id: O identificador exclusivo da chave de acesso específica cujos detalhes são solicitados.

• AdminUser: O nome de usuário do banco de dados usado para autenticação.

• TestPass#: A senha do usuário do banco de dados.

• Request-Id: Identificador exclusivo para esta solicitação de API., útil para log ou solução de problemas.

• Content-Type: Especifica o formato esperado da resposta (application ou json; definido no cabeçalho).

• Accept: Especifica o formato de resposta.

• extend_expiration_minutes_by: (Corpo) Número de minutos para estender a expiração da chave de acesso.

Parâmetros da resposta:

• access_key_id: O identificador exclusivo da chave de acesso atualizada.

• expiration_timestamp: O novo timestamp de expiração para a chave de acesso.

• permissions: Array descrevendo as permissões associadas à chave de acesso.

  • actions: Lista de ações permitidas (exemplo: "ADMIN_ANY").

• message: Mensagem de confirmação indicando a ação executada.

Excluir uma chave de acesso

Você pode excluir uma chave de acesso existente quando ela não for mais necessária. Você usa a API REST DELETE /accesskeys para remover uma chave de acesso do seu banco de dados.

Sintaxe e exemplo para remover uma chave de acesso do seu banco de dados:

Sintaxe:

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>

Exemplo: A solicitação a seguir remove a chave de acesso especificada do Autonomous AI Database. Depois de excluída, a chave não poderá mais ser usada para autenticação ou acesso ao banco de dados. Uma exclusão bem-sucedida retorna um código de status HTTP 204 No Content ou 200 OK, sem corpo de resposta.

# 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 solicitação:

• database-ocid: O OCID (Oracle Cloud Identifier) exclusivo do Autonomous Database que está sendo consultado.

• access-key-id: O identificador exclusivo da chave de acesso específica cujos detalhes são solicitados.

• AdminUser: O nome de usuário do banco de dados usado para autenticação.

• TestPass#: A senha do usuário do banco de dados.

• Request-Id: Identificador exclusivo para esta solicitação de API., útil para log ou solução de problemas.

• Content-Type: Especifica o formato esperado da resposta (application ou json; definido no cabeçalho).

Parâmetros da resposta:

• message: Mensagem de confirmação indicando o resultado da operação de exclusão.

• access_key_id: O identificador exclusivo da chave de acesso atualizada.

• status: O status final da chave de acesso após a exclusão (por exemplo, "DELETED").

Siga estas etapas para configurar seu cliente DynamoDB para chamar a API do Autonomous AI Database para DynamoDB.

Configure DynamoDbClient with Autonomous AI Database DynamoDB-Compatible Endpoint

Atualizar Arquivo de Credenciais da 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>

Atualize o código do cliente DynamoDB para usar o ponto final do Autonomous AI Database.

Por exemplo, o código a seguir configura o cliente DynamoDB usando o Java SDK para apontar para o ponto final do Autonomous AI Database:

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

Este exemplo substitui o ponto final padrão para que o cliente aponte para o ponto final REST Compatível com DynamoDB do Autonomous AI Database.

Elementos do código:

• DynamoDbClient.builder(): Inicializa uma nova instância do DynamoDbClient.Builder. Esse construtor faz parte do AWS SDK for Java e é usado para construir instâncias de cliente DynamoDB.

• region(Region region): Especifica a região da AWS na qual o cliente opera. Observe que esse nome de região é opcional e será substituído pelo valor de região especificado no ponto final da API REST.

• endpointOverride(URI endpoint): Configura o cliente para se comunicar com um ponto final HTTP compatível com DynamoDB especificado, em vez do ponto final do serviço AWS padrão.

• build(): Finaliza a configuração do construtor e cria uma nova instância do DynamoDbClient com as definições especificadas.

Você também pode configurar ou substituir o ponto final do cliente DynamoDB usando outras linguagens de programação e seus respectivos SDKs da AWS, como Python (com Boto3) e C++.

Chamar a API Compatível com DynamoDB no seu Autonomous AI Database

O código a seguir demonstra como criar uma tabela movie compatível com DynamoDB e executar operações básicas: descreva, liste, insira, atualize e exclua itens usando o Java AWS SDK v2 com um ponto 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()
        );
    }
}

Observações de uso

Limitações