describe-workspace-configuration
Описание
Используйте эту операцию для получения информации о конфигурации рабочей области. Возвращаемые данные о конфигурации включают состояние конфигурации рабочей области, пределы набора меток и срок хранения.
См. также: Документация API AWS
Синтаксис
describe-workspace-configuration
--workspace-id <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]
Параметры
--workspace-id (строка)
--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
- text
- таблица
- 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.
Вывод
workspaceConfiguration -> (структура)
Эта структура содержит информацию о конфигурации рабочей области.
limitsPerLabelSet -> (список)
Это массив структур, где каждая структура отображает один набор меток для рабочей области и пределы для этого набора меток.
(структура)
Эта структура определяет один набор меток, используемый для принудительного ограничения активных временных рядов для рабочей области, и определяет предел для этого набора меток.
Набор меток — это уникальное сочетание пар «метка-значение». Используйте их для управления ограничениями временных рядов и мониторинга использования определенными группами меток. Примеры наборов меток могут быть team:finance или env:prod
labelSet -> (массив)
Это определяет один набор меток, для которого будет принудительно установлено ограничение активных временных рядов.
Значения меток принимают символы ASCII и должны содержать хотя бы один символ, который не является пробелом. Символы управления ASCII не принимаются. Если имя метки — имя метрики __*name* __, то часть метрика имени должна соответствовать следующему шаблону: [a-zA-Z_:][a-zA-Z0-9_:]*
key -> (строка)
value -> (строка)
limits -> (структура)
Эта структура содержит информацию об ограничениях, которые применяются к временным рядам, соответствующим этому набору меток.
maxSeries -> (длинное целое число)
Максимальное количество активных временных рядов, которые могут быть обработаны, соответствующие этому набору меток.
Установка этого значения в 0 приводит к тому, что ограничение наборов меток не применяется, но это заставляет Amazon Managed Service for Prometheus отправлять метрики наборов меток в CloudWatch
retentionPeriodInDays -> (целое число)
status -> (структура)
Эта структура отображает текущее состояние конфигурации рабочей области и может также содержать причину этого состояния.
statusCode -> (строка)
statusReason -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.