1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. apig
  5. Gateway
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.apig.Gateway

bytepluscc logo
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    API网关(Gateway)是API管理服务的核心组件，负责接收、处理、转发API请求，并提供安全认证、流量控制等功能。

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  aPIGGatewayDemo:
    type: bytepluscc:apig:Gateway
    name: APIGGatewayDemo
    properties:
      name: APIGGatewayDemo
      type: standard
      comments: APIGGatewayDemo comments
      vpcId: vpc-13f8k4dwdsydc3n6nu5rxxxxx
      subnetIds:
        - subnet-***
        - subnet-***
      resourceSpec:
        instance_spec_code: 1c2g
        replicas: 2
        clb_spec_code: small_1
        public_network_bandwidth: 1
        public_network_billing_type: bandwidth
        network_type:
          enablePublicNetwork: true
          enablePrivateNetwork: true
      monitorSpec:
        enable: true
        workspace_id: '***'
      logSpec:
        enable: true
        project_id: '***'
        topic_id: '***'
      traceSpec:
        enable: true
        trace_type: tls
        tls_trace_spec:
          projectId: '***'
          iamUserAk: '***'
          iamUserSk: '***'

    Create Gateway Resource

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

    Constructor syntax

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

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            comments: Optional[str] = None,
            custom_log: Optional[GatewayCustomLogArgs] = None,
            log_spec: Optional[GatewayLogSpecArgs] = None,
            monitor_spec: Optional[GatewayMonitorSpecArgs] = None,
            project_name: Optional[str] = None,
            resource_spec: Optional[GatewayResourceSpecArgs] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            trace_spec: Optional[GatewayTraceSpecArgs] = None,
            type: Optional[str] = None,
            vpc_id: Optional[str] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

    type: bytepluscc:apig:Gateway
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 GatewayArgs
    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 GatewayArgs
    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 GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    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 gatewayResource = new Bytepluscc.Apig.Gateway("gatewayResource", new()
{
    Name = "string",
    Comments = "string",
    CustomLog = new Bytepluscc.Apig.Inputs.GatewayCustomLogArgs
    {
        CustomVariables = new[]
        {
            new Bytepluscc.Apig.Inputs.GatewayCustomLogCustomVariableArgs
            {
                AliasesInLog = "string",
                Key = "string",
            },
        },
        RequestHeaders = new[]
        {
            new Bytepluscc.Apig.Inputs.GatewayCustomLogRequestHeaderArgs
            {
                AliasesInLog = "string",
                Key = "string",
            },
        },
        ResponseHeaders = new[]
        {
            new Bytepluscc.Apig.Inputs.GatewayCustomLogResponseHeaderArgs
            {
                AliasesInLog = "string",
                Key = "string",
            },
        },
    },
    LogSpec = new Bytepluscc.Apig.Inputs.GatewayLogSpecArgs
    {
        Enable = false,
        ProjectId = "string",
        TopicId = "string",
    },
    MonitorSpec = new Bytepluscc.Apig.Inputs.GatewayMonitorSpecArgs
    {
        Enable = false,
        WorkspaceId = "string",
    },
    ProjectName = "string",
    ResourceSpec = new Bytepluscc.Apig.Inputs.GatewayResourceSpecArgs
    {
        ClbSpecCode = "string",
        InstanceSpecCode = "string",
        NetworkType = new Bytepluscc.Apig.Inputs.GatewayResourceSpecNetworkTypeArgs
        {
            EnablePrivateNetwork = false,
            EnablePublicNetwork = false,
        },
        PublicNetworkBandwidth = 0,
        PublicNetworkBillingType = "string",
        Replicas = 0,
    },
    SubnetIds = new[]
    {
        "string",
    },
    TraceSpec = new Bytepluscc.Apig.Inputs.GatewayTraceSpecArgs
    {
        ApmTraceSpec = new Bytepluscc.Apig.Inputs.GatewayTraceSpecApmTraceSpecArgs
        {
            ApiKey = "string",
        },
        Enable = false,
        TlsTraceSpec = new Bytepluscc.Apig.Inputs.GatewayTraceSpecTlsTraceSpecArgs
        {
            IamUserAk = "string",
            IamUserSk = "string",
            ProjectId = "string",
            TraceId = "string",
        },
        TraceType = "string",
    },
    Type = "string",
    VpcId = "string",
});

    example, err := apig.NewGateway(ctx, "gatewayResource", &apig.GatewayArgs{
	Name:     pulumi.String("string"),
	Comments: pulumi.String("string"),
	CustomLog: &apig.GatewayCustomLogArgs{
		CustomVariables: apig.GatewayCustomLogCustomVariableArray{
			&apig.GatewayCustomLogCustomVariableArgs{
				AliasesInLog: pulumi.String("string"),
				Key:          pulumi.String("string"),
			},
		},
		RequestHeaders: apig.GatewayCustomLogRequestHeaderArray{
			&apig.GatewayCustomLogRequestHeaderArgs{
				AliasesInLog: pulumi.String("string"),
				Key:          pulumi.String("string"),
			},
		},
		ResponseHeaders: apig.GatewayCustomLogResponseHeaderArray{
			&apig.GatewayCustomLogResponseHeaderArgs{
				AliasesInLog: pulumi.String("string"),
				Key:          pulumi.String("string"),
			},
		},
	},
	LogSpec: &apig.GatewayLogSpecArgs{
		Enable:    pulumi.Bool(false),
		ProjectId: pulumi.String("string"),
		TopicId:   pulumi.String("string"),
	},
	MonitorSpec: &apig.GatewayMonitorSpecArgs{
		Enable:      pulumi.Bool(false),
		WorkspaceId: pulumi.String("string"),
	},
	ProjectName: pulumi.String("string"),
	ResourceSpec: &apig.GatewayResourceSpecArgs{
		ClbSpecCode:      pulumi.String("string"),
		InstanceSpecCode: pulumi.String("string"),
		NetworkType: &apig.GatewayResourceSpecNetworkTypeArgs{
			EnablePrivateNetwork: pulumi.Bool(false),
			EnablePublicNetwork:  pulumi.Bool(false),
		},
		PublicNetworkBandwidth:   pulumi.Int(0),
		PublicNetworkBillingType: pulumi.String("string"),
		Replicas:                 pulumi.Int(0),
	},
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	TraceSpec: &apig.GatewayTraceSpecArgs{
		ApmTraceSpec: &apig.GatewayTraceSpecApmTraceSpecArgs{
			ApiKey: pulumi.String("string"),
		},
		Enable: pulumi.Bool(false),
		TlsTraceSpec: &apig.GatewayTraceSpecTlsTraceSpecArgs{
			IamUserAk: pulumi.String("string"),
			IamUserSk: pulumi.String("string"),
			ProjectId: pulumi.String("string"),
			TraceId:   pulumi.String("string"),
		},
		TraceType: pulumi.String("string"),
	},
	Type:  pulumi.String("string"),
	VpcId: pulumi.String("string"),
})

    var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .name("string")
    .comments("string")
    .customLog(GatewayCustomLogArgs.builder()
        .customVariables(GatewayCustomLogCustomVariableArgs.builder()
            .aliasesInLog("string")
            .key("string")
            .build())
        .requestHeaders(GatewayCustomLogRequestHeaderArgs.builder()
            .aliasesInLog("string")
            .key("string")
            .build())
        .responseHeaders(GatewayCustomLogResponseHeaderArgs.builder()
            .aliasesInLog("string")
            .key("string")
            .build())
        .build())
    .logSpec(GatewayLogSpecArgs.builder()
        .enable(false)
        .projectId("string")
        .topicId("string")
        .build())
    .monitorSpec(GatewayMonitorSpecArgs.builder()
        .enable(false)
        .workspaceId("string")
        .build())
    .projectName("string")
    .resourceSpec(GatewayResourceSpecArgs.builder()
        .clbSpecCode("string")
        .instanceSpecCode("string")
        .networkType(GatewayResourceSpecNetworkTypeArgs.builder()
            .enablePrivateNetwork(false)
            .enablePublicNetwork(false)
            .build())
        .publicNetworkBandwidth(0)
        .publicNetworkBillingType("string")
        .replicas(0)
        .build())
    .subnetIds("string")
    .traceSpec(GatewayTraceSpecArgs.builder()
        .apmTraceSpec(GatewayTraceSpecApmTraceSpecArgs.builder()
            .apiKey("string")
            .build())
        .enable(false)
        .tlsTraceSpec(GatewayTraceSpecTlsTraceSpecArgs.builder()
            .iamUserAk("string")
            .iamUserSk("string")
            .projectId("string")
            .traceId("string")
            .build())
        .traceType("string")
        .build())
    .type("string")
    .vpcId("string")
    .build());

    gateway_resource = bytepluscc.apig.Gateway("gatewayResource",
    name="string",
    comments="string",
    custom_log={
        "custom_variables": [{
            "aliases_in_log": "string",
            "key": "string",
        }],
        "request_headers": [{
            "aliases_in_log": "string",
            "key": "string",
        }],
        "response_headers": [{
            "aliases_in_log": "string",
            "key": "string",
        }],
    },
    log_spec={
        "enable": False,
        "project_id": "string",
        "topic_id": "string",
    },
    monitor_spec={
        "enable": False,
        "workspace_id": "string",
    },
    project_name="string",
    resource_spec={
        "clb_spec_code": "string",
        "instance_spec_code": "string",
        "network_type": {
            "enable_private_network": False,
            "enable_public_network": False,
        },
        "public_network_bandwidth": 0,
        "public_network_billing_type": "string",
        "replicas": 0,
    },
    subnet_ids=["string"],
    trace_spec={
        "apm_trace_spec": {
            "api_key": "string",
        },
        "enable": False,
        "tls_trace_spec": {
            "iam_user_ak": "string",
            "iam_user_sk": "string",
            "project_id": "string",
            "trace_id": "string",
        },
        "trace_type": "string",
    },
    type="string",
    vpc_id="string")

    const gatewayResource = new bytepluscc.apig.Gateway("gatewayResource", {
    name: "string",
    comments: "string",
    customLog: {
        customVariables: [{
            aliasesInLog: "string",
            key: "string",
        }],
        requestHeaders: [{
            aliasesInLog: "string",
            key: "string",
        }],
        responseHeaders: [{
            aliasesInLog: "string",
            key: "string",
        }],
    },
    logSpec: {
        enable: false,
        projectId: "string",
        topicId: "string",
    },
    monitorSpec: {
        enable: false,
        workspaceId: "string",
    },
    projectName: "string",
    resourceSpec: {
        clbSpecCode: "string",
        instanceSpecCode: "string",
        networkType: {
            enablePrivateNetwork: false,
            enablePublicNetwork: false,
        },
        publicNetworkBandwidth: 0,
        publicNetworkBillingType: "string",
        replicas: 0,
    },
    subnetIds: ["string"],
    traceSpec: {
        apmTraceSpec: {
            apiKey: "string",
        },
        enable: false,
        tlsTraceSpec: {
            iamUserAk: "string",
            iamUserSk: "string",
            projectId: "string",
            traceId: "string",
        },
        traceType: "string",
    },
    type: "string",
    vpcId: "string",
});

    type: bytepluscc:apig:Gateway
properties:
    comments: string
    customLog:
        customVariables:
            - aliasesInLog: string
              key: string
        requestHeaders:
            - aliasesInLog: string
              key: string
        responseHeaders:
            - aliasesInLog: string
              key: string
    logSpec:
        enable: false
        projectId: string
        topicId: string
    monitorSpec:
        enable: false
        workspaceId: string
    name: string
    projectName: string
    resourceSpec:
        clbSpecCode: string
        instanceSpecCode: string
        networkType:
            enablePrivateNetwork: false
            enablePublicNetwork: false
        publicNetworkBandwidth: 0
        publicNetworkBillingType: string
        replicas: 0
    subnetIds:
        - string
    traceSpec:
        apmTraceSpec:
            apiKey: string
        enable: false
        tlsTraceSpec:
            iamUserAk: string
            iamUserSk: string
            projectId: string
            traceId: string
        traceType: string
    type: string
    vpcId: string

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

    Name string
    网关名称。
    Comments string
    网关备注信息。长度限制为0~253个字符。
    CustomLog Byteplus.GatewayCustomLog
    自定义日志配置。
    LogSpec Byteplus.GatewayLogSpec
    日志配置。
    MonitorSpec Byteplus.GatewayMonitorSpec
    监控配置信息。
    ProjectName string
    项目名称。
    ResourceSpec Byteplus.GatewayResourceSpec
    资源规格配置信息。
    SubnetIds List<string>
    子网ID列表。长度限制为1~2个。
    TraceSpec Byteplus.GatewayTraceSpec
    链路追踪配置信息。
    Type string
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    VpcId string
    VPC ID。
    Name string
    网关名称。
    Comments string
    网关备注信息。长度限制为0~253个字符。
    CustomLog GatewayCustomLogArgs
    自定义日志配置。
    LogSpec GatewayLogSpecArgs
    日志配置。
    MonitorSpec GatewayMonitorSpecArgs
    监控配置信息。
    ProjectName string
    项目名称。
    ResourceSpec GatewayResourceSpecArgs
    资源规格配置信息。
    SubnetIds []string
    子网ID列表。长度限制为1~2个。
    TraceSpec GatewayTraceSpecArgs
    链路追踪配置信息。
    Type string
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    VpcId string
    VPC ID。
    name String
    网关名称。
    comments String
    网关备注信息。长度限制为0~253个字符。
    customLog GatewayCustomLog
    自定义日志配置。
    logSpec GatewayLogSpec
    日志配置。
    monitorSpec GatewayMonitorSpec
    监控配置信息。
    projectName String
    项目名称。
    resourceSpec GatewayResourceSpec
    资源规格配置信息。
    subnetIds List<String>
    子网ID列表。长度限制为1~2个。
    traceSpec GatewayTraceSpec
    链路追踪配置信息。
    type String
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    vpcId String
    VPC ID。
    name string
    网关名称。
    comments string
    网关备注信息。长度限制为0~253个字符。
    customLog GatewayCustomLog
    自定义日志配置。
    logSpec GatewayLogSpec
    日志配置。
    monitorSpec GatewayMonitorSpec
    监控配置信息。
    projectName string
    项目名称。
    resourceSpec GatewayResourceSpec
    资源规格配置信息。
    subnetIds string[]
    子网ID列表。长度限制为1~2个。
    traceSpec GatewayTraceSpec
    链路追踪配置信息。
    type string
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    vpcId string
    VPC ID。
    name str
    网关名称。
    comments str
    网关备注信息。长度限制为0~253个字符。
    custom_log GatewayCustomLogArgs
    自定义日志配置。
    log_spec GatewayLogSpecArgs
    日志配置。
    monitor_spec GatewayMonitorSpecArgs
    监控配置信息。
    project_name str
    项目名称。
    resource_spec GatewayResourceSpecArgs
    资源规格配置信息。
    subnet_ids Sequence[str]
    子网ID列表。长度限制为1~2个。
    trace_spec GatewayTraceSpecArgs
    链路追踪配置信息。
    type str
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    vpc_id str
    VPC ID。
    name String
    网关名称。
    comments String
    网关备注信息。长度限制为0~253个字符。
    customLog Property Map
    自定义日志配置。
    logSpec Property Map
    日志配置。
    monitorSpec Property Map
    监控配置信息。
    projectName String
    项目名称。
    resourceSpec Property Map
    资源规格配置信息。
    subnetIds List<String>
    子网ID列表。长度限制为1~2个。
    traceSpec Property Map
    链路追踪配置信息。
    type String
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    vpcId String
    VPC ID。

    Outputs

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

    BackendSpec Byteplus.GatewayBackendSpec
    后端服务配置信息。
    CreatedTime string
    网关创建时间。
    Events List<Byteplus.GatewayEvent>
    GatewayId string
    网关实例ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    网关创建失败、删除失败或异常时的错误信息。
    NetworkSpec Byteplus.GatewayNetworkSpec
    网络配置信息。
    Status string
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    Version string
    网关版本。
    BackendSpec GatewayBackendSpec
    后端服务配置信息。
    CreatedTime string
    网关创建时间。
    Events []GatewayEvent
    GatewayId string
    网关实例ID。
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    网关创建失败、删除失败或异常时的错误信息。
    NetworkSpec GatewayNetworkSpec
    网络配置信息。
    Status string
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    Version string
    网关版本。
    backendSpec GatewayBackendSpec
    后端服务配置信息。
    createdTime String
    网关创建时间。
    events List<GatewayEvent>
    gatewayId String
    网关实例ID。
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    网关创建失败、删除失败或异常时的错误信息。
    networkSpec GatewayNetworkSpec
    网络配置信息。
    status String
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    version String
    网关版本。
    backendSpec GatewayBackendSpec
    后端服务配置信息。
    createdTime string
    网关创建时间。
    events GatewayEvent[]
    gatewayId string
    网关实例ID。
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    网关创建失败、删除失败或异常时的错误信息。
    networkSpec GatewayNetworkSpec
    网络配置信息。
    status string
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    version string
    网关版本。
    backend_spec GatewayBackendSpec
    后端服务配置信息。
    created_time str
    网关创建时间。
    events Sequence[GatewayEvent]
    gateway_id str
    网关实例ID。
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    网关创建失败、删除失败或异常时的错误信息。
    network_spec GatewayNetworkSpec
    网络配置信息。
    status str
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    version str
    网关版本。
    backendSpec Property Map
    后端服务配置信息。
    createdTime String
    网关创建时间。
    events List<Property Map>
    gatewayId String
    网关实例ID。
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    网关创建失败、删除失败或异常时的错误信息。
    networkSpec Property Map
    网络配置信息。
    status String
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    version String
    网关版本。

    Look up Existing Gateway Resource

    Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backend_spec: Optional[GatewayBackendSpecArgs] = None,
        comments: Optional[str] = None,
        created_time: Optional[str] = None,
        custom_log: Optional[GatewayCustomLogArgs] = None,
        events: Optional[Sequence[GatewayEventArgs]] = None,
        gateway_id: Optional[str] = None,
        log_spec: Optional[GatewayLogSpecArgs] = None,
        message: Optional[str] = None,
        monitor_spec: Optional[GatewayMonitorSpecArgs] = None,
        name: Optional[str] = None,
        network_spec: Optional[GatewayNetworkSpecArgs] = None,
        project_name: Optional[str] = None,
        resource_spec: Optional[GatewayResourceSpecArgs] = None,
        status: Optional[str] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        trace_spec: Optional[GatewayTraceSpecArgs] = None,
        type: Optional[str] = None,
        version: Optional[str] = None,
        vpc_id: Optional[str] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:apig:Gateway    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:
    BackendSpec Byteplus.GatewayBackendSpec
    后端服务配置信息。
    Comments string
    网关备注信息。长度限制为0~253个字符。
    CreatedTime string
    网关创建时间。
    CustomLog Byteplus.GatewayCustomLog
    自定义日志配置。
    Events List<Byteplus.GatewayEvent>
    GatewayId string
    网关实例ID。
    LogSpec Byteplus.GatewayLogSpec
    日志配置。
    Message string
    网关创建失败、删除失败或异常时的错误信息。
    MonitorSpec Byteplus.GatewayMonitorSpec
    监控配置信息。
    Name string
    网关名称。
    NetworkSpec Byteplus.GatewayNetworkSpec
    网络配置信息。
    ProjectName string
    项目名称。
    ResourceSpec Byteplus.GatewayResourceSpec
    资源规格配置信息。
    Status string
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    SubnetIds List<string>
    子网ID列表。长度限制为1~2个。
    TraceSpec Byteplus.GatewayTraceSpec
    链路追踪配置信息。
    Type string
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    Version string
    网关版本。
    VpcId string
    VPC ID。
    BackendSpec GatewayBackendSpecArgs
    后端服务配置信息。
    Comments string
    网关备注信息。长度限制为0~253个字符。
    CreatedTime string
    网关创建时间。
    CustomLog GatewayCustomLogArgs
    自定义日志配置。
    Events []GatewayEventArgs
    GatewayId string
    网关实例ID。
    LogSpec GatewayLogSpecArgs
    日志配置。
    Message string
    网关创建失败、删除失败或异常时的错误信息。
    MonitorSpec GatewayMonitorSpecArgs
    监控配置信息。
    Name string
    网关名称。
    NetworkSpec GatewayNetworkSpecArgs
    网络配置信息。
    ProjectName string
    项目名称。
    ResourceSpec GatewayResourceSpecArgs
    资源规格配置信息。
    Status string
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    SubnetIds []string
    子网ID列表。长度限制为1~2个。
    TraceSpec GatewayTraceSpecArgs
    链路追踪配置信息。
    Type string
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    Version string
    网关版本。
    VpcId string
    VPC ID。
    backendSpec GatewayBackendSpec
    后端服务配置信息。
    comments String
    网关备注信息。长度限制为0~253个字符。
    createdTime String
    网关创建时间。
    customLog GatewayCustomLog
    自定义日志配置。
    events List<GatewayEvent>
    gatewayId String
    网关实例ID。
    logSpec GatewayLogSpec
    日志配置。
    message String
    网关创建失败、删除失败或异常时的错误信息。
    monitorSpec GatewayMonitorSpec
    监控配置信息。
    name String
    网关名称。
    networkSpec GatewayNetworkSpec
    网络配置信息。
    projectName String
    项目名称。
    resourceSpec GatewayResourceSpec
    资源规格配置信息。
    status String
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    subnetIds List<String>
    子网ID列表。长度限制为1~2个。
    traceSpec GatewayTraceSpec
    链路追踪配置信息。
    type String
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    version String
    网关版本。
    vpcId String
    VPC ID。
    backendSpec GatewayBackendSpec
    后端服务配置信息。
    comments string
    网关备注信息。长度限制为0~253个字符。
    createdTime string
    网关创建时间。
    customLog GatewayCustomLog
    自定义日志配置。
    events GatewayEvent[]
    gatewayId string
    网关实例ID。
    logSpec GatewayLogSpec
    日志配置。
    message string
    网关创建失败、删除失败或异常时的错误信息。
    monitorSpec GatewayMonitorSpec
    监控配置信息。
    name string
    网关名称。
    networkSpec GatewayNetworkSpec
    网络配置信息。
    projectName string
    项目名称。
    resourceSpec GatewayResourceSpec
    资源规格配置信息。
    status string
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    subnetIds string[]
    子网ID列表。长度限制为1~2个。
    traceSpec GatewayTraceSpec
    链路追踪配置信息。
    type string
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    version string
    网关版本。
    vpcId string
    VPC ID。
    backend_spec GatewayBackendSpecArgs
    后端服务配置信息。
    comments str
    网关备注信息。长度限制为0~253个字符。
    created_time str
    网关创建时间。
    custom_log GatewayCustomLogArgs
    自定义日志配置。
    events Sequence[GatewayEventArgs]
    gateway_id str
    网关实例ID。
    log_spec GatewayLogSpecArgs
    日志配置。
    message str
    网关创建失败、删除失败或异常时的错误信息。
    monitor_spec GatewayMonitorSpecArgs
    监控配置信息。
    name str
    网关名称。
    network_spec GatewayNetworkSpecArgs
    网络配置信息。
    project_name str
    项目名称。
    resource_spec GatewayResourceSpecArgs
    资源规格配置信息。
    status str
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    subnet_ids Sequence[str]
    子网ID列表。长度限制为1~2个。
    trace_spec GatewayTraceSpecArgs
    链路追踪配置信息。
    type str
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    version str
    网关版本。
    vpc_id str
    VPC ID。
    backendSpec Property Map
    后端服务配置信息。
    comments String
    网关备注信息。长度限制为0~253个字符。
    createdTime String
    网关创建时间。
    customLog Property Map
    自定义日志配置。
    events List<Property Map>
    gatewayId String
    网关实例ID。
    logSpec Property Map
    日志配置。
    message String
    网关创建失败、删除失败或异常时的错误信息。
    monitorSpec Property Map
    监控配置信息。
    name String
    网关名称。
    networkSpec Property Map
    网络配置信息。
    projectName String
    项目名称。
    resourceSpec Property Map
    资源规格配置信息。
    status String
    网关状态，取值：Creating：创建中。CreatedFailed：创建失败。Updating：更新中。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。
    subnetIds List<String>
    子网ID列表。长度限制为1~2个。
    traceSpec Property Map
    链路追踪配置信息。
    type String
    网关类型，取值：standard：标准网关。serverless：Serverless网关（暂不支持）。
    version String
    网关版本。
    vpcId String
    VPC ID。

    Supporting Types

    GatewayBackendSpec, GatewayBackendSpecArgs

    IsVkeWithFlannelCniSupported bool
    是否支持VKE Flannel CNI。
    VkePodCidr string
    VKE Pod CIDR。
    IsVkeWithFlannelCniSupported bool
    是否支持VKE Flannel CNI。
    VkePodCidr string
    VKE Pod CIDR。
    isVkeWithFlannelCniSupported Boolean
    是否支持VKE Flannel CNI。
    vkePodCidr String
    VKE Pod CIDR。
    isVkeWithFlannelCniSupported boolean
    是否支持VKE Flannel CNI。
    vkePodCidr string
    VKE Pod CIDR。
    is_vke_with_flannel_cni_supported bool
    是否支持VKE Flannel CNI。
    vke_pod_cidr str
    VKE Pod CIDR。
    isVkeWithFlannelCniSupported Boolean
    是否支持VKE Flannel CNI。
    vkePodCidr String
    VKE Pod CIDR。

    GatewayCustomLog, GatewayCustomLogArgs

    GatewayCustomLogCustomVariable, GatewayCustomLogCustomVariableArgs

    AliasesInLog string
    字段别名。
    Key string
    请求头键。
    AliasesInLog string
    字段别名。
    Key string
    请求头键。
    aliasesInLog String
    字段别名。
    key String
    请求头键。
    aliasesInLog string
    字段别名。
    key string
    请求头键。
    aliases_in_log str
    字段别名。
    key str
    请求头键。
    aliasesInLog String
    字段别名。
    key String
    请求头键。

    GatewayCustomLogRequestHeader, GatewayCustomLogRequestHeaderArgs

    AliasesInLog string
    字段别名。
    Key string
    请求头键。
    AliasesInLog string
    字段别名。
    Key string
    请求头键。
    aliasesInLog String
    字段别名。
    key String
    请求头键。
    aliasesInLog string
    字段别名。
    key string
    请求头键。
    aliases_in_log str
    字段别名。
    key str
    请求头键。
    aliasesInLog String
    字段别名。
    key String
    请求头键。

    GatewayCustomLogResponseHeader, GatewayCustomLogResponseHeaderArgs

    AliasesInLog string
    字段别名。
    Key string
    请求头键。
    AliasesInLog string
    字段别名。
    Key string
    请求头键。
    aliasesInLog String
    字段别名。
    key String
    请求头键。
    aliasesInLog string
    字段别名。
    key string
    请求头键。
    aliases_in_log str
    字段别名。
    key str
    请求头键。
    aliasesInLog String
    字段别名。
    key String
    请求头键。

    GatewayEvent, GatewayEventArgs

    Code string
    事件代码。
    CreatedTime string
    事件创建时间。
    Data string
    附带信息。
    Description string
    事件描述。
    Code string
    事件代码。
    CreatedTime string
    事件创建时间。
    Data string
    附带信息。
    Description string
    事件描述。
    code String
    事件代码。
    createdTime String
    事件创建时间。
    data String
    附带信息。
    description String
    事件描述。
    code string
    事件代码。
    createdTime string
    事件创建时间。
    data string
    附带信息。
    description string
    事件描述。
    code str
    事件代码。
    created_time str
    事件创建时间。
    data str
    附带信息。
    description str
    事件描述。
    code String
    事件代码。
    createdTime String
    事件创建时间。
    data String
    附带信息。
    description String
    事件描述。

    GatewayLogSpec, GatewayLogSpecArgs

    Enable bool
    是否开启日志服务。
    ProjectId string
    日志项目ID。
    TopicId string
    日志主题ID。ProjectId 指定项目里面的日志主题。
    Enable bool
    是否开启日志服务。
    ProjectId string
    日志项目ID。
    TopicId string
    日志主题ID。ProjectId 指定项目里面的日志主题。
    enable Boolean
    是否开启日志服务。
    projectId String
    日志项目ID。
    topicId String
    日志主题ID。ProjectId 指定项目里面的日志主题。
    enable boolean
    是否开启日志服务。
    projectId string
    日志项目ID。
    topicId string
    日志主题ID。ProjectId 指定项目里面的日志主题。
    enable bool
    是否开启日志服务。
    project_id str
    日志项目ID。
    topic_id str
    日志主题ID。ProjectId 指定项目里面的日志主题。
    enable Boolean
    是否开启日志服务。
    projectId String
    日志项目ID。
    topicId String
    日志主题ID。ProjectId 指定项目里面的日志主题。

    GatewayMonitorSpec, GatewayMonitorSpecArgs

    Enable bool
    托管Prometheus（VMP）服务。
    WorkspaceId string
    Prometheus工作区ID。
    Enable bool
    托管Prometheus（VMP）服务。
    WorkspaceId string
    Prometheus工作区ID。
    enable Boolean
    托管Prometheus（VMP）服务。
    workspaceId String
    Prometheus工作区ID。
    enable boolean
    托管Prometheus（VMP）服务。
    workspaceId string
    Prometheus工作区ID。
    enable bool
    托管Prometheus（VMP）服务。
    workspace_id str
    Prometheus工作区ID。
    enable Boolean
    托管Prometheus（VMP）服务。
    workspaceId String
    Prometheus工作区ID。

    GatewayNetworkSpec, GatewayNetworkSpecArgs

    Subnets []GatewayNetworkSpecSubnet
    VpcId string
    VPC ID。
    VpcName string
    VPC名称。
    subnets List<GatewayNetworkSpecSubnet>
    vpcId String
    VPC ID。
    vpcName String
    VPC名称。
    subnets GatewayNetworkSpecSubnet[]
    vpcId string
    VPC ID。
    vpcName string
    VPC名称。
    subnets List<Property Map>
    vpcId String
    VPC ID。
    vpcName String
    VPC名称。

    GatewayNetworkSpecSubnet, GatewayNetworkSpecSubnetArgs

    Az string
    可用区。
    SubnetId string
    子网ID。
    SubnetName string
    子网名称。
    Az string
    可用区。
    SubnetId string
    子网ID。
    SubnetName string
    子网名称。
    az String
    可用区。
    subnetId String
    子网ID。
    subnetName String
    子网名称。
    az string
    可用区。
    subnetId string
    子网ID。
    subnetName string
    子网名称。
    az str
    可用区。
    subnet_id str
    子网ID。
    subnet_name str
    子网名称。
    az String
    可用区。
    subnetId String
    子网ID。
    subnetName String
    子网名称。

    GatewayResourceSpec, GatewayResourceSpecArgs

    ClbSpecCode string
    CLB规格编码。CLB规格，取值：small1：小型 I。small2：小型 II。medium1：中型 I。medium2：中型 II。large1：大型 I。large2：大型 II。
    InstanceSpecCode string
    节点规格，取值：1c2g。2c4g。4c8g。8c16g。
    NetworkType Byteplus.GatewayResourceSpecNetworkType
    网络类型。默认值为开启公网，开启私网。
    PublicNetworkBandwidth int
    公网带宽上限，该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
    PublicNetworkBillingType string
    公网网络计费方式，取值：traffic：按实际流量计费。bandwidth：按带宽上限计费。
    Replicas int
    节点数量。取值限制为2~100。
    ClbSpecCode string
    CLB规格编码。CLB规格，取值：small1：小型 I。small2：小型 II。medium1：中型 I。medium2：中型 II。large1：大型 I。large2：大型 II。
    InstanceSpecCode string
    节点规格，取值：1c2g。2c4g。4c8g。8c16g。
    NetworkType GatewayResourceSpecNetworkType
    网络类型。默认值为开启公网，开启私网。
    PublicNetworkBandwidth int
    公网带宽上限，该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
    PublicNetworkBillingType string
    公网网络计费方式，取值：traffic：按实际流量计费。bandwidth：按带宽上限计费。
    Replicas int
    节点数量。取值限制为2~100。
    clbSpecCode String
    CLB规格编码。CLB规格，取值：small1：小型 I。small2：小型 II。medium1：中型 I。medium2：中型 II。large1：大型 I。large2：大型 II。
    instanceSpecCode String
    节点规格，取值：1c2g。2c4g。4c8g。8c16g。
    networkType GatewayResourceSpecNetworkType
    网络类型。默认值为开启公网，开启私网。
    publicNetworkBandwidth Integer
    公网带宽上限，该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
    publicNetworkBillingType String
    公网网络计费方式，取值：traffic：按实际流量计费。bandwidth：按带宽上限计费。
    replicas Integer
    节点数量。取值限制为2~100。
    clbSpecCode string
    CLB规格编码。CLB规格，取值：small1：小型 I。small2：小型 II。medium1：中型 I。medium2：中型 II。large1：大型 I。large2：大型 II。
    instanceSpecCode string
    节点规格，取值：1c2g。2c4g。4c8g。8c16g。
    networkType GatewayResourceSpecNetworkType
    网络类型。默认值为开启公网，开启私网。
    publicNetworkBandwidth number
    公网带宽上限，该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
    publicNetworkBillingType string
    公网网络计费方式，取值：traffic：按实际流量计费。bandwidth：按带宽上限计费。
    replicas number
    节点数量。取值限制为2~100。
    clb_spec_code str
    CLB规格编码。CLB规格，取值：small1：小型 I。small2：小型 II。medium1：中型 I。medium2：中型 II。large1：大型 I。large2：大型 II。
    instance_spec_code str
    节点规格，取值：1c2g。2c4g。4c8g。8c16g。
    network_type GatewayResourceSpecNetworkType
    网络类型。默认值为开启公网，开启私网。
    public_network_bandwidth int
    公网带宽上限，该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
    public_network_billing_type str
    公网网络计费方式，取值：traffic：按实际流量计费。bandwidth：按带宽上限计费。
    replicas int
    节点数量。取值限制为2~100。
    clbSpecCode String
    CLB规格编码。CLB规格，取值：small1：小型 I。small2：小型 II。medium1：中型 I。medium2：中型 II。large1：大型 I。large2：大型 II。
    instanceSpecCode String
    节点规格，取值：1c2g。2c4g。4c8g。8c16g。
    networkType Property Map
    网络类型。默认值为开启公网，开启私网。
    publicNetworkBandwidth Number
    公网带宽上限，该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
    publicNetworkBillingType String
    公网网络计费方式，取值：traffic：按实际流量计费。bandwidth：按带宽上限计费。
    replicas Number
    节点数量。取值限制为2~100。

    GatewayResourceSpecNetworkType, GatewayResourceSpecNetworkTypeArgs

    EnablePrivateNetwork bool
    是否启用私网。
    EnablePublicNetwork bool
    是否启用公网。
    EnablePrivateNetwork bool
    是否启用私网。
    EnablePublicNetwork bool
    是否启用公网。
    enablePrivateNetwork Boolean
    是否启用私网。
    enablePublicNetwork Boolean
    是否启用公网。
    enablePrivateNetwork boolean
    是否启用私网。
    enablePublicNetwork boolean
    是否启用公网。
    enable_private_network bool
    是否启用私网。
    enable_public_network bool
    是否启用公网。
    enablePrivateNetwork Boolean
    是否启用私网。
    enablePublicNetwork Boolean
    是否启用公网。

    GatewayTraceSpec, GatewayTraceSpecArgs

    ApmTraceSpec Byteplus.GatewayTraceSpecApmTraceSpec
    应用性能监控全链路版链路追踪配置。
    Enable bool
    是否启用链路追踪。
    TlsTraceSpec Byteplus.GatewayTraceSpecTlsTraceSpec
    链路追踪配置信息。
    TraceType string
    链路追踪类型，取值：tls：日志服务。apm：应用性能监控全链路版。
    ApmTraceSpec GatewayTraceSpecApmTraceSpec
    应用性能监控全链路版链路追踪配置。
    Enable bool
    是否启用链路追踪。
    TlsTraceSpec GatewayTraceSpecTlsTraceSpec
    链路追踪配置信息。
    TraceType string
    链路追踪类型，取值：tls：日志服务。apm：应用性能监控全链路版。
    apmTraceSpec GatewayTraceSpecApmTraceSpec
    应用性能监控全链路版链路追踪配置。
    enable Boolean
    是否启用链路追踪。
    tlsTraceSpec GatewayTraceSpecTlsTraceSpec
    链路追踪配置信息。
    traceType String
    链路追踪类型，取值：tls：日志服务。apm：应用性能监控全链路版。
    apmTraceSpec GatewayTraceSpecApmTraceSpec
    应用性能监控全链路版链路追踪配置。
    enable boolean
    是否启用链路追踪。
    tlsTraceSpec GatewayTraceSpecTlsTraceSpec
    链路追踪配置信息。
    traceType string
    链路追踪类型，取值：tls：日志服务。apm：应用性能监控全链路版。
    apm_trace_spec GatewayTraceSpecApmTraceSpec
    应用性能监控全链路版链路追踪配置。
    enable bool
    是否启用链路追踪。
    tls_trace_spec GatewayTraceSpecTlsTraceSpec
    链路追踪配置信息。
    trace_type str
    链路追踪类型，取值：tls：日志服务。apm：应用性能监控全链路版。
    apmTraceSpec Property Map
    应用性能监控全链路版链路追踪配置。
    enable Boolean
    是否启用链路追踪。
    tlsTraceSpec Property Map
    链路追踪配置信息。
    traceType String
    链路追踪类型，取值：tls：日志服务。apm：应用性能监控全链路版。

    GatewayTraceSpecApmTraceSpec, GatewayTraceSpecApmTraceSpecArgs

    ApiKey string
    API Key。
    ApiKey string
    API Key。
    apiKey String
    API Key。
    apiKey string
    API Key。
    api_key str
    API Key。
    apiKey String
    API Key。

    GatewayTraceSpecTlsTraceSpec, GatewayTraceSpecTlsTraceSpecArgs

    IamUserAk string
    Access key。
    IamUserSk string
    Secret key。
    ProjectId string
    日志项目ID。
    TraceId string
    Trace ID。
    IamUserAk string
    Access key。
    IamUserSk string
    Secret key。
    ProjectId string
    日志项目ID。
    TraceId string
    Trace ID。
    iamUserAk String
    Access key。
    iamUserSk String
    Secret key。
    projectId String
    日志项目ID。
    traceId String
    Trace ID。
    iamUserAk string
    Access key。
    iamUserSk string
    Secret key。
    projectId string
    日志项目ID。
    traceId string
    Trace ID。
    iam_user_ak str
    Access key。
    iam_user_sk str
    Secret key。
    project_id str
    日志项目ID。
    trace_id str
    Trace ID。
    iamUserAk String
    Access key。
    iamUserSk String
    Secret key。
    projectId String
    日志项目ID。
    traceId String
    Trace ID。

    Import

    $ pulumi import bytepluscc:apig/gateway:Gateway example "gateway_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Meet Neo: Your AI Platform Teammate