register-container-instance

Описание

Примечание

Данное действие используется только агентом Amazon ECS и не предназначено для использования вне агента.

Регистрирует экземпляр EC2 в указанном кластере. Этот экземпляр станет доступным для размещения контейнеров.

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

Синтаксис

  register-container-instance
[--cluster <value>]
[--instance-identity-document <value>]
[--instance-identity-document-signature <value>]
[--total-resources <value>]
[--version-info <value>]
[--container-instance-arn <value>]
[--attributes <value>]
[--platform-devices <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]

Параметры

--cluster (строка)

Короткое имя или полное имя Amazon Resource Name (ARN) кластера, с которым вы хотите зарегистрировать свой контейнерный экземпляр. Если кластер не указан, используется кластер по умолчанию.

--instance-identity-document (строка)

Документ идентификации экземпляра для экземпляра EC2, который нужно зарегистрировать. Этот документ можно найти, выполнив следующую команду на экземпляре: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

--instance-identity-document-signature (строка)

Подпись документа идентификации экземпляра для экземпляра EC2, который нужно зарегистрировать. Эту подпись можно найти, выполнив следующую команду на экземпляре: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

--total-resources (список)

Доступные ресурсы на экземпляре.

(структура)

Описывает доступные ресурсы для контейнерного экземпляра.

name -> (строка)

Имя ресурса, например, CPU , MEMORY , PORTS , PORTS_UDP или пользовательский ресурс.

type -> (строка)

Тип ресурса. Допустимые значения: INTEGER , DOUBLE , LONG или STRINGSET .

doubleValue -> (двойное)

Когда тип doubleValue установлен, значение ресурса должно быть типом с плавающей запятой двойной точности.

longValue -> (длинное)

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

integerValue -> (целое)

Когда тип integerValue установлен, значение ресурса должно быть целым числом.

stringSetValue -> (список)

Когда тип stringSetValue установлен, значение ресурса должно быть строковым типом.

(строка)

Краткая форма:

name=string,type=string,doubleValue=double,longValue=long,integerValue=integer,stringSetValue=string,string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "type": "string",
    "doubleValue": double,
    "longValue": long,
    "integerValue": integer,
    "stringSetValue": ["string", ...]
  }
  ...
]

--version-info (структура)

Информация о версии агента Amazon ECS для контейнеров и демона Docker, работающих на экземпляре контейнера.

agentVersion -> (строка)

Номер версии агента Amazon ECS для контейнеров.

agentHash -> (строка)

Хэш Git коммита для сборки агента Amazon ECS для контейнеров на репозитории GitHub amazon-ecs-agent.

dockerVersion -> (строка)

Версия Docker, работающая на экземпляре контейнера.

Краткая форма:

agentVersion=string,agentHash=string,dockerVersion=string

Синтаксис JSON:

{
  "agentVersion": "string",
  "agentHash": "string",
  "dockerVersion": "string"
}

--container-instance-arn (строка)

ARN экземпляра контейнера (если он был зарегистрирован ранее).

--attributes (список)

Атрибуты экземпляра контейнера, поддерживаемые этим экземпляром.

(структура)

Атрибут — это пара «имя-значение», связанная с объектом Amazon ECS. Используйте атрибуты, чтобы расширить модель данных Amazon ECS, добавив пользовательские метаданные в свои ресурсы. Дополнительную информацию см. в разделе Атрибуты в руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя атрибута. name должно содержать от 1 до 128 символов. Имя может содержать буквы (строчные и прописные), цифры, дефисы (-), нижние подчеркивания (_), косые черты (/), обратные косые черты (), или точки (.).

value -> (строка)

Значение атрибута. value должно содержать от 1 до 128 символов. Оно может содержать буквы (строчные и прописные), цифры, дефисы (-), нижние подчеркивания (_), точки (.), знаки «@», косые черты (/), обратные косые черты (), двоеточия (:) или пробелы. Значение не может начинаться или заканчиваться пробелом.

targetType -> (строка)

Тип целевого объекта для присоединения атрибута. Этот параметр необходим, если вы используете короткий идентификатор ресурса вместо полного ARN.

targetId -> (строка)

Идентификатор целевого объекта. Вы можете указать короткий идентификатор ресурса или полное имя Amazon Resource Name (ARN).

Краткая форма:

name=string,value=string,targetType=string,targetId=string ...

Синтаксис JSON:

[
  {
    "name": "string",
    "value": "string",
    "targetType": "container-instance",
    "targetId": "string"
  }
  ...
]

--platform-devices (список)

Устройства, доступные на экземпляре контейнера. Поддерживается только тип устройства GPU.

(структура)

Устройства, доступные на экземпляре контейнера. Поддерживается только тип устройства GPU.

id -> (строка)

Идентификатор GPU на экземпляре контейнера. Доступные идентификаторы GPU также можно получить на экземпляре контейнера в файле /var/lib/ecs/gpu/nvidia_gpu_info.json.

type -> (строка)

Тип устройства, доступного на экземпляре контейнера. Единственное поддерживаемое значение — GPU.

Краткая форма:

id=string,type=string ...

Синтаксис JSON:

[
  {
    "id": "string",
    "type": "GPU"
  }
  ...
]

--tags (список)

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

Следующие базовые ограничения применяются к тегам:

Максимальное количество тегов на ресурс — 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа — 128 символов Юникода в UTF-8
Максимальная длина значения — 256 символов Юникода в UTF-8
Если ваша схема тегирования используется в нескольких сервисах и ресурсах, имейте в виду, что другие сервисы могут иметь ограничения на разрешенные символы. В общем случае разрешены буквы, цифры, пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws: , AWS: или любую комбинацию верхнего/нижнего регистра таких префиксов для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете ограничений тегов на ресурс.

(структура)

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

Следующие базовые ограничения применяются к тегам:

Максимальное количество тегов на ресурс — 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа — 128 символов Юникода в UTF-8
Максимальная длина значения — 256 символов Юникода в UTF-8
Если ваша схема тегирования используется в нескольких сервисах и ресурсах, имейте в виду, что другие сервисы могут иметь ограничения на разрешенные символы. В общем случае разрешены буквы, цифры, пробелы, представимые в UTF-8, а также следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws: , AWS: или любую комбинацию верхнего/нижнего регистра таких префиксов для ключей или значений, так как они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете ограничений тегов на ресурс.

key -> (строка)

Часть пары «ключ-значение», составляющей тег. Ключ — это общий ярлык, который выступает в качестве категории для более специфичных значений тегов.

value -> (строка)

Необязательная часть пары «ключ-значение», составляющей тег. Значение действует как описание в категории тега (ключ).

Краткая форма:

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "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 (boolean)

Включить отладку регистрации.

--endpoint-url (string)

Переопределить URL команды по умолчанию на указанный URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод с помощью кли-пейджера.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

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

Регистрируемый экземпляр контейнера.

containerInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра контейнера. Дополнительную информацию о формате ARN см. в разделе Amazon Resource Name (ARN) в руководстве разработчика Amazon ECS.

ec2InstanceId -> (строка)

Идентификатор экземпляра контейнера. Для экземпляров Amazon EC2 это идентификатор экземпляра Amazon EC2. Для внешних экземпляров это идентификатор управляемого экземпляра Amazon Web Services Systems Manager.

capacityProviderName -> (строка)

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

version -> (длинное целое)

Счётчик версий экземпляра контейнера. Каждый раз, когда в экземпляре контейнера происходят изменения, которые запускают событие CloudWatch, счётчик версий увеличивается. Если вы реплицируете состояние экземпляра контейнера Amazon ECS с помощью CloudWatch Events, вы можете сравнить версию экземпляра контейнера, сообщённую API Amazon ECS, с версией, сообщённой в CloudWatch Events для экземпляра контейнера (внутри объекта detail), чтобы убедиться, что версия в вашем потоке событий актуальна.

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

Информация о версии агента Amazon ECS и демона Docker, работающих на экземпляре контейнера.

agentVersion -> (строка)

Номер версии агента Amazon ECS контейнера.

agentHash -> (строка)

Хэш Git коммита сборки агента Amazon ECS контейнера на GitHub-репозитории amazon-ecs-agent.

dockerVersion -> (строка)

Версия Docker, работающая на экземпляре контейнера.

remainingResources -> (список)

Для типов ресурсов CPU и памяти этот параметр описывает оставшийся CPU и память, которые ещё не были выделены задачам и, следовательно, доступны для новых задач. Для типов ресурсов портов этот параметр описывает порты, которые были зарезервированы агентом Amazon ECS контейнера (во время регистрации экземпляра) и контейнерами задач, которые зарезервировали сопоставления портов на хосте (с использованием сетевого режима host или bridge). Любой порт, который здесь не указан, доступен для новых задач.

