Модуль google.cloud.gcp_sql_instance_info – сбор информации об экземпляре GCP

access_token

string

Токен доступа OAuth2, если выбран тип учетных данных accesstoken.

auth_kind

string / обязательный

Тип используемых учетных данных.

Варианты:

• "application"
• "machineaccount"
• "serviceaccount"
• "accesstoken"

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

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

Этот параметр изменяет только строку User Agent для всех запросов к API.

project

string

Проект Google Cloud Platform, который нужно использовать.

scopes

list / элементы=string

Массив используемых областей доступа

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы: словарь или строка JSON, представляющая это содержимое.

service_account_email

string

Необязательный адрес электронной почты учетной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.

resources

complex

Список ресурсов

Возвращается: всегда

backendType

string

* FIRST_GEN: экземпляр первого поколения. Только MySQL.

* SECOND_GEN: экземпляр второго поколения или экземпляр PostgreSQL.

* EXTERNAL: сервер базы данных, управляемый не Google.

Возвращается: при успешном выполнении

connectionName

string

Имя подключения экземпляра Cloud SQL, используемое в строках подключения.

Возвращается: при успешном выполнении

databaseVersion

string

Тип и версия ядра базы данных. Для экземпляров первого поколения может иметь значение MYSQL_5_5 или MYSQL_5_6. Для экземпляров второго поколения может иметь значение MYSQL_5_6 или MYSQL_5_7. По умолчанию — MYSQL_5_6.

Экземпляры PostgreSQL: POSTGRES_9_6. Свойство databaseVersion нельзя изменить после создания экземпляра.

Возвращается: при успешном выполнении

diskEncryptionConfiguration

complex

Настройки шифрования диска.

Возвращается: при успешном выполнении

kmsKeyName

string

Ключ KMS, используемый для шифрования экземпляра Cloud SQL.

Возвращается: при успешном выполнении

diskEncryptionStatus

complex

Статус шифрования диска.

Возвращается: при успешном выполнении

kmsKeyVersionName

string

Версия ключа KMS, используемая для шифрования экземпляра Cloud SQL.

Возвращается: при успешном выполнении

failoverReplica

complex

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

Возвращается: при успешном выполнении

available

boolean

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

gceZone

string

Зона Compute Engine, из которой в настоящее время обслуживается экземпляр. Это значение может отличаться от зоны, указанной при создании экземпляра, если экземпляр переключился на резервную зону.

Возвращается: при успешном выполнении

instanceType

string

Тип экземпляра. Может иметь одно из следующих значений.

* CLOUD_SQL_INSTANCE: экземпляр Cloud SQL, который не реплицирует данные с основного экземпляра.

* ON_PREMISES_INSTANCE: экземпляр, работающий в локальной инфраструктуре заказчика.

* READ_REPLICA_INSTANCE: экземпляр Cloud SQL, настроенный как реплика для чтения.

Возвращается: при успешном выполнении

ipAddresses

complex

IP-адреса, назначенные экземпляру.

Возвращается: при успешном выполнении

ipAddress

string

Назначенный IP-адрес.

Возвращается: при успешном выполнении

timeToRetire

string

Время вывода этого IP-адреса из эксплуатации в формате RFC 3339, например 2012-11-15T16:19:00.094Z. Это поле доступно только в том случае, если вывод IP-адреса из эксплуатации запланирован.

Возвращается: при успешном выполнении

type

string

Тип этого IP-адреса. Адрес PRIMARY может принимать входящие подключения. Адрес OUTGOING является исходным адресом подключений, инициируемых экземпляром, если такая возможность поддерживается.

Возвращается: при успешном выполнении

ipv6Address

string

IPv6-адрес, назначенный экземпляру. Это свойство применимо только к экземплярам первого поколения.

Возвращается: при успешном выполнении

masterInstanceName

string

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

Возвращается: при успешном выполнении

maxDiskSize

integer

Максимальный размер диска экземпляра в байтах.

Возвращается: при успешном выполнении

name

string

Имя экземпляра Cloud SQL. Не включает идентификатор проекта.

Возвращается: при успешном выполнении

region

string

Географический регион. По умолчанию — us-central или us-central1 в зависимости от типа экземпляра (первое поколение или второе поколение/PostgreSQL).

Возвращается: при успешном выполнении

replicaConfiguration

complex

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

Возвращается: при успешном выполнении

failoverTarget

boolean

Указывает, является ли реплика целевой для переключения при сбое. Если для поля задано значение true, реплика будет назначена резервной репликой для переключения при сбое.

В случае сбоя основного экземпляра экземпляр-реплика станет новым основным экземпляром.

Целевой для переключения при сбое можно назначить только одну реплику. Она должна находиться в другой зоне, чем основной экземпляр.

Возвращается: при успешном выполнении

mysqlReplicaConfiguration

complex

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

Возвращается: при успешном выполнении

caCertificate

string

Представление доверенного сертификата x509 центра сертификации в формате PEM.

Возвращается: при успешном выполнении

clientCertificate

string

Представление сертификата x509 реплики в формате PEM.

Возвращается: при успешном выполнении

clientKey

string

Представление закрытого ключа реплики в формате PEM. Соответствующий открытый ключ закодирован в сертификате клиента.

Возвращается: при успешном выполнении

connectRetryInterval

integer

Интервал ожидания между повторными попытками подключения в секундах. Значение по умолчанию для MySQL — 60 секунд.

Возвращается: при успешном выполнении

dumpFilePath

string

Путь к файлу дампа SQL в Google Cloud Storage, на основе которого создаётся экземпляр-реплика. URI имеет формат gs://bucketName/fileName. Также поддерживаются сжатые файлы gzip (.gz). Дампы должны содержать координаты binlog, с которых должна начинаться репликация. Чтобы обеспечить это, при использовании mysqldump задайте для параметра --master-data значение 1.

Возвращается: при успешном выполнении

masterHeartbeatPeriod

integer

Интервал между сигналами проверки связи при репликации в миллисекундах.

Возвращается: при успешном выполнении

password

string

Пароль для подключения репликации.

Возвращается: при успешном выполнении

sslCipher

string

Список допустимых шифров для использования при SSL-шифровании.

Возвращается: при успешном выполнении

username

string

Имя пользователя для подключения репликации.

Возвращается: при успешном выполнении

verifyServerCertificate

boolean

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

Возвращается: при успешном выполнении

replicaNames

list / elements=string

Реплики экземпляра.

Возвращается: при успешном выполнении

serviceAccountEmailAddress

string

Адрес электронной почты сервисного аккаунта, назначенного экземпляру. Это свойство применимо только к экземплярам второго поколения.

Возвращается: при успешном выполнении

serverCaCert

complex

Конфигурация SSL.

Возвращается: при успешном выполнении

cert

string

Представление сертификата X.509 в формате PEM.

Возвращается: при успешном выполнении

certSerialNumber

string

Серийный номер, извлечённый из сертификата.

Возвращается: при успешном выполнении

commonName

string

Имя, заданное пользователем. Должно соответствовать шаблону [a-zA-Z.-_ ]+.

Возвращается: при успешном выполнении

createTime

string

Время создания сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

Возвращается: при успешном выполнении

expirationTime

string

Время истечения срока действия сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

Возвращается: при успешном выполнении

sha1Fingerprint

string

Отпечаток сертификата SHA-1.

Возвращается: при успешном выполнении

settings

complex

Пользовательские настройки.

Возвращается: при успешном выполнении

availabilityType

string

Параметр availabilityType определяет, работает ли экземпляр PostgreSQL в одной зоне или в нескольких регионах.

Возвращается: при успешном выполнении

backupConfiguration

complex

Конфигурация ежедневного резервного копирования экземпляра.

Возвращается: при успешном выполнении

binaryLogEnabled

boolean

Включено ли ведение двоичного журнала. Если резервное копирование отключено, двоичное журналирование также должно быть отключено. Только MySQL.

Возвращается: при успешном выполнении

enabled

boolean

Включить автоматическое резервное копирование экземпляра.

Возвращается: при успешном выполнении

startTime

string

Задать время начала резервного копирования в формате UTC (HH:MM).

Возвращается: при успешном выполнении

databaseFlags

complex

Флаги базы данных, передаваемые экземпляру при запуске.

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

value

string

Значение флага. Для значения true следует указать on, а для false — off. Это поле необходимо опустить, если флаг не принимает значение.

Возвращается: при успехе

ipConfiguration

complex

Настройки управления IP-адресами. Они позволяют включать или отключать IP-адрес экземпляра и управлять внешними сетями, которым разрешено подключаться к экземпляру. Для экземпляров второго поколения нельзя отключить адрес IPv4.

Возвращается: при успехе

authorizedNetworks

complex

Список внешних сетей, которым разрешено подключаться к экземпляру по IP-адресу. Используется нотация CIDR, также известная как нотация со слешем (например, 192.168.100.0/24).

Возвращается: при успехе

expirationTime

string

Время истечения срока действия этой записи управления доступом в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

Возвращается: при успехе

name

string

Необязательная метка для идентификации этой записи.

Возвращается: при успехе

value

string

Значение в списке разрешённых для управления доступом. Например, чтобы разрешить доступ клиенту с внешнего IP-адреса (IPv4 или IPv6) или из подсети, укажите здесь этот адрес или подсеть.

Возвращается: при успехе

ipv4Enabled

boolean

Следует ли назначить экземпляру IP-адрес.

Возвращается: при успехе

privateNetwork

string

Ссылка на ресурс сети VPC, из которой доступен частный IP-адрес экземпляра Cloud SQL (например, /projects/myProject/global/networks/default)

Возвращается: при успехе

requireSsl

boolean

Следует ли по умолчанию устанавливать для mysqld параметр ‘REQUIRE X509’ для пользователей, подключающихся по IP.

Возвращается: при успехе

settingsVersion

integer

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

При обновлении используйте последнее значение settingsVersion для этого экземпляра и не пытайтесь изменить это значение.

Возвращается: при успехе

tier

string

Уровень или тип машины для этого экземпляра, например db-n1-standard-1. Для экземпляров MySQL это поле определяет, относится ли экземпляр ко второму (рекомендуется) или первому поколению.

Возвращается: при успехе

userLabels

dictionary

Метки, заданные пользователем и представленные в виде словаря, где каждая метка является парой «ключ-значение».

Возвращается: при успехе

state

string

Текущее состояние экземпляра базы данных.

Возвращается: при успехе