1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCisHealthchecks
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getCisHealthchecks

Explore with Pulumi AI

Retrieve information about an existing IBM Cloud Internet Service Global Load Balancer health monitor and check as a read-only data source. For more information, about CIS health check, see setting up health checks.

Using getCisHealthchecks

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCisHealthchecks(args: GetCisHealthchecksArgs, opts?: InvokeOptions): Promise<GetCisHealthchecksResult>
function getCisHealthchecksOutput(args: GetCisHealthchecksOutputArgs, opts?: InvokeOptions): Output<GetCisHealthchecksResult>
Copy
def get_cis_healthchecks(cis_id: Optional[str] = None,
                         id: Optional[str] = None,
                         timeouts: Optional[GetCisHealthchecksTimeouts] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCisHealthchecksResult
def get_cis_healthchecks_output(cis_id: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         timeouts: Optional[pulumi.Input[GetCisHealthchecksTimeoutsArgs]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCisHealthchecksResult]
Copy
func GetCisHealthchecks(ctx *Context, args *GetCisHealthchecksArgs, opts ...InvokeOption) (*GetCisHealthchecksResult, error)
func GetCisHealthchecksOutput(ctx *Context, args *GetCisHealthchecksOutputArgs, opts ...InvokeOption) GetCisHealthchecksResultOutput
Copy

> Note: This function is named GetCisHealthchecks in the Go SDK.

public static class GetCisHealthchecks 
{
    public static Task<GetCisHealthchecksResult> InvokeAsync(GetCisHealthchecksArgs args, InvokeOptions? opts = null)
    public static Output<GetCisHealthchecksResult> Invoke(GetCisHealthchecksInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCisHealthchecksResult> getCisHealthchecks(GetCisHealthchecksArgs args, InvokeOptions options)
public static Output<GetCisHealthchecksResult> getCisHealthchecks(GetCisHealthchecksArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCisHealthchecks:getCisHealthchecks
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CisId This property is required. string
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
Id string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts
CisId This property is required. string
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
Id string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts
cisId This property is required. String
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id String
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts
cisId This property is required. string
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts
cis_id This property is required. str
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id str
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts
cisId This property is required. String
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
id String
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts Property Map

getCisHealthchecks Result

The following output properties are available:

CisHealthchecks List<GetCisHealthchecksCisHealthcheck>
CisId string
Id string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts
CisHealthchecks []GetCisHealthchecksCisHealthcheck
CisId string
Id string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Timeouts GetCisHealthchecksTimeouts
cisHealthchecks List<GetCisHealthchecksCisHealthcheck>
cisId String
id String
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts
cisHealthchecks GetCisHealthchecksCisHealthcheck[]
cisId string
id string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts
cis_healthchecks Sequence[GetCisHealthchecksCisHealthcheck]
cis_id str
id str
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts GetCisHealthchecksTimeouts
cisHealthchecks List<Property Map>
cisId String
id String
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
timeouts Property Map

Supporting Types

GetCisHealthchecksCisHealthcheck

AllowInsecure This property is required. bool
(String) Do not validate the certificate when health check uses HTTPS.
CisId This property is required. string
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
CreateOn This property is required. string
Description This property is required. string
(String) Free text description.
ExpectedBody This property is required. string
(String) The requested body.
ExpectedCodes This property is required. string
(String) The expected HTTP response code or code range of the health check. For example, 2xx.
FollowRedirects This property is required. bool
(String) Follow redirects if returned by the origin.
Headers This property is required. List<GetCisHealthchecksCisHealthcheckHeader>
(String) The health check header.
Id This property is required. string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Interval This property is required. double
(String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
Method This property is required. string
(String) The HTTP method to use for the health check.
ModifiedOn This property is required. string
(String) The RFC3339 timestamp of when the load balancer monitor was last modified.
MonitorId This property is required. string
(String) The load balancer monitor ID.
Path This property is required. string
(String) The endpoint path to health check.
Port This property is required. double
(String) The TCP port to use for the health check.
Retries This property is required. double
(String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
Timeout This property is required. double
(String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
Type This property is required. string
(String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.
AllowInsecure This property is required. bool
(String) Do not validate the certificate when health check uses HTTPS.
CisId This property is required. string
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
CreateOn This property is required. string
Description This property is required. string
(String) Free text description.
ExpectedBody This property is required. string
(String) The requested body.
ExpectedCodes This property is required. string
(String) The expected HTTP response code or code range of the health check. For example, 2xx.
FollowRedirects This property is required. bool
(String) Follow redirects if returned by the origin.
Headers This property is required. []GetCisHealthchecksCisHealthcheckHeader
(String) The health check header.
Id This property is required. string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
Interval This property is required. float64
(String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
Method This property is required. string
(String) The HTTP method to use for the health check.
ModifiedOn This property is required. string
(String) The RFC3339 timestamp of when the load balancer monitor was last modified.
MonitorId This property is required. string
(String) The load balancer monitor ID.
Path This property is required. string
(String) The endpoint path to health check.
Port This property is required. float64
(String) The TCP port to use for the health check.
Retries This property is required. float64
(String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
Timeout This property is required. float64
(String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
Type This property is required. string
(String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.
allowInsecure This property is required. Boolean
(String) Do not validate the certificate when health check uses HTTPS.
cisId This property is required. String
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
createOn This property is required. String
description This property is required. String
(String) Free text description.
expectedBody This property is required. String
(String) The requested body.
expectedCodes This property is required. String
(String) The expected HTTP response code or code range of the health check. For example, 2xx.
followRedirects This property is required. Boolean
(String) Follow redirects if returned by the origin.
headers This property is required. List<GetCisHealthchecksCisHealthcheckHeader>
(String) The health check header.
id This property is required. String
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval This property is required. Double
(String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method This property is required. String
(String) The HTTP method to use for the health check.
modifiedOn This property is required. String
(String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitorId This property is required. String
(String) The load balancer monitor ID.
path This property is required. String
(String) The endpoint path to health check.
port This property is required. Double
(String) The TCP port to use for the health check.
retries This property is required. Double
(String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout This property is required. Double
(String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type This property is required. String
(String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.
allowInsecure This property is required. boolean
(String) Do not validate the certificate when health check uses HTTPS.
cisId This property is required. string
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
createOn This property is required. string
description This property is required. string
(String) Free text description.
expectedBody This property is required. string
(String) The requested body.
expectedCodes This property is required. string
(String) The expected HTTP response code or code range of the health check. For example, 2xx.
followRedirects This property is required. boolean
(String) Follow redirects if returned by the origin.
headers This property is required. GetCisHealthchecksCisHealthcheckHeader[]
(String) The health check header.
id This property is required. string
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval This property is required. number
(String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method This property is required. string
(String) The HTTP method to use for the health check.
modifiedOn This property is required. string
(String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitorId This property is required. string
(String) The load balancer monitor ID.
path This property is required. string
(String) The endpoint path to health check.
port This property is required. number
(String) The TCP port to use for the health check.
retries This property is required. number
(String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout This property is required. number
(String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type This property is required. string
(String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.
allow_insecure This property is required. bool
(String) Do not validate the certificate when health check uses HTTPS.
cis_id This property is required. str
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
create_on This property is required. str
description This property is required. str
(String) Free text description.
expected_body This property is required. str
(String) The requested body.
expected_codes This property is required. str
(String) The expected HTTP response code or code range of the health check. For example, 2xx.
follow_redirects This property is required. bool
(String) Follow redirects if returned by the origin.
headers This property is required. Sequence[GetCisHealthchecksCisHealthcheckHeader]
(String) The health check header.
id This property is required. str
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval This property is required. float
(String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method This property is required. str
(String) The HTTP method to use for the health check.
modified_on This property is required. str
(String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitor_id This property is required. str
(String) The load balancer monitor ID.
path This property is required. str
(String) The endpoint path to health check.
port This property is required. float
(String) The TCP port to use for the health check.
retries This property is required. float
(String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout This property is required. float
(String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type This property is required. str
(String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.
allowInsecure This property is required. Boolean
(String) Do not validate the certificate when health check uses HTTPS.
cisId This property is required. String
The resource CRN ID of the IBM Cloud Internet Services on which zones were created.
createOn This property is required. String
description This property is required. String
(String) Free text description.
expectedBody This property is required. String
(String) The requested body.
expectedCodes This property is required. String
(String) The expected HTTP response code or code range of the health check. For example, 2xx.
followRedirects This property is required. Boolean
(String) Follow redirects if returned by the origin.
headers This property is required. List<Property Map>
(String) The health check header.
id This property is required. String
(String) The load balancer monitor ID and CRN. For example, monitor_id:crn.
interval This property is required. Number
(String) The interval between each health check. Shorter intervals improve failover time, but can increase load on the origins as you check from multiple locations. The default value is 60.
method This property is required. String
(String) The HTTP method to use for the health check.
modifiedOn This property is required. String
(String) The RFC3339 timestamp of when the load balancer monitor was last modified.
monitorId This property is required. String
(String) The load balancer monitor ID.
path This property is required. String
(String) The endpoint path to health check.
port This property is required. Number
(String) The TCP port to use for the health check.
retries This property is required. Number
(String) The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. The default value is 2.
timeout This property is required. Number
(String) The timeout (in seconds) before marking the health check as failed. The default value is 5.
type This property is required. String
(String) The protocol to use for the health check. Currently supported protocols are HTTP, HTTPS, and TCP. The default value is HTTP.

GetCisHealthchecksCisHealthcheckHeader

Header This property is required. string
Values This property is required. List<string>
Header This property is required. string
Values This property is required. []string
header This property is required. String
values This property is required. List<String>
header This property is required. string
values This property is required. string[]
header This property is required. str
values This property is required. Sequence[str]
header This property is required. String
values This property is required. List<String>

GetCisHealthchecksTimeouts

Read string
Read string
read String
read string
read str
read String

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.