(структура)

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

name -> (строка)

Название ресурса, например CPU , MEMORY , PORTS , PORTS_UDP или пользовательский ресурс.

type -> (строка)

Тип ресурса. Допустимые значения: INTEGER , DOUBLE , LONG или STRINGSET.

doubleValue -> (двойное число)

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

longValue -> (длинное целое)

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

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

Если тип integerValue задан, значение ресурса должно быть целым числом.

stringSetValue -> (список)

Если тип stringSetValue задан, значение ресурса должно быть строкой.

(строка)

registeredResources -> (список)

Для типов ресурсов CPU и памяти этот параметр описывает количество каждого ресурса, которое было доступно на экземпляре контейнера, когда агент контейнера зарегистрировал его в Amazon ECS. Это значение представляет собой общее количество CPU и памяти, которое может быть выделено на этом экземпляре контейнера для задач. Для типов ресурсов портов этот параметр описывает порты, которые были зарезервированы агентом Amazon ECS контейнера, когда он зарегистрировал экземпляр контейнера в Amazon ECS.

(структура)

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

name -> (строка)

Название ресурса, например CPU , MEMORY , PORTS , PORTS_UDP или пользовательский ресурс.

type -> (строка)

Тип ресурса. Допустимые значения: INTEGER , DOUBLE , LONG или STRINGSET.

doubleValue -> (двойное число)

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

longValue -> (длинное целое)

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

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

Если тип integerValue задан, значение ресурса должно быть целым числом.

stringSetValue -> (список)

Если тип stringSetValue задан, значение ресурса должно быть строкой.

(строка)

status -> (строка)

Статус экземпляра контейнера. Допустимые значения: REGISTERING , REGISTRATION_FAILED , ACTIVE , INACTIVE , DEREGISTERING или DRAINING.

Если ваш аккаунт включил настройку аккаунта awsvpcTrunking, то любой новый зарегистрированный экземпляр контейнера перейдёт в состояние REGISTERING, пока для экземпляра не будет предоставлен trunk elastic network interface. Если регистрация не удастся, экземпляр перейдёт в состояние REGISTRATION_FAILED. Вы можете описать экземпляр контейнера и увидеть причину неудачи в параметре statusReason. После завершения работы экземпляра контейнера экземпляр переходит в состояние DEREGISTERING, пока не будет депровизировано trunk elastic network interface. Затем экземпляр переходит в состояние INACTIVE.

Статус ACTIVE указывает, что экземпляр контейнера может принимать задачи. Статус DRAINING указывает, что новые задачи не размещаются на экземпляре контейнера, и любые задачи сервиса, выполняемые на экземпляре контейнера, удаляются, если это возможно. Дополнительную информацию см. в разделе Остановка работы экземпляра контейнера в руководстве разработчика Amazon Elastic Container Service.

statusReason -> (строка)

Причина, по которой экземпляр контейнера достиг текущего состояния.

agentConnected -> (булево)

Этот параметр возвращает true, если агент подключён к Amazon ECS. Экземпляр с агентом, который может быть неисправен или остановлен, возвращает false. Только экземпляры, подключённые к агенту, могут принимать запросы размещения задач.

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

Количество задач на экземпляре контейнера, у которых желаемое состояние (desiredStatus) равно RUNNING.

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

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

agentUpdateStatus -> (строка)

Статус последнего обновления агента. Если запрос на обновление не был выполнен, это значение равно NULL.

attributes -> (список)

Атрибуты, заданные для экземпляра контейнера, либо агентом Amazon ECS контейнера при регистрации экземпляра, либо вручную с помощью операции PutAttributes.

(структура)

Атрибут — это пара имя-значение, связанная с объектом Amazon ECS. Используйте атрибуты для расширения модели данных Amazon ECS, добавляя пользовательские метаданные к вашим ресурсам. Дополнительную информацию см. в разделе Атрибуты в руководстве разработчика Amazon Elastic Container Service.

name -> (строка)

Имя атрибута. Имя name должно содержать от 1 до 128 символов. Имя может содержать буквы (заглавные и строчные), цифры, дефисы (-), подчёркивания (_), слэши (/), обратные слэши (\) или точки (.).

value -> (строка)

