1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigChannel
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.ApigChannel

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

    Manages a channel resource within FlexibleEngine.

    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:
      instanceId:
        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: flexibleengine:ApigChannel
        properties:
          instanceId: ${instanceId}
          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:
      instanceId:
        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: flexibleengine:ApigChannel
        properties:
          instanceId: ${instanceId}
          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:
      instanceId:
        type: dynamic
      channelName:
        type: dynamic
      clusterId:
        type: dynamic
      workloadName:
        type: dynamic
      memberGroupsConfig:
        type: list(object({microservice_labels = union(map(string), none), microservice_port = union(none, number), name = union(none, string), weight = union(none, number)}))
    resources:
      test:
        type: flexibleengine:ApigChannel
        properties:
          instanceId: ${instanceId}
          port: 80
          balanceStrategy: 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}
                  microserviceLabels: ${member_group.value.microservice_labels}
          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
              workloadName: ${workloadName}
    

    Create ApigChannel Resource

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

    Constructor syntax

    new ApigChannel(name: string, args: ApigChannelArgs, opts?: CustomResourceOptions);
    @overload
    def ApigChannel(resource_name: str,
                    args: ApigChannelArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApigChannel(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    balance_strategy: Optional[float] = None,
                    instance_id: Optional[str] = None,
                    port: Optional[float] = None,
                    apig_channel_id: Optional[str] = None,
                    health_check: Optional[ApigChannelHealthCheckArgs] = None,
                    member_groups: Optional[Sequence[ApigChannelMemberGroupArgs]] = None,
                    member_type: Optional[str] = None,
                    members: Optional[Sequence[ApigChannelMemberArgs]] = None,
                    microservice: Optional[ApigChannelMicroserviceArgs] = None,
                    name: Optional[str] = None,
                    region: Optional[str] = None,
                    type: Optional[float] = None)
    func NewApigChannel(ctx *Context, name string, args ApigChannelArgs, opts ...ResourceOption) (*ApigChannel, error)
    public ApigChannel(string name, ApigChannelArgs args, CustomResourceOptions? opts = null)
    public ApigChannel(String name, ApigChannelArgs args)
    public ApigChannel(String name, ApigChannelArgs args, CustomResourceOptions options)
    
    type: flexibleengine:ApigChannel
    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 ApigChannelArgs
    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 ApigChannelArgs
    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 ApigChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigChannelArgs
    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 apigChannelResource = new Flexibleengine.ApigChannel("apigChannelResource", new()
    {
        BalanceStrategy = 0,
        InstanceId = "string",
        Port = 0,
        ApigChannelId = "string",
        HealthCheck = new Flexibleengine.Inputs.ApigChannelHealthCheckArgs
        {
            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 Flexibleengine.Inputs.ApigChannelMemberGroupArgs
            {
                Name = "string",
                Description = "string",
                MicroserviceLabels = 
                {
                    { "string", "string" },
                },
                MicroservicePort = 0,
                MicroserviceVersion = "string",
                Weight = 0,
            },
        },
        MemberType = "string",
        Members = new[]
        {
            new Flexibleengine.Inputs.ApigChannelMemberArgs
            {
                GroupName = "string",
                Host = "string",
                Id = "string",
                IsBackup = false,
                Name = "string",
                Port = 0,
                Status = 0,
                Weight = 0,
            },
        },
        Microservice = new Flexibleengine.Inputs.ApigChannelMicroserviceArgs
        {
            CceConfig = new Flexibleengine.Inputs.ApigChannelMicroserviceCceConfigArgs
            {
                ClusterId = "string",
                Namespace = "string",
                WorkloadType = "string",
                LabelKey = "string",
                LabelValue = "string",
                WorkloadName = "string",
            },
            CseConfig = new Flexibleengine.Inputs.ApigChannelMicroserviceCseConfigArgs
            {
                EngineId = "string",
                ServiceId = "string",
            },
        },
        Name = "string",
        Region = "string",
        Type = 0,
    });
    
    example, err := flexibleengine.NewApigChannel(ctx, "apigChannelResource", &flexibleengine.ApigChannelArgs{
    	BalanceStrategy: pulumi.Float64(0),
    	InstanceId:      pulumi.String("string"),
    	Port:            pulumi.Float64(0),
    	ApigChannelId:   pulumi.String("string"),
    	HealthCheck: &flexibleengine.ApigChannelHealthCheckArgs{
    		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: flexibleengine.ApigChannelMemberGroupArray{
    		&flexibleengine.ApigChannelMemberGroupArgs{
    			Name:        pulumi.String("string"),
    			Description: pulumi.String("string"),
    			MicroserviceLabels: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			MicroservicePort:    pulumi.Float64(0),
    			MicroserviceVersion: pulumi.String("string"),
    			Weight:              pulumi.Float64(0),
    		},
    	},
    	MemberType: pulumi.String("string"),
    	Members: flexibleengine.ApigChannelMemberArray{
    		&flexibleengine.ApigChannelMemberArgs{
    			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: &flexibleengine.ApigChannelMicroserviceArgs{
    		CceConfig: &flexibleengine.ApigChannelMicroserviceCceConfigArgs{
    			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: &flexibleengine.ApigChannelMicroserviceCseConfigArgs{
    			EngineId:  pulumi.String("string"),
    			ServiceId: pulumi.String("string"),
    		},
    	},
    	Name:   pulumi.String("string"),
    	Region: pulumi.String("string"),
    	Type:   pulumi.Float64(0),
    })
    
    var apigChannelResource = new ApigChannel("apigChannelResource", ApigChannelArgs.builder()
        .balanceStrategy(0)
        .instanceId("string")
        .port(0)
        .apigChannelId("string")
        .healthCheck(ApigChannelHealthCheckArgs.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(ApigChannelMemberGroupArgs.builder()
            .name("string")
            .description("string")
            .microserviceLabels(Map.of("string", "string"))
            .microservicePort(0)
            .microserviceVersion("string")
            .weight(0)
            .build())
        .memberType("string")
        .members(ApigChannelMemberArgs.builder()
            .groupName("string")
            .host("string")
            .id("string")
            .isBackup(false)
            .name("string")
            .port(0)
            .status(0)
            .weight(0)
            .build())
        .microservice(ApigChannelMicroserviceArgs.builder()
            .cceConfig(ApigChannelMicroserviceCceConfigArgs.builder()
                .clusterId("string")
                .namespace("string")
                .workloadType("string")
                .labelKey("string")
                .labelValue("string")
                .workloadName("string")
                .build())
            .cseConfig(ApigChannelMicroserviceCseConfigArgs.builder()
                .engineId("string")
                .serviceId("string")
                .build())
            .build())
        .name("string")
        .region("string")
        .type(0)
        .build());
    
    apig_channel_resource = flexibleengine.ApigChannel("apigChannelResource",
        balance_strategy=0,
        instance_id="string",
        port=0,
        apig_channel_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_labels": {
                "string": "string",
            },
            "microservice_port": 0,
            "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",
        region="string",
        type=0)
    
    const apigChannelResource = new flexibleengine.ApigChannel("apigChannelResource", {
        balanceStrategy: 0,
        instanceId: "string",
        port: 0,
        apigChannelId: "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",
            microserviceLabels: {
                string: "string",
            },
            microservicePort: 0,
            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",
        region: "string",
        type: 0,
    });
    
    type: flexibleengine:ApigChannel
    properties:
        apigChannelId: string
        balanceStrategy: 0
        healthCheck:
            enableClientSsl: false
            httpCodes: string
            interval: 0
            method: string
            path: string
            port: 0
            protocol: string
            status: 0
            thresholdAbnormal: 0
            thresholdNormal: 0
            timeout: 0
        instanceId: string
        memberGroups:
            - description: string
              microserviceLabels:
                string: string
              microservicePort: 0
              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
        region: string
        type: 0
    

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

    BalanceStrategy double
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    InstanceId string
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    Port double
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    ApigChannelId string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    HealthCheck ApigChannelHealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    MemberGroups List<ApigChannelMemberGroup>
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    MemberType string
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    Members List<ApigChannelMember>
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    Microservice ApigChannelMicroservice

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

    The member_group block supports:

    Name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    Region string
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    Type double

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    BalanceStrategy float64
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    InstanceId string
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    Port float64
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    ApigChannelId string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    HealthCheck ApigChannelHealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    MemberGroups []ApigChannelMemberGroupArgs
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    MemberType string
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    Members []ApigChannelMemberArgs
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    Microservice ApigChannelMicroserviceArgs

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

    The member_group block supports:

    Name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    Region string
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    Type float64

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    balanceStrategy Double
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    instanceId String
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    port Double
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    apigChannelId String
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    healthCheck ApigChannelHealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    memberGroups List<ApigChannelMemberGroup>
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    memberType String
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members List<ApigChannelMember>
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice ApigChannelMicroservice

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

    The member_group block supports:

    name String
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    region String
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    type Double

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    balanceStrategy number
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    instanceId string
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    port number
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    apigChannelId string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    healthCheck ApigChannelHealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    memberGroups ApigChannelMemberGroup[]
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    memberType string
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members ApigChannelMember[]
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice ApigChannelMicroservice

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

    The member_group block supports:

    name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    region string
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    type number

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    balance_strategy float
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    instance_id str
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    port float
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    apig_channel_id str
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    health_check ApigChannelHealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    member_groups Sequence[ApigChannelMemberGroupArgs]
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    member_type str
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members Sequence[ApigChannelMemberArgs]
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice ApigChannelMicroserviceArgs

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

    The member_group block supports:

    name str
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    region str
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    type float

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    balanceStrategy Number
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    instanceId String
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    port Number
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    apigChannelId String
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    healthCheck Property Map
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    memberGroups List<Property Map>
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    memberType String
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members List<Property Map>
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice Property Map

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

    The member_group block supports:

    name String
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    region String
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    type Number

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApigChannel 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.
    Status double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    CreatedAt string
    The time when the channel was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status float64

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    createdAt String
    The time when the channel was created.
    id String
    The provider-assigned unique ID for this managed resource.
    status Double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    createdAt string
    The time when the channel was created.
    id string
    The provider-assigned unique ID for this managed resource.
    status number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    created_at str
    The time when the channel was created.
    id str
    The provider-assigned unique ID for this managed resource.
    status float

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    createdAt String
    The time when the channel was created.
    id String
    The provider-assigned unique ID for this managed resource.
    status Number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    Look up Existing ApigChannel Resource

    Get an existing ApigChannel 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?: ApigChannelState, opts?: CustomResourceOptions): ApigChannel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            apig_channel_id: Optional[str] = None,
            balance_strategy: Optional[float] = None,
            created_at: Optional[str] = None,
            health_check: Optional[ApigChannelHealthCheckArgs] = None,
            instance_id: Optional[str] = None,
            member_groups: Optional[Sequence[ApigChannelMemberGroupArgs]] = None,
            member_type: Optional[str] = None,
            members: Optional[Sequence[ApigChannelMemberArgs]] = None,
            microservice: Optional[ApigChannelMicroserviceArgs] = None,
            name: Optional[str] = None,
            port: Optional[float] = None,
            region: Optional[str] = None,
            status: Optional[float] = None,
            type: Optional[float] = None) -> ApigChannel
    func GetApigChannel(ctx *Context, name string, id IDInput, state *ApigChannelState, opts ...ResourceOption) (*ApigChannel, error)
    public static ApigChannel Get(string name, Input<string> id, ApigChannelState? state, CustomResourceOptions? opts = null)
    public static ApigChannel get(String name, Output<String> id, ApigChannelState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigChannel    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:
    ApigChannelId string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    BalanceStrategy double
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    CreatedAt string
    The time when the channel was created.
    HealthCheck ApigChannelHealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    InstanceId string
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    MemberGroups List<ApigChannelMemberGroup>
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    MemberType string
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    Members List<ApigChannelMember>
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    Microservice ApigChannelMicroservice

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

    The member_group block supports:

    Name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    Port double
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    Region string
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    Status double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    Type double

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    ApigChannelId string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    BalanceStrategy float64
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    CreatedAt string
    The time when the channel was created.
    HealthCheck ApigChannelHealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    InstanceId string
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    MemberGroups []ApigChannelMemberGroupArgs
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    MemberType string
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    Members []ApigChannelMemberArgs
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    Microservice ApigChannelMicroserviceArgs

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

    The member_group block supports:

    Name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    Port float64
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    Region string
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    Status float64

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    Type float64

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    apigChannelId String
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    balanceStrategy Double
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    createdAt String
    The time when the channel was created.
    healthCheck ApigChannelHealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    instanceId String
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    memberGroups List<ApigChannelMemberGroup>
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    memberType String
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members List<ApigChannelMember>
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice ApigChannelMicroservice

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

    The member_group block supports:

    name String
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    port Double
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    region String
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    status Double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    type Double

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    apigChannelId string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    balanceStrategy number
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    createdAt string
    The time when the channel was created.
    healthCheck ApigChannelHealthCheck
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    instanceId string
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    memberGroups ApigChannelMemberGroup[]
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    memberType string
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members ApigChannelMember[]
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice ApigChannelMicroservice

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

    The member_group block supports:

    name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    port number
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    region string
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    status number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    type number

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    apig_channel_id str
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    balance_strategy float
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    created_at str
    The time when the channel was created.
    health_check ApigChannelHealthCheckArgs
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    instance_id str
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    member_groups Sequence[ApigChannelMemberGroupArgs]
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    member_type str
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members Sequence[ApigChannelMemberArgs]
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice ApigChannelMicroserviceArgs

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

    The member_group block supports:

    name str
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    port float
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    region str
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    status float

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    type float

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    apigChannelId String
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host are alternative.
    balanceStrategy Number
    Specifies the distribution algorithm.
    The valid values are as follows:

    • 1: Weighted round robin (WRR).
    • 2: Weighted least connections (WLC).
    • 3: Source hashing.
    • 4: URI hashing.
    createdAt String
    The time when the channel was created.
    healthCheck Property Map
    Specifies the health configuration of cloud servers associated with the load balance channel for APIG regularly check. The health_check structure is documented below.
    instanceId String
    Specifies the ID of the dedicated instance to which the channel belongs. Changing this will create a new resource.
    memberGroups List<Property Map>
    Specifies the backend (server) groups of the channel.
    The member_group structure is documented below.
    memberType String
    Specifies the member type of the channel.
    The valid values are as follows:

    • ip.
    • ecs.
    members List<Property Map>
    Specifies the backend servers of the channel.
    This parameter is required and only available if the type is 2. The member structure is documented below.
    microservice Property Map

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

    The member_group block supports:

    name String
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    port Number
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    region String
    Specifies the region where the channel is located.
    If omitted, the provider-level region will be used. Changing this will create a new resource.
    status Number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    type Number

    Specifies the type of the channel.
    The valid values are as follows:

    • 2: Server type.
    • 3: Microservice type.

    Defaults to 2 (server type).

    Supporting Types

    ApigChannelHealthCheck, ApigChannelHealthCheckArgs

    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 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 65535.
    Status double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    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 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 65535.
    Status float64

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    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 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 65535.
    status Double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    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 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 65535.
    status number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    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 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 65535.
    status float

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    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 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 65535.
    status Number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    ApigChannelMember, ApigChannelMemberArgs

    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.
    Required if the member_type is ecs. This parameter and member.id are alternative.
    Id string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host 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 member.id is set. This parameter and member.host are alternative.
    Port double
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    Status double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    Weight double
    Specifies the weight of current backend server.
    The valid value ranges from 0 to 10000, 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.
    Required if the member_type is ecs. This parameter and member.id are alternative.
    Id string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host 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 member.id is set. This parameter and member.host are alternative.
    Port float64
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    Status float64

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    Weight float64
    Specifies the weight of current backend server.
    The valid value ranges from 0 to 10000, 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.
    Required if the member_type is ecs. This parameter and member.id are alternative.
    id String
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host 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 member.id is set. This parameter and member.host are alternative.
    port Double
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    status Double

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    weight Double
    Specifies the weight of current backend server.
    The valid value ranges from 0 to 10000, 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.
    Required if the member_type is ecs. This parameter and member.id are alternative.
    id string
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host 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 member.id is set. This parameter and member.host are alternative.
    port number
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    status number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    weight number
    Specifies the weight of current backend server.
    The valid value ranges from 0 to 10000, 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.
    Required if the member_type is ecs. This parameter and member.id are alternative.
    id str
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host 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 member.id is set. This parameter and member.host are alternative.
    port float
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    status float

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    weight float
    Specifies the weight of current backend server.
    The valid value ranges from 0 to 10000, 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.
    Required if the member_type is ecs. This parameter and member.id are alternative.
    id String
    Specifies the ECS ID for each backend servers.
    Required if the member_type is ecs. This parameter and member.host 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 member.id is set. This parameter and member.host are alternative.
    port Number
    Specifies the destination host port for health check.
    The valid value ranges from 0 to 65535.
    status Number

    Specifies the status of health check.
    The valid values are as follows:

    • 1: Normal.
    • 2: Abnormal.

    Defaults to 1 (normal).

    The microservice block supports:

    weight Number
    Specifies the weight of current backend server.
    The valid value ranges from 0 to 10000, defaults to 0.

    ApigChannelMemberGroup, ApigChannelMemberGroupArgs

    Name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    Description string
    Specifies the description of the member group.
    MicroserviceLabels Dictionary<string, string>

    Specifies the microservice tags of the backend server group.

    The member block supports:

    MicroservicePort double
    Specifies the microservice port of the backend server group.
    The valid value ranges from 0 to 65535.
    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 10000, defaults to 0.
    Name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    Description string
    Specifies the description of the member group.
    MicroserviceLabels map[string]string

    Specifies the microservice tags of the backend server group.

    The member block supports:

    MicroservicePort float64
    Specifies the microservice port of the backend server group.
    The valid value ranges from 0 to 65535.
    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 10000, defaults to 0.
    name String
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    description String
    Specifies the description of the member group.
    microserviceLabels Map<String,String>

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microservicePort Double
    Specifies the microservice port of the backend server group.
    The valid value ranges from 0 to 65535.
    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 10000, defaults to 0.
    name string
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    description string
    Specifies the description of the member group.
    microserviceLabels {[key: string]: string}

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microservicePort number
    Specifies the microservice port of the backend server group.
    The valid value ranges from 0 to 65535.
    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 10000, defaults to 0.
    name str
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    description str
    Specifies the description of the member group.
    microservice_labels Mapping[str, str]

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microservice_port float
    Specifies the microservice port of the backend server group.
    The valid value ranges from 0 to 65535.
    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 10000, defaults to 0.
    name String
    Specifies the name of the backend server.
    Required if the member.id is set. This parameter and member.host are alternative.
    description String
    Specifies the description of the member group.
    microserviceLabels Map<String>

    Specifies the microservice tags of the backend server group.

    The member block supports:

    microservicePort Number
    Specifies the microservice port of the backend server group.
    The valid value ranges from 0 to 65535.
    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 10000, defaults to 0.

    ApigChannelMicroservice, ApigChannelMicroserviceArgs

    CceConfig ApigChannelMicroserviceCceConfig

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

    The cce_config block supports:

    CseConfig ApigChannelMicroserviceCseConfig
    schema:Internal; The CSE microservice details.
    CceConfig ApigChannelMicroserviceCceConfig

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

    The cce_config block supports:

    CseConfig ApigChannelMicroserviceCseConfig
    schema:Internal; The CSE microservice details.
    cceConfig ApigChannelMicroserviceCceConfig

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

    The cce_config block supports:

    cseConfig ApigChannelMicroserviceCseConfig
    schema:Internal; The CSE microservice details.
    cceConfig ApigChannelMicroserviceCceConfig

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

    The cce_config block supports:

    cseConfig ApigChannelMicroserviceCseConfig
    schema:Internal; The CSE microservice details.
    cce_config ApigChannelMicroserviceCceConfig

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

    The cce_config block supports:

    cse_config ApigChannelMicroserviceCseConfig
    schema:Internal; The CSE microservice details.
    cceConfig Property Map

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

    The cce_config block supports:

    cseConfig Property Map
    schema:Internal; The CSE microservice details.

    ApigChannelMicroserviceCceConfig, ApigChannelMicroserviceCceConfigArgs

    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.

    • deployment: Stateless load.
    • statefulset: Stateful load.
    • daemonset: Daemons set.
    LabelKey string
    The service label key.
    LabelValue string
    The service label value.
    WorkloadName string
    Specifies the workload name.
    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.

    • deployment: Stateless load.
    • statefulset: Stateful load.
    • daemonset: Daemons set.
    LabelKey string
    The service label key.
    LabelValue string
    The service label value.
    WorkloadName string
    Specifies the workload name.
    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.

    • deployment: Stateless load.
    • statefulset: Stateful load.
    • daemonset: Daemons set.
    labelKey String
    The service label key.
    labelValue String
    The service label value.
    workloadName String
    Specifies the workload name.
    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.

    • deployment: Stateless load.
    • statefulset: Stateful load.
    • daemonset: Daemons set.
    labelKey string
    The service label key.
    labelValue string
    The service label value.
    workloadName string
    Specifies the workload name.
    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.

    • deployment: Stateless load.
    • statefulset: Stateful load.
    • daemonset: Daemons set.
    label_key str
    The service label key.
    label_value str
    The service label value.
    workload_name str
    Specifies the workload name.
    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.

    • deployment: Stateless load.
    • statefulset: Stateful load.
    • daemonset: Daemons set.
    labelKey String
    The service label key.
    labelValue String
    The service label value.
    workloadName String
    Specifies the workload name.

    ApigChannelMicroserviceCseConfig, ApigChannelMicroserviceCseConfigArgs

    EngineId string
    schema:Internal; The microservice engine ID.
    ServiceId string
    schema:Internal; The microservice ID.
    EngineId string
    schema:Internal; The microservice engine ID.
    ServiceId string
    schema:Internal; The microservice ID.
    engineId String
    schema:Internal; The microservice engine ID.
    serviceId String
    schema:Internal; The microservice ID.
    engineId string
    schema:Internal; The microservice engine ID.
    serviceId string
    schema:Internal; The microservice ID.
    engine_id str
    schema:Internal; The microservice engine ID.
    service_id str
    schema:Internal; The microservice ID.
    engineId String
    schema:Internal; The microservice engine ID.
    serviceId String
    schema:Internal; The microservice ID.

    Import

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

    bash

    $ pulumi import flexibleengine:index/apigChannel:ApigChannel test <instance_id>/<id>
    

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud