describe-replication-instances
Описание
Возвращает информацию о реплицирующих экземплярах для вашей учетной записи в текущем регионе.
См. также: Документация API AWS
describe-replication-instances является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ReplicationInstances
Синтаксис
describe-replication-instances
[--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]
Параметры
--filters (список)
Фильтры, применяемые к реплицирующим экземплярам.
Допустимые имена фильтров: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
(структура)
Определяет имя и значение объекта фильтра. Этот фильтр используется для ограничения количества и типа объектов DMS, возвращаемых для конкретного вызова Describe* или аналогичной операции. Фильтры используются в качестве необязательного параметра для определенных операций API.
Имя -> (строка)
Describe* или аналогичной операции.Значения -> (список)
Значение фильтра, которое может указать одно или несколько значений, используемых для сужения возвращаемых результатов.
(строка)
Сокращенный синтаксис:
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 CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная навигация в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возвращения в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для продолжения постраничной навигации необходимо предоставить значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.
Примеры использования см. в разделе Постраничная навигация в руководстве пользователя AWS CLI.
--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 для вывода.
--cli-auto-prompt (булево)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросить параметры ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.
Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Для описания реплицирующих экземпляров
Следующий пример describe-replication-instances отображает реплицирующие экземпляры в вашей учетной записи AWS.
aws dms describe-replication-instances
Вывод:
{
"ReplicationInstances": [
{
"ReplicationInstanceIdentifier": "my-repl-instance",
"ReplicationInstanceClass": "dms.t2.micro",
"ReplicationInstanceStatus": "available",
"AllocatedStorage": 5,
"InstanceCreateTime": 1590011235.952,
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-f839b688",
"Status": "active"
}
],
"AvailabilityZone": "us-east-1e",
"ReplicationSubnetGroup": {
"ReplicationSubnetGroupIdentifier": "default",
"ReplicationSubnetGroupDescription": "default",
"VpcId": "vpc-136a4c6a",
"SubnetGroupStatus": "Complete",
"Subnets": [
{
"SubnetIdentifier": "subnet-da327bf6",
"SubnetAvailabilityZone": {
"Name": "us-east-1a"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-42599426",
"SubnetAvailabilityZone": {
"Name": "us-east-1d"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-bac383e0",
"SubnetAvailabilityZone": {
"Name": "us-east-1c"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-6746046b",
"SubnetAvailabilityZone": {
"Name": "us-east-1f"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-d7c825e8",
"SubnetAvailabilityZone": {
"Name": "us-east-1e"
},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-cbfff283",
"SubnetAvailabilityZone": {
"Name": "us-east-1b"
},
"SubnetStatus": "Active"
}
]
},
"PreferredMaintenanceWindow": "wed:11:42-wed:12:12",
"PendingModifiedValues": {
"MultiAZ": true
},
"MultiAZ": false,
"EngineVersion": "3.3.2",
"AutoMinorVersionUpgrade": true,
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
"ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE",
"ReplicationInstancePublicIpAddress": "3.230.18.248",
"ReplicationInstancePrivateIpAddress": "172.31.75.90",
"ReplicationInstancePublicIpAddresses": [
"3.230.18.248"
],
"ReplicationInstancePrivateIpAddresses": [
"172.31.75.90"
],
"PubliclyAccessible": true,
"FreeUntil": 1590194829.267
}
]
}
Дополнительную информацию см. в разделе Работа с реплицирующим экземпляром AWS DMS в руководстве пользователя AWS Database Migration Service.
Вывод
Маркер -> (строка)
MaxRecords.ReplicationInstances -> (список)
Описанные реплицирующие экземпляры.
(структура)
Предоставляет информацию, определяющую реплицирующий экземпляр.
ReplicationInstanceIdentifier -> (строка)
Идентификатор реплицирующего экземпляра — обязательный параметр. Этот параметр хранится в виде строчной строки.
Ограничения:
- Должен содержать от 1 до 63 буквенно-цифровых символов или дефисов.
- Первый символ должен быть буквой.
- Не может заканчиваться дефисом или содержать два последовательных дефиса.
Пример: myrepinstance
ReplicationInstanceClass -> (строка)
Вычислительная и запоминающая способность реплицирующего экземпляра, определённая для указанного класса реплицирующего экземпляра. Является обязательным параметром, хотя по умолчанию значение выбрано в консоли DMS.
Для получения дополнительной информации о настройках и возможностях доступных классов реплицирующих экземпляров см. Выбор подходящего реплицирующего экземпляра DMS для миграции.
ReplicationInstanceStatus -> (строка)
Статус реплицирующего экземпляра. Возможные возвращаемые значения включают:
"available""creating""deleted""deleting""failed""modifying""upgrading""rebooting""resetting-master-credentials""storage-full""incompatible-credentials""incompatible-network""maintenance"
AllocatedStorage -> (целое число)
InstanceCreateTime -> (метка времени)
VpcSecurityGroups -> (список)
Группа безопасности VPC для экземпляра.
(структура)
Описание состояния группы безопасности, связанной с виртуальной частной областью (VPC), в которой размещены реплицирующий и экземпляры баз данных.
VpcSecurityGroupId -> (строка)
Status -> (строка)
AvailabilityZone -> (строка)
ReplicationSubnetGroup -> (структура)
Группа подсетей для реплицирующего экземпляра.
ReplicationSubnetGroupIdentifier -> (строка)
ReplicationSubnetGroupDescription -> (строка)
VpcId -> (строка)
SubnetGroupStatus -> (строка)
Subnets -> (список)
Подсети, которые входят в группу подсетей.
(структура)
В ответ на запрос операции DescribeReplicationSubnetGroups этот объект определяет подсеть по её заданной доступной зоне, идентификатору подсети и статусу.
SubnetIdentifier -> (строка)
SubnetAvailabilityZone -> (структура)
Доступная зона подсети.
Name -> (строка)
SubnetStatus -> (строка)
SupportedNetworkTypes -> (список)
Протокол IP-адресации, поддерживаемый группой подсетей. Используется реплицирующим экземпляром со значениями, такими как только IPv4 или Dual-stack, который поддерживает как IPv4, так и IPv6 адресацию. IPv6 только пока не поддерживается.
(строка)
PreferredMaintenanceWindow -> (строка)
PendingModifiedValues -> (структура)
Значения ожидающих изменений.
ReplicationInstanceClass -> (строка)
Вычислительная и запоминающая способность реплицирующего экземпляра, определённая для указанного класса реплицирующего экземпляра.
Для получения дополнительной информации о настройках и возможностях доступных классов реплицирующих экземпляров см. Выбор подходящего реплицирующего экземпляра DMS для миграции.
AllocatedStorage -> (целое число)
MultiAZ -> (булево)
AvailabilityZone, если параметр Multi-AZ установлен в значение true.EngineVersion -> (строка)
NetworkType -> (строка)
MultiAZ -> (булево)
AvailabilityZone, если параметр Multi-AZ установлен в значение true.EngineVersion -> (строка)
Номер версии движка реплицирующего экземпляра.
Если номер версии движка не указан при создании реплицирующего экземпляра, по умолчанию используется последняя доступная версия движка.
При изменении основной версии движка экземпляра также установите AllowMajorVersionUpgrade в значение true.
AutoMinorVersionUpgrade -> (булево)
KmsKeyId -> (строка)
Идентификатор ключа KMS, используемый для шифрования данных в реплицирующем экземпляре.
Если вы не укажете значение для параметра KmsKeyId, DMS будет использовать ваш ключ шифрования по умолчанию.
KMS создаёт ключ шифрования по умолчанию для вашей учётной записи Amazon Web Services. У вашей учётной записи Amazon Web Services есть отдельный ключ шифрования по умолчанию для каждой зоны Amazon Web Services.
ReplicationInstanceArn -> (строка)
ReplicationInstancePublicIpAddress -> (строка)
ReplicationInstancePrivateIpAddress -> (строка)
ReplicationInstancePublicIpAddresses -> (список)
Один или несколько общедоступных IP-адресов для реплицирующего экземпляра.
(строка)
ReplicationInstancePrivateIpAddresses -> (список)
Один или несколько приватных IP-адресов для реплицирующего экземпляра.
(строка)
ReplicationInstanceIpv6Addresses -> (список)
Один или несколько IP-адресов IPv6 для реплицирующего экземпляра.
(строка)
PubliclyAccessible -> (булево)
true обозначает экземпляр с общедоступным IP-адресом. Значение false обозначает экземпляр с приватным IP-адресом. Значение по умолчанию — true.SecondaryAvailabilityZone -> (строка)
FreeUntil -> (метка времени)
DnsNameServers -> (строка)
NetworkType -> (строка)
KerberosAuthenticationSettings -> (структура)
Указывает настройки, необходимые для аутентификации Kerberos при репликации экземпляра.
KeyCacheSecretId -> (строка)
KeyCacheSecretIamArn -> (строка)
Krb5FileContents -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.