opentelekomcloud 1.36.37, Apr 24 25

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.LbMonitorV3

Explore with Pulumi AI

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";

const lb = new opentelekomcloud.LbLoadbalancerV3("lb", {
    routerId: data.opentelekomcloud_vpc_subnet_v1.shared_subnet.vpc_id,
    networkIds: [data.opentelekomcloud_vpc_subnet_v1.shared_subnet.network_id],
    availabilityZones: [_var.availability_zone],
});
const pool = new opentelekomcloud.LbPoolV3("pool", {
    loadbalancerId: lb.lbLoadbalancerV3Id,
    protocol: "HTTP",
    lbAlgorithm: "ROUND_ROBIN",
});
const monitor = new opentelekomcloud.LbMonitorV3("monitor", {
    poolId: pool.lbPoolV3Id,
    type: "HTTP",
    delay: 3,
    timeout: 30,
    monitorPort: 8080,
    maxRetries: 5,
    maxRetriesDown: 1,
});

import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

lb = opentelekomcloud.LbLoadbalancerV3("lb",
    router_id=data["opentelekomcloud_vpc_subnet_v1"]["shared_subnet"]["vpc_id"],
    network_ids=[data["opentelekomcloud_vpc_subnet_v1"]["shared_subnet"]["network_id"]],
    availability_zones=[var["availability_zone"]])
pool = opentelekomcloud.LbPoolV3("pool",
    loadbalancer_id=lb.lb_loadbalancer_v3_id,
    protocol="HTTP",
    lb_algorithm="ROUND_ROBIN")
monitor = opentelekomcloud.LbMonitorV3("monitor",
    pool_id=pool.lb_pool_v3_id,
    type="HTTP",
    delay=3,
    timeout=30,
    monitor_port=8080,
    max_retries=5,
    max_retries_down=1)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		lb, err := opentelekomcloud.NewLbLoadbalancerV3(ctx, "lb", &opentelekomcloud.LbLoadbalancerV3Args{
			RouterId: pulumi.Any(data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Vpc_id),
			NetworkIds: pulumi.StringArray{
				data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Network_id,
			},
			AvailabilityZones: pulumi.StringArray{
				_var.Availability_zone,
			},
		})
		if err != nil {
			return err
		}
		pool, err := opentelekomcloud.NewLbPoolV3(ctx, "pool", &opentelekomcloud.LbPoolV3Args{
			LoadbalancerId: lb.LbLoadbalancerV3Id,
			Protocol:       pulumi.String("HTTP"),
			LbAlgorithm:    pulumi.String("ROUND_ROBIN"),
		})
		if err != nil {
			return err
		}
		_, err = opentelekomcloud.NewLbMonitorV3(ctx, "monitor", &opentelekomcloud.LbMonitorV3Args{
			PoolId:         pool.LbPoolV3Id,
			Type:           pulumi.String("HTTP"),
			Delay:          pulumi.Float64(3),
			Timeout:        pulumi.Float64(30),
			MonitorPort:    pulumi.Float64(8080),
			MaxRetries:     pulumi.Float64(5),
			MaxRetriesDown: pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var lb = new Opentelekomcloud.LbLoadbalancerV3("lb", new()
    {
        RouterId = data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Vpc_id,
        NetworkIds = new[]
        {
            data.Opentelekomcloud_vpc_subnet_v1.Shared_subnet.Network_id,
        },
        AvailabilityZones = new[]
        {
            @var.Availability_zone,
        },
    });

    var pool = new Opentelekomcloud.LbPoolV3("pool", new()
    {
        LoadbalancerId = lb.LbLoadbalancerV3Id,
        Protocol = "HTTP",
        LbAlgorithm = "ROUND_ROBIN",
    });

    var monitor = new Opentelekomcloud.LbMonitorV3("monitor", new()
    {
        PoolId = pool.LbPoolV3Id,
        Type = "HTTP",
        Delay = 3,
        Timeout = 30,
        MonitorPort = 8080,
        MaxRetries = 5,
        MaxRetriesDown = 1,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.LbLoadbalancerV3;
import com.pulumi.opentelekomcloud.LbLoadbalancerV3Args;
import com.pulumi.opentelekomcloud.LbPoolV3;
import com.pulumi.opentelekomcloud.LbPoolV3Args;
import com.pulumi.opentelekomcloud.LbMonitorV3;
import com.pulumi.opentelekomcloud.LbMonitorV3Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var lb = new LbLoadbalancerV3("lb", LbLoadbalancerV3Args.builder()
            .routerId(data.opentelekomcloud_vpc_subnet_v1().shared_subnet().vpc_id())
            .networkIds(data.opentelekomcloud_vpc_subnet_v1().shared_subnet().network_id())
            .availabilityZones(var_.availability_zone())
            .build());

        var pool = new LbPoolV3("pool", LbPoolV3Args.builder()
            .loadbalancerId(lb.lbLoadbalancerV3Id())
            .protocol("HTTP")
            .lbAlgorithm("ROUND_ROBIN")
            .build());

        var monitor = new LbMonitorV3("monitor", LbMonitorV3Args.builder()
            .poolId(pool.lbPoolV3Id())
            .type("HTTP")
            .delay(3)
            .timeout(30)
            .monitorPort(8080)
            .maxRetries(5)
            .maxRetriesDown(1)
            .build());

    }
}

resources:
  lb:
    type: opentelekomcloud:LbLoadbalancerV3
    properties:
      routerId: ${data.opentelekomcloud_vpc_subnet_v1.shared_subnet.vpc_id}
      networkIds:
        - ${data.opentelekomcloud_vpc_subnet_v1.shared_subnet.network_id}
      availabilityZones:
        - ${var.availability_zone}
  pool:
    type: opentelekomcloud:LbPoolV3
    properties:
      loadbalancerId: ${lb.lbLoadbalancerV3Id}
      protocol: HTTP
      lbAlgorithm: ROUND_ROBIN
  monitor:
    type: opentelekomcloud:LbMonitorV3
    properties:
      poolId: ${pool.lbPoolV3Id}
      type: HTTP
      delay: 3
      timeout: 30
      monitorPort: 8080
      maxRetries: 5
      maxRetriesDown: 1

Create LbMonitorV3 Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new LbMonitorV3(name: string, args: LbMonitorV3Args, opts?: CustomResourceOptions);

@overload
def LbMonitorV3(resource_name: str,
                args: LbMonitorV3Args,
                opts: Optional[ResourceOptions] = None)

@overload
def LbMonitorV3(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                max_retries: Optional[float] = None,
                delay: Optional[float] = None,
                type: Optional[str] = None,
                timeout: Optional[float] = None,
                pool_id: Optional[str] = None,
                expected_codes: Optional[str] = None,
                lb_monitor_v3_id: Optional[str] = None,
                max_retries_down: Optional[float] = None,
                monitor_port: Optional[float] = None,
                name: Optional[str] = None,
                http_method: Optional[str] = None,
                project_id: Optional[str] = None,
                admin_state_up: Optional[bool] = None,
                domain_name: Optional[str] = None,
                url_path: Optional[str] = None)

func NewLbMonitorV3(ctx *Context, name string, args LbMonitorV3Args, opts ...ResourceOption) (*LbMonitorV3, error)

public LbMonitorV3(string name, LbMonitorV3Args args, CustomResourceOptions? opts = null)

public LbMonitorV3(String name, LbMonitorV3Args args)
public LbMonitorV3(String name, LbMonitorV3Args args, CustomResourceOptions options)

type: opentelekomcloud:LbMonitorV3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args LbMonitorV3Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args LbMonitorV3Args: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args LbMonitorV3Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args LbMonitorV3Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args LbMonitorV3Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var lbMonitorV3Resource = new Opentelekomcloud.LbMonitorV3("lbMonitorV3Resource", new()
{
    MaxRetries = 0,
    Delay = 0,
    Type = "string",
    Timeout = 0,
    PoolId = "string",
    ExpectedCodes = "string",
    LbMonitorV3Id = "string",
    MaxRetriesDown = 0,
    MonitorPort = 0,
    Name = "string",
    HttpMethod = "string",
    ProjectId = "string",
    AdminStateUp = false,
    DomainName = "string",
    UrlPath = "string",
});

example, err := opentelekomcloud.NewLbMonitorV3(ctx, "lbMonitorV3Resource", &opentelekomcloud.LbMonitorV3Args{
	MaxRetries:     pulumi.Float64(0),
	Delay:          pulumi.Float64(0),
	Type:           pulumi.String("string"),
	Timeout:        pulumi.Float64(0),
	PoolId:         pulumi.String("string"),
	ExpectedCodes:  pulumi.String("string"),
	LbMonitorV3Id:  pulumi.String("string"),
	MaxRetriesDown: pulumi.Float64(0),
	MonitorPort:    pulumi.Float64(0),
	Name:           pulumi.String("string"),
	HttpMethod:     pulumi.String("string"),
	ProjectId:      pulumi.String("string"),
	AdminStateUp:   pulumi.Bool(false),
	DomainName:     pulumi.String("string"),
	UrlPath:        pulumi.String("string"),
})

var lbMonitorV3Resource = new LbMonitorV3("lbMonitorV3Resource", LbMonitorV3Args.builder()
    .maxRetries(0)
    .delay(0)
    .type("string")
    .timeout(0)
    .poolId("string")
    .expectedCodes("string")
    .lbMonitorV3Id("string")
    .maxRetriesDown(0)
    .monitorPort(0)
    .name("string")
    .httpMethod("string")
    .projectId("string")
    .adminStateUp(false)
    .domainName("string")
    .urlPath("string")
    .build());

lb_monitor_v3_resource = opentelekomcloud.LbMonitorV3("lbMonitorV3Resource",
    max_retries=0,
    delay=0,
    type="string",
    timeout=0,
    pool_id="string",
    expected_codes="string",
    lb_monitor_v3_id="string",
    max_retries_down=0,
    monitor_port=0,
    name="string",
    http_method="string",
    project_id="string",
    admin_state_up=False,
    domain_name="string",
    url_path="string")

const lbMonitorV3Resource = new opentelekomcloud.LbMonitorV3("lbMonitorV3Resource", {
    maxRetries: 0,
    delay: 0,
    type: "string",
    timeout: 0,
    poolId: "string",
    expectedCodes: "string",
    lbMonitorV3Id: "string",
    maxRetriesDown: 0,
    monitorPort: 0,
    name: "string",
    httpMethod: "string",
    projectId: "string",
    adminStateUp: false,
    domainName: "string",
    urlPath: "string",
});

type: opentelekomcloud:LbMonitorV3
properties:
    adminStateUp: false
    delay: 0
    domainName: string
    expectedCodes: string
    httpMethod: string
    lbMonitorV3Id: string
    maxRetries: 0
    maxRetriesDown: 0
    monitorPort: 0
    name: string
    poolId: string
    projectId: string
    timeout: 0
    type: string
    urlPath: string

LbMonitorV3 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The LbMonitorV3 resource accepts the following input properties:

Delay double

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

MaxRetries double

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

PoolId string

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

Timeout double

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

Type string

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

AdminStateUp bool

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

DomainName string

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

ExpectedCodes string

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

HttpMethod string

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

LbMonitorV3Id string

Specifies the health check (monitor) ID.

MaxRetriesDown double

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

MonitorPort double

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

Name string

Specifies the health check name.

ProjectId string

Specifies the project ID. Changing this creates a new monitor.

UrlPath string

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

Delay float64

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

MaxRetries float64

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

PoolId string

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

Timeout float64

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

Type string

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

AdminStateUp bool

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

DomainName string

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

ExpectedCodes string

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

HttpMethod string

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

LbMonitorV3Id string

Specifies the health check (monitor) ID.

MaxRetriesDown float64

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

MonitorPort float64

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

Name string

Specifies the health check name.

ProjectId string

Specifies the project ID. Changing this creates a new monitor.

UrlPath string

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

delay Double

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

maxRetries Double

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

poolId String

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

timeout Double

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type String

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

adminStateUp Boolean

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

domainName String

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expectedCodes String

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

httpMethod String

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lbMonitorV3Id String

Specifies the health check (monitor) ID.

maxRetriesDown Double

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitorPort Double

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name String

Specifies the health check name.

projectId String

Specifies the project ID. Changing this creates a new monitor.

urlPath String

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

delay number

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

maxRetries number

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

poolId string

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

timeout number

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type string

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

adminStateUp boolean

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

domainName string

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expectedCodes string

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

httpMethod string

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lbMonitorV3Id string

Specifies the health check (monitor) ID.

maxRetriesDown number

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitorPort number

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name string

Specifies the health check name.

projectId string

Specifies the project ID. Changing this creates a new monitor.

urlPath string

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

delay float

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

max_retries float

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

pool_id str

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

timeout float

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type str

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

admin_state_up bool

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

domain_name str

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expected_codes str

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

http_method str

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lb_monitor_v3_id str

Specifies the health check (monitor) ID.

max_retries_down float

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitor_port float

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name str

Specifies the health check name.

project_id str

Specifies the project ID. Changing this creates a new monitor.

url_path str

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

delay Number

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

maxRetries Number

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

poolId String

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

timeout Number

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type String

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

adminStateUp Boolean

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

domainName String

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expectedCodes String

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

httpMethod String

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lbMonitorV3Id String

Specifies the health check (monitor) ID.

maxRetriesDown Number

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitorPort Number

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name String

Specifies the health check name.

projectId String

Specifies the project ID. Changing this creates a new monitor.

urlPath String

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

Outputs

All input properties are implicitly available as output properties. Additionally, the LbMonitorV3 resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing LbMonitorV3 Resource

Get an existing LbMonitorV3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: LbMonitorV3State, opts?: CustomResourceOptions): LbMonitorV3

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        delay: Optional[float] = None,
        domain_name: Optional[str] = None,
        expected_codes: Optional[str] = None,
        http_method: Optional[str] = None,
        lb_monitor_v3_id: Optional[str] = None,
        max_retries: Optional[float] = None,
        max_retries_down: Optional[float] = None,
        monitor_port: Optional[float] = None,
        name: Optional[str] = None,
        pool_id: Optional[str] = None,
        project_id: Optional[str] = None,
        timeout: Optional[float] = None,
        type: Optional[str] = None,
        url_path: Optional[str] = None) -> LbMonitorV3

func GetLbMonitorV3(ctx *Context, name string, id IDInput, state *LbMonitorV3State, opts ...ResourceOption) (*LbMonitorV3, error)

public static LbMonitorV3 Get(string name, Input<string> id, LbMonitorV3State? state, CustomResourceOptions? opts = null)

public static LbMonitorV3 get(String name, Output<String> id, LbMonitorV3State state, CustomResourceOptions options)

resources:  _:    type: opentelekomcloud:LbMonitorV3    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AdminStateUp bool

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

Delay double

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

DomainName string

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

ExpectedCodes string

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

HttpMethod string

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

LbMonitorV3Id string

Specifies the health check (monitor) ID.

MaxRetries double

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

MaxRetriesDown double

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

MonitorPort double

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

Name string

Specifies the health check name.

PoolId string

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

ProjectId string

Specifies the project ID. Changing this creates a new monitor.

Timeout double

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

Type string

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

UrlPath string

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

AdminStateUp bool

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

Delay float64

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

DomainName string

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

ExpectedCodes string

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

HttpMethod string

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

LbMonitorV3Id string

Specifies the health check (monitor) ID.

MaxRetries float64

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

MaxRetriesDown float64

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

MonitorPort float64

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

Name string

Specifies the health check name.

PoolId string

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

ProjectId string

Specifies the project ID. Changing this creates a new monitor.

Timeout float64

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

Type string

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

UrlPath string

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

adminStateUp Boolean

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

delay Double

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

domainName String

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expectedCodes String

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

httpMethod String

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lbMonitorV3Id String

Specifies the health check (monitor) ID.

maxRetries Double

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

maxRetriesDown Double

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitorPort Double

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name String

Specifies the health check name.

poolId String

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

projectId String

Specifies the project ID. Changing this creates a new monitor.

timeout Double

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type String

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

urlPath String

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

adminStateUp boolean

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

delay number

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

domainName string

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expectedCodes string

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

httpMethod string

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lbMonitorV3Id string

Specifies the health check (monitor) ID.

maxRetries number

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

maxRetriesDown number

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitorPort number

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name string

Specifies the health check name.

poolId string

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

projectId string

Specifies the project ID. Changing this creates a new monitor.

timeout number

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type string

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

urlPath string

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

admin_state_up bool

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

delay float

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

domain_name str

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expected_codes str

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

http_method str

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lb_monitor_v3_id str

Specifies the health check (monitor) ID.

max_retries float

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

max_retries_down float

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitor_port float

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name str

Specifies the health check name.

pool_id str

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

project_id str

Specifies the project ID. Changing this creates a new monitor.

timeout float

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type str

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

url_path str

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

adminStateUp Boolean

Specifies the administrative status of the health check. true indicates that the health check is enabled, and false indicates that the health check is disabled.

Default: true

delay Number

Specifies the interval between health checks, in seconds.

The value of this parameter ranges from 1 to 50.

domainName String

Specifies the domain name that HTTP requests are sent to during the health check.

This parameter is available only when type is set to HTTP.

The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.

The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.

expectedCodes String

Specifies the expected HTTP status code. This parameter will take effect only when type is set to HTTP.

The value options are as follows:

A specific value, for example, 200
A list of values that are separated with commas (,), for example, 200, 202
A value range, for example, 200-204

Default: 200

httpMethod String

Specifies the HTTP method.

The value can be GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, or PATCH.

This parameter will take effect only when type is set to HTTP.

lbMonitorV3Id String

Specifies the health check (monitor) ID.

maxRetries Number

Specifies the number of consecutive health checks when the health check result of a backend server changes from OFFLINE to ONLINE.

The value ranges from 1 to 10.

maxRetriesDown Number

Specifies the number of consecutive health checks when the health check result of a backend server changes from ONLINE to OFFLINE.

The value ranges from 1 to 10.

Default value is 3

monitorPort Number

Specifies the port used for the health check. If this parameter is left blank, the port of the backend server group will be used by default.

name String

Specifies the health check name.

poolId String

Specifies the ID of the backend server group for which the health check is configured. Changing this creates a new monitor.

projectId String

Specifies the project ID. Changing this creates a new monitor.

timeout Number

Specifies the maximum time required for waiting for a response from the health check, in seconds.

The value of this parameter ranges from 1 to 50.

It is recommended that you set the value less than that of parameter delay.

type String

Specifies the health check protocol.

The value can be TCP, UDP_CONNECT, HTTP, HTTPS, or PING.

urlPath String

Specifies the HTTP request path for the health check.

The value must start with a slash (/), and the default value is /.

This parameter is available only when type is set to HTTP.

Import

Load Balancer Monitor can be imported using the monitor ID, e.g.:

$ pulumi import opentelekomcloud:index/lbMonitorV3:LbMonitorV3 monitor b4ef7345-cf1a-41ca-8baa-941466a66853

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.LbMonitorV3

On this page

On this page

Example Usage

Create LbMonitorV3 Resource

Constructor syntax

Parameters

Constructor example

LbMonitorV3 Resource Properties

Inputs

Outputs

Look up Existing LbMonitorV3 Resource

Import

Package Details

On this page

On this page