Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-ops-items

Описание

Запрос набора OpsItems. Вы должны иметь разрешение в Identity and Access Management (IAM) для запроса списка OpsItems. Дополнительную информацию см. в разделе Настройка OpsCenter в руководстве пользователя Amazon Web Services Systems Manager.

Инженеры по работе с операциями и ИТ-специалисты используют Amazon Web Services Systems Manager OpsCenter для просмотра, исследования и устранения операционных проблем, влияющих на производительность и состояние ресурсов Amazon Web Services. Дополнительную информацию см. в разделе Amazon Web Services Systems Manager OpsCenter в руководстве пользователя Amazon Web Services Systems Manager.

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

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

Синтаксис

  describe-ops-items
[--ops-item-filters <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]

Параметры

--ops-item-filters (список)

Один или несколько фильтров для ограничения ответа.

  • Ключ: CreatedTime Операции: Больше, Меньше
  • Ключ: LastModifiedBy Операции: Содержит, Равно
  • Ключ: LastModifiedTime Операции: Больше, Меньше
  • Ключ: Priority Операции: Равно
  • Ключ: Source Операции: Содержит, Равно
  • Ключ: Status Операции: Равно
  • Ключ: Title* Операции: Равно,Содержит
  • Ключ: OperationalData** Операции: Равно
  • Ключ: OperationalDataKey Операции: Равно
  • Ключ: OperationalDataValue Операции: Равно, Содержит
  • Ключ: OpsItemId Операции: Равно
  • Ключ: ResourceId Операции: Содержит
  • Ключ: AutomationId Операции: Равно
  • Ключ: AccountId Операции: Равно

*Оператор Равно для Title соответствует первым 100 символам. Если вы укажете более 100 символов, система вернёт ошибку, что значение фильтра превышает предел длины.

**Если вы фильтруете ответ с помощью оператора OperationalData, укажите пару ключ-значение, используя следующий формат JSON: {“key”:”key_name”,”value”:”a_value”}

(структура)

Описание фильтра OpsItem.

Key -> (строка)

Имя фильтра.

Values -> (список)

Значение фильтра.

(строка)

Operator -> (строка)

Оператор, используемый в вызове фильтра.

Сокращённый синтаксис:

Key=string,Values=string,string,Operator=string ...

Синтаксис JSON:

[
  {
    "Key": "Status"|"CreatedBy"|"Source"|"Priority"|"Title"|"OpsItemId"|"CreatedTime"|"LastModifiedTime"|"ActualStartTime"|"ActualEndTime"|"PlannedStartTime"|"PlannedEndTime"|"OperationalData"|"OperationalDataKey"|"OperationalDataValue"|"ResourceId"|"AutomationId"|"Category"|"Severity"|"OpsItemType"|"AccessRequestByRequesterArn"|"AccessRequestByRequesterId"|"AccessRequestByApproverArn"|"AccessRequestByApproverId"|"AccessRequestBySourceAccountId"|"AccessRequestBySourceOpsItemId"|"AccessRequestBySourceRegion"|"AccessRequestByIsReplica"|"AccessRequestByTargetResourceId"|"ChangeRequestByRequesterArn"|"ChangeRequestByRequesterName"|"ChangeRequestByApproverArn"|"ChangeRequestByApproverName"|"ChangeRequestByTemplate"|"ChangeRequestByTargetsResourceGroup"|"InsightByType"|"AccountId",
    "Values": ["string", ...],
    "Operator": "Equal"|"Contains"|"GreaterThan"|"LessThan"
  }
  ...
]

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

Примеры

Примечание

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

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

Для отображения набора OpsItems

В следующем примере describe-ops-items отображается список всех открытых OpsItems в вашей учётной записи AWS.

aws ssm describe-ops-items \
    --ops-item-filters "Key=Status,Values=Open,Operator=Equal"

Вывод:

