Spec-Zone.ru › AWS CLI v2

[ aws . neptune ]

describe-db-cluster-endpoints

Описание

Возвращает информацию об узлах конечных точек для кластера баз данных Amazon Neptune.

Примечание

Данная операция также может возвращать информацию для кластеров Amazon RDS и кластеров Amazon DocDB.

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

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

Синтаксис

  describe-db-cluster-endpoints
[--db-cluster-identifier <value>]
[--db-cluster-endpoint-identifier <value>]
[--filters <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]

Параметры

--db-cluster-identifier (строка)

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

--db-cluster-endpoint-identifier (строка)

Идентификатор конечной точки, которую нужно описать. Этот параметр хранится в виде строчной строки.

--filters (список)

Набор пар имя-значение, определяющих, какие конечные точки следует включить в вывод. Фильтры задаются как пары имя-значение в формате Name=*endpoint_type* ,Values=*endpoint_type1* ,*endpoint_type2* ,... . Name может быть одним из: db-cluster-endpoint-type , db-cluster-endpoint-custom-type , db-cluster-endpoint-id , db-cluster-endpoint-status . Values для фильтра db-cluster-endpoint-type может быть одним или несколькими из: reader , writer , custom . Values для фильтра db-cluster-endpoint-custom-type может быть одним или несколькими из: reader , any . Values для фильтра db-cluster-endpoint-status может быть одним или несколькими из: available , creating , deleting , inactive , modifying .

(структура)

Этот тип в настоящее время не поддерживается.

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

Этот параметр в настоящее время не поддерживается.

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

Этот параметр в настоящее время не поддерживается.

(строка)

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

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

Синтаксис JSON:

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

--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
  • текст
  • таблица
  • 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 (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

Маркер -> (строка)

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

DBClusterEndpoints -> (список)

Содержит сведения о конечных точках, связанных с кластером и соответствующих любым условиям фильтрации.

(структура)

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

  • CreateDBClusterEndpoint
  • DescribeDBClusterEndpoints
  • ModifyDBClusterEndpoint
  • DeleteDBClusterEndpoint

Структуру данных, представляющую конечные точки экземпляров баз данных Amazon Neptune, см. в разделе Endpoint.

DBClusterEndpointIdentifier -> (строка)

Идентификатор, связанный с конечной точкой. Этот параметр хранится в виде строчной строки.

DBClusterIdentifier -> (строка)

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

DBClusterEndpointResourceIdentifier -> (строка)

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

Endpoint -> (строка)

DNS-адрес конечной точки.

Статус -> (строка)

Текущий статус конечной точки. Один из: creating , available , deleting , inactive , modifying . Состояние inactive относится к конечной точке, которую нельзя использовать для определенного типа кластера, например, конечной точке writer для вторичного кластера с чтением-только в глобальной базе данных.

EndpointType -> (строка)

Тип конечной точки. Один из: READER , WRITER , CUSTOM .

CustomEndpointType -> (строка)

Тип, связанный с пользовательской конечной точкой. Один из: READER , WRITER , ANY.

StaticMembers -> (список)

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

(строка)

ExcludedMembers -> (список)

Список идентификаторов экземпляров баз данных, которые не входят в группу пользовательских конечных точек. Все остальные допустимые экземпляры доступны через пользовательскую конечную точку. Актуально только в том случае, если список статических членов пуст.

(строка)

DBClusterEndpointArn -> (строка)

Amazon Resource Name (ARN) для конечной точки.

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

Spec-Zone.ru

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