Значение атрибута. Значение value должно содержать от 1 до 128 символов. Оно может содержать буквы (заглавные и строчные), цифры, дефисы (-), подчёркивания (_), точки (.), знаки @, слэши (/), обратные слэши (\), двоеточия (:) или пробелы. Значение не может начинаться или заканчиваться пробелом.

targetType -> (строка)

Тип целевого объекта для добавления атрибута. Этот параметр требуется, если вы используете короткий идентификатор ресурса вместо полного ARN.

targetId -> (строка)

Идентификатор целевого объекта. Вы можете указать короткий идентификатор ресурса или полный Amazon Resource Name (ARN).

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

Временная метка Unix для момента регистрации экземпляра контейнера.

attachments -> (список)

Ресурсы, подключённые к экземпляру контейнера, такие как elastic network interface.

(структура)

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

id -> (строка)

Уникальный идентификатор подключения.

type -> (строка)

Тип подключения, например ElasticNetworkInterface , Service Connect и AmazonElasticBlockStorage.

status -> (строка)

Статус подключения. Допустимые значения: PRECREATED , CREATED , ATTACHING , ATTACHED , DETACHING , DETACHED , DELETED и FAILED.

details -> (список)

Подробности подключения.

Для elastic network interfaces это включает идентификатор сетевого интерфейса, MAC-адрес, идентификатор подсети и частный IPv4-адрес.

Для служб Service Connect это включает portName , clientAliases , discoveryName и ingressPortOverride.

Для Elastic Block Storage это включает roleArn , deleteOnTermination , volumeName , volumeId и statusReason (только в случае неудачи при создании или подключении).

(структура)

Объект пары ключ-значение.

name -> (строка)

Имя пары ключ-значение. Для переменных среды это имя переменной среды.

value -> (строка)

Значение пары ключ-значение. Для переменных среды это значение переменной среды.

tags -> (список)

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

Применяются следующие основные ограничения к тегам:

Максимальное количество тегов на ресурс - 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа - 128 Unicode символов в UTF-8
Максимальная длина значения - 256 Unicode символов в UTF-8
Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на допустимые символы. В целом допустимыми символами являются: буквы, цифры и пробелы, представляемые в UTF-8, а также следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws: , AWS: или любые сочетания верхнего и нижнего регистра, такие как префикс для ключей или значений, поскольку они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете лимита тегов на ресурс.

(структура)

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

Применяются следующие основные ограничения к тегам:

Максимальное количество тегов на ресурс - 50
Для каждого ресурса каждый ключ тега должен быть уникальным, и каждый ключ тега может иметь только одно значение.
Максимальная длина ключа - 128 Unicode символов в UTF-8
Максимальная длина значения - 256 Unicode символов в UTF-8
Если ваша схема тегов используется в нескольких службах и ресурсах, помните, что другие службы могут иметь ограничения на допустимые символы. В целом допустимыми символами являются: буквы, цифры и пробелы, представляемые в UTF-8, а также следующие символы: + - = . _ : / @.
Ключи и значения тегов чувствительны к регистру.
Не используйте aws: , AWS: или любые сочетания верхнего и нижнего регистра, такие как префикс для ключей или значений, поскольку они зарезервированы для использования Amazon Web Services. Вы не можете редактировать или удалять ключи или значения тегов с этим префиксом. Теги с этим префиксом не учитываются при подсчете лимита тегов на ресурс.

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

Одна часть пары ключ-значение, составляющей тег. key — это общий ярлык, который действует как категория для более специфичных значений тегов.

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

Необязательная часть пары ключ-значение, составляющей тег. value действует как описание в рамках категории тегов (ключ).

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

Объект, представляющий состояние здоровья экземпляра контейнера.

overallStatus -> (строка)

Общее состояние здоровья экземпляра контейнера. Это агрегированное состояние всех проверок состояния экземпляра контейнера.

details -> (список)

Массив объектов, представляющих детали состояния здоровья экземпляра контейнера.

(структура)

Объект, представляющий результат проверки состояния здоровья экземпляра контейнера.

type -> (строка)

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

status -> (строка)

Состояние здоровья экземпляра контейнера.

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

Маркер времени Unix, когда состояние здоровья экземпляра контейнера было обновлено в последний раз.

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

Маркер времени Unix, когда состояние здоровья экземпляра контейнера в последний раз изменилось.

END_OF_DOCUMENT_MARKER