{
    "OpsItemSummaries": [
        {
            "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "CreatedTime": "2020-03-14T17:02:46.375000-07:00",
            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "LastModifiedTime": "2020-03-14T17:02:46.375000-07:00",
            "Source": "SSM",
            "Status": "Open",
            "OpsItemId": "oi-7cfc5EXAMPLE",
            "Title": "SSM Maintenance Window execution failed",
            "OperationalData": {
                "/aws/dedup": {
                    "Value": "{\"dedupString\":\"SSMOpsItems-SSM-maintenance-window-execution-failed\"}",
                    "Type": "SearchableString"
                },
                "/aws/resources": {
                    "Value": "[{\"arn\":\"arn:aws:ssm:us-east-2:111222333444:maintenancewindow/mw-034093d322EXAMPLE\"}]",
                    "Type": "SearchableString"
                }
            },
            "Category": "Availability",
            "Severity": "3"
        },
        {
            "CreatedBy": "arn:aws:sts::1112223233444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "CreatedTime": "2020-02-26T11:43:15.426000-08:00",
            "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
            "LastModifiedTime": "2020-02-26T11:43:15.426000-08:00",
            "Source": "EC2",
            "Status": "Open",
            "OpsItemId": "oi-6f966EXAMPLE",
            "Title": "EC2 instance stopped",
            "OperationalData": {
                "/aws/automations": {
                    "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-RestartEC2Instance\" } ]",
                    "Type": "SearchableString"
                },
                "/aws/dedup": {
                    "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-stopped\"}",
                    "Type": "SearchableString"
                },
                "/aws/resources": {
                    "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-0beccfbc02EXAMPLE\"}]",
                    "Type": "SearchableString"
                }
            },
            "Category": "Availability",
            "Severity": "3"
        }
    ]
}

Дополнительную информацию см. в разделе Работа с OpsItems в руководстве пользователя AWS Systems Manager.

Вывод

NextToken -> (строка)

Токен для следующего набора элементов для возврата. Используйте этот токен для получения следующего набора результатов.

OpsItemSummaries -> (список)

Список OpsItems.

(структура)

Количество OpsItems.

CreatedBy -> (строка)

Идентификатор ресурса Amazon (ARN) сущности IAM, которая создала OpsItem.

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

Дата и время создания OpsItem.

LastModifiedBy -> (строка)

Идентификатор ресурса Amazon (ARN) сущности IAM, которая создала OpsItem.

LastModifiedTime -> (временная метка)

Дата и время последнего обновления OpsItem.

Priority -> (целое число)

Важность данного OpsItem по отношению к другим OpsItems в системе.

Source -> (строка)

Затронутый ресурс Amazon Web Services.

Status -> (строка)

Статус OpsItem.

OpsItemId -> (строка)

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

Title -> (строка)

Короткое заголовок, описывающий характер OpsItem и затронутого ресурса.

OperationalData -> (словарь)

Операционные данные — это пользовательские данные, которые предоставляют полезные справочные сведения об OpsItem.

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

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

Объект, определяющий значение ключа и его тип в словаре OperationalData.

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

Значение ключа OperationalData.

Тип -> (строка)

Тип пары ключ-значение. Допустимые типы включают SearchableString и String.

Category -> (строка)

Список OpsItems по категориям.

Severity -> (строка)

Список OpsItems по уровню критичности.

OpsItemType -> (строка)

Тип OpsItem. Systems Manager поддерживает следующие типы OpsItems:

  • /aws/issue Этот тип OpsItem используется для стандартных OpsItems, созданных OpsCenter.
  • /aws/changerequest Этот тип OpsItem используется Change Manager для проверки и утверждения или отклонения запросов на изменения.
  • /aws/insight Этот тип OpsItem используется OpsCenter для агрегирования и отчетности о дублирующих OpsItems.

ActualStartTime -> (временная метка)

Время начала работы потока рабочей книги. В настоящее время отображается только для типа OpsItem /aws/changerequest.

ActualEndTime -> (временная метка)

Время завершения работы потока рабочей книги. В настоящее время отображается только для типа OpsItem /aws/changerequest.

PlannedStartTime -> (временная метка)

Время, указанное в запросе на изменение, для начала потока рабочей книги. В настоящее время поддерживается только для типа OpsItem /aws/changerequest.

PlannedEndTime -> (временная метка)

Время, указанное в запросе на изменение, для завершения потока рабочей книги. В настоящее время поддерживается только для типа OpsItem /aws/changerequest.

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

Spec-Zone.ru

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