API-ключ
API-ключ — секретный ключ, используемый только для упрощенной аутентификации сервисных аккаунтов в API Yandex Cloud.
Используйте API-ключи, если у вас нет возможности автоматически запрашивать IAM-токен.
Внимание
Если кто-то мог узнать ваш секретный ключ, удалите его и создайте новый.
Пользователь самостоятельно хранит API-ключ. Yandex Cloud предоставляет доступ к API-ключу только в процессе его создания. Если ключ утрачен или поврежден, восстановить его нельзя. В этом случае вы можете перевыпустить ключ или создать новый.
Чтобы обеспечивать безопасность и контроль над доступом к ресурсам, отслеживать случаи несанкционированного использования ключей, а также удалять неиспользуемые ключи без риска нарушить работу сервисов Yandex Cloud, вы можете отслеживать даты последнего использования ключей доступа сервисных аккаунтов. Информация доступна на странице сервисного аккаунта в консоли управления, а также в поле last_used_at при вызове методов управления ключами доступа через API.
API-ключи с ограничениями области и срока действия
При создании API-ключа вы можете задать одну или несколько областей действия.
Область действия — совокупность разрешенных сервисному аккаунту действий с ресурсами сервиса. В сервисе может быть больше одной области действия. API-ключ с заданными областями действия нельзя использовать в других сервисах или областях действия.
Область действия ограничивает применение API-ключей в дополнение к собственным правам доступа сервисного аккаунта.
Дополнительно при создании API-ключа вы можете ограничить срок его действия. Настройка ограничений области и срока действия позволяет снизить риск несанкционированного использования ключей.
Доступные области действия:
yc.ai.foundationModels.execute— для отправки запросов к AI Assistant API, Image Generation API, Text Generation API, API SpeechKit, API Yandex Translate и Vision OCR API.yc.ai.imageGeneration.execute— для отправки запросов к моделям генерации изображений в сервисе Yandex Foundation Models через Image Generation API.yc.ai.languageModels.execute— для отправки запросов к моделям генерации текста в сервисе Yandex Foundation Models через Text Generation API.yc.ai.speechkitStt.execute— для распознавания речи через API SpeechKit.yc.ai.speechkitTts.execute— для синтеза речи через API SpeechKit.yc.ai.translate.execute— для перевода текста через API Yandex Translate.yc.ai.vision.execute— для оптического распознавания текста с помощью Vision OCR API.yc.monitoring.manage— для просмотра и записи данных в Yandex Monitoring через API Monitoring.yc.monitoring.read— для просмотра данных в Yandex Monitoring через API Monitoring.yc.postbox.send— для отправки писем через API Yandex Cloud Postbox.yc.search-api.execute— для отправки поисковых запросов к Yandex Search API.yc.serverless.containers.invoke— для вызова контейнеров через API Serverless Containers.yc.serverless.functions.invoke— для вызова функций через API Cloud Functions.yc.ydb.tables.manage— для работы с YDB в режиме совместимости с PostgreSQL.yc.ydb.topics.manage— для работы с Kafka API в Yandex Data Streams.
При создании API-ключа в консоли управления область действия является обязательным параметром. При создании API-ключа с помощью Yandex Cloud CLI, Terraform или API задавать область действия необязательно. Если область действия создаваемого API ключа не задана, ему будут по умолчанию назначены следующие области действия:
yc.ai.imageGeneration.execute;yc.ai.languageModels.execute;yc.ai.speechkitStt.execute;yc.ai.speechkitTts.execute;yc.ai.translate.execute;yc.ai.vision.execute;yc.monitoring.manage;yc.search-api.execute;yc.serverless.containers.invoke;yc.serverless.functions.invoke.
Использование API-ключа
Полученный API-ключ указывайте при обращении к ресурсам Yandex Cloud через API. Передавайте API-ключ в заголовке Authorization в следующем формате:
Authorization: Api-Key <API-ключ>
Сервисы, поддерживающие этот способ аутентификации
API-ключи в качестве способа аутентификации поддерживаются в следующих сервисах:
- Yandex Cloud Functions
- Yandex DataSphere
- Yandex Monitoring
- Yandex Cloud Postbox
- Yandex Search API
- Yandex Serverless Containers
- Yandex SpeechKit
- Yandex SpeechSense
- Yandex Translate
- Yandex Vision OCR
- Yandex Data Streams — Kafka API
- Yandex Managed Service for YDB — только в режиме совместимости с PostgreSQL. Для других режимов работы используйте соответствующий способ аутентификации.
- Yandex MetaData Hub — в рамках Yandex Schema Registry.