Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ApiGatewayService
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ApiGatewayService

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this resource to create API gateway service.

    NOTE: After setting uniq_vpc_id, it cannot be modified.

    Example Usage

    Shared Service

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

const vpc = new tencentcloud.Vpc("vpc", {cidrBlock: "10.0.0.0/16"});
const example = new tencentcloud.ApiGatewayService("example", {
    serviceName: "tf-example",
    protocol: "http&https",
    serviceDesc: "desc.",
    netTypes: [
        "INNER",
        "OUTER",
    ],
    ipVersion: "IPv4",
    uniqVpcId: vpc.vpcId,
    tags: {
        createdBy: "terraform",
    },
    releaseLimit: 500,
    preLimit: 500,
    testLimit: 500,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

vpc = tencentcloud.Vpc("vpc", cidr_block="10.0.0.0/16")
example = tencentcloud.ApiGatewayService("example",
    service_name="tf-example",
    protocol="http&https",
    service_desc="desc.",
    net_types=[
        "INNER",
        "OUTER",
    ],
    ip_version="IPv4",
    uniq_vpc_id=vpc.vpc_id,
    tags={
        "createdBy": "terraform",
    },
    release_limit=500,
    pre_limit=500,
    test_limit=500)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		vpc, err := tencentcloud.NewVpc(ctx, "vpc", &tencentcloud.VpcArgs{
			CidrBlock: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		_, err = tencentcloud.NewApiGatewayService(ctx, "example", &tencentcloud.ApiGatewayServiceArgs{
			ServiceName: pulumi.String("tf-example"),
			Protocol:    pulumi.String("http&https"),
			ServiceDesc: pulumi.String("desc."),
			NetTypes: pulumi.StringArray{
				pulumi.String("INNER"),
				pulumi.String("OUTER"),
			},
			IpVersion: pulumi.String("IPv4"),
			UniqVpcId: vpc.VpcId,
			Tags: pulumi.StringMap{
				"createdBy": pulumi.String("terraform"),
			},
			ReleaseLimit: pulumi.Float64(500),
			PreLimit:     pulumi.Float64(500),
			TestLimit:    pulumi.Float64(500),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var vpc = new Tencentcloud.Vpc("vpc", new()
    {
        CidrBlock = "10.0.0.0/16",
    });

    var example = new Tencentcloud.ApiGatewayService("example", new()
    {
        ServiceName = "tf-example",
        Protocol = "http&https",
        ServiceDesc = "desc.",
        NetTypes = new[]
        {
            "INNER",
            "OUTER",
        },
        IpVersion = "IPv4",
        UniqVpcId = vpc.VpcId,
        Tags = 
        {
            { "createdBy", "terraform" },
        },
        ReleaseLimit = 500,
        PreLimit = 500,
        TestLimit = 500,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.Vpc;
import com.pulumi.tencentcloud.VpcArgs;
import com.pulumi.tencentcloud.ApiGatewayService;
import com.pulumi.tencentcloud.ApiGatewayServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var vpc = new Vpc("vpc", VpcArgs.builder()
            .cidrBlock("10.0.0.0/16")
            .build());

        var example = new ApiGatewayService("example", ApiGatewayServiceArgs.builder()
            .serviceName("tf-example")
            .protocol("http&https")
            .serviceDesc("desc.")
            .netTypes(            
                "INNER",
                "OUTER")
            .ipVersion("IPv4")
            .uniqVpcId(vpc.vpcId())
            .tags(Map.of("createdBy", "terraform"))
            .releaseLimit(500)
            .preLimit(500)
            .testLimit(500)
            .build());

    }
}

    resources:
  vpc:
    type: tencentcloud:Vpc
    properties:
      cidrBlock: 10.0.0.0/16
  example:
    type: tencentcloud:ApiGatewayService
    properties:
      serviceName: tf-example
      protocol: http&https
      serviceDesc: desc.
      netTypes:
        - INNER
        - OUTER
      ipVersion: IPv4
      uniqVpcId: ${vpc.vpcId}
      tags:
        createdBy: terraform
      releaseLimit: 500
      preLimit: 500
      testLimit: 500

    Exclusive Service

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

const example = new tencentcloud.ApiGatewayService("example", {
    serviceName: "tf-example",
    protocol: "http&https",
    serviceDesc: "desc.",
    netTypes: [
        "INNER",
        "OUTER",
    ],
    ipVersion: "IPv4",
    uniqVpcId: tencentcloud_vpc.vpc.id,
    instanceId: "instance-rc6fcv4e",
    tags: {
        createdBy: "terraform",
    },
    releaseLimit: 500,
    preLimit: 500,
    testLimit: 500,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.ApiGatewayService("example",
    service_name="tf-example",
    protocol="http&https",
    service_desc="desc.",
    net_types=[
        "INNER",
        "OUTER",
    ],
    ip_version="IPv4",
    uniq_vpc_id=tencentcloud_vpc["vpc"]["id"],
    instance_id="instance-rc6fcv4e",
    tags={
        "createdBy": "terraform",
    },
    release_limit=500,
    pre_limit=500,
    test_limit=500)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewApiGatewayService(ctx, "example", &tencentcloud.ApiGatewayServiceArgs{
			ServiceName: pulumi.String("tf-example"),
			Protocol:    pulumi.String("http&https"),
			ServiceDesc: pulumi.String("desc."),
			NetTypes: pulumi.StringArray{
				pulumi.String("INNER"),
				pulumi.String("OUTER"),
			},
			IpVersion:  pulumi.String("IPv4"),
			UniqVpcId:  pulumi.Any(tencentcloud_vpc.Vpc.Id),
			InstanceId: pulumi.String("instance-rc6fcv4e"),
			Tags: pulumi.StringMap{
				"createdBy": pulumi.String("terraform"),
			},
			ReleaseLimit: pulumi.Float64(500),
			PreLimit:     pulumi.Float64(500),
			TestLimit:    pulumi.Float64(500),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Tencentcloud.ApiGatewayService("example", new()
    {
        ServiceName = "tf-example",
        Protocol = "http&https",
        ServiceDesc = "desc.",
        NetTypes = new[]
        {
            "INNER",
            "OUTER",
        },
        IpVersion = "IPv4",
        UniqVpcId = tencentcloud_vpc.Vpc.Id,
        InstanceId = "instance-rc6fcv4e",
        Tags = 
        {
            { "createdBy", "terraform" },
        },
        ReleaseLimit = 500,
        PreLimit = 500,
        TestLimit = 500,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ApiGatewayService;
import com.pulumi.tencentcloud.ApiGatewayServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new ApiGatewayService("example", ApiGatewayServiceArgs.builder()
            .serviceName("tf-example")
            .protocol("http&https")
            .serviceDesc("desc.")
            .netTypes(            
                "INNER",
                "OUTER")
            .ipVersion("IPv4")
            .uniqVpcId(tencentcloud_vpc.vpc().id())
            .instanceId("instance-rc6fcv4e")
            .tags(Map.of("createdBy", "terraform"))
            .releaseLimit(500)
            .preLimit(500)
            .testLimit(500)
            .build());

    }
}

    resources:
  example:
    type: tencentcloud:ApiGatewayService
    properties:
      serviceName: tf-example
      protocol: http&https
      serviceDesc: desc.
      netTypes:
        - INNER
        - OUTER
      ipVersion: IPv4
      uniqVpcId: ${tencentcloud_vpc.vpc.id}
      instanceId: instance-rc6fcv4e
      tags:
        createdBy: terraform
      releaseLimit: 500
      preLimit: 500
      testLimit: 500

    Create ApiGatewayService Resource

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

    Constructor syntax

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

@overload
def ApiGatewayService(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      service_name: Optional[str] = None,
                      net_types: Optional[Sequence[str]] = None,
                      protocol: Optional[str] = None,
                      exclusive_set_name: Optional[str] = None,
                      instance_id: Optional[str] = None,
                      ip_version: Optional[str] = None,
                      pre_limit: Optional[float] = None,
                      release_limit: Optional[float] = None,
                      service_desc: Optional[str] = None,
                      api_gateway_service_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      test_limit: Optional[float] = None,
                      uniq_vpc_id: Optional[str] = None)
    func NewApiGatewayService(ctx *Context, name string, args ApiGatewayServiceArgs, opts ...ResourceOption) (*ApiGatewayService, error)
    public ApiGatewayService(string name, ApiGatewayServiceArgs args, CustomResourceOptions? opts = null)
    public ApiGatewayService(String name, ApiGatewayServiceArgs args)
public ApiGatewayService(String name, ApiGatewayServiceArgs args, CustomResourceOptions options)

    type: tencentcloud:ApiGatewayService
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 ApiGatewayServiceArgs
    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 ApiGatewayServiceArgs
    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 ApiGatewayServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiGatewayServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiGatewayServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    NetTypes List<string>
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    Protocol string
    Service frontend request type. Valid values: http, https, http&https.
    ServiceName string
    Custom service name.
    ApiGatewayServiceId string
    ID of the resource.
    ExclusiveSetName string
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    InstanceId string
    Exclusive instance ID.
    IpVersion string
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    PreLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    ReleaseLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    ServiceDesc string
    Custom service description.
    Tags Dictionary<string, string>
    Tag description list.
    TestLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    UniqVpcId string
    VPC ID.
    NetTypes []string
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    Protocol string
    Service frontend request type. Valid values: http, https, http&https.
    ServiceName string
    Custom service name.
    ApiGatewayServiceId string
    ID of the resource.
    ExclusiveSetName string
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    InstanceId string
    Exclusive instance ID.
    IpVersion string
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    PreLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    ReleaseLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    ServiceDesc string
    Custom service description.
    Tags map[string]string
    Tag description list.
    TestLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    UniqVpcId string
    VPC ID.
    netTypes List<String>
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    protocol String
    Service frontend request type. Valid values: http, https, http&https.
    serviceName String
    Custom service name.
    apiGatewayServiceId String
    ID of the resource.
    exclusiveSetName String
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    instanceId String
    Exclusive instance ID.
    ipVersion String
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    preLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    releaseLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    serviceDesc String
    Custom service description.
    tags Map<String,String>
    Tag description list.
    testLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniqVpcId String
    VPC ID.
    netTypes string[]
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    protocol string
    Service frontend request type. Valid values: http, https, http&https.
    serviceName string
    Custom service name.
    apiGatewayServiceId string
    ID of the resource.
    exclusiveSetName string
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    instanceId string
    Exclusive instance ID.
    ipVersion string
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    preLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    releaseLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    serviceDesc string
    Custom service description.
    tags {[key: string]: string}
    Tag description list.
    testLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniqVpcId string
    VPC ID.
    net_types Sequence[str]
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    protocol str
    Service frontend request type. Valid values: http, https, http&https.
    service_name str
    Custom service name.
    api_gateway_service_id str
    ID of the resource.
    exclusive_set_name str
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    instance_id str
    Exclusive instance ID.
    ip_version str
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    pre_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    release_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    service_desc str
    Custom service description.
    tags Mapping[str, str]
    Tag description list.
    test_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniq_vpc_id str
    VPC ID.
    netTypes List<String>
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    protocol String
    Service frontend request type. Valid values: http, https, http&https.
    serviceName String
    Custom service name.
    apiGatewayServiceId String
    ID of the resource.
    exclusiveSetName String
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    instanceId String
    Exclusive instance ID.
    ipVersion String
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    preLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    releaseLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    serviceDesc String
    Custom service description.
    tags Map<String>
    Tag description list.
    testLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniqVpcId String
    VPC ID.

    Outputs

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

    ApiLists List<ApiGatewayServiceApiList>
    A list of APIs.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    Id string
    The provider-assigned unique ID for this managed resource.
    InnerHttpPort double
    Port number for http access over private network.
    InnerHttpsPort double
    Port number for https access over private network.
    InternalSubDomain string
    Private network access subdomain name.
    ModifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    OuterSubDomain string
    Public network access subdomain name.
    UsagePlanLists List<ApiGatewayServiceUsagePlanList>
    A list of attach usage plans.
    ApiLists []ApiGatewayServiceApiList
    A list of APIs.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    Id string
    The provider-assigned unique ID for this managed resource.
    InnerHttpPort float64
    Port number for http access over private network.
    InnerHttpsPort float64
    Port number for https access over private network.
    InternalSubDomain string
    Private network access subdomain name.
    ModifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    OuterSubDomain string
    Public network access subdomain name.
    UsagePlanLists []ApiGatewayServiceUsagePlanList
    A list of attach usage plans.
    apiLists List<ApiGatewayServiceApiList>
    A list of APIs.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id String
    The provider-assigned unique ID for this managed resource.
    innerHttpPort Double
    Port number for http access over private network.
    innerHttpsPort Double
    Port number for https access over private network.
    internalSubDomain String
    Private network access subdomain name.
    modifyTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    outerSubDomain String
    Public network access subdomain name.
    usagePlanLists List<ApiGatewayServiceUsagePlanList>
    A list of attach usage plans.
    apiLists ApiGatewayServiceApiList[]
    A list of APIs.
    createTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id string
    The provider-assigned unique ID for this managed resource.
    innerHttpPort number
    Port number for http access over private network.
    innerHttpsPort number
    Port number for https access over private network.
    internalSubDomain string
    Private network access subdomain name.
    modifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    outerSubDomain string
    Public network access subdomain name.
    usagePlanLists ApiGatewayServiceUsagePlanList[]
    A list of attach usage plans.
    api_lists Sequence[ApiGatewayServiceApiList]
    A list of APIs.
    create_time str
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id str
    The provider-assigned unique ID for this managed resource.
    inner_http_port float
    Port number for http access over private network.
    inner_https_port float
    Port number for https access over private network.
    internal_sub_domain str
    Private network access subdomain name.
    modify_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    outer_sub_domain str
    Public network access subdomain name.
    usage_plan_lists Sequence[ApiGatewayServiceUsagePlanList]
    A list of attach usage plans.
    apiLists List<Property Map>
    A list of APIs.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    id String
    The provider-assigned unique ID for this managed resource.
    innerHttpPort Number
    Port number for http access over private network.
    innerHttpsPort Number
    Port number for https access over private network.
    internalSubDomain String
    Private network access subdomain name.
    modifyTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    outerSubDomain String
    Public network access subdomain name.
    usagePlanLists List<Property Map>
    A list of attach usage plans.

    Look up Existing ApiGatewayService Resource

    Get an existing ApiGatewayService 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?: ApiGatewayServiceState, opts?: CustomResourceOptions): ApiGatewayService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_gateway_service_id: Optional[str] = None,
        api_lists: Optional[Sequence[ApiGatewayServiceApiListArgs]] = None,
        create_time: Optional[str] = None,
        exclusive_set_name: Optional[str] = None,
        inner_http_port: Optional[float] = None,
        inner_https_port: Optional[float] = None,
        instance_id: Optional[str] = None,
        internal_sub_domain: Optional[str] = None,
        ip_version: Optional[str] = None,
        modify_time: Optional[str] = None,
        net_types: Optional[Sequence[str]] = None,
        outer_sub_domain: Optional[str] = None,
        pre_limit: Optional[float] = None,
        protocol: Optional[str] = None,
        release_limit: Optional[float] = None,
        service_desc: Optional[str] = None,
        service_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        test_limit: Optional[float] = None,
        uniq_vpc_id: Optional[str] = None,
        usage_plan_lists: Optional[Sequence[ApiGatewayServiceUsagePlanListArgs]] = None) -> ApiGatewayService
    func GetApiGatewayService(ctx *Context, name string, id IDInput, state *ApiGatewayServiceState, opts ...ResourceOption) (*ApiGatewayService, error)
    public static ApiGatewayService Get(string name, Input<string> id, ApiGatewayServiceState? state, CustomResourceOptions? opts = null)
    public static ApiGatewayService get(String name, Output<String> id, ApiGatewayServiceState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ApiGatewayService    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:
    ApiGatewayServiceId string
    ID of the resource.
    ApiLists List<ApiGatewayServiceApiList>
    A list of APIs.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    ExclusiveSetName string
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    InnerHttpPort double
    Port number for http access over private network.
    InnerHttpsPort double
    Port number for https access over private network.
    InstanceId string
    Exclusive instance ID.
    InternalSubDomain string
    Private network access subdomain name.
    IpVersion string
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    ModifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    NetTypes List<string>
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    OuterSubDomain string
    Public network access subdomain name.
    PreLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    Protocol string
    Service frontend request type. Valid values: http, https, http&https.
    ReleaseLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    ServiceDesc string
    Custom service description.
    ServiceName string
    Custom service name.
    Tags Dictionary<string, string>
    Tag description list.
    TestLimit double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    UniqVpcId string
    VPC ID.
    UsagePlanLists List<ApiGatewayServiceUsagePlanList>
    A list of attach usage plans.
    ApiGatewayServiceId string
    ID of the resource.
    ApiLists []ApiGatewayServiceApiListArgs
    A list of APIs.
    CreateTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    ExclusiveSetName string
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    InnerHttpPort float64
    Port number for http access over private network.
    InnerHttpsPort float64
    Port number for https access over private network.
    InstanceId string
    Exclusive instance ID.
    InternalSubDomain string
    Private network access subdomain name.
    IpVersion string
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    ModifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    NetTypes []string
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    OuterSubDomain string
    Public network access subdomain name.
    PreLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    Protocol string
    Service frontend request type. Valid values: http, https, http&https.
    ReleaseLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    ServiceDesc string
    Custom service description.
    ServiceName string
    Custom service name.
    Tags map[string]string
    Tag description list.
    TestLimit float64
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    UniqVpcId string
    VPC ID.
    UsagePlanLists []ApiGatewayServiceUsagePlanListArgs
    A list of attach usage plans.
    apiGatewayServiceId String
    ID of the resource.
    apiLists List<ApiGatewayServiceApiList>
    A list of APIs.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    exclusiveSetName String
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    innerHttpPort Double
    Port number for http access over private network.
    innerHttpsPort Double
    Port number for https access over private network.
    instanceId String
    Exclusive instance ID.
    internalSubDomain String
    Private network access subdomain name.
    ipVersion String
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    modifyTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    netTypes List<String>
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    outerSubDomain String
    Public network access subdomain name.
    preLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol String
    Service frontend request type. Valid values: http, https, http&https.
    releaseLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    serviceDesc String
    Custom service description.
    serviceName String
    Custom service name.
    tags Map<String,String>
    Tag description list.
    testLimit Double
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniqVpcId String
    VPC ID.
    usagePlanLists List<ApiGatewayServiceUsagePlanList>
    A list of attach usage plans.
    apiGatewayServiceId string
    ID of the resource.
    apiLists ApiGatewayServiceApiList[]
    A list of APIs.
    createTime string
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    exclusiveSetName string
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    innerHttpPort number
    Port number for http access over private network.
    innerHttpsPort number
    Port number for https access over private network.
    instanceId string
    Exclusive instance ID.
    internalSubDomain string
    Private network access subdomain name.
    ipVersion string
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    modifyTime string
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    netTypes string[]
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    outerSubDomain string
    Public network access subdomain name.
    preLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol string
    Service frontend request type. Valid values: http, https, http&https.
    releaseLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    serviceDesc string
    Custom service description.
    serviceName string
    Custom service name.
    tags {[key: string]: string}
    Tag description list.
    testLimit number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniqVpcId string
    VPC ID.
    usagePlanLists ApiGatewayServiceUsagePlanList[]
    A list of attach usage plans.
    api_gateway_service_id str
    ID of the resource.
    api_lists Sequence[ApiGatewayServiceApiListArgs]
    A list of APIs.
    create_time str
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    exclusive_set_name str
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    inner_http_port float
    Port number for http access over private network.
    inner_https_port float
    Port number for https access over private network.
    instance_id str
    Exclusive instance ID.
    internal_sub_domain str
    Private network access subdomain name.
    ip_version str
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    modify_time str
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    net_types Sequence[str]
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    outer_sub_domain str
    Public network access subdomain name.
    pre_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol str
    Service frontend request type. Valid values: http, https, http&https.
    release_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    service_desc str
    Custom service description.
    service_name str
    Custom service name.
    tags Mapping[str, str]
    Tag description list.
    test_limit float
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniq_vpc_id str
    VPC ID.
    usage_plan_lists Sequence[ApiGatewayServiceUsagePlanListArgs]
    A list of attach usage plans.
    apiGatewayServiceId String
    ID of the resource.
    apiLists List<Property Map>
    A list of APIs.
    createTime String
    Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    exclusiveSetName String
    It has been deprecated from version 1.81.9. Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.

    Deprecated: Deprecated

    innerHttpPort Number
    Port number for http access over private network.
    innerHttpsPort Number
    Port number for https access over private network.
    instanceId String
    Exclusive instance ID.
    internalSubDomain String
    Private network access subdomain name.
    ipVersion String
    IP version number. Valid values: IPv4, IPv6. Default value: IPv4.
    modifyTime String
    Last modified time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
    netTypes List<String>
    Network type list, which is used to specify the supported network types. Valid values: INNER, OUTER. INNER indicates access over private network, and OUTER indicates access over public network.
    outerSubDomain String
    Public network access subdomain name.
    preLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    protocol String
    Service frontend request type. Valid values: http, https, http&https.
    releaseLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    serviceDesc String
    Custom service description.
    serviceName String
    Custom service name.
    tags Map<String>
    Tag description list.
    testLimit Number
    API QPS value. Enter a positive number to limit the API query rate per second QPS.
    uniqVpcId String
    VPC ID.
    usagePlanLists List<Property Map>
    A list of attach usage plans.

    Supporting Types

    ApiGatewayServiceApiList, ApiGatewayServiceApiListArgs

    ApiDesc string
    Description of the API.
    ApiId string
    ID of the API.
    ApiName string
    Name of the API.
    Method string
    Method of the API.
    Path string
    Path of the API.
    ApiDesc string
    Description of the API.
    ApiId string
    ID of the API.
    ApiName string
    Name of the API.
    Method string
    Method of the API.
    Path string
    Path of the API.
    apiDesc String
    Description of the API.
    apiId String
    ID of the API.
    apiName String
    Name of the API.
    method String
    Method of the API.
    path String
    Path of the API.
    apiDesc string
    Description of the API.
    apiId string
    ID of the API.
    apiName string
    Name of the API.
    method string
    Method of the API.
    path string
    Path of the API.
    api_desc str
    Description of the API.
    api_id str
    ID of the API.
    api_name str
    Name of the API.
    method str
    Method of the API.
    path str
    Path of the API.
    apiDesc String
    Description of the API.
    apiId String
    ID of the API.
    apiName String
    Name of the API.
    method String
    Method of the API.
    path String
    Path of the API.

    ApiGatewayServiceUsagePlanList, ApiGatewayServiceUsagePlanListArgs

    ApiId string
    ID of the API.
    BindType string
    Binding type.
    UsagePlanId string
    ID of the usage plan.
    UsagePlanName string
    Name of the usage plan.
    ApiId string
    ID of the API.
    BindType string
    Binding type.
    UsagePlanId string
    ID of the usage plan.
    UsagePlanName string
    Name of the usage plan.
    apiId String
    ID of the API.
    bindType String
    Binding type.
    usagePlanId String
    ID of the usage plan.
    usagePlanName String
    Name of the usage plan.
    apiId string
    ID of the API.
    bindType string
    Binding type.
    usagePlanId string
    ID of the usage plan.
    usagePlanName string
    Name of the usage plan.
    api_id str
    ID of the API.
    bind_type str
    Binding type.
    usage_plan_id str
    ID of the usage plan.
    usage_plan_name str
    Name of the usage plan.
    apiId String
    ID of the API.
    bindType String
    Binding type.
    usagePlanId String
    ID of the usage plan.
    usagePlanName String
    Name of the usage plan.

    Import

    API gateway service can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/apiGatewayService:ApiGatewayService service service-pg6ud8pa

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud