Spec-Zone.ru › AWS CLI v2

[ aws . efs ]

describe-access-points

Описание

Возвращает описание конкретной точки доступа Amazon EFS, если предоставлен AccessPointId. Если вы предоставляете EFS FileSystemId, он возвращает описания всех точек доступа для этой файловой системы. Вы можете предоставить либо AccessPointId, либо FileSystemId в запросе, но не оба.

Для этой операции требуются разрешения на действие elasticfilesystem:DescribeAccessPoints.

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

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

Синтаксис

  describe-access-points
[--access-point-id <value>]
[--file-system-id <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]

Параметры

--access-point-id (строка)

(Необязательно) Указывает точку доступа EFS, описание которой нужно вернуть в ответе; взаимно исключающий параметр с FileSystemId.

--file-system-id (строка)

(Необязательно) Если вы предоставите FileSystemId, EFS вернёт все точки доступа для этой файловой системы; взаимно исключающий параметр с AccessPointId.

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

Отключение постраничной обработки для вывода.

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

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

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

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

Вывод

AccessPoints -> (список)

Массив описаний точек доступа.

(структура)

Предоставляет описание точки доступа к файловой системе EFS.

ClientToken -> (строка)

Непрозрачная строка, указанная в запросе для обеспечения идемпотентного создания.

Name -> (строка)

Имя точки доступа. Это значение тега Name.

Tags -> (список)

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

(структура)

Тег — это пара ключ-значение. Допускаются буквы, пробелы и цифры, которые можно представить в UTF-8, а также следующие символы:+ - = . _ : /.

Key -> (строка)

Ключ тега (строка). Ключ не может начинаться с aws:.

Value -> (строка)

Значение ключа тега.

AccessPointId -> (строка)

Идентификатор точки доступа, назначенный Amazon EFS.

AccessPointArn -> (строка)

Уникальный Amazon Resource Name (ARN), связанный с точкой доступа.

FileSystemId -> (строка)

Идентификатор файловой системы EFS, к которой относится точка доступа.

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

Полная информация о пользователе POSIX, включая идентификатор пользователя, идентификатор группы и идентификаторы дополнительных групп в точке доступа, используемые для всех операций с файлами клиентами NFS, использующими эту точку доступа.

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

Идентификатор пользователя POSIX, используемый для всех операций с файловой системой, использующих эту точку доступа.

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

Идентификатор группы POSIX, используемый для всех операций с файловой системой, использующих эту точку доступа.

SecondaryGids -> (список)

Дополнительные идентификаторы групп POSIX, используемые для всех операций с файловой системой, использующих эту точку доступа.

(целое число)

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

Директория в файловой системе EFS, экспонируемая в качестве корневой директории для клиентов NFS, использующих эту точку доступа.

Path -> (строка)

Указывает путь в файловой системе EFS, который должен быть экспонирован в качестве корневой директории для клиентов NFS, использующих точку доступа для доступа к файловой системе EFS. Путь может содержать до четырёх поддиректорий. Если указанный путь не существует, необходимо предоставить CreationInfo.

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

(Необязательно) Указывает идентификаторы POSIX и разрешения, которые нужно применить к RootDirectory точки доступа. Если RootDirectory > Path, указанный путь не существует, EFS создаёт корневую директорию с использованием параметров CreationInfo при подключении клиента к точке доступа. При указании CreationInfo, необходимо предоставить значения для всех свойств.

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

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

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

Указывает идентификатор пользователя POSIX, который нужно применить к RootDirectory.

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

Указывает идентификатор группы POSIX, который нужно применить к RootDirectory.

Permissions -> (строка)

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

OwnerId -> (строка)

Идентифицирует учётную запись Amazon Web Services, владеющую ресурсом точки доступа.

LifeCycleState -> (строка)

Идентифицирует фазу жизненного цикла точки доступа.

NextToken -> (строка)

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

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

Spec-Zone.ru

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