Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

получение CIDR-блоков ресурсов IPAM

Описание

Возвращает CIDR-блоки ресурсов, управляемые IPAM в заданном объеме. Если IPAM связан с несколькими обнаружениями ресурсов, возвращаются CIDR-блоки ресурсов из всех обнаружений ресурсов. Обнаружение ресурсов — это компонент IPAM, который позволяет IPAM управлять и контролировать ресурсы, принадлежащие учетной записи-владельцу.

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

get-ipam-resource-cidrs является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько API-запросов. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: IpamResourceCidrs

Синтаксис

  get-ipam-resource-cidrs
[--dry-run | --no-dry-run]
[--filters <value>]
--ipam-scope-id <value>
[--ipam-pool-id <value>]
[--resource-id <value>]
[--resource-type <value>]
[--resource-tag <value>]
[--resource-owner <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверка наличия необходимых разрешений для действия без фактического выполнения запроса и предоставление ответа об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке — DryRunOperation . В противном случае, это UnauthorizedOperation .

--filters (список)

Один или несколько фильтров для запроса. Дополнительную информацию о фильтрации см. в разделе Фильтрация вывода командной строки .

(структура)

Пара имя-значение фильтра, используемая для возвращения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы укажете несколько фильтров, фильтры соединяются с помощью AND , и запрос возвращает только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в Руководстве пользователя Amazon EC2 .

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения соединяются с помощью OR , и запрос возвращает все результаты, соответствующие любому из указанных значений.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--ipam-scope-id (строка)

Идентификатор области, в которой находится ресурс.

--ipam-pool-id (строка)

Идентификатор пула IPAM, в котором находится ресурс.

--resource-id (строка)

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

--resource-type (строка)

Тип ресурса.

Возможные значения:

  • vpc
  • subnet
  • eip
  • public-ipv4-pool
  • ipv6-pool
  • eni

--resource-tag (структура)

Тег ресурса.

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

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

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

Значение тега.

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

Key=string,Value=string

Синтаксис JSON:

{
  "Key": "string",
  "Value": "string"
}

--resource-owner (строка)

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные значения с использованием значения, предоставленного в формате JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS CLI .

--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 (boolean)

Включить отладку.

--endpoint-url (строка)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (строка)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--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 (boolean)

Отключить кли-страничник для вывода.

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Получение CIDR-блоков, выделенных для ресурса

Следующий пример получения CIDR-блоков, выделенных для ресурса.

(Linux):

aws ec2 get-ipam-resource-cidrs \
    --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 \
    --filters Name=management-state,Values=unmanaged

(Windows):

aws ec2 get-ipam-resource-cidrs ^
    --ipam-scope-id ipam-scope-02fc38cd4c48e7d38 ^
    --filters Name=management-state,Values=unmanaged

Вывод:

{
    "IpamResourceCidrs": [
        {
            "IpamId": "ipam-08440e7a3acde3908",
            "IpamScopeId": "ipam-scope-02fc38cd4c48e7d38",
            "ResourceRegion": "us-east-2",
            "ResourceOwnerId": "123456789012",
            "ResourceId": "vpc-621b8709",
            "ResourceName": "Default AWS VPC",
            "ResourceCidr": "172.33.0.0/16",
            "ResourceType": "vpc",
            "ResourceTags": [
                {
                    "Key": "Environment",
                    "Value": "Test"
                },
                {
                    "Key": "Name",
                    "Value": "Default AWS VPC"
                }
            ],
            "IpUsage": 0.0039,
            "ComplianceStatus": "unmanaged",
            "ManagementState": "unmanaged",
            "OverlapStatus": "nonoverlapping",
            "VpcId": "vpc-621b8709"
        }
    ]
}

Дополнительную информацию см. в разделе Отслеживание использования CIDR по ресурсам в Руководстве пользователя Amazon VPC IPAM.

Вывод

NextToken -> (строка)

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

IpamResourceCidrs -> (список)

CIDR-ресурсов IPAM.

(структура)

CIDR для ресурса IPAM.

IpamId -> (строка)

ID IPAM для ресурса IPAM.

IpamScopeId -> (строка)

ID области для ресурса IPAM.

IpamPoolId -> (строка)

ID пула для ресурса IPAM.

ResourceRegion -> (строка)

Регион Amazon Web Services для ресурса IPAM.

ResourceOwnerId -> (строка)

Номер учетной записи Amazon Web Services владельца ресурса IPAM.

ResourceId -> (строка)

ID ресурса IPAM.

ResourceName -> (строка)

Имя ресурса IPAM.

ResourceCidr -> (строка)

CIDR для ресурса IPAM.

ResourceType -> (строка)

Тип ресурса IPAM.

ResourceTags -> (список)

Теги ресурса IPAM.

(структура)

Пара ключ/значение тега, назначенного ресурсу. Используйте ключ тега в имени фильтра, а значение тега — в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением TeamA, укажите tag:Owner для имени фильтра и TeamA для значения фильтра.

Key -> (строка)

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

Value -> (строка)

Значение тега.

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

Процент используемого адресного пространства IP. Для перевода десятичной дроби в процент умножьте ее на 100. Обратите внимание на следующее:

  • Для ресурсов, являющихся VPC, это процент адресного пространства IP в VPC, занимаемый CIDR подсетей.
  • Для ресурсов, являющихся подсетями, если подсети выделен CIDR IPv4, это процент адресного пространства IPv4 в подсети, который используется. Если подсети выделен CIDR IPv6, процент используемого адресного пространства IPv6 не отображается. В настоящее время процент используемого адресного пространства IPv6 рассчитать нельзя.
  • Для ресурсов, являющихся общедоступными пулами IPv4, это процент адресного пространства IP в пуле, выделенный для Elastic IP-адресов (EIPs).

ComplianceStatus -> (строка)

Состояние соответствия ресурса IPAM. Дополнительную информацию о статусах соответствия см. в разделе «Отслеживание использования CIDR по ресурсам» в Руководстве пользователя Amazon VPC IPAM.

ManagementState -> (строка)

Состояние управления ресурсом. Дополнительную информацию о состояниях управления см. в разделе «Отслеживание использования CIDR по ресурсам» в Руководстве пользователя Amazon VPC IPAM.

OverlapStatus -> (строка)

Статус перекрытия ресурса IPAM. Статус перекрытия показывает, перекрывается ли CIDR ресурса с другим CIDR в области. Дополнительную информацию о статусах перекрытия см. в разделе «Отслеживание использования CIDR по ресурсам» в Руководстве пользователя Amazon VPC IPAM.

VpcId -> (строка)

ID VPC.

AvailabilityZoneId -> (строка)

ID зоны доступности.

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

Spec-Zone.ru

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