Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

describe-db-shard-groups

Описание

Описывает существующие группы фрагментов базы данных Aurora Limitless.

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

Синтаксис

  describe-db-shard-groups
[--db-shard-group-identifier <value>]
[--filters <value>]
[--marker <value>]
[--max-records <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]

Параметры

--db-shard-group-identifier (строка)

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

Ограничения:

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

--filters (список)

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

(структура)

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

Примечание

В настоящее время подстановочные знаки в фильтрах не поддерживаются.

Следующие действия можно отфильтровать:

  • DescribeDBClusterBacktracks
  • DescribeDBClusterEndpoints
  • DescribeDBClusters
  • DescribeDBInstances
  • DescribeDBRecommendations
  • DescribeDBShardGroups
  • DescribePendingMaintenanceActions

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

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

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

Одно или несколько значений фильтра. Значения фильтров чувствительны к регистру.

(строка)

Краткая синтаксическая запись:

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

Синтаксис JSON:

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

--marker (строка)

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

--max-records (целое число)

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

По умолчанию: 100

Ограничения: от 20 до 100

--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: Описание групп фрагментов базы данных

Следующий пример describe-db-shard-groups получения информации о группах фрагментов базы данных.

aws rds describe-db-shard-groups

Вывод:

{
    "DBShardGroups": [
        {
            "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example",
            "DBShardGroupIdentifier": "limitless-test-shard-grp",
            "DBClusterIdentifier": "limitless-test-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": true,
            "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        },
        {
            "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
            "DBShardGroupIdentifier": "my-db-shard-group",
            "DBClusterIdentifier": "my-sv2-cluster",
            "MaxACU": 768.0,
            "ComputeRedundancy": 0,
            "Status": "available",
            "PubliclyAccessible": false,
            "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
        }
    ]
}

Для получения дополнительной информации см. раздел Amazon Aurora DB кластеры в Руководстве пользователя Amazon Aurora.

Вывод

DBShardGroups -> (список)

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

(структура)

Содержит сведения о группе фрагментов базы данных Amazon RDS.

DBShardGroupResourceId -> (строка)

Уникальный, неизменяемый идентификатор группы фрагментов базы данных, относящийся к определённому региону Amazon Web Services.

DBShardGroupIdentifier -> (строка)

Имя группы фрагментов базы данных.

DBClusterIdentifier -> (строка)

Имя основного кластера базы данных для группы фрагментов базы данных.

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

Максимальная ёмкость группы фрагментов базы данных в единицах ёмкости Aurora (ACU).

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

Минимальная ёмкость группы фрагментов базы данных в единицах ёмкости Aurora (ACU).

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

Указывает, нужно ли создавать резервные группы фрагментов базы данных для группы фрагментов базы данных. Допустимые значения:

  • 0 - Создаёт группу фрагментов базы данных без резервной группы фрагментов базы данных. Это значение по умолчанию.
  • 1 - Создаёт группу фрагментов базы данных с резервной группой фрагментов базы данных в другой зоне доступности (AZ).
  • 2 - Создаёт группу фрагментов базы данных с двумя резервными группами фрагментов базы данных в двух разных зонах доступности.

Status -> (строка)

Статус группы фрагментов базы данных.

PubliclyAccessible -> (логическое значение)

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

Если группа фрагментов базы данных доступна публично, её DNS-адрес резолютируется до частного IP-адреса изнутри VPC группы фрагментов базы данных. Он резолютируется до публичного IP-адреса снаружи VPC группы фрагментов базы данных. Доступ к группе фрагментов базы данных в конечном счете контролируется используемой группой безопасности. Такой публичный доступ запрещается, если группа безопасности, назначенная группе фрагментов базы данных, его не разрешает.

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

Для получения дополнительной информации см. CreateDBShardGroup.

Это значение актуально только для Aurora Limitless Database.

Endpoint -> (строка)

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

DBShardGroupArn -> (строка)

Amazon Resource Name (ARN) для группы фрагментов базы данных.

TagList -> (список)

Список тегов.

Дополнительную информацию см. в разделе «Использование тегов с ресурсами Amazon RDS» в Руководстве пользователя Amazon RDS или «Использование тегов с ресурсами Amazon Aurora и Amazon RDS» в Руководстве пользователя Amazon Aurora.

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.

Дополнительную информацию см. в разделе «Использование тегов с ресурсами Amazon RDS» в Руководстве пользователя Amazon RDS или «Использование тегов с ресурсами Amazon Aurora и Amazon RDS» в Руководстве пользователя Amazon Aurora.

Key -> (строка)

Ключ — это обязательное имя тега. Строковое значение может содержать от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только символы Юникода, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Value -> (строка)

Значение — необязательное значение тега. Строковое значение может содержать от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только символы Юникода, цифры, пробелы, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Marker -> (строка)

Маркер постраничной навигации, который можно использовать в последующем запросе DescribeDBClusters.

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

Spec-Zone.ru

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