{
"additionalProperties": false,
"extends": {
"$ref": "LbActiveMonitor
},
"id": "LbHttpsMonitor",
"module_id": "LoadBalancer",
"polymorphic-type-descriptor": {
"type-identifier": "LbHttpsMonitor"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"title": "Generation of this resource config",
"type": "int"
},
"_schema": {
"readonly": true,
"title": "Schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true,
"title": "Link to this resource"
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"certificate_chain_depth": {
"default": 3,
"description": "authentication depth is used to set the verification depth in the server certificates chain.",
"maximum": 2147483647,
"minimum": 1,
"required": false,
"title": "the maximum traversal depth of server certificate chain",
"type": "integer"
},
"cipher_group_label": {
"$ref": "SslCipherGroup,
"description": "It is a label of cipher group which is mostly consumed by GUI.",
"required": false,
"title": "Label of cipher group"
},
"ciphers": {
"items": {
"$ref": "SslCipher
},
"required": false,
"title": "supported SSL cipher list to servers",
"type": "array"
},
"client_certificate_id": {
"description": "client certificate can be specified to support client authentication.",
"required": false,
"title": "client certificate identifier",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"fall_count": {
"default": 3,
"maximum": 2147483647,
"minimum": 1,
"required": false,
"title": "num of consecutive checks must fail before marking it down",
"type": "integer"
},
"id": {
"can_sort": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"interval": {
"default": 5,
"maximum": 2147483647,
"minimum": 1,
"required": false,
"title": "the frequency at which the system issues the monitor check (in second)",
"type": "integer"
},
"is_fips": {
"description": "This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant..",
"readonly": true,
"title": "FIPS compliance of ciphers and protocols",
"type": "boolean"
},
"is_secure": {
"description": "This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure.",
"readonly": true,
"title": "Secure/Insecure monitor flag",
"type": "boolean"
},
"monitor_port": {
"$ref": "PortElement,
"description": "If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. For ICMP monitor, monitor_port is not required.",
"required": false,
"title": "port which is used for healthcheck"
},
"protocols": {
"description": "SSL versions TLS1.1 and TLS1.2 are supported and enabled by default. SSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.",
"items": {
"$ref": "SslProtocol
},
"required": false,
"title": "supported SSL protocol list to servers",
"type": "array"
},
"request_body": {
"required": false,
"title": "String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n",
"type": "string"
},
"request_headers": {
"items": {
"$ref": "LbHttpRequestHeader
},
"required": false,
"title": "Array of HTTP request headers",
"type": "array"
},
"request_method": {
"$ref": "HttpRequestMethodType,
"default": "GET",
"required": false,
"title": "the health check method for HTTP monitor type"
},
"request_url": {
"required": false,
"title": "URL used for HTTP monitor",
"type": "string"
},
"request_version": {
"$ref": "HttpRequestVersionType,
"default": "HTTP_VERSION_1_1",
"required": false,
"title": "HTTP request version"
},
"resource_type": {
"$ref": "MonitorType,
"required": true
},
"response_body": {
"description": "If HTTP response body match string (regular expressions not supported) is specified (using LbHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.",
"required": false,
"title": "response body to match",
"type": "string"
},
"response_status_codes": {
"description": "The HTTP response status code should be a valid HTTP status code.",
"items": {
"type": "int"
},
"maxItems": 64,
"required": false,
"title": "Array of single HTTP response status codes",
"type": "array"
},
"rise_count": {
"default": 3,
"maximum": 2147483647,
"minimum": 1,
"required": false,
"title": "num of consecutive checks must pass before marking it up",
"type": "integer"
},
"server_auth": {
"$ref": "ServerAuthType,
"default": "IGNORE",
"title": "server authentication mode"
},
"server_auth_ca_ids": {
"description": "If server auth type is REQUIRED, server certificate must be signed by one of the trusted Certificate Authorities (CAs), also referred to as root CAs, whose self signed certificates are specified.",
"items": {
"type": "string"
},
"required": false,
"title": "CA identifier list to verify server certificate",
"type": "array"
},
"server_auth_crl_ids": {
"description": "A Certificate Revocation List (CRL) can be specified in the server-side SSL profile binding to disallow compromised server certificates.",
"items": {
"type": "string"
},
"required": false,
"title": "CRL identifier list to verify server certificate",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"timeout": {
"default": 15,
"maximum": 2147483647,
"minimum": 1,
"required": false,
"title": "the number of seconds the target has in which to respond to the monitor\nrequest\n",
"type": "integer"
}
},
"type": "object"
}