1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwVpcChannelV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.ApigwVpcChannelV2

Explore with Pulumi AI

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

    Up-to-date reference of API arguments for API Gateway VPC Channel service you can get at documentation portal

    Manages a channel resource within OpenTelekomCloud.

    After creating a channel of type server, you can configure it for an API of an HTTP/HTTPS backend service.

    Example Usage

    Create a channel of type server and use the default group to manage servers

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      channelName:
        type: dynamic
      backendServers:
        type: list(object({group_name = union(none, string), id = union(none, string), weight = union(none, number)}))
    resources:
      test:
        type: opentelekomcloud:ApigwVpcChannelV2
        properties:
          gatewayId: ${gatewayId}
          port: 8080
          dynamic:
            - forEach: ${backendServers}
              content:
                - id: ${member.value.id}
                  weight: ${member.value.weight}
    

    Create a channel of type server and use the custom group to manage servers

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      channelName:
        type: dynamic
      backendServerGroups:
        type: list(object({description = union(none, string), name = union(none, string), weight = union(none, number)}))
      backendServers:
        type: list(object({group_name = union(none, string), id = union(none, string), weight = union(none, number)}))
    resources:
      test:
        type: opentelekomcloud:ApigwVpcChannelV2
        properties:
          gatewayId: ${gatewayId}
          port: 8080
          # The length of group list cannot be 0 if you want to use dynamic syntax
          dynamic:
            - forEach: ${backendServerGroups}
              content:
                - name: ${member.value.name}
                  description: ${member.value.description}
                  weight: ${member.value.weight}
            - forEach: ${backendServers}
              content:
                - groupName: ${member.value.group_name}
                  id: ${member.value.id}
                  weight: ${member.value.weight}
    

    Create a channel of type microservice

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    configuration:
      gatewayId:
        type: dynamic
      channelName:
        type: dynamic
      clusterId:
        type: dynamic
      statelessWorkloadName:
        type: dynamic
      memberGroupsConfig:
        type: list(object({microservice_port = union(none, number), microservice_tags = union(map(string), none), name = union(none, string), weight = union(none, number)}))
    resources:
      test:
        type: opentelekomcloud:ApigwVpcChannelV2
        properties:
          gatewayId: ${gatewayId}
          port: 80
          lbAlgorithm: 1
          memberType: ip
          type: 3
          dynamic:
            - forEach: ${memberGroupsConfig}
              content:
                - name: ${member_group.value.name}
                  weight: ${member_group.value.weight}
                  microservicePort: ${member_group.value.microservice_port}
                  microserviceTags: ${member_group.value.microservice_tags}
          healthCheck:
            protocol: TCP
            thresholdNormal: 2
            thresholdAbnormal: 2
            interval: 5
            timeout: 2
            port: 65530
            path: /
            method: GET
            httpCodes: 200,201,208-209
            enableClientSsl: false
            status: 1
          microservice:
            cceConfig:
              clusterId: ${clusterId}
              namespace: default
              workloadType: deployment
              labelKey: app
              labelValue: ${statelessWorkloadName}
    

    Create ApigwVpcChannelV2 Resource

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

    Constructor syntax

    new ApigwVpcChannelV2(name: string, args: ApigwVpcChannelV2Args, opts?: CustomResourceOptions);
    @overload
    def ApigwVpcChannelV2(resource_name: str,
                          args: ApigwVpcChannelV2Args,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApigwVpcChannelV2(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          gateway_id: Optional[str] = None,
                          lb_algorithm: Optional[float] = None,
                          port: Optional[float] = None,
                          apigw_vpc_channel_v2_id: Optional[str] = None,
                          health_check: Optional[ApigwVpcChannelV2HealthCheckArgs] = None,
                          member_groups: Optional[Sequence[ApigwVpcChannelV2MemberGroupArgs]] = None,
                          member_type: Optional[str] = None,
                          members: Optional[Sequence[ApigwVpcChannelV2MemberArgs]] = None,
                          microservice: Optional[ApigwVpcChannelV2MicroserviceArgs] = None,
                          name: Optional[str] = None,
                          type: Optional[float] = None)
    func NewApigwVpcChannelV2(ctx *Context, name string, args ApigwVpcChannelV2Args, opts ...ResourceOption) (*ApigwVpcChannelV2, error)
    public ApigwVpcChannelV2(string name, ApigwVpcChannelV2Args args, CustomResourceOptions? opts = null)
    public ApigwVpcChannelV2(String name, ApigwVpcChannelV2Args args)
    public ApigwVpcChannelV2(String name, ApigwVpcChannelV2Args args, CustomResourceOptions options)
    
    type: opentelekomcloud:ApigwVpcChannelV2
    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 ApigwVpcChannelV2Args
    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 ApigwVpcChannelV2Args
    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 ApigwVpcChannelV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwVpcChannelV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwVpcChannelV2Args
    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 apigwVpcChannelV2Resource = new Opentelekomcloud.ApigwVpcChannelV2("apigwVpcChannelV2Resource", new()
    {
        GatewayId = "string",
        LbAlgorithm = 0,
        Port = 0,
        ApigwVpcChannelV2Id = "string",
        HealthCheck = new Opentelekomcloud.Inputs.ApigwVpcChannelV2HealthCheckArgs
        {
            Interval = 0,
            Protocol = "string",
            ThresholdAbnormal = 0,
            ThresholdNormal = 0,
            Timeout = 0,
            EnableClientSsl = false,
            HttpCodes = "string",
            Method = "string",
            Path = "string",
            Port = 0,
            Status = 0,
        },
        MemberGroups = new[]
        {
            new Opentelekomcloud.Inputs.ApigwVpcChannelV2MemberGroupArgs
            {
                Name = "string",
                Description = "string",
                MicroservicePort = 0,
                MicroserviceTags = 
                {
                    { "string", "string" },
                },
                MicroserviceVersion = "string",
                Weight = 0,
            },
        },
        MemberType = "string",
        Members = new[]
        {
            new Opentelekomcloud.Inputs.ApigwVpcChannelV2MemberArgs
            {
                GroupName = "string",
                Host = "string",
                Id = "string",
                IsBackup = false,
                Name = "string",
                Port = 0,
                Status = 0,
                Weight = 0,
            },
        },
        Microservice = new Opentelekomcloud.Inputs.ApigwVpcChannelV2MicroserviceArgs
        {
            CceConfig = new Opentelekomcloud.Inputs.ApigwVpcChannelV2MicroserviceCceConfigArgs
            {
                ClusterId = "string",
                Namespace = "string",
                WorkloadType = "string",
                LabelKey = "string",
                LabelValue = "string",
                WorkloadName = "string",
            },
            CseConfig = new Opentelekomcloud.Inputs.ApigwVpcChannelV2MicroserviceCseConfigArgs
            {
                EngineId = "string",
                ServiceId = "string",
            },
        },
        Name = "string",
        Type = 0,
    });
    
    example, err := opentelekomcloud.NewApigwVpcChannelV2(ctx, "apigwVpcChannelV2Resource", &opentelekomcloud.ApigwVpcChannelV2Args{
    	GatewayId:           pulumi.String("string"),
    	LbAlgorithm:         pulumi.Float64(0),
    	Port:                pulumi.Float64(0),
    	ApigwVpcChannelV2Id: pulumi.String("string"),
    	HealthCheck: &opentelekomcloud.ApigwVpcChannelV2HealthCheckArgs{
    		Interval:          pulumi.Float64(0),
    		Protocol:          pulumi.String("string"),
    		ThresholdAbnormal: pulumi.Float64(0),
    		ThresholdNormal:   pulumi.Float64(0),
    		Timeout:           pulumi.Float64(0),
    		EnableClientSsl:   pulumi.Bool(false),
    		HttpCodes:         pulumi.String("string"),
    		Method:            pulumi.String("string"),
    		Path:              pulumi.String("string"),
    		Port:              pulumi.Float64(0),
    		Status:            pulumi.Float64(0),
    	},
    	MemberGroups: opentelekomcloud.ApigwVpcChannelV2MemberGroupArray{
    		&opentelekomcloud.ApigwVpcChannelV2MemberGroupArgs{
    			Name:             pulumi.String("string"),
    			Description:      pulumi.String("string"),
    			MicroservicePort: pulumi.Float64(0),
    			MicroserviceTags: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			MicroserviceVersion: pulumi.String("string"),
    			Weight:              pulumi.Float64(0),
    		},
    	},
    	MemberType: pulumi.String("string"),
    	Members: opentelekomcloud.ApigwVpcChannelV2MemberArray{
    		&opentelekomcloud.ApigwVpcChannelV2MemberArgs{
    			GroupName: pulumi.String("string"),
    			Host:      pulumi.String("string"),
    			Id:        pulumi.String("string"),
    			IsBackup:  pulumi.Bool(false),
    			Name:      pulumi.String("string"),
    			Port:      pulumi.Float64(0),
    			Status:    pulumi.Float64(0),
    			Weight:    pulumi.Float64(0),
    		},
    	},
    	Microservice: &opentelekomcloud.ApigwVpcChannelV2MicroserviceArgs{
    		CceConfig: &opentelekomcloud.ApigwVpcChannelV2MicroserviceCceConfigArgs{
    			ClusterId:    pulumi.String("string"),
    			Namespace:    pulumi.String("string"),
    			WorkloadType: pulumi.String("string"),
    			LabelKey:     pulumi.String("string"),
    			LabelValue:   pulumi.String("string"),
    			WorkloadName: pulumi.String("string"),
    		},
    		CseConfig: &opentelekomcloud.ApigwVpcChannelV2MicroserviceCseConfigArgs{
    			EngineId:  pulumi.String("string"),
    			ServiceId: pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	Type: pulumi.Float64(0),
    })
    
    var apigwVpcChannelV2Resource = new ApigwVpcChannelV2("apigwVpcChannelV2Resource", ApigwVpcChannelV2Args.builder()
        .gatewayId("string")
        .lbAlgorithm(0)
        .port(0)
        .apigwVpcChannelV2Id("string")
        .healthCheck(ApigwVpcChannelV2HealthCheckArgs.builder()
            .interval(0)
            .protocol("string")
            .thresholdAbnormal(0)
            .thresholdNormal(0)
            .timeout(0)
            .enableClientSsl(false)
            .httpCodes("string")
            .method("string")
            .path("string")
            .port(0)
            .status(0)
            .build())
        .memberGroups(ApigwVpcChannelV2MemberGroupArgs.builder()
            .name("string")
            .description("string")
            .microservicePort(0)
            .microserviceTags(Map.of("string", "string"))
            .microserviceVersion("string")
            .weight(0)
            .build())
        .memberType("string")
        .members(ApigwVpcChannelV2MemberArgs.builder()
            .groupName("string")
            .host("string")
            .id("string")
            .isBackup(false)
            .name("string")
            .port(0)
            .status(0)
            .weight(0)
            .build())
        .microservice(ApigwVpcChannelV2MicroserviceArgs.builder()
            .cceConfig(ApigwVpcChannelV2MicroserviceCceConfigArgs.builder()
                .clusterId("string")
                .namespace("string")
                .workloadType("string")
                .labelKey("string")
                .labelValue("string")
                .workloadName("string")
                .build())
            .cseConfig(ApigwVpcChannelV2MicroserviceCseConfigArgs.builder()
                .engineId("string")
                .serviceId("string")
                .build())
            .build())
        .name("string")
        .type(0)
        .build());
    
    apigw_vpc_channel_v2_resource = opentelekomcloud.ApigwVpcChannelV2("apigwVpcChannelV2Resource",
        gateway_id="string",
        lb_algorithm=0,
        port=0,
        apigw_vpc_channel_v2_id="string",
        health_check={
            "interval": 0,
            "protocol": "string",
            "threshold_abnormal": 0,
            "threshold_normal": 0,
            "timeout": 0,
            "enable_client_ssl": False,
            "http_codes": "string",
            "method": "string",
            "path": "string",
            "port": 0,
            "status": 0,
        },
        member_groups=[{
            "name": "string",
            "description": "string",
            "microservice_port": 0,
            "microservice_tags": {
                "string": "string",
            },
            "microservice_version": "string",
            "weight": 0,
        }],
        member_type="string",
        members=[{
            "group_name": "string",
            "host": "string",
            "id": "string",
            "is_backup": False,
            "name": "string",
            "port": 0,
            "status": 0,
            "weight": 0,
        }],
        microservice={
            "cce_config": {
                "cluster_id": "string",
                "namespace": "string",
                "workload_type": "string",
                "label_key": "string",
                "label_value": "string",
                "workload_name": "string",
            },
            "cse_config": {
                "engine_id": "string",
                "service_id": "string",
            },
        },
        name="string",
        type=0)
    
    const apigwVpcChannelV2Resource = new opentelekomcloud.ApigwVpcChannelV2("apigwVpcChannelV2Resource", {
        gatewayId: "string",
        lbAlgorithm: 0,
        port: 0,
        apigwVpcChannelV2Id: "string",
        healthCheck: {
            interval: 0,
            protocol: "string",
            thresholdAbnormal: 0,
            thresholdNormal: 0,
            timeout: 0,
            enableClientSsl: false,
            httpCodes: "string",
            method: "string",
            path: "string",
            port: 0,
            status: 0,
        },
        memberGroups: [{
            name: "string",
            description: "string",
            microservicePort: 0,
            microserviceTags: {
                string: "string",
            },
            microserviceVersion: "string",
            weight: 0,
        }],
        memberType: "string",
        members: [{
            groupName: "string",
            host: "string",
            id: "string",
            isBackup: false,
            name: "string",
            port: 0,
            status: 0,
            weight: 0,
        }],
        microservice: {
            cceConfig: {
                clusterId: "string",
                namespace: "string",
                workloadType: "string",
                labelKey: "string",
                labelValue: "string",
                workloadName: "string",
            },
            cseConfig: {
                engineId: "string",
                serviceId: "string",
            },
        },
        name: "string",
        type: 0,
    });
    
    type: opentelekomcloud:ApigwVpcChannelV2
    properties:
        apigwVpcChannelV2Id: string
        gatewayId: string
        healthCheck:
            enableClientSsl: false
            httpCodes: string
            interval: 0
            method: string
            path: string
            port: 0
            protocol: string
            status: 0
            thresholdAbnormal: 0
            thresholdNormal: 0
            timeout: 0
        lbAlgorithm: 0
        memberGroups:
            - description: string
              microservicePort: 0
              microserviceTags:
                string: string
              microserviceVersion: string
              name: string
              weight: 0
        memberType: string
        members:
            - groupName: string
              host: string
              id: string
              isBackup: false
              name: string
              port: 0
              status: 0
              weight: 0
        microservice:
            cceConfig:
                clusterId: string
                labelKey: string
                labelValue: string
                namespace: string
                workloadName: string
                workloadType: string
            cseConfig:
                engineId: string
                serviceId: string
        name: string
        port: 0
        type: 0
    

    ApigwVpcChannelV2 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 ApigwVpcChannelV2 resource accepts the following input properties:

    GatewayId string
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    LbAlgorithm double
    Specifies the distribution algorithm. The valid values are as follows:
    Port double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    ApigwVpcChannelV2Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    HealthCheck ApigwVpcChannelV2HealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    MemberGroups List<ApigwVpcChannelV2MemberGroup>
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    MemberType string
    Specifies the member type of the channel. The valid values are as follows:
    Members List<ApigwVpcChannelV2Member>
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    Microservice ApigwVpcChannelV2Microservice

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Type double
    Specifies the type of the channel. The valid values are as follows:
    GatewayId string
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    LbAlgorithm float64
    Specifies the distribution algorithm. The valid values are as follows:
    Port float64
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    ApigwVpcChannelV2Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    HealthCheck ApigwVpcChannelV2HealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    MemberGroups []ApigwVpcChannelV2MemberGroupArgs
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    MemberType string
    Specifies the member type of the channel. The valid values are as follows:
    Members []ApigwVpcChannelV2MemberArgs
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    Microservice ApigwVpcChannelV2MicroserviceArgs

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Type float64
    Specifies the type of the channel. The valid values are as follows:
    gatewayId String
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    lbAlgorithm Double
    Specifies the distribution algorithm. The valid values are as follows:
    port Double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    apigwVpcChannelV2Id String

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    healthCheck ApigwVpcChannelV2HealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    memberGroups List<ApigwVpcChannelV2MemberGroup>
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    memberType String
    Specifies the member type of the channel. The valid values are as follows:
    members List<ApigwVpcChannelV2Member>
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice ApigwVpcChannelV2Microservice

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    type Double
    Specifies the type of the channel. The valid values are as follows:
    gatewayId string
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    lbAlgorithm number
    Specifies the distribution algorithm. The valid values are as follows:
    port number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    apigwVpcChannelV2Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    healthCheck ApigwVpcChannelV2HealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    memberGroups ApigwVpcChannelV2MemberGroup[]
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    memberType string
    Specifies the member type of the channel. The valid values are as follows:
    members ApigwVpcChannelV2Member[]
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice ApigwVpcChannelV2Microservice

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    type number
    Specifies the type of the channel. The valid values are as follows:
    gateway_id str
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    lb_algorithm float
    Specifies the distribution algorithm. The valid values are as follows:
    port float
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    apigw_vpc_channel_v2_id str

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    health_check ApigwVpcChannelV2HealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    member_groups Sequence[ApigwVpcChannelV2MemberGroupArgs]
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    member_type str
    Specifies the member type of the channel. The valid values are as follows:
    members Sequence[ApigwVpcChannelV2MemberArgs]
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice ApigwVpcChannelV2MicroserviceArgs

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name str
    Specifies the name of the backend server. Required if the parameter member.id is set.
    type float
    Specifies the type of the channel. The valid values are as follows:
    gatewayId String
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    lbAlgorithm Number
    Specifies the distribution algorithm. The valid values are as follows:
    port Number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    apigwVpcChannelV2Id String

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    healthCheck Property Map
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    memberGroups List<Property Map>
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    memberType String
    Specifies the member type of the channel. The valid values are as follows:
    members List<Property Map>
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice Property Map

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    type Number
    Specifies the type of the channel. The valid values are as follows:

    Outputs

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

    CreatedAt string
    The time when the channel was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the channel is located.
    Status double
    Specifies the status of health check. The valid values are as follows:
    CreatedAt string
    The time when the channel was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Region string
    The region where the channel is located.
    Status float64
    Specifies the status of health check. The valid values are as follows:
    createdAt String
    The time when the channel was created.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the channel is located.
    status Double
    Specifies the status of health check. The valid values are as follows:
    createdAt string
    The time when the channel was created.
    id string
    The provider-assigned unique ID for this managed resource.
    region string
    The region where the channel is located.
    status number
    Specifies the status of health check. The valid values are as follows:
    created_at str
    The time when the channel was created.
    id str
    The provider-assigned unique ID for this managed resource.
    region str
    The region where the channel is located.
    status float
    Specifies the status of health check. The valid values are as follows:
    createdAt String
    The time when the channel was created.
    id String
    The provider-assigned unique ID for this managed resource.
    region String
    The region where the channel is located.
    status Number
    Specifies the status of health check. The valid values are as follows:

    Look up Existing ApigwVpcChannelV2 Resource

    Get an existing ApigwVpcChannelV2 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?: ApigwVpcChannelV2State, opts?: CustomResourceOptions): ApigwVpcChannelV2
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apigw_vpc_channel_v2_id: Optional[str] = None,
            created_at: Optional[str] = None,
            gateway_id: Optional[str] = None,
            health_check: Optional[ApigwVpcChannelV2HealthCheckArgs] = None,
            lb_algorithm: Optional[float] = None,
            member_groups: Optional[Sequence[ApigwVpcChannelV2MemberGroupArgs]] = None,
            member_type: Optional[str] = None,
            members: Optional[Sequence[ApigwVpcChannelV2MemberArgs]] = None,
            microservice: Optional[ApigwVpcChannelV2MicroserviceArgs] = None,
            name: Optional[str] = None,
            port: Optional[float] = None,
            region: Optional[str] = None,
            status: Optional[float] = None,
            type: Optional[float] = None) -> ApigwVpcChannelV2
    func GetApigwVpcChannelV2(ctx *Context, name string, id IDInput, state *ApigwVpcChannelV2State, opts ...ResourceOption) (*ApigwVpcChannelV2, error)
    public static ApigwVpcChannelV2 Get(string name, Input<string> id, ApigwVpcChannelV2State? state, CustomResourceOptions? opts = null)
    public static ApigwVpcChannelV2 get(String name, Output<String> id, ApigwVpcChannelV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwVpcChannelV2    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:
    ApigwVpcChannelV2Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    CreatedAt string
    The time when the channel was created.
    GatewayId string
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    HealthCheck ApigwVpcChannelV2HealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    LbAlgorithm double
    Specifies the distribution algorithm. The valid values are as follows:
    MemberGroups List<ApigwVpcChannelV2MemberGroup>
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    MemberType string
    Specifies the member type of the channel. The valid values are as follows:
    Members List<ApigwVpcChannelV2Member>
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    Microservice ApigwVpcChannelV2Microservice

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Port double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    Region string
    The region where the channel is located.
    Status double
    Specifies the status of health check. The valid values are as follows:
    Type double
    Specifies the type of the channel. The valid values are as follows:
    ApigwVpcChannelV2Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    CreatedAt string
    The time when the channel was created.
    GatewayId string
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    HealthCheck ApigwVpcChannelV2HealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    LbAlgorithm float64
    Specifies the distribution algorithm. The valid values are as follows:
    MemberGroups []ApigwVpcChannelV2MemberGroupArgs
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    MemberType string
    Specifies the member type of the channel. The valid values are as follows:
    Members []ApigwVpcChannelV2MemberArgs
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    Microservice ApigwVpcChannelV2MicroserviceArgs

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Port float64
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    Region string
    The region where the channel is located.
    Status float64
    Specifies the status of health check. The valid values are as follows:
    Type float64
    Specifies the type of the channel. The valid values are as follows:
    apigwVpcChannelV2Id String

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    createdAt String
    The time when the channel was created.
    gatewayId String
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    healthCheck ApigwVpcChannelV2HealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    lbAlgorithm Double
    Specifies the distribution algorithm. The valid values are as follows:
    memberGroups List<ApigwVpcChannelV2MemberGroup>
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    memberType String
    Specifies the member type of the channel. The valid values are as follows:
    members List<ApigwVpcChannelV2Member>
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice ApigwVpcChannelV2Microservice

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port Double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    region String
    The region where the channel is located.
    status Double
    Specifies the status of health check. The valid values are as follows:
    type Double
    Specifies the type of the channel. The valid values are as follows:
    apigwVpcChannelV2Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    createdAt string
    The time when the channel was created.
    gatewayId string
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    healthCheck ApigwVpcChannelV2HealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    lbAlgorithm number
    Specifies the distribution algorithm. The valid values are as follows:
    memberGroups ApigwVpcChannelV2MemberGroup[]
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    memberType string
    Specifies the member type of the channel. The valid values are as follows:
    members ApigwVpcChannelV2Member[]
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice ApigwVpcChannelV2Microservice

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    region string
    The region where the channel is located.
    status number
    Specifies the status of health check. The valid values are as follows:
    type number
    Specifies the type of the channel. The valid values are as follows:
    apigw_vpc_channel_v2_id str

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    created_at str
    The time when the channel was created.
    gateway_id str
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    health_check ApigwVpcChannelV2HealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    lb_algorithm float
    Specifies the distribution algorithm. The valid values are as follows:
    member_groups Sequence[ApigwVpcChannelV2MemberGroupArgs]
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    member_type str
    Specifies the member type of the channel. The valid values are as follows:
    members Sequence[ApigwVpcChannelV2MemberArgs]
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice ApigwVpcChannelV2MicroserviceArgs

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name str
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port float
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    region str
    The region where the channel is located.
    status float
    Specifies the status of health check. The valid values are as follows:
    type float
    Specifies the type of the channel. The valid values are as follows:
    apigwVpcChannelV2Id String

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    createdAt String
    The time when the channel was created.
    gatewayId String
    Specifies the ID of the dedicated API gateway to which the channel belongs. Changing this will create a new resource.
    healthCheck Property Map
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The object structure is documented below.
    lbAlgorithm Number
    Specifies the distribution algorithm. The valid values are as follows:
    memberGroups List<Property Map>
    Specifies the backend (server) groups of the channel. The object structure is documented below.
    memberType String
    Specifies the member type of the channel. The valid values are as follows:
    members List<Property Map>
    Specifies the backend servers of the channel. This parameter is required and only available if the type is 2. The object structure is documented below.
    microservice Property Map

    Specifies the configuration of the microservice. The object structure is documented below.

    The member_group block supports:

    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port Number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    region String
    The region where the channel is located.
    status Number
    Specifies the status of health check. The valid values are as follows:
    type Number
    Specifies the type of the channel. The valid values are as follows:

    Supporting Types

    ApigwVpcChannelV2HealthCheck, ApigwVpcChannelV2HealthCheckArgs

    Interval double
    Specifies the interval between consecutive checks, in second. The valid value ranges from 1 to 300.
    Protocol string
    Specifies the microservice for performing health check on backend servers. The valid values are TCP, HTTP and HTTPS, defaults to TCP.
    ThresholdAbnormal double
    Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from 1 to 10.
    ThresholdNormal double
    Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from 1 to 10.
    Timeout double
    Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of the time interval. The valid value ranges from 1 to 30.
    EnableClientSsl bool
    Specifies whether to enable two-way authentication. Defaults to false.
    HttpCodes string
    Specifies the response codes for determining a successful HTTP response. The valid value ranges from 100 to 599 and the valid formats are as follows:

    • The multiple values, for example, 200,201,202.
    • The range, for example, 200-299.
    • Both multiple values and ranges, for example, 201,202,210-299.
    Method string
    Specifies the request method for health check. The valid values are GET and HEAD.
    Path string
    Specifies the destination path for health checks. Required if the protocol is HTTP or HTTPS.
    Port double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    Status double
    Specifies the status of health check. The valid values are as follows:
    Interval float64
    Specifies the interval between consecutive checks, in second. The valid value ranges from 1 to 300.
    Protocol string
    Specifies the microservice for performing health check on backend servers. The valid values are TCP, HTTP and HTTPS, defaults to TCP.
    ThresholdAbnormal float64
    Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from 1 to 10.
    ThresholdNormal float64
    Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from 1 to 10.
    Timeout float64
    Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of the time interval. The valid value ranges from 1 to 30.
    EnableClientSsl bool
    Specifies whether to enable two-way authentication. Defaults to false.
    HttpCodes string
    Specifies the response codes for determining a successful HTTP response. The valid value ranges from 100 to 599 and the valid formats are as follows:

    • The multiple values, for example, 200,201,202.
    • The range, for example, 200-299.
    • Both multiple values and ranges, for example, 201,202,210-299.
    Method string
    Specifies the request method for health check. The valid values are GET and HEAD.
    Path string
    Specifies the destination path for health checks. Required if the protocol is HTTP or HTTPS.
    Port float64
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    Status float64
    Specifies the status of health check. The valid values are as follows:
    interval Double
    Specifies the interval between consecutive checks, in second. The valid value ranges from 1 to 300.
    protocol String
    Specifies the microservice for performing health check on backend servers. The valid values are TCP, HTTP and HTTPS, defaults to TCP.
    thresholdAbnormal Double
    Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from 1 to 10.
    thresholdNormal Double
    Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from 1 to 10.
    timeout Double
    Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of the time interval. The valid value ranges from 1 to 30.
    enableClientSsl Boolean
    Specifies whether to enable two-way authentication. Defaults to false.
    httpCodes String
    Specifies the response codes for determining a successful HTTP response. The valid value ranges from 100 to 599 and the valid formats are as follows:

    • The multiple values, for example, 200,201,202.
    • The range, for example, 200-299.
    • Both multiple values and ranges, for example, 201,202,210-299.
    method String
    Specifies the request method for health check. The valid values are GET and HEAD.
    path String
    Specifies the destination path for health checks. Required if the protocol is HTTP or HTTPS.
    port Double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status Double
    Specifies the status of health check. The valid values are as follows:
    interval number
    Specifies the interval between consecutive checks, in second. The valid value ranges from 1 to 300.
    protocol string
    Specifies the microservice for performing health check on backend servers. The valid values are TCP, HTTP and HTTPS, defaults to TCP.
    thresholdAbnormal number
    Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from 1 to 10.
    thresholdNormal number
    Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from 1 to 10.
    timeout number
    Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of the time interval. The valid value ranges from 1 to 30.
    enableClientSsl boolean
    Specifies whether to enable two-way authentication. Defaults to false.
    httpCodes string
    Specifies the response codes for determining a successful HTTP response. The valid value ranges from 100 to 599 and the valid formats are as follows:

    • The multiple values, for example, 200,201,202.
    • The range, for example, 200-299.
    • Both multiple values and ranges, for example, 201,202,210-299.
    method string
    Specifies the request method for health check. The valid values are GET and HEAD.
    path string
    Specifies the destination path for health checks. Required if the protocol is HTTP or HTTPS.
    port number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status number
    Specifies the status of health check. The valid values are as follows:
    interval float
    Specifies the interval between consecutive checks, in second. The valid value ranges from 1 to 300.
    protocol str
    Specifies the microservice for performing health check on backend servers. The valid values are TCP, HTTP and HTTPS, defaults to TCP.
    threshold_abnormal float
    Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from 1 to 10.
    threshold_normal float
    Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from 1 to 10.
    timeout float
    Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of the time interval. The valid value ranges from 1 to 30.
    enable_client_ssl bool
    Specifies whether to enable two-way authentication. Defaults to false.
    http_codes str
    Specifies the response codes for determining a successful HTTP response. The valid value ranges from 100 to 599 and the valid formats are as follows:

    • The multiple values, for example, 200,201,202.
    • The range, for example, 200-299.
    • Both multiple values and ranges, for example, 201,202,210-299.
    method str
    Specifies the request method for health check. The valid values are GET and HEAD.
    path str
    Specifies the destination path for health checks. Required if the protocol is HTTP or HTTPS.
    port float
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status float
    Specifies the status of health check. The valid values are as follows:
    interval Number
    Specifies the interval between consecutive checks, in second. The valid value ranges from 1 to 300.
    protocol String
    Specifies the microservice for performing health check on backend servers. The valid values are TCP, HTTP and HTTPS, defaults to TCP.
    thresholdAbnormal Number
    Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value ranges from 1 to 10.
    thresholdNormal Number
    Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value ranges from 1 to 10.
    timeout Number
    Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of the time interval. The valid value ranges from 1 to 30.
    enableClientSsl Boolean
    Specifies whether to enable two-way authentication. Defaults to false.
    httpCodes String
    Specifies the response codes for determining a successful HTTP response. The valid value ranges from 100 to 599 and the valid formats are as follows:

    • The multiple values, for example, 200,201,202.
    • The range, for example, 200-299.
    • Both multiple values and ranges, for example, 201,202,210-299.
    method String
    Specifies the request method for health check. The valid values are GET and HEAD.
    path String
    Specifies the destination path for health checks. Required if the protocol is HTTP or HTTPS.
    port Number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status Number
    Specifies the status of health check. The valid values are as follows:

    ApigwVpcChannelV2Member, ApigwVpcChannelV2MemberArgs

    GroupName string
    Specifies the IP address each backend servers. If omitted, means that all backend servers are both in one group.
    Host string
    Specifies the IP address each backend servers.
    Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    IsBackup bool
    Specifies whether this member is the backup member. Defaults to false.
    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Port double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    Status double
    Specifies the status of health check. The valid values are as follows:
    Weight double
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    GroupName string
    Specifies the IP address each backend servers. If omitted, means that all backend servers are both in one group.
    Host string
    Specifies the IP address each backend servers.
    Id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    IsBackup bool
    Specifies whether this member is the backup member. Defaults to false.
    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Port float64
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    Status float64
    Specifies the status of health check. The valid values are as follows:
    Weight float64
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    groupName String
    Specifies the IP address each backend servers. If omitted, means that all backend servers are both in one group.
    host String
    Specifies the IP address each backend servers.
    id String

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    isBackup Boolean
    Specifies whether this member is the backup member. Defaults to false.
    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port Double
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status Double
    Specifies the status of health check. The valid values are as follows:
    weight Double
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    groupName string
    Specifies the IP address each backend servers. If omitted, means that all backend servers are both in one group.
    host string
    Specifies the IP address each backend servers.
    id string

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    isBackup boolean
    Specifies whether this member is the backup member. Defaults to false.
    name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status number
    Specifies the status of health check. The valid values are as follows:
    weight number
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    group_name str
    Specifies the IP address each backend servers. If omitted, means that all backend servers are both in one group.
    host str
    Specifies the IP address each backend servers.
    id str

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    is_backup bool
    Specifies whether this member is the backup member. Defaults to false.
    name str
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port float
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status float
    Specifies the status of health check. The valid values are as follows:
    weight float
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    groupName String
    Specifies the IP address each backend servers. If omitted, means that all backend servers are both in one group.
    host String
    Specifies the IP address each backend servers.
    id String

    Specifies the ECS ID for each backend servers.

    One of the parameter member.host and member.id must be set if member_type is ecs. The parameter member.host and member.id are alternative.

    isBackup Boolean
    Specifies whether this member is the backup member. Defaults to false.
    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    port Number
    Specifies the destination host port for health check. The valid value ranges from 0 to 65,535.
    status Number
    Specifies the status of health check. The valid values are as follows:
    weight Number
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.

    ApigwVpcChannelV2MemberGroup, ApigwVpcChannelV2MemberGroupArgs

    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Description string
    Specifies the description of the member group.
    MicroservicePort double
    Specifies the microservice port of the backend server group. The valid value ranges from 0 to 65,535.
    MicroserviceTags Dictionary<string, string>

    Specifies the microservice tags of the backend server group.

    The member block supports:

    MicroserviceVersion string
    Specifies the microservice version of the backend server group.
    Weight double
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    Name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    Description string
    Specifies the description of the member group.
    MicroservicePort float64
    Specifies the microservice port of the backend server group. The valid value ranges from 0 to 65,535.
    MicroserviceTags map[string]string

    Specifies the microservice tags of the backend server group.

    The member block supports:

    MicroserviceVersion string
    Specifies the microservice version of the backend server group.
    Weight float64
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    description String
    Specifies the description of the member group.
    microservicePort Double
    Specifies the microservice port of the backend server group. The valid value ranges from 0 to 65,535.
    microserviceTags Map<String,String>

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microserviceVersion String
    Specifies the microservice version of the backend server group.
    weight Double
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    name string
    Specifies the name of the backend server. Required if the parameter member.id is set.
    description string
    Specifies the description of the member group.
    microservicePort number
    Specifies the microservice port of the backend server group. The valid value ranges from 0 to 65,535.
    microserviceTags {[key: string]: string}

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microserviceVersion string
    Specifies the microservice version of the backend server group.
    weight number
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    name str
    Specifies the name of the backend server. Required if the parameter member.id is set.
    description str
    Specifies the description of the member group.
    microservice_port float
    Specifies the microservice port of the backend server group. The valid value ranges from 0 to 65,535.
    microservice_tags Mapping[str, str]

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microservice_version str
    Specifies the microservice version of the backend server group.
    weight float
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.
    name String
    Specifies the name of the backend server. Required if the parameter member.id is set.
    description String
    Specifies the description of the member group.
    microservicePort Number
    Specifies the microservice port of the backend server group. The valid value ranges from 0 to 65,535.
    microserviceTags Map<String>

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microserviceVersion String
    Specifies the microservice version of the backend server group.
    weight Number
    Specifies the weight of current backend server. The valid value ranges from 0 to 10,000, defaults to 0.

    ApigwVpcChannelV2Microservice, ApigwVpcChannelV2MicroserviceArgs

    CceConfig ApigwVpcChannelV2MicroserviceCceConfig

    Specifies the CCE microservice details. The object structure is documented below.

    The cce_config block supports:

    CseConfig ApigwVpcChannelV2MicroserviceCseConfig
    CceConfig ApigwVpcChannelV2MicroserviceCceConfig

    Specifies the CCE microservice details. The object structure is documented below.

    The cce_config block supports:

    CseConfig ApigwVpcChannelV2MicroserviceCseConfig
    cceConfig ApigwVpcChannelV2MicroserviceCceConfig

    Specifies the CCE microservice details. The object structure is documented below.

    The cce_config block supports:

    cseConfig ApigwVpcChannelV2MicroserviceCseConfig
    cceConfig ApigwVpcChannelV2MicroserviceCceConfig

    Specifies the CCE microservice details. The object structure is documented below.

    The cce_config block supports:

    cseConfig ApigwVpcChannelV2MicroserviceCseConfig
    cce_config ApigwVpcChannelV2MicroserviceCceConfig

    Specifies the CCE microservice details. The object structure is documented below.

    The cce_config block supports:

    cse_config ApigwVpcChannelV2MicroserviceCseConfig
    cceConfig Property Map

    Specifies the CCE microservice details. The object structure is documented below.

    The cce_config block supports:

    cseConfig Property Map

    ApigwVpcChannelV2MicroserviceCceConfig, ApigwVpcChannelV2MicroserviceCceConfigArgs

    ClusterId string
    Specifies the CCE cluster ID.
    Namespace string
    Specifies the namespace, such as the default namespace for CCE cluster: default.
    WorkloadType string
    Specifies the workload type.
    LabelKey string
    Specifies the service label key.
    LabelValue string
    Specifies the service label value.
    WorkloadName string
    ClusterId string
    Specifies the CCE cluster ID.
    Namespace string
    Specifies the namespace, such as the default namespace for CCE cluster: default.
    WorkloadType string
    Specifies the workload type.
    LabelKey string
    Specifies the service label key.
    LabelValue string
    Specifies the service label value.
    WorkloadName string
    clusterId String
    Specifies the CCE cluster ID.
    namespace String
    Specifies the namespace, such as the default namespace for CCE cluster: default.
    workloadType String
    Specifies the workload type.
    labelKey String
    Specifies the service label key.
    labelValue String
    Specifies the service label value.
    workloadName String
    clusterId string
    Specifies the CCE cluster ID.
    namespace string
    Specifies the namespace, such as the default namespace for CCE cluster: default.
    workloadType string
    Specifies the workload type.
    labelKey string
    Specifies the service label key.
    labelValue string
    Specifies the service label value.
    workloadName string
    cluster_id str
    Specifies the CCE cluster ID.
    namespace str
    Specifies the namespace, such as the default namespace for CCE cluster: default.
    workload_type str
    Specifies the workload type.
    label_key str
    Specifies the service label key.
    label_value str
    Specifies the service label value.
    workload_name str
    clusterId String
    Specifies the CCE cluster ID.
    namespace String
    Specifies the namespace, such as the default namespace for CCE cluster: default.
    workloadType String
    Specifies the workload type.
    labelKey String
    Specifies the service label key.
    labelValue String
    Specifies the service label value.
    workloadName String

    ApigwVpcChannelV2MicroserviceCseConfig, ApigwVpcChannelV2MicroserviceCseConfigArgs

    EngineId string
    ServiceId string
    EngineId string
    ServiceId string
    engineId String
    serviceId String
    engineId string
    serviceId string
    engineId String
    serviceId String

    Import

    Channels can be imported using their id and the ID of the related API gateway instance, separated by a slash, e.g.

    bash

    $ pulumi import opentelekomcloud:index/apigwVpcChannelV2:ApigwVpcChannelV2 test <gateway_id>/<id>
    

    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 logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud