Spec-Zone.ru › AWS CLI v2

[ aws . pi ]

list-available-resource-dimensions

Описание

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

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

Синтаксис

  list-available-resource-dimensions
--service-type <value>
--identifier <value>
--metrics <value>
[--max-results <value>]
[--next-token <value>]
[--authorized-actions <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]

Параметры

--service-type (строка)

Сервис Amazon Web Services, для которого Performance Insights возвращает метрики.

Возможные значения:

  • RDS
  • DOCDB

--identifier (строка)

Неизменяемый идентификатор источника данных, уникальный в регионе Amazon Web Services. Performance Insights собирает метрики из этого источника данных. Для использования экземпляра Amazon RDS DB в качестве источника данных укажите его значение DbiResourceId. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

--metrics (список)

Типы метрик, для которых необходимо получить размеры. Допустимые значения включают db.load.

(строка)

Универсальный строковый тип, запрещающий символы, которые могут подвергнуть наш сервис (или сервисы ниже по цепочке) риску уязвимости к инъекциям.

Синтаксис:

"string" "string" ...

--max-results (целое число)

Максимальное количество элементов, возвращаемых в ответе. Если существует больше элементов, чем указанное значение MaxRecords, в ответ включается маркер постраничной навигации, чтобы можно было получить оставшиеся результаты.

--next-token (строка)

Необязательный маркер постраничной навигации, предоставленный в предыдущем запросе. Если этот параметр указан, ответ включает только записи после маркера, до значения, указанного MaxRecords.

--authorized-actions (список)

Действия для обнаружения размеров, к которым вы имеете доступ. Если вы указываете несколько действий, ответ будет содержать размеры, общие для всех действий.

Если вы не указываете этот параметр запроса или предоставляете пустой список, ответ содержит все доступные размеры для целевого движка базы данных, независимо от того, имеете ли вы к ним доступ.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  DescribeDimensionKeys
  GetDimensionKeyDetails
  GetResourceMetrics

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для вывода размеров, которые можно запросить для типа метрики на экземпляре базы данных

В следующем примере list-available-resource-dimensions выводятся db.load метрики, которые можно запросить для базы данных db-abcdefg123456789.

aws pi list-available-resource-dimensions \
    --service-type RDS \
    --identifier db-abcdefg123456789 \
    --metrics db.load

Вывод:

{
    "MetricDimensions": [
        {
            "Metric": "db.load",
            "Groups": [
                {
                    "Group": "db.user",
                    "Dimensions": [
                        {
                            "Identifier": "db.user.id"
                        },
                        {
                            "Identifier": "db.user.name"
                        }
                    ]
                },
                {
                    "Group": "db.sql_tokenized",
                    "Dimensions": [
                        {
                            "Identifier": "db.sql_tokenized.id"
                        },
                        {
                            "Identifier": "db.sql_tokenized.db_id"
                        },
                        {
                            "Identifier": "db.sql_tokenized.statement"
                        }
                    ]
                },
                ...
            ]
        }
    ]
}

Дополнительную информацию о размерах в Performance Insights см. в разделах «Загрузка базы данных» в руководстве пользователя Amazon RDS и «Загрузка базы данных» в руководстве пользователя Amazon Aurora.

Вывод

MetricDimensions -> (список)

Возвращаемая информация о размерах для запрошенных типов метрик.

(структура)

Доступная информация о размерах для типа метрики.

Metric -> (строка)

Тип метрики, к которому относится информация о размерах.

Groups -> (список)

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

(структура)

Информация о размерах в группе размеров.

Group -> (строка)

Название группы размеров.

Dimensions -> (список)

Размеры в группе размеров.

(структура)

Информация о размере.

Identifier -> (строка)

Идентификатор размера.

NextToken -> (строка)

Необязательный маркер постраничной навигации, предоставленный в предыдущем запросе. Если этот параметр указан, ответ включает только записи после маркера, до значения, указанного MaxRecords.

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

Spec-Zone.ru

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