Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Alibaba Cloud Provider
  4. API Docs
  5. apig
  6. Service
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.apig.Service

alicloud logo alicloud logo
Viewing docs for Alibaba Cloud v3.108.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    Provides an APIG Service resource.

    For information about APIG Service and how to use it, see What is Service.

    NOTE: Available since v1.286.0.

    Example Usage

    Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const address = config.get("address") || "127.0.0.1:8080";
const address1 = config.get("address1") || "127.0.0.1:7891";
const address2 = config.get("address2") || "127.0.0.1:7890";
const defaultvpc = new alicloud.vpc.Network("defaultvpc", {
    cidrBlock: "172.32.0.0/12",
    vpcName: "zhenyuan-example",
});
const defaultvswitch = new alicloud.vpc.Switch("defaultvswitch", {
    vpcId: defaultvpc.id,
    zoneId: "cn-hangzhou-g",
    cidrBlock: "172.32.100.0/24",
    vswitchName: "zhenyuan-example",
});
const defaultFsRKYn = new alicloud.apig.Gateway("defaultFsRKYn", {
    networkAccessConfig: {
        type: "Intranet",
    },
    vswitch: {
        vswitchId: defaultvswitch.id,
        name: defaultvswitch.vswitchName,
    },
    zoneConfig: {
        selectOption: "Auto",
    },
    vpc: {
        vpcId: defaultvpc.id,
    },
    paymentType: "PayAsYouGo",
    gatewayName: "zhenyuanexample",
    spec: "apigw.small.x1",
    logConfig: {
        sls: {
            enable: false,
        },
    },
});
const _default = new alicloud.apig.Service("default", {
    addresses: [address],
    serviceName: "1784264562",
    sourceType: "VIP",
    gatewayId: defaultFsRKYn.id,
    namespace: "default",
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
address = config.get("address")
if address is None:
    address = "127.0.0.1:8080"
address1 = config.get("address1")
if address1 is None:
    address1 = "127.0.0.1:7891"
address2 = config.get("address2")
if address2 is None:
    address2 = "127.0.0.1:7890"
defaultvpc = alicloud.vpc.Network("defaultvpc",
    cidr_block="172.32.0.0/12",
    vpc_name="zhenyuan-example")
defaultvswitch = alicloud.vpc.Switch("defaultvswitch",
    vpc_id=defaultvpc.id,
    zone_id="cn-hangzhou-g",
    cidr_block="172.32.100.0/24",
    vswitch_name="zhenyuan-example")
default_fs_rk_yn = alicloud.apig.Gateway("defaultFsRKYn",
    network_access_config={
        "type": "Intranet",
    },
    vswitch={
        "vswitch_id": defaultvswitch.id,
        "name": defaultvswitch.vswitch_name,
    },
    zone_config={
        "select_option": "Auto",
    },
    vpc={
        "vpc_id": defaultvpc.id,
    },
    payment_type="PayAsYouGo",
    gateway_name="zhenyuanexample",
    spec="apigw.small.x1",
    log_config={
        "sls": {
            "enable": False,
        },
    })
default = alicloud.apig.Service("default",
    addresses=[address],
    service_name="1784264562",
    source_type="VIP",
    gateway_id=default_fs_rk_yn.id,
    namespace="default")

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apig"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		address := "127.0.0.1:8080"
		if param := cfg.Get("address"); param != "" {
			address = param
		}
		address1 := "127.0.0.1:7891"
		if param := cfg.Get("address1"); param != "" {
			address1 = param
		}
		address2 := "127.0.0.1:7890"
		if param := cfg.Get("address2"); param != "" {
			address2 = param
		}
		defaultvpc, err := vpc.NewNetwork(ctx, "defaultvpc", &vpc.NetworkArgs{
			CidrBlock: pulumi.String("172.32.0.0/12"),
			VpcName:   pulumi.String("zhenyuan-example"),
		})
		if err != nil {
			return err
		}
		defaultvswitch, err := vpc.NewSwitch(ctx, "defaultvswitch", &vpc.SwitchArgs{
			VpcId:       defaultvpc.ID().ToIDOutput().ToStringOutput(),
			ZoneId:      pulumi.String("cn-hangzhou-g"),
			CidrBlock:   pulumi.String("172.32.100.0/24"),
			VswitchName: pulumi.String("zhenyuan-example"),
		})
		if err != nil {
			return err
		}
		defaultFsRKYn, err := apig.NewGateway(ctx, "defaultFsRKYn", &apig.GatewayArgs{
			NetworkAccessConfig: &apig.GatewayNetworkAccessConfigArgs{
				Type: pulumi.String("Intranet"),
			},
			Vswitch: &apig.GatewayVswitchArgs{
				VswitchId: defaultvswitch.ID().ToIDOutput().ToStringOutput(),
				Name:      defaultvswitch.VswitchName,
			},
			ZoneConfig: &apig.GatewayZoneConfigArgs{
				SelectOption: pulumi.String("Auto"),
			},
			Vpc: &apig.GatewayVpcArgs{
				VpcId: defaultvpc.ID().ToIDOutput().ToStringOutput(),
			},
			PaymentType: pulumi.String("PayAsYouGo"),
			GatewayName: pulumi.String("zhenyuanexample"),
			Spec:        pulumi.String("apigw.small.x1"),
			LogConfig: &apig.GatewayLogConfigArgs{
				Sls: &apig.GatewayLogConfigSlsArgs{
					Enable: pulumi.Bool(false),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = apig.NewService(ctx, "default", &apig.ServiceArgs{
			Addresses: pulumi.StringArray{
				pulumi.String(address),
			},
			ServiceName: pulumi.String("1784264562"),
			SourceType:  pulumi.String("VIP"),
			GatewayId:   defaultFsRKYn.ID().ToIDOutput().ToStringOutput(),
			Namespace:   pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var address = config.Get("address") ?? "127.0.0.1:8080";
    var address1 = config.Get("address1") ?? "127.0.0.1:7891";
    var address2 = config.Get("address2") ?? "127.0.0.1:7890";
    var defaultvpc = new AliCloud.Vpc.Network("defaultvpc", new()
    {
        CidrBlock = "172.32.0.0/12",
        VpcName = "zhenyuan-example",
    });

    var defaultvswitch = new AliCloud.Vpc.Switch("defaultvswitch", new()
    {
        VpcId = defaultvpc.Id,
        ZoneId = "cn-hangzhou-g",
        CidrBlock = "172.32.100.0/24",
        VswitchName = "zhenyuan-example",
    });

    var defaultFsRKYn = new AliCloud.Apig.Gateway("defaultFsRKYn", new()
    {
        NetworkAccessConfig = new AliCloud.Apig.Inputs.GatewayNetworkAccessConfigArgs
        {
            Type = "Intranet",
        },
        Vswitch = new AliCloud.Apig.Inputs.GatewayVswitchArgs
        {
            VswitchId = defaultvswitch.Id,
            Name = defaultvswitch.VswitchName,
        },
        ZoneConfig = new AliCloud.Apig.Inputs.GatewayZoneConfigArgs
        {
            SelectOption = "Auto",
        },
        Vpc = new AliCloud.Apig.Inputs.GatewayVpcArgs
        {
            VpcId = defaultvpc.Id,
        },
        PaymentType = "PayAsYouGo",
        GatewayName = "zhenyuanexample",
        Spec = "apigw.small.x1",
        LogConfig = new AliCloud.Apig.Inputs.GatewayLogConfigArgs
        {
            Sls = new AliCloud.Apig.Inputs.GatewayLogConfigSlsArgs
            {
                Enable = false,
            },
        },
    });

    var @default = new AliCloud.Apig.Service("default", new()
    {
        Addresses = new[]
        {
            address,
        },
        ServiceName = "1784264562",
        SourceType = "VIP",
        GatewayId = defaultFsRKYn.Id,
        Namespace = "default",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.apig.Gateway;
import com.pulumi.alicloud.apig.GatewayArgs;
import com.pulumi.alicloud.apig.inputs.GatewayNetworkAccessConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayVswitchArgs;
import com.pulumi.alicloud.apig.inputs.GatewayZoneConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayVpcArgs;
import com.pulumi.alicloud.apig.inputs.GatewayLogConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayLogConfigSlsArgs;
import com.pulumi.alicloud.apig.Service;
import com.pulumi.alicloud.apig.ServiceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        final var address = config.get("address").orElse("127.0.0.1:8080");
        final var address1 = config.get("address1").orElse("127.0.0.1:7891");
        final var address2 = config.get("address2").orElse("127.0.0.1:7890");
        var defaultvpc = new Network("defaultvpc", NetworkArgs.builder()
            .cidrBlock("172.32.0.0/12")
            .vpcName("zhenyuan-example")
            .build());

        var defaultvswitch = new Switch("defaultvswitch", SwitchArgs.builder()
            .vpcId(defaultvpc.id())
            .zoneId("cn-hangzhou-g")
            .cidrBlock("172.32.100.0/24")
            .vswitchName("zhenyuan-example")
            .build());

        var defaultFsRKYn = new Gateway("defaultFsRKYn", GatewayArgs.builder()
            .networkAccessConfig(GatewayNetworkAccessConfigArgs.builder()
                .type("Intranet")
                .build())
            .vswitch(GatewayVswitchArgs.builder()
                .vswitchId(defaultvswitch.id())
                .name(defaultvswitch.vswitchName())
                .build())
            .zoneConfig(GatewayZoneConfigArgs.builder()
                .selectOption("Auto")
                .build())
            .vpc(GatewayVpcArgs.builder()
                .vpcId(defaultvpc.id())
                .build())
            .paymentType("PayAsYouGo")
            .gatewayName("zhenyuanexample")
            .spec("apigw.small.x1")
            .logConfig(GatewayLogConfigArgs.builder()
                .sls(GatewayLogConfigSlsArgs.builder()
                    .enable(false)
                    .build())
                .build())
            .build());

        var default_ = new Service("default", ServiceArgs.builder()
            .addresses(address)
            .serviceName("1784264562")
            .sourceType("VIP")
            .gatewayId(defaultFsRKYn.id())
            .namespace("default")
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
  address:
    type: string
    default: 127.0.0.1:8080
  address1:
    type: string
    default: 127.0.0.1:7891
  address2:
    type: string
    default: 127.0.0.1:7890
resources:
  defaultvpc:
    type: alicloud:vpc:Network
    properties:
      cidrBlock: 172.32.0.0/12
      vpcName: zhenyuan-example
  defaultvswitch:
    type: alicloud:vpc:Switch
    properties:
      vpcId: ${defaultvpc.id}
      zoneId: cn-hangzhou-g
      cidrBlock: 172.32.100.0/24
      vswitchName: zhenyuan-example
  defaultFsRKYn:
    type: alicloud:apig:Gateway
    properties:
      networkAccessConfig:
        type: Intranet
      vswitch:
        vswitchId: ${defaultvswitch.id}
        name: ${defaultvswitch.vswitchName}
      zoneConfig:
        selectOption: Auto
      vpc:
        vpcId: ${defaultvpc.id}
      paymentType: PayAsYouGo
      gatewayName: zhenyuanexample
      spec: apigw.small.x1
      logConfig:
        sls:
          enable: false
  default:
    type: alicloud:apig:Service
    properties:
      addresses:
        - ${address}
      serviceName: '1784264562'
      sourceType: VIP
      gatewayId: ${defaultFsRKYn.id}
      namespace: default

    pulumi {
  required_providers {
    alicloud = {
      source = "pulumi/alicloud"
    }
  }
}

resource "alicloud_vpc_network" "defaultvpc" {
  cidr_block = "172.32.0.0/12"
  vpc_name   = "zhenyuan-example"
}
resource "alicloud_vpc_switch" "defaultvswitch" {
  vpc_id       = alicloud_vpc_network.defaultvpc.id
  zone_id      = "cn-hangzhou-g"
  cidr_block   = "172.32.100.0/24"
  vswitch_name = "zhenyuan-example"
}
resource "alicloud_apig_gateway" "defaultFsRKYn" {
  network_access_config = {
    type = "Intranet"
  }
  vswitch = {
    vswitch_id = alicloud_vpc_switch.defaultvswitch.id
    name       = alicloud_vpc_switch.defaultvswitch.vswitch_name
  }
  zone_config = {
    select_option = "Auto"
  }
  vpc = {
    vpc_id = alicloud_vpc_network.defaultvpc.id
  }
  payment_type = "PayAsYouGo"
  gateway_name = "zhenyuanexample"
  spec         = "apigw.small.x1"
  log_config = {
    sls = {
      enable = false
    }
  }
}
resource "alicloud_apig_service" "default" {
  addresses    = [var.address]
  service_name = "1784264562"
  source_type  = "VIP"
  gateway_id   = alicloud_apig_gateway.defaultFsRKYn.id
  namespace    = "default"
}
variable "name" {
  type    = string
  default = "terraform-example"
}
variable "address" {
  type    = string
  default = "127.0.0.1:8080"
}
variable "address1" {
  type    = string
  default = "127.0.0.1:7891"
}
variable "address2" {
  type    = string
  default = "127.0.0.1:7890"
}

    📚 Need more examples? VIEW MORE EXAMPLES

    Create Service Resource

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

    Constructor syntax

    new Service(name: string, args?: ServiceArgs, opts?: CustomResourceOptions);
    @overload
def Service(resource_name: str,
            args: Optional[ServiceArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            addresses: Optional[Sequence[str]] = None,
            dns_servers: Optional[Sequence[str]] = None,
            express_type: Optional[str] = None,
            gateway_id: Optional[str] = None,
            health_check_config: Optional[ServiceHealthCheckConfigArgs] = None,
            healthy_panic_threshold: Optional[float] = None,
            namespace: Optional[str] = None,
            outlier_detection_config: Optional[ServiceOutlierDetectionConfigArgs] = None,
            protocol: Optional[str] = None,
            qualifier: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            service_name: Optional[str] = None,
            source_type: Optional[str] = None)
    func NewService(ctx *Context, name string, args *ServiceArgs, opts ...ResourceOption) (*Service, error)
    public Service(string name, ServiceArgs? args = null, CustomResourceOptions? opts = null)
    public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

    type: alicloud:apig:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "alicloud_apig_service" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 serviceResource = new AliCloud.Apig.Service("serviceResource", new()
{
    Addresses = new[]
    {
        "string",
    },
    DnsServers = new[]
    {
        "string",
    },
    ExpressType = "string",
    GatewayId = "string",
    HealthCheckConfig = new AliCloud.Apig.Inputs.ServiceHealthCheckConfigArgs
    {
        Enable = false,
        ExpectedStatuses = new[]
        {
            "string",
        },
        HealthyThreshold = 0,
        HttpHost = "string",
        HttpPath = "string",
        Interval = 0,
        Protocol = "string",
        Timeout = 0,
        UnhealthyThreshold = 0,
    },
    HealthyPanicThreshold = 0.0,
    Namespace = "string",
    OutlierDetectionConfig = new AliCloud.Apig.Inputs.ServiceOutlierDetectionConfigArgs
    {
        BaseEjectionTime = 0,
        Enable = false,
        FailurePercentageMinimumHosts = 0,
        FailurePercentageThreshold = 0,
        Interval = 0,
    },
    Protocol = "string",
    Qualifier = "string",
    ResourceGroupId = "string",
    ServiceName = "string",
    SourceType = "string",
});

    example, err := apig.NewService(ctx, "serviceResource", &apig.ServiceArgs{
	Addresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	DnsServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExpressType: pulumi.String("string"),
	GatewayId:   pulumi.String("string"),
	HealthCheckConfig: &apig.ServiceHealthCheckConfigArgs{
		Enable: pulumi.Bool(false),
		ExpectedStatuses: pulumi.StringArray{
			pulumi.String("string"),
		},
		HealthyThreshold:   pulumi.Int(0),
		HttpHost:           pulumi.String("string"),
		HttpPath:           pulumi.String("string"),
		Interval:           pulumi.Int(0),
		Protocol:           pulumi.String("string"),
		Timeout:            pulumi.Int(0),
		UnhealthyThreshold: pulumi.Int(0),
	},
	HealthyPanicThreshold: pulumi.Float64(0),
	Namespace:             pulumi.String("string"),
	OutlierDetectionConfig: &apig.ServiceOutlierDetectionConfigArgs{
		BaseEjectionTime:              pulumi.Int(0),
		Enable:                        pulumi.Bool(false),
		FailurePercentageMinimumHosts: pulumi.Int(0),
		FailurePercentageThreshold:    pulumi.Int(0),
		Interval:                      pulumi.Int(0),
	},
	Protocol:        pulumi.String("string"),
	Qualifier:       pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	ServiceName:     pulumi.String("string"),
	SourceType:      pulumi.String("string"),
})

    resource "alicloud_apig_service" "serviceResource" {
  lifecycle {
    create_before_destroy = true
  }
  addresses    = ["string"]
  dns_servers  = ["string"]
  express_type = "string"
  gateway_id   = "string"
  health_check_config = {
    enable              = false
    expected_statuses   = ["string"]
    healthy_threshold   = 0
    http_host           = "string"
    http_path           = "string"
    interval            = 0
    protocol            = "string"
    timeout             = 0
    unhealthy_threshold = 0
  }
  healthy_panic_threshold = 0
  namespace               = "string"
  outlier_detection_config = {
    base_ejection_time               = 0
    enable                           = false
    failure_percentage_minimum_hosts = 0
    failure_percentage_threshold     = 0
    interval                         = 0
  }
  protocol          = "string"
  qualifier         = "string"
  resource_group_id = "string"
  service_name      = "string"
  source_type       = "string"
}

    var serviceResource = new com.pulumi.alicloud.apig.Service("serviceResource", com.pulumi.alicloud.apig.ServiceArgs.builder()
    .addresses("string")
    .dnsServers("string")
    .expressType("string")
    .gatewayId("string")
    .healthCheckConfig(ServiceHealthCheckConfigArgs.builder()
        .enable(false)
        .expectedStatuses("string")
        .healthyThreshold(0)
        .httpHost("string")
        .httpPath("string")
        .interval(0)
        .protocol("string")
        .timeout(0)
        .unhealthyThreshold(0)
        .build())
    .healthyPanicThreshold(0.0)
    .namespace("string")
    .outlierDetectionConfig(ServiceOutlierDetectionConfigArgs.builder()
        .baseEjectionTime(0)
        .enable(false)
        .failurePercentageMinimumHosts(0)
        .failurePercentageThreshold(0)
        .interval(0)
        .build())
    .protocol("string")
    .qualifier("string")
    .resourceGroupId("string")
    .serviceName("string")
    .sourceType("string")
    .build());

    service_resource = alicloud.apig.Service("serviceResource",
    addresses=["string"],
    dns_servers=["string"],
    express_type="string",
    gateway_id="string",
    health_check_config={
        "enable": False,
        "expected_statuses": ["string"],
        "healthy_threshold": 0,
        "http_host": "string",
        "http_path": "string",
        "interval": 0,
        "protocol": "string",
        "timeout": 0,
        "unhealthy_threshold": 0,
    },
    healthy_panic_threshold=float(0),
    namespace="string",
    outlier_detection_config={
        "base_ejection_time": 0,
        "enable": False,
        "failure_percentage_minimum_hosts": 0,
        "failure_percentage_threshold": 0,
        "interval": 0,
    },
    protocol="string",
    qualifier="string",
    resource_group_id="string",
    service_name="string",
    source_type="string")

    const serviceResource = new alicloud.apig.Service("serviceResource", {
    addresses: ["string"],
    dnsServers: ["string"],
    expressType: "string",
    gatewayId: "string",
    healthCheckConfig: {
        enable: false,
        expectedStatuses: ["string"],
        healthyThreshold: 0,
        httpHost: "string",
        httpPath: "string",
        interval: 0,
        protocol: "string",
        timeout: 0,
        unhealthyThreshold: 0,
    },
    healthyPanicThreshold: 0,
    namespace: "string",
    outlierDetectionConfig: {
        baseEjectionTime: 0,
        enable: false,
        failurePercentageMinimumHosts: 0,
        failurePercentageThreshold: 0,
        interval: 0,
    },
    protocol: "string",
    qualifier: "string",
    resourceGroupId: "string",
    serviceName: "string",
    sourceType: "string",
});

    type: alicloud:apig:Service
properties:
    addresses:
        - string
    dnsServers:
        - string
    expressType: string
    gatewayId: string
    healthCheckConfig:
        enable: false
        expectedStatuses:
            - string
        healthyThreshold: 0
        httpHost: string
        httpPath: string
        interval: 0
        protocol: string
        timeout: 0
        unhealthyThreshold: 0
    healthyPanicThreshold: 0
    namespace: string
    outlierDetectionConfig:
        baseEjectionTime: 0
        enable: false
        failurePercentageMinimumHosts: 0
        failurePercentageThreshold: 0
        interval: 0
    protocol: string
    qualifier: string
    resourceGroupId: string
    serviceName: string
    sourceType: string

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

    Addresses List<string>
    A list of domain names or fixed addresses.
    DnsServers List<string>
    The list of DNS server addresses. Used when sourceType is DNS.
    ExpressType string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    GatewayId string
    The ID of the Cloud Native API Gateway.
    HealthCheckConfig Pulumi.AliCloud.Apig.Inputs.ServiceHealthCheckConfig
    Health check configuration See healthCheckConfig below.
    HealthyPanicThreshold double
    Healthy panic threshold
    Namespace string
    The namespace of the service.
    OutlierDetectionConfig Pulumi.AliCloud.Apig.Inputs.ServiceOutlierDetectionConfig
    Outlier detection configuration See outlierDetectionConfig below.
    Protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    Qualifier string
    The function version or alias. Used when sourceType is FC3.
    ResourceGroupId string
    The ID of the resource group.
    ServiceName string
    The service name.
    SourceType string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    Addresses []string
    A list of domain names or fixed addresses.
    DnsServers []string
    The list of DNS server addresses. Used when sourceType is DNS.
    ExpressType string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    GatewayId string
    The ID of the Cloud Native API Gateway.
    HealthCheckConfig ServiceHealthCheckConfigArgs
    Health check configuration See healthCheckConfig below.
    HealthyPanicThreshold float64
    Healthy panic threshold
    Namespace string
    The namespace of the service.
    OutlierDetectionConfig ServiceOutlierDetectionConfigArgs
    Outlier detection configuration See outlierDetectionConfig below.
    Protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    Qualifier string
    The function version or alias. Used when sourceType is FC3.
    ResourceGroupId string
    The ID of the resource group.
    ServiceName string
    The service name.
    SourceType string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    addresses list(string)
    A list of domain names or fixed addresses.
    dns_servers list(string)
    The list of DNS server addresses. Used when sourceType is DNS.
    express_type string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gateway_id string
    The ID of the Cloud Native API Gateway.
    health_check_config object
    Health check configuration See healthCheckConfig below.
    healthy_panic_threshold number
    Healthy panic threshold
    namespace string
    The namespace of the service.
    outlier_detection_config object
    Outlier detection configuration See outlierDetectionConfig below.
    protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier string
    The function version or alias. Used when sourceType is FC3.
    resource_group_id string
    The ID of the resource group.
    service_name string
    The service name.
    source_type string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    addresses List<String>
    A list of domain names or fixed addresses.
    dnsServers List<String>
    The list of DNS server addresses. Used when sourceType is DNS.
    expressType String
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gatewayId String
    The ID of the Cloud Native API Gateway.
    healthCheckConfig ServiceHealthCheckConfig
    Health check configuration See healthCheckConfig below.
    healthyPanicThreshold Double
    Healthy panic threshold
    namespace String
    The namespace of the service.
    outlierDetectionConfig ServiceOutlierDetectionConfig
    Outlier detection configuration See outlierDetectionConfig below.
    protocol String

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier String
    The function version or alias. Used when sourceType is FC3.
    resourceGroupId String
    The ID of the resource group.
    serviceName String
    The service name.
    sourceType String
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    addresses string[]
    A list of domain names or fixed addresses.
    dnsServers string[]
    The list of DNS server addresses. Used when sourceType is DNS.
    expressType string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gatewayId string
    The ID of the Cloud Native API Gateway.
    healthCheckConfig ServiceHealthCheckConfig
    Health check configuration See healthCheckConfig below.
    healthyPanicThreshold number
    Healthy panic threshold
    namespace string
    The namespace of the service.
    outlierDetectionConfig ServiceOutlierDetectionConfig
    Outlier detection configuration See outlierDetectionConfig below.
    protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier string
    The function version or alias. Used when sourceType is FC3.
    resourceGroupId string
    The ID of the resource group.
    serviceName string
    The service name.
    sourceType string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    addresses Sequence[str]
    A list of domain names or fixed addresses.
    dns_servers Sequence[str]
    The list of DNS server addresses. Used when sourceType is DNS.
    express_type str
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gateway_id str
    The ID of the Cloud Native API Gateway.
    health_check_config ServiceHealthCheckConfigArgs
    Health check configuration See healthCheckConfig below.
    healthy_panic_threshold float
    Healthy panic threshold
    namespace str
    The namespace of the service.
    outlier_detection_config ServiceOutlierDetectionConfigArgs
    Outlier detection configuration See outlierDetectionConfig below.
    protocol str

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier str
    The function version or alias. Used when sourceType is FC3.
    resource_group_id str
    The ID of the resource group.
    service_name str
    The service name.
    source_type str
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    addresses List<String>
    A list of domain names or fixed addresses.
    dnsServers List<String>
    The list of DNS server addresses. Used when sourceType is DNS.
    expressType String
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gatewayId String
    The ID of the Cloud Native API Gateway.
    healthCheckConfig Property Map
    Health check configuration See healthCheckConfig below.
    healthyPanicThreshold Number
    Healthy panic threshold
    namespace String
    The namespace of the service.
    outlierDetectionConfig Property Map
    Outlier detection configuration See outlierDetectionConfig below.
    protocol String

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier String
    The function version or alias. Used when sourceType is FC3.
    resourceGroupId String
    The ID of the resource group.
    serviceName String
    The service name.
    sourceType String
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).

    Outputs

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

    CreateTimestamp int
    Creation timestamp.
    HealthStatus string
    Health status.
    Id string
    The provider-assigned unique ID for this managed resource.
    OutlierEndpoints List<string>
    Outlier endpoints.
    Ports List<Pulumi.AliCloud.Apig.Outputs.ServicePort>
    Port information derived by the gateway. Each element contains:
    RuntimeDetailErrorCode string
    Runtime detail error code.
    RuntimeDetailStatus string
    Runtime detail status.
    UnhealthyEndpoints List<string>
    Unhealthy endpoints.
    UpdateTimestamp int
    Update timestamp.
    CreateTimestamp int
    Creation timestamp.
    HealthStatus string
    Health status.
    Id string
    The provider-assigned unique ID for this managed resource.
    OutlierEndpoints []string
    Outlier endpoints.
    Ports []ServicePort
    Port information derived by the gateway. Each element contains:
    RuntimeDetailErrorCode string
    Runtime detail error code.
    RuntimeDetailStatus string
    Runtime detail status.
    UnhealthyEndpoints []string
    Unhealthy endpoints.
    UpdateTimestamp int
    Update timestamp.
    create_timestamp number
    Creation timestamp.
    health_status string
    Health status.
    id string
    The provider-assigned unique ID for this managed resource.
    outlier_endpoints list(string)
    Outlier endpoints.
    ports list(object)
    Port information derived by the gateway. Each element contains:
    runtime_detail_error_code string
    Runtime detail error code.
    runtime_detail_status string
    Runtime detail status.
    unhealthy_endpoints list(string)
    Unhealthy endpoints.
    update_timestamp number
    Update timestamp.
    createTimestamp Integer
    Creation timestamp.
    healthStatus String
    Health status.
    id String
    The provider-assigned unique ID for this managed resource.
    outlierEndpoints List<String>
    Outlier endpoints.
    ports List<ServicePort>
    Port information derived by the gateway. Each element contains:
    runtimeDetailErrorCode String
    Runtime detail error code.
    runtimeDetailStatus String
    Runtime detail status.
    unhealthyEndpoints List<String>
    Unhealthy endpoints.
    updateTimestamp Integer
    Update timestamp.
    createTimestamp number
    Creation timestamp.
    healthStatus string
    Health status.
    id string
    The provider-assigned unique ID for this managed resource.
    outlierEndpoints string[]
    Outlier endpoints.
    ports ServicePort[]
    Port information derived by the gateway. Each element contains:
    runtimeDetailErrorCode string
    Runtime detail error code.
    runtimeDetailStatus string
    Runtime detail status.
    unhealthyEndpoints string[]
    Unhealthy endpoints.
    updateTimestamp number
    Update timestamp.
    create_timestamp int
    Creation timestamp.
    health_status str
    Health status.
    id str
    The provider-assigned unique ID for this managed resource.
    outlier_endpoints Sequence[str]
    Outlier endpoints.
    ports Sequence[ServicePort]
    Port information derived by the gateway. Each element contains:
    runtime_detail_error_code str
    Runtime detail error code.
    runtime_detail_status str
    Runtime detail status.
    unhealthy_endpoints Sequence[str]
    Unhealthy endpoints.
    update_timestamp int
    Update timestamp.
    createTimestamp Number
    Creation timestamp.
    healthStatus String
    Health status.
    id String
    The provider-assigned unique ID for this managed resource.
    outlierEndpoints List<String>
    Outlier endpoints.
    ports List<Property Map>
    Port information derived by the gateway. Each element contains:
    runtimeDetailErrorCode String
    Runtime detail error code.
    runtimeDetailStatus String
    Runtime detail status.
    unhealthyEndpoints List<String>
    Unhealthy endpoints.
    updateTimestamp Number
    Update timestamp.

    Look up Existing Service Resource

    Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[str]] = None,
        create_timestamp: Optional[int] = None,
        dns_servers: Optional[Sequence[str]] = None,
        express_type: Optional[str] = None,
        gateway_id: Optional[str] = None,
        health_check_config: Optional[ServiceHealthCheckConfigArgs] = None,
        health_status: Optional[str] = None,
        healthy_panic_threshold: Optional[float] = None,
        namespace: Optional[str] = None,
        outlier_detection_config: Optional[ServiceOutlierDetectionConfigArgs] = None,
        outlier_endpoints: Optional[Sequence[str]] = None,
        ports: Optional[Sequence[ServicePortArgs]] = None,
        protocol: Optional[str] = None,
        qualifier: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        runtime_detail_error_code: Optional[str] = None,
        runtime_detail_status: Optional[str] = None,
        service_name: Optional[str] = None,
        source_type: Optional[str] = None,
        unhealthy_endpoints: Optional[Sequence[str]] = None,
        update_timestamp: Optional[int] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:apig:Service    get:      id: ${id}
    import {
  to = alicloud_apig_service.example
  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:
    Addresses List<string>
    A list of domain names or fixed addresses.
    CreateTimestamp int
    Creation timestamp.
    DnsServers List<string>
    The list of DNS server addresses. Used when sourceType is DNS.
    ExpressType string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    GatewayId string
    The ID of the Cloud Native API Gateway.
    HealthCheckConfig Pulumi.AliCloud.Apig.Inputs.ServiceHealthCheckConfig
    Health check configuration See healthCheckConfig below.
    HealthStatus string
    Health status.
    HealthyPanicThreshold double
    Healthy panic threshold
    Namespace string
    The namespace of the service.
    OutlierDetectionConfig Pulumi.AliCloud.Apig.Inputs.ServiceOutlierDetectionConfig
    Outlier detection configuration See outlierDetectionConfig below.
    OutlierEndpoints List<string>
    Outlier endpoints.
    Ports List<Pulumi.AliCloud.Apig.Inputs.ServicePort>
    Port information derived by the gateway. Each element contains:
    Protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    Qualifier string
    The function version or alias. Used when sourceType is FC3.
    ResourceGroupId string
    The ID of the resource group.
    RuntimeDetailErrorCode string
    Runtime detail error code.
    RuntimeDetailStatus string
    Runtime detail status.
    ServiceName string
    The service name.
    SourceType string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    UnhealthyEndpoints List<string>
    Unhealthy endpoints.
    UpdateTimestamp int
    Update timestamp.
    Addresses []string
    A list of domain names or fixed addresses.
    CreateTimestamp int
    Creation timestamp.
    DnsServers []string
    The list of DNS server addresses. Used when sourceType is DNS.
    ExpressType string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    GatewayId string
    The ID of the Cloud Native API Gateway.
    HealthCheckConfig ServiceHealthCheckConfigArgs
    Health check configuration See healthCheckConfig below.
    HealthStatus string
    Health status.
    HealthyPanicThreshold float64
    Healthy panic threshold
    Namespace string
    The namespace of the service.
    OutlierDetectionConfig ServiceOutlierDetectionConfigArgs
    Outlier detection configuration See outlierDetectionConfig below.
    OutlierEndpoints []string
    Outlier endpoints.
    Ports []ServicePortArgs
    Port information derived by the gateway. Each element contains:
    Protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    Qualifier string
    The function version or alias. Used when sourceType is FC3.
    ResourceGroupId string
    The ID of the resource group.
    RuntimeDetailErrorCode string
    Runtime detail error code.
    RuntimeDetailStatus string
    Runtime detail status.
    ServiceName string
    The service name.
    SourceType string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    UnhealthyEndpoints []string
    Unhealthy endpoints.
    UpdateTimestamp int
    Update timestamp.
    addresses list(string)
    A list of domain names or fixed addresses.
    create_timestamp number
    Creation timestamp.
    dns_servers list(string)
    The list of DNS server addresses. Used when sourceType is DNS.
    express_type string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gateway_id string
    The ID of the Cloud Native API Gateway.
    health_check_config object
    Health check configuration See healthCheckConfig below.
    health_status string
    Health status.
    healthy_panic_threshold number
    Healthy panic threshold
    namespace string
    The namespace of the service.
    outlier_detection_config object
    Outlier detection configuration See outlierDetectionConfig below.
    outlier_endpoints list(string)
    Outlier endpoints.
    ports list(object)
    Port information derived by the gateway. Each element contains:
    protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier string
    The function version or alias. Used when sourceType is FC3.
    resource_group_id string
    The ID of the resource group.
    runtime_detail_error_code string
    Runtime detail error code.
    runtime_detail_status string
    Runtime detail status.
    service_name string
    The service name.
    source_type string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    unhealthy_endpoints list(string)
    Unhealthy endpoints.
    update_timestamp number
    Update timestamp.
    addresses List<String>
    A list of domain names or fixed addresses.
    createTimestamp Integer
    Creation timestamp.
    dnsServers List<String>
    The list of DNS server addresses. Used when sourceType is DNS.
    expressType String
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gatewayId String
    The ID of the Cloud Native API Gateway.
    healthCheckConfig ServiceHealthCheckConfig
    Health check configuration See healthCheckConfig below.
    healthStatus String
    Health status.
    healthyPanicThreshold Double
    Healthy panic threshold
    namespace String
    The namespace of the service.
    outlierDetectionConfig ServiceOutlierDetectionConfig
    Outlier detection configuration See outlierDetectionConfig below.
    outlierEndpoints List<String>
    Outlier endpoints.
    ports List<ServicePort>
    Port information derived by the gateway. Each element contains:
    protocol String

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier String
    The function version or alias. Used when sourceType is FC3.
    resourceGroupId String
    The ID of the resource group.
    runtimeDetailErrorCode String
    Runtime detail error code.
    runtimeDetailStatus String
    Runtime detail status.
    serviceName String
    The service name.
    sourceType String
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    unhealthyEndpoints List<String>
    Unhealthy endpoints.
    updateTimestamp Integer
    Update timestamp.
    addresses string[]
    A list of domain names or fixed addresses.
    createTimestamp number
    Creation timestamp.
    dnsServers string[]
    The list of DNS server addresses. Used when sourceType is DNS.
    expressType string
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gatewayId string
    The ID of the Cloud Native API Gateway.
    healthCheckConfig ServiceHealthCheckConfig
    Health check configuration See healthCheckConfig below.
    healthStatus string
    Health status.
    healthyPanicThreshold number
    Healthy panic threshold
    namespace string
    The namespace of the service.
    outlierDetectionConfig ServiceOutlierDetectionConfig
    Outlier detection configuration See outlierDetectionConfig below.
    outlierEndpoints string[]
    Outlier endpoints.
    ports ServicePort[]
    Port information derived by the gateway. Each element contains:
    protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier string
    The function version or alias. Used when sourceType is FC3.
    resourceGroupId string
    The ID of the resource group.
    runtimeDetailErrorCode string
    Runtime detail error code.
    runtimeDetailStatus string
    Runtime detail status.
    serviceName string
    The service name.
    sourceType string
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    unhealthyEndpoints string[]
    Unhealthy endpoints.
    updateTimestamp number
    Update timestamp.
    addresses Sequence[str]
    A list of domain names or fixed addresses.
    create_timestamp int
    Creation timestamp.
    dns_servers Sequence[str]
    The list of DNS server addresses. Used when sourceType is DNS.
    express_type str
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gateway_id str
    The ID of the Cloud Native API Gateway.
    health_check_config ServiceHealthCheckConfigArgs
    Health check configuration See healthCheckConfig below.
    health_status str
    Health status.
    healthy_panic_threshold float
    Healthy panic threshold
    namespace str
    The namespace of the service.
    outlier_detection_config ServiceOutlierDetectionConfigArgs
    Outlier detection configuration See outlierDetectionConfig below.
    outlier_endpoints Sequence[str]
    Outlier endpoints.
    ports Sequence[ServicePortArgs]
    Port information derived by the gateway. Each element contains:
    protocol str

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier str
    The function version or alias. Used when sourceType is FC3.
    resource_group_id str
    The ID of the resource group.
    runtime_detail_error_code str
    Runtime detail error code.
    runtime_detail_status str
    Runtime detail status.
    service_name str
    The service name.
    source_type str
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    unhealthy_endpoints Sequence[str]
    Unhealthy endpoints.
    update_timestamp int
    Update timestamp.
    addresses List<String>
    A list of domain names or fixed addresses.
    createTimestamp Number
    Creation timestamp.
    dnsServers List<String>
    The list of DNS server addresses. Used when sourceType is DNS.
    expressType String
    The service express type, which identifies a special type or mode of the service. Example value: Standard.
    gatewayId String
    The ID of the Cloud Native API Gateway.
    healthCheckConfig Property Map
    Health check configuration See healthCheckConfig below.
    healthStatus String
    Health status.
    healthyPanicThreshold Number
    Healthy panic threshold
    namespace String
    The namespace of the service.
    outlierDetectionConfig Property Map
    Outlier detection configuration See outlierDetectionConfig below.
    outlierEndpoints List<String>
    Outlier endpoints.
    ports List<Property Map>
    Port information derived by the gateway. Each element contains:
    protocol String

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    qualifier String
    The function version or alias. Used when sourceType is FC3.
    resourceGroupId String
    The ID of the resource group.
    runtimeDetailErrorCode String
    Runtime detail error code.
    runtimeDetailStatus String
    Runtime detail status.
    serviceName String
    The service name.
    sourceType String
    The service source type. Valid values: DNS, VIP, FC3.

    • VIP: a fixed-address service (set addresses).
    • DNS: a DNS domain service (set addresses, optionally dnsServers).
    • FC3: a Function Compute service (set qualifier).
    unhealthyEndpoints List<String>
    Unhealthy endpoints.
    updateTimestamp Number
    Update timestamp.

    Supporting Types

    ServiceHealthCheckConfig, ServiceHealthCheckConfigArgs

    Enable bool
    Whether to enable health check
    ExpectedStatuses List<string>
    Expected HTTP status codes
    HealthyThreshold int
    Healthy threshold
    HttpHost string
    Health check host (optional when protocol is HTTP)
    HttpPath string
    Health check path (required when protocol is HTTP)
    Interval int
    Health check interval
    Protocol string
    Health check protocol TCP|HTTP|GRPC
    Timeout int
    Health check response timeout
    UnhealthyThreshold int
    Unhealthy threshold
    Enable bool
    Whether to enable health check
    ExpectedStatuses []string
    Expected HTTP status codes
    HealthyThreshold int
    Healthy threshold
    HttpHost string
    Health check host (optional when protocol is HTTP)
    HttpPath string
    Health check path (required when protocol is HTTP)
    Interval int
    Health check interval
    Protocol string
    Health check protocol TCP|HTTP|GRPC
    Timeout int
    Health check response timeout
    UnhealthyThreshold int
    Unhealthy threshold
    enable bool
    Whether to enable health check
    expected_statuses list(string)
    Expected HTTP status codes
    healthy_threshold number
    Healthy threshold
    http_host string
    Health check host (optional when protocol is HTTP)
    http_path string
    Health check path (required when protocol is HTTP)
    interval number
    Health check interval
    protocol string
    Health check protocol TCP|HTTP|GRPC
    timeout number
    Health check response timeout
    unhealthy_threshold number
    Unhealthy threshold
    enable Boolean
    Whether to enable health check
    expectedStatuses List<String>
    Expected HTTP status codes
    healthyThreshold Integer
    Healthy threshold
    httpHost String
    Health check host (optional when protocol is HTTP)
    httpPath String
    Health check path (required when protocol is HTTP)
    interval Integer
    Health check interval
    protocol String
    Health check protocol TCP|HTTP|GRPC
    timeout Integer
    Health check response timeout
    unhealthyThreshold Integer
    Unhealthy threshold
    enable boolean
    Whether to enable health check
    expectedStatuses string[]
    Expected HTTP status codes
    healthyThreshold number
    Healthy threshold
    httpHost string
    Health check host (optional when protocol is HTTP)
    httpPath string
    Health check path (required when protocol is HTTP)
    interval number
    Health check interval
    protocol string
    Health check protocol TCP|HTTP|GRPC
    timeout number
    Health check response timeout
    unhealthyThreshold number
    Unhealthy threshold
    enable bool
    Whether to enable health check
    expected_statuses Sequence[str]
    Expected HTTP status codes
    healthy_threshold int
    Healthy threshold
    http_host str
    Health check host (optional when protocol is HTTP)
    http_path str
    Health check path (required when protocol is HTTP)
    interval int
    Health check interval
    protocol str
    Health check protocol TCP|HTTP|GRPC
    timeout int
    Health check response timeout
    unhealthy_threshold int
    Unhealthy threshold
    enable Boolean
    Whether to enable health check
    expectedStatuses List<String>
    Expected HTTP status codes
    healthyThreshold Number
    Healthy threshold
    httpHost String
    Health check host (optional when protocol is HTTP)
    httpPath String
    Health check path (required when protocol is HTTP)
    interval Number
    Health check interval
    protocol String
    Health check protocol TCP|HTTP|GRPC
    timeout Number
    Health check response timeout
    unhealthyThreshold Number
    Unhealthy threshold

    ServiceOutlierDetectionConfig, ServiceOutlierDetectionConfigArgs

    BaseEjectionTime int
    Base ejection time
    Enable bool
    Whether to enable outlier detection
    FailurePercentageMinimumHosts int
    Failure percentage minimum hosts
    FailurePercentageThreshold int
    Failure percentage threshold
    Interval int
    Detection interval
    BaseEjectionTime int
    Base ejection time
    Enable bool
    Whether to enable outlier detection
    FailurePercentageMinimumHosts int
    Failure percentage minimum hosts
    FailurePercentageThreshold int
    Failure percentage threshold
    Interval int
    Detection interval
    base_ejection_time number
    Base ejection time
    enable bool
    Whether to enable outlier detection
    failure_percentage_minimum_hosts number
    Failure percentage minimum hosts
    failure_percentage_threshold number
    Failure percentage threshold
    interval number
    Detection interval
    baseEjectionTime Integer
    Base ejection time
    enable Boolean
    Whether to enable outlier detection
    failurePercentageMinimumHosts Integer
    Failure percentage minimum hosts
    failurePercentageThreshold Integer
    Failure percentage threshold
    interval Integer
    Detection interval
    baseEjectionTime number
    Base ejection time
    enable boolean
    Whether to enable outlier detection
    failurePercentageMinimumHosts number
    Failure percentage minimum hosts
    failurePercentageThreshold number
    Failure percentage threshold
    interval number
    Detection interval
    base_ejection_time int
    Base ejection time
    enable bool
    Whether to enable outlier detection
    failure_percentage_minimum_hosts int
    Failure percentage minimum hosts
    failure_percentage_threshold int
    Failure percentage threshold
    interval int
    Detection interval
    baseEjectionTime Number
    Base ejection time
    enable Boolean
    Whether to enable outlier detection
    failurePercentageMinimumHosts Number
    Failure percentage minimum hosts
    failurePercentageThreshold Number
    Failure percentage threshold
    interval Number
    Detection interval

    ServicePort, ServicePortArgs

    Name string
    Port name.
    Port int
    Port number.
    Protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    Name string
    Port name.
    Port int
    Port number.
    Protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    name string
    Port name.
    port number
    Port number.
    protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    name String
    Port name.
    port Integer
    Port number.
    protocol String

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    name string
    Port name.
    port number
    Port number.
    protocol string

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    name str
    Port name.
    port int
    Port number.
    protocol str

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    name String
    Port name.
    port Number
    Port number.
    protocol String

    Service protocol.

    NOTE: The parameter protocol is immutable after resource creation. Changing it after creation has no effect.

    Import

    APIG Service can be imported using the id, e.g.

    $ pulumi import alicloud:apig/service:Service example <service_id>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo alicloud logo
    Viewing docs for Alibaba Cloud v3.108.0
    published on Thursday, Sep 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial