Аутентификация и соединение с БД по HTTP API, совместимому с Amazon SQS

ЭндпоинтЭндпоинт

Эндпоинт подключения отображается в консоли управления, на странице базы данных. Эндпоинт одинаковый для протоколов Amazon Kinesis Data Streams и Amazon Simple Queue Service (SQS).

Предварительные требованияПредварительные требования

Для аутентификации требуется:

1. Создать сервисный аккаунт.
2. Назначить сервисному аккаунту роли:
   • Для чтения из потока данных: ydb.viewer.
   • Для записи в поток данных: ydb.editor.
   • Для создания и удаления очереди: ydb.editor.
3. Создать статический ключ доступа для сервисного аккаунта. Надежно сохраните идентификатор и секретный ключ.

АутентификацияАутентификация

В HTTP API, совместимом с Amazon SQS, аутентификация выполняется через подпись запросов Signature Version 4, как в Amazon SQS.

Для этого необходимы:

• <access_key_id> — идентификатор статического ключа доступа.
• <secret_access_key> — секретная часть статического ключа доступа.

Настройте AWS CLI:

1. Запустите интерактивную настройку профиля:

   aws configure
   

2. Укажите полученный ранее идентификатор ключа сервисного аккаунта:

   AWS Access Key ID [****************ver_]: <идентификатор_ключа_сервисного_аккаунта>
   

3. Укажите полученный ранее секретный ключ сервисного аккаунта:

   AWS Secret Access Key [****************w5lb]: <секретный_ключ_сервисного_аккаунта>
   

4. Укажите имя региона по умолчанию kz1:

   Default region name [kz1]: kz1
   

5. Укажите формат выходных данных по умолчанию json:

   Default output format [None]: json
   

6. Чтобы посмотреть текущие настройки профиля, выполните команду:

   aws configure list
   

   Результат:

         Name                    Value             Type    Location
         ----                    -----             ----    --------
      profile                <not set>             None    None
   access_key     ****************aBc1 shared-credentials-file
   secret_key     ****************DeF2 shared-credentials-file
       region              kz1      config-file    ~/.aws/config
   

Пример создания очередиПример создания очереди

В примере используются:

• <sqs_api_endpoint> — эндпоинт.
• <stream_name> — имя создаваемого потока данных.

1. Установите AWS CLI, если он еще не установлен.

2. Создайте очередь:

   aws --endpoint "<sqs_api_endpoint>" sqs create-queue \
     --queue-name "<stream_name>"
   

   Будет создан поток данных с указанным именем и разделяемым (общим) читателем ydb-sqs-consumer.

   Для создания FIFO-очереди укажите атрибут FifoQueue=true. Имя такой очереди рекомендуется заканчивать на .fifo:

   aws --endpoint "<sqs_api_endpoint>" sqs create-queue \
     --queue-name "<stream_name>.fifo" \
     --attributes FifoQueue=true
   

Пример записи и чтения сообщенияПример записи и чтения сообщения

В примере используются:

• <sqs_api_endpoint> — эндпоинт.
• <stream_name> — имя потока данных.

1. Установите AWS CLI, если он еще не установлен.

2. Получите QueueUrl потока:

   QUEUE_URL="$(aws --endpoint "<sqs_api_endpoint>" sqs get-queue-url \
     --queue-name "<stream_name>" \
     --query 'QueueUrl' --output text)"
   

3. Отправьте сообщение в поток:

   aws --endpoint "<sqs_api_endpoint>" sqs send-message \
     --queue-url "$QUEUE_URL" \
     --message-body "test message"
   

4. Прочитайте сообщение из потока:

   aws --endpoint "<sqs_api_endpoint>" sqs receive-message \
     --queue-url "$QUEUE_URL" \
     --wait-time-seconds 20 \
     --max-number-of-messages 1
   

Основную документацию по работе с Data Streams через HTTP API, совместимый с Amazon SQS, и больше примеров читайте в документации YDB.