Spec-Zone.ru › AWS CLI v2

[ aws . s3api ]

get-bucket-metrics-configuration

Описание

Примечание

Данная операция не поддерживается для ведер-каталогов.

Получает конфигурацию метрик (указанную по идентификатору конфигурации метрик) из ведра. Обратите внимание, что это не включает ежедневные метрики хранилища.

Для использования этой операции необходимо иметь разрешение на выполнение действия s3:GetMetricsConfiguration. Владелец ведра имеет это разрешение по умолчанию. Владелец ведра может предоставить это разрешение другим. Дополнительную информацию о разрешениях см. в разделе Разрешения, относящиеся к операциям с подресурсами ведра, и Управление разрешениями доступа к вашим ресурсам Amazon S3 .

Дополнительную информацию о метриках запросов CloudWatch для Amazon S3 см. в разделе Отслеживание метрик с помощью Amazon CloudWatch .

Следующие операции связаны с GetBucketMetricsConfiguration :

  • PutBucketMetricsConfiguration
  • DeleteBucketMetricsConfiguration
  • ListBucketMetricsConfigurations
  • Отслеживание метрик с помощью Amazon CloudWatch

См. также: Документация API AWS

Синтаксис

  get-bucket-metrics-configuration
--bucket <value>
--id <value>
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--bucket (строка)

Имя ведра, содержащего конфигурацию метрик для извлечения.

--id (строка)

Идентификатор, используемый для идентификации конфигурации метрик. Идентификатор имеет ограничение в 64 символа и может содержать только буквы, цифры, точки, дефисы и подчеркивания.

--expected-bucket-owner (строка)

Идентификатор учетной записи предполагаемого владельца ведра. Если предоставленный вами идентификатор учетной записи не совпадает с фактическим владельцем ведра, запрос завершается с HTTP-кодом состояния 403 Forbidden (доступ запрещен).

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку.

--endpoint-url (строка)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования выходных данных команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии данного инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страницы CLI.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения конфигурации метрик для ведра с заданным ID

Следующий get-bucket-metrics-configuration пример отображает конфигурацию метрик для указанного ведра и ID.

aws s3api get-bucket-metrics-configuration \
    --bucket amzn-s3-demo-bucket \
    --id 123

Вывод:

{
    "MetricsConfiguration": {
        "Filter": {
            "Prefix": "logs"
        },
        "Id": "123"
    }
}

Вывод

MetricsConfiguration -> (структура)

Указывает конфигурацию метрик.

Id -> (строка)

Идентификатор, используемый для идентификации конфигурации метрик. Идентификатор имеет ограничение в 64 символа и может содержать только буквы, цифры, точки, дефисы и подчеркивания.

Filter -> (структура)

Указывает фильтр конфигурации метрик. Конфигурация метрик будет включать только объекты, которые соответствуют критериям фильтра. Фильтр должен быть префиксом, тегом объекта, ARN точки доступа или союзом (MetricsAndOperator).

Prefix -> (строка)

Префикс, используемый при оценке фильтра метрик.

Tag -> (структура)

Тег, используемый при оценке фильтра метрик.

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

Значение тега.

AccessPointArn -> (строка)

ARN точки доступа, используемой при оценке фильтра метрик.

And -> (структура)

Союз (логическое И) предикатов, используемый при оценке фильтра метрик. Оператор должен иметь как минимум два предиката, и объект должен соответствовать всем предикатам, чтобы фильтр применялся.

Prefix -> (строка)

Префикс, используемый при оценке предиката И.

Tags -> (список)

Список тегов, используемых при оценке предиката И.

(структура)

Контейнер пары имя-значение ключа.

Key -> (строка)

Имя ключа объекта.

Value -> (строка)

Значение тега.

AccessPointArn -> (строка)

ARN точки доступа, используемой при оценке предиката AND.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API