Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

get-ops-item

Описание

Получение информации об элементе OpsItem по его идентификатору. Для просмотра информации об элементе OpsItem требуется разрешение в Identity and Access Management (IAM). Дополнительную информацию см. в разделе Настройка OpsCenter в руководстве Amazon Web Services Systems Manager User Guide.

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

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

Синтаксис

  get-ops-item
--ops-item-id <value>
[--ops-item-arn <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]

Параметры

--ops-item-id (строка)

Идентификатор элемента OpsItem, который требуется получить.

--ops-item-arn (строка)

Amazon Resource Name (ARN) элемента OpsItem.

--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 (логическое значение)

Отключить тулбар AWS CLI для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для просмотра информации об элементе OpsItem

Следующий get-ops-item пример отображает подробности о заданном элементе OpsItem.

aws ssm get-ops-item \
    --ops-item-id oi-0b725EXAMPLE

Вывод:

{
    "OpsItem": {
        "CreatedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
        "CreatedTime": "2019-12-04T15:52:16.793000-08:00",
        "Description": "CloudWatch Event Rule SSMOpsItems-EC2-instance-terminated was triggered. Your EC2 instance has terminated. See below for more details.",
        "LastModifiedBy": "arn:aws:sts::111222333444:assumed-role/OpsItem-CWE-Role/fbf77cbe264a33509569f23e4EXAMPLE",
        "LastModifiedTime": "2019-12-04T15:52:16.793000-08:00",
        "Notifications": [],
        "RelatedOpsItems": [],
        "Status": "Open",
        "OpsItemId": "oi-0b725EXAMPLE",
        "Title": "EC2 instance terminated",
        "Source": "EC2",
        "OperationalData": {
            "/aws/automations": {
                "Value": "[ { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedWindowsInstance\" }, { \"automationType\": \"AWS:SSM:Automation\", \"automationId\": \"AWS-CreateManagedLinuxInstance\" } ]",
                "Type": "SearchableString"
            },
            "/aws/dedup": {
                "Value": "{\"dedupString\":\"SSMOpsItems-EC2-instance-terminated\"}",
                "Type": "SearchableString"
            },
            "/aws/resources": {
                "Value": "[{\"arn\":\"arn:aws:ec2:us-east-2:111222333444:instance/i-05adec7e97EXAMPLE\"}]",
                "Type": "SearchableString"
            },
            "event-time": {
                "Value": "2019-12-04T23:52:16Z",
                "Type": "String"
            },
            "instance-state": {
                "Value": "terminated",
                "Type": "String"
            }
        },
        "Category": "Availability",
        "Severity": "4"
    }
}

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

Вывод

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

Элемент OpsItem.

CreatedBy -> (строка)

Идентификатор ARN учетной записи Amazon Web Services, создавшей OpsItem.

OpsItemType -> (строка)

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

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

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

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

Description -> (строка)

Описание OpsItem.

LastModifiedBy -> (строка)

Идентификатор ARN учетной записи Amazon Web Services, которая последней обновила OpsItem.

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

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

Notifications -> (список)

Идентификатор ARN (Amazon Resource Name) темы Amazon Simple Notification Service (Amazon SNS), куда отправляются уведомления при редактировании или изменении этого OpsItem.

(структура)

Уведомление об OpsItem.

Arn -> (строка)

Идентификатор ARN (Amazon Resource Name) темы Amazon Simple Notification Service (Amazon SNS), куда отправляются уведомления при редактировании или изменении этого OpsItem.

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

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

RelatedOpsItems -> (список)

Один или несколько OpsItem, имеющих общие черты с текущим OpsItem. Например, связанные OpsItem могут включать OpsItem с похожими сообщениями об ошибках, затронутыми ресурсами или состояниями затронутого ресурса.

(структура)

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

OpsItemId -> (строка)

Идентификатор OpsItem, связанного с текущим OpsItem.

Status -> (строка)

Состояние OpsItem. Более подробную информацию см. в разделе Редактирование подробностей OpsItem в руководстве пользователя Amazon Web Services Systems Manager.

OpsItemId -> (строка)

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

Version -> (строка)

Версия этого OpsItem. Каждый раз при редактировании OpsItem номер версии увеличивается на единицу.

Title -> (строка)

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

Source -> (строка)

Источник OpsItem, например, Amazon EC2 или Systems Manager. Затронутый ресурс является подмножеством источника.

OperationalData -> (карта)

Операционные данные — это пользовательские данные, которые предоставляют полезные справочные сведения об OpsItem. Например, вы можете указать файлы журналов, строки ошибок, ключи лицензий, советы по устранению неполадок или другие релевантные данные. Вы вводите операционные данные в виде пар «ключ-значение». Длина ключа составляет максимум 128 символов. Размер значения — максимум 20 КБ.

Предупреждение

Ключи операционных данных не могут начинаться со следующих: amazon , aws , amzn , ssm , /amazon , /aws , /amzn , /ssm .

Вы можете сделать данные доступными для поиска другим пользователям в аккаунте или ограничить доступ к поиску. Поисковые данные означают, что все пользователи с доступом к странице обзора OpsItem (предоставляемой операцией API DescribeOpsItems) могут просматривать и искать указанные данные. Операционные данные, которые недоступны для поиска, могут просматриваться только пользователями, имеющими доступ к OpsItem (предоставляемый операцией API GetOpsItem).

Используйте ключ /aws/resources в OperationalData для указания связанного ресурса в запросе. Используйте ключ /aws/automations в OperationalData для связывания рабочего процесса Automation с OpsItem. Примеры команд Amazon Web Services CLI, которые используют эти ключи, см. в разделе Руководство по созданию OpsItem вручную в руководстве пользователя Amazon Web Services Systems Manager.

key -> (строка)

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

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

Value -> (строка)

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

Type -> (строка)

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

Category -> (строка)

Категория OpsItem. Доступные категории: Доступность, Стоимость, Производительность, Восстановление, Безопасность.

Severity -> (строка)

Степень важности OpsItem. Варианты степени важности — от 1 до 4.

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

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

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

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

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

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

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

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

OpsItemArn -> (строка)

Идентификатор ARN (Amazon Resource Name) OpsItem.

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

Spec-Zone.ru

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