Spec-Zone.ru › AWS CLI v2

[ aws . application-signals ]

list-service-level-objectives

Описание

Возвращает список SLO, созданных в данной учетной записи.

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

list-service-level-objectives является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: SloSummaries

Синтаксис

  list-service-level-objectives
[--key-attributes <value>]
[--operation-name <value>]
[--dependency-config <value>]
[--metric-source-types <value>]
[--include-linked-accounts | --no-include-linked-accounts]
[--slo-owner-aws-account-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--key-attributes (отображение)

Вы можете использовать это необязательное поле для указания, для каких сервисов вы хотите получить информацию об SLO.

Это отображение строка-строка. Оно может содержать следующие поля.

  • Type обозначает тип объекта.
  • ResourceType определяет тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
  • Name указывает имя объекта. Это используется только если значение поля Type равно Service, RemoteService или AWS::Service.
  • Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только если значение поля Type равно Resource или AWS::Resource.
  • Environment указывает место размещения этого объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

Краткая запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--operation-name (строка)

Имя операции, с которой связан этот SLO.

--dependency-config (структура)

Идентифицирует зависимость, используя DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (отображение)

Это отображение строка-строка. Оно может содержать следующие поля.

  • Type обозначает тип объекта.
  • ResourceType определяет тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
  • Name указывает имя объекта. Это используется только если значение поля Type равно Service, RemoteService или AWS::Service.
  • Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только если значение поля Type равно Resource или AWS::Resource.
  • Environment указывает место размещения этого объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

Краткая запись:

DependencyKeyAttributes={KeyName1=string,KeyName2=string},DependencyOperationName=string

Синтаксис JSON:

{
  "DependencyKeyAttributes": {"string": "string"
    ...},
  "DependencyOperationName": "string"
}

--metric-source-types (список)

Используйте это необязательное поле, чтобы включить в вывод только SLO с указанными типами источников метрик. Поддерживаемые типы:

  • Операция сервиса
  • Зависимость сервиса
  • Метрика CloudWatch

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  ServiceOperation
  CloudWatchMetric
  ServiceDependency

--include-linked-accounts | --no-include-linked-accounts (логическое значение)

Если вы используете эту операцию в учетной записи мониторинга, укажите true, чтобы включить SLO из исходных учетных записей в возвращаемые данные. </p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p>

--slo-owner-aws-account-id (строка)

Идентификатор учетной записи Amazon Web Services SLO.

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

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

Токен для указания, с чего начать постраничный запрос. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный доступ в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS сервиса.

Примеры использования см. в разделе Постраничный доступ в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничного доступа предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Постраничный доступ в Руководстве пользователя AWS Command Line Interface.

--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.

Вывод

SloSummaries -> (список)

Массив структур, где каждая структура содержит информацию об одном SLO.

(структура)

Структура, содержащая информацию об одном объективе уровня обслуживания (SLO), созданном в Application Signals.

Arn -> (строка)

ARN этого объектива уровня обслуживания.

Name -> (строка)

Имя объектива уровня обслуживания.

KeyAttributes -> (карта)

Это карта строка-строка. Она может содержать следующие поля.

  • Type указывает тип объекта, для которого предназначен этот объектив уровня обслуживания.
  • ResourceType указывает тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
  • Name указывает имя объекта. Это используется только в том случае, если значение поля Type равно Service, RemoteService или AWS::Service.
  • Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
  • Environment указывает местоположение размещения этого объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

OperationName -> (строка)

Если этот объектив уровня обслуживания специфичен для одной операции, это поле отображает имя этой операции.

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

Идентифицирует зависимость, используя DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (карта)

Это карта строка-строка. Она может содержать следующие поля.

  • Type указывает тип объекта.
  • ResourceType указывает тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
  • Name указывает имя объекта. Это используется только в том случае, если значение поля Type равно Service, RemoteService или AWS::Service.
  • Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
  • Environment указывает местоположение размещения этого объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

CreatedTime -> (метка времени)

Дата и время создания этого объектива уровня обслуживания. Она выражается в миллисекундах с начала 1 января 1970 года 00:00:00 по UTC.

EvaluationType -> (строка)

Отображает, является ли это SLO на основе периода или на основе запроса.

MetricSourceType -> (строка)

Отображает тип источника метрики SLI для этого SLO. Поддерживаемые типы:

  • Операция сервиса
  • Зависимость сервиса
  • Метрика CloudWatch

NextToken -> (строка)

Включите это значение в ваш следующий запрос к этому API, чтобы получить следующий набор объективов уровня обслуживания.

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

Spec-Zone.ru

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