Spec-Zone.ru › AWS CLI v2

[ aws . ecs ]

update-task-protection

Описание

Обновляет состояние защиты задачи. Вы можете установить protectionEnabled на true, чтобы защитить свою задачу от завершения во время событий масштабирования из Service Autoscaling или развертываний.

Защита задачи по умолчанию истекает через 2 часа, после чего Amazon ECS очищает свойство protectionEnabled, делая задачу подходящей для завершения последующим событием масштабирования.

Вы можете указать настраиваемый срок действия защиты задачи от 1 минуты до 2880 минут (48 часов). Для указания настраиваемого срока действия установите свойство expiresInMinutes. Свойство expiresInMinutes всегда сбрасывается, когда вы вызываете эту операцию для задачи, для которой уже установлено protectionEnabled на true. Вы можете продолжать продлевать срок действия защиты задачи, неоднократно вызывая эту операцию.

Чтобы узнать больше о защите задач Amazon ECS, см. Защита от масштабирования задач в * Руководстве разработчика Amazon Elastic Container Service *.

Примечание

Данная операция поддерживается только для задач, принадлежащих сервису Amazon ECS. Вызов этой операции для автономной задачи приведет к ошибке TASK_NOT_VALID. Для получения дополнительной информации см. Причины ошибок API.

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

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

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

Синтаксис

  update-task-protection
--cluster <value>
--tasks <value>
--protection-enabled | --no-protection-enabled
[--expires-in-minutes <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]

Параметры

--cluster (строка)

Короткое имя или полное Amazon Resource Name (ARN) кластера, в котором находится сервис, в котором существуют наборы задач.

--tasks (список)

Список до 10 идентификаторов задач или полных записей ARN.

(строка)

Синтаксис:

"string" "string" ...

--protection-enabled | --no-protection-enabled (булево)

Укажите true, чтобы пометить задачу для защиты, и false, чтобы снять защиту, сделав ее подходящей для завершения.

--expires-in-minutes (целое число)

Если вы установите protectionEnabled на true, вы можете указать продолжительность защиты задачи в минутах. Вы можете указать значение от 1 минуты до 2880 минут (48 часов). В течение этого времени ваша задача не будет завершена событиями масштабирования из Service Auto Scaling или развертываний. По истечении этого периода protectionEnabled будет сброшен на false.

Если вы не укажете время, то задача автоматически защищается на 120 минут (2 часа).

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--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 в *Руководстве пользователя AWS CLI*.

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

Пример 1: Включение защиты задач для задач ECS

Следующая команда защищает задачу ECS от завершения во время масштабирования из развертываний или Service AutoScaling. Вы можете указать настраиваемый срок действия защиты задачи от 1 до 2880 минут (48 часов). Если вы не укажете срок действия, по умолчанию защита задач включится на 2 часа.

aws ecs update-task-protection \
    --cluster ECS-project-update-cluster \
    --tasks c43ed3b1331041f289316f958adb6a24 \
    --protection-enabled \
    --expires-in-minutes 300

Вывод:

{
"protectedTasks": [
    {
        "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
        "protectionEnabled": true,
        "expirationDate": "2024-09-14T19:53:36.687000-05:00"
    }
],
"failures": []
}

Пример 2: Отключение защиты задач для задач ECS

Следующая команда отключает защиту задач от масштабирования из развертываний или Service AutoScaling.

aws ecs update-task-protection \
    --cluster ECS-project-update-cluster \
    --tasks c43ed3b1331041f289316f958adb6a24 \
    --no-protection-enabled

Вывод:

{
    "protectedTasks": [
        {
            "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24",
            "protectionEnabled": false
        }
    ],
    "failures": []
}

Для получения дополнительной информации о защите задач см. Защита задач Amazon ECS от завершения событиями масштабирования в *Руководстве разработчика Amazon ECS*.

Вывод

protectedTasks -> (список)

Список задач с указанной информацией.

  • taskArn : ARN задачи.
  • protectionEnabled : Состояние защиты задачи. Если защита от масштабирования включена для задачи, значение равно true. В противном случае, оно равно false.
  • expirationDate : Эпохальное время истечения защиты для задачи.

(структура)

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

taskArn -> (строка)

ARN задачи.

protectionEnabled -> (булево)

Состояние защиты задачи. Если защита от масштабирования включена для задачи, значение равно true. В противном случае, оно равно false.

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

Эпохальное время истечения защиты для задачи.

failures -> (список)

Возможные ошибки, связанные с вызовом.

(структура)

Ошибка ресурса. Список распространенных причин см. в разделе Причины ошибок API в *Руководстве разработчика Amazon Elastic Container Service*.

arn -> (строка)

Amazon Resource Name (ARN) ошибочного ресурса.

reason -> (строка)

Причина ошибки.

detail -> (строка)

Подробности ошибки.

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

Spec-Zone.ru

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