Spec-Zone.ru › AWS CLI v2

[ aws . fis ]

start-experiment

Описание

Запускает выполнение эксперимента из указанной шаблона эксперимента.

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

Синтаксис

  start-experiment
[--client-token <value>]
--experiment-template-id <value>
[--experiment-options <value>]
[--tags <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]

Параметры

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса.

--experiment-template-id (строка)

Идентификатор шаблона эксперимента.

--experiment-options (структура)

Параметры эксперимента для запуска эксперимента.

actionsMode -> (строка)

Определяет режим действий для параметров эксперимента.

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

actionsMode=string

Синтаксис JSON:

{
  "actionsMode": "skip-all"|"run-all"
}

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

Теги для применения к эксперименту.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--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 для вывода.

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

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

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

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

Примеры

Примечание

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

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

Для запуска эксперимента

Следующий start-experiment пример запускает указанный эксперимент.

aws fis start-experiment \
    --experiment-template-id ABCDE1fgHIJkLmNop

Вывод:

{
    "experiment": {
        "id": "ABC12DeFGhI3jKLMNOP",
        "experimentTemplateId": "ABCDE1fgHIJkLmNop",
        "roleArn": "arn:aws:iam::123456789012:role/myRole",
        "state": {
            "status": "initiating",
            "reason": "Experiment is initiating."
        },
        "targets": {
            "Instances-Target-1": {
                "resourceType": "aws:ec2:instance",
                "resourceArns": [
                    "arn:aws:ec2:us-west-2:123456789012:instance/i-12a3b4c56d78e9012"
                ],
                "selectionMode": "ALL"
            }
        },
        "actions": {
            "reboot": {
                "actionId": "aws:ec2:reboot-instances",
                "parameters": {},
                "targets": {
                    "Instances": "Instances-Target-1"
                },
                "state": {
                    "status": "pending",
                    "reason": "Initial state"
                }
            }
        },
        "stopConditions": [
            {
                "source": "none"
            }
        ],
        "creationTime": 1616432464.025,
        "startTime": 1616432464.374,
        "tags": {}
    }
}

Для получения дополнительной информации см. Эксперименты для AWS FIS в Руководстве пользователя AWS Fault Injection Simulator.

Вывод

эксперимент -> (структура)

Информация об эксперименте.

id -> (строка)

Идентификатор эксперимента.

arn -> (строка)

Amazon Resource Name (ARN) эксперимента.

experimentTemplateId -> (строка)

Идентификатор шаблона эксперимента.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM, предоставляющей службе FIS разрешение на выполнение действий службы от вашего имени.

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

Состояние эксперимента.

status -> (строка)

Состояние эксперимента.

reason -> (строка)

Причина состояния.

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

Информация об ошибке эксперимента, когда действие имеет failed .

accountId -> (строка)

Идентификатор учетной записи Amazon Web Services, где произошла ошибка эксперимента.

code -> (строка)

Код ошибки неудачного эксперимента.

location -> (строка)

Контекст раздела шаблона эксперимента, который завершился ошибкой.

targets -> (массив)

Цели эксперимента.

key -> (строка)

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

Описание цели эксперимента.

resourceType -> (строка)

Тип ресурса.

resourceArns -> (список)

Amazon Resource Names (ARN) ресурсов.

(строка)

resourceTags -> (массив)

Теги целевых ресурсов.

key -> (строка)

value -> (строка)

filters -> (список)

Фильтры для определения целевых ресурсов с помощью определенных атрибутов.

(структура)

Описание фильтра, используемого для целевых ресурсов в эксперименте.

path -> (строка)

Путь к атрибуту для фильтра.

values -> (список)

Значения атрибутов для фильтра.

(строка)

selectionMode -> (строка)

Ограничивает идентифицированные ресурсы до определенного количества или процента.

parameters -> (массив)

Параметры типа ресурса.

key -> (строка)

value -> (строка)

actions -> (массив)

Действия эксперимента.

key -> (строка)

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

Описание действия для эксперимента.

actionId -> (строка)

Идентификатор действия.

description -> (строка)

Описание действия.

parameters -> (массив)

Параметры действия.

key -> (строка)

value -> (строка)

targets -> (массив)

Цели действия.

key -> (строка)

value -> (строка)

startAfter -> (список)

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

(строка)

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

Состояние действия.

status -> (строка)

Состояние действия.

reason -> (строка)

Причина состояния.

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

Время начала действия.

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

Время завершения действия.

stopConditions -> (список)

Условия остановки эксперимента.

(структура)

Описание условия остановки эксперимента.

source -> (строка)

Источник условия остановки.

value -> (строка)

Amazon Resource Name (ARN) сигнализации CloudWatch, если применимо.

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

Время создания эксперимента.

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

Время начала эксперимента.

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

Время завершения эксперимента.

tags -> (массив)

Теги эксперимента.

key -> (строка)

value -> (строка)

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

Настройка ведения журнала эксперимента.

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

Настройка ведения журнала эксперимента в Amazon CloudWatch Logs.

logGroupArn -> (строка)

Amazon Resource Name (ARN) целевой группы журнала Amazon CloudWatch Logs.

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

Настройка ведения журнала эксперимента в Amazon S3.

bucketName -> (строка)

Имя целевого ведра.

prefix -> (строка)

Префикс ведра.

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

Версия схемы.

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

Параметры эксперимента.

accountTargeting -> (строка)

Параметр настройки целевых учетных записей.

emptyTargetResolutionMode -> (строка)

Режим обработки пустых целевых ресурсов.

actionsMode -> (строка)

Режим действий эксперимента, заданный командой API StartExperiment.

targetAccountConfigurationsCount -> (длинное число)

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

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

Настройка отчета об эксперименте.

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

Пункты назначения отчета об эксперименте.

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

Пункт назначения S3 для отчета об эксперименте.

bucketName -> (строка)

Имя ведра S3, где будет храниться отчет об эксперименте.

prefix -> (строка)

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

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

Источники данных для отчета об эксперименте.

cloudWatchDashboards -> (список)

CloudWatch панели мониторинга для включения в качестве источников данных в отчете об эксперименте.

(структура)

Указывает CloudWatch панель мониторинга для включения в отчет об эксперименте. Графики виджетов панели будут запечатлены как моментальные снимки в отчете.

dashboardIdentifier -> (строка)

Amazon Resource Name (ARN) CloudWatch панели мониторинга для включения в отчет об эксперименте.

preExperimentDuration -> (строка)

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

postExperimentDuration -> (строка)

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

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

Отчет об эксперименте.

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

Состояние отчета об эксперименте.

status -> (строка)

Состояние генерации отчета об эксперименте.

reason -> (строка)

Причина состояния генерации отчета об эксперименте.

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

Информация об ошибке при генерации отчета об эксперименте.

code -> (строка)

Код ошибки генерации отчета об эксперименте.

s3Reports -> (список)

Пункт назначения S3 для отчета об эксперименте.

(структура)

Описание пункта назначения S3 для отчета.

arn -> (строка)

Amazon Resource Name (ARN) сгенерированного отчета.

reportType -> (строка)

Тип отчета.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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