модуль google.cloud.gcp_compute_health_check_info — сбор сведений о проверке работоспособности GCP

access_token

string

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

auth_kind

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

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

Варианты:

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

env_type

string

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

Не задавайте это значение, если не знаете, что делаете.

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

filters

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

Список пар значений фильтров. Доступные фильтры перечислены здесь: https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Каждый дополнительный фильтр в списке будет добавлен как условие AND (filter1 и filter2).

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

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

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

checkIntervalSec

integer

Как часто (в секундах) отправляется проверка работоспособности. Значение по умолчанию — 5 секунд.

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

creationTimestamp

string

Временная метка создания в текстовом формате RFC3339.

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

description

string

Необязательное описание этого ресурса. Укажите это свойство при создании ресурса.

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

grpcHealthCheck

complex

Вложенный объект-ресурс.

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

grpcServiceName

string

Имя службы gRPC для проверки работоспособности.

По соглашению значение grpcServiceName имеет следующие значения: - Пустое значение serviceName означает общий статус всех служб на серверной части.

- Непустое значение serviceName означает состояние указанной службы gRPC, определяемое владельцем этой службы.

Значение grpcServiceName может содержать только символы ASCII.

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

port

integer

Номер порта для запроса проверки работоспособности.

Необходимо указать, если не заданы portName и portSpecification или если port_specification имеет значение USE_FIXED_PORT. Допустимые значения — от 1 до 65535.

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

portName

string

Имя порта, определённое в InstanceGroup#NamedPort#name. Если заданы и port, и port_name, приоритет имеет port.

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

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности. Допустимы следующие значения: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта из `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup при проверке работоспособности используется порт, указанный для каждой сетевой конечной точки. Для других серверных частей используется порт или именованный порт, указанный в Backend Service.

Если значение не указано, проверка работоспособности gRPC следует поведению, заданному полями `port` и `portName`.

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

healthyThreshold

integer

Ранее неработоспособный экземпляр будет считаться работоспособным после указанного количества последовательных успешных проверок. Значение по умолчанию — 2.

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

http2HealthCheck

complex

Вложенный объект-ресурс.

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

host

string

Значение заголовка host в запросе проверки работоспособности HTTP2.

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

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

port

integer

Номер TCP-порта для запроса проверки работоспособности HTTP2.

Значение по умолчанию — 443.

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

portName

string

Имя порта, определённое в InstanceGroup#NamedPort#name. Если заданы и port, и port_name, приоритет имеет port.

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

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности. Допустимы следующие значения: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта из `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup при проверке работоспособности используется порт, указанный для каждой сетевой конечной точки. Для других серверных частей используется порт или именованный порт, указанный в Backend Service.

Если значение не указано, проверка работоспособности HTTP2 следует поведению, заданному полями `port` и `portName`.

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

proxyHeader

string

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

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

requestPath

string

Путь запроса проверки работоспособности HTTP2.

Значение по умолчанию — /.

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

response

string

Байты, с которыми сравнивается начало данных ответа. Если оставить поле пустым (значение по умолчанию), любой ответ будет означать работоспособность. Данные ответа могут содержать только символы ASCII.

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

httpHealthCheck

complex

Вложенный объект-ресурс.

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

host

string

Значение заголовка host в запросе проверки работоспособности HTTP.

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

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

port

integer

Номер TCP-порта для запроса проверки работоспособности HTTP.

Значение по умолчанию — 80.

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

portName

string

Имя порта, определённое в InstanceGroup#NamedPort#name. Если заданы и port, и port_name, приоритет имеет port.

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

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности. Допустимы следующие значения: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта из `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup при проверке работоспособности используется порт, указанный для каждой сетевой конечной точки. Для других серверных частей используется порт или именованный порт, указанный в Backend Service.

Если значение не указано, проверка работоспособности HTTP следует поведению, заданному полями `port` и `portName`.

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

proxyHeader

string

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

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

requestPath

string

Путь запроса проверки работоспособности HTTP.

Значение по умолчанию — /.

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

response

string

Байты, с которыми сравнивается начало данных ответа. Если оставить поле пустым (значение по умолчанию), любой ответ будет означать работоспособность. Данные ответа могут содержать только символы ASCII.

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

httpsHealthCheck

complex

Вложенный объект-ресурс.

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

host

string

Значение заголовка host в запросе проверки работоспособности HTTPS.

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

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

port

integer

Номер TCP-порта для запроса проверки работоспособности HTTPS.

Значение по умолчанию — 443.

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

portName

string

Имя порта, определённое в InstanceGroup#NamedPort#name. Если заданы и port, и port_name, приоритет имеет port.

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

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности. Допустимы следующие значения: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта из `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup при проверке работоспособности используется порт, указанный для каждой сетевой конечной точки. Для других серверных частей используется порт или именованный порт, указанный в Backend Service.

Если значение не указано, проверка работоспособности HTTPS следует поведению, заданному полями `port` и `portName`.

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

proxyHeader

string

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

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

requestPath

string

Путь запроса проверки работоспособности HTTPS.

Значение по умолчанию — /.

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

response

string

Байты, с которыми сравнивается начало данных ответа. Если оставить поле пустым (значение по умолчанию), любой ответ будет означать работоспособность. Данные ответа могут содержать только символы ASCII.

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

id

integer

Уникальный идентификатор ресурса. Этот идентификатор задаётся сервером.

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

logConfig

complex

Настройка ведения журналов для этой проверки работоспособности.

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

enable

boolean

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

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

name

string

Имя ресурса. Указывается клиентом при создании ресурса. Имя должно содержать от 1 до 63 символов и соответствовать RFC1035. В частности, имя должно содержать от 1 до 63 символов и соответствовать регулярному выражению `[a-z]([-a-z0-9]*[a-z0-9])?`: первый символ должен быть строчной буквой, а все последующие символы — дефисом, строчной буквой или цифрой, за исключением последнего символа, которым не может быть дефис.

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

sslHealthCheck

complex

Вложенный объект-ресурс.

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

port

integer

Номер TCP-порта для запроса проверки работоспособности SSL.

Значение по умолчанию — 443.

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

portName

string

Имя порта, определённое в InstanceGroup#NamedPort#name. Если заданы и port, и port_name, приоритет имеет port.

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

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности. Допустимы следующие значения: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта из `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup при проверке работоспособности используется порт, указанный для каждой сетевой конечной точки. Для других серверных частей используется порт или именованный порт, указанный в Backend Service.

Если значение не указано, проверка работоспособности SSL следует поведению, заданному полями `port` и `portName`.

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

proxyHeader

string

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

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

request

string

Данные приложения, отправляемые после установления SSL-соединения (по умолчанию поле пустое). Если поля request и response пусты, работоспособность будет определяться только установлением соединения. Данные запроса могут содержать только символы ASCII.

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

response

string

Байты, с которыми сравнивается начало данных ответа. Если оставить поле пустым (значение по умолчанию), любой ответ будет означать работоспособность. Данные ответа могут содержать только символы ASCII.

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

tcpHealthCheck

complex

Вложенный объект-ресурс.

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

port

integer

Номер TCP-порта для запроса проверки работоспособности TCP.

Значение по умолчанию — 443.

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

portName

string

Имя порта, определённое в InstanceGroup#NamedPort#name. Если заданы и port, и port_name, приоритет имеет port.

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

portSpecification

string

Указывает, как выбирается порт для проверки работоспособности; возможны следующие значения: * `USE_FIXED_PORT`: для проверки работоспособности используется номер порта из `port`.

* `USE_NAMED_PORT`: для проверки работоспособности используется `portName`.

* `USE_SERVING_PORT`: для NetworkEndpointGroup при проверке работоспособности используется порт, указанный для каждой сетевой конечной точки. Для других серверных частей при проверке работоспособности используется порт или именованный порт, указанный в Backend Service.

Если параметр не указан, проверка работоспособности TCP выполняется в соответствии с поведением, заданным полями `port` и `portName`.

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

proxyHeader

string

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

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

request

string

Данные приложения, отправляемые после установления TCP-соединения (значение по умолчанию — пустая строка). Если и request, и response пусты, для определения работоспособности достаточно установить соединение. Данные запроса могут содержать только символы ASCII.

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

response

string

Байты, с которыми сравнивается начало данных ответа. Если оставить это поле пустым (значение по умолчанию), любой ответ будет указывать на работоспособность. Данные ответа могут содержать только символы ASCII.

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

timeoutSec

integer

Время ожидания (в секундах) до объявления сбоя.

Значение по умолчанию — 5 секунд. Значение timeoutSec не может быть больше значения checkIntervalSec.

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

type

string

Указывает тип healthCheck: TCP, SSL, HTTP или HTTPS. Если параметр не указан, по умолчанию используется TCP. Должно быть указано ровно одно поле проверки работоспособности для конкретного протокола, и оно должно соответствовать полю type.

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

unhealthyThreshold

integer

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

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