1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. apig
  6. Gateway
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.apig.Gateway

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    API Gateway (Gateway) is the core component of the API management service. It receives, processes, and forwards API requests, and provides security authentication, traffic control, and other features

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  aPIGGatewayDemo:
    type: volcenginecc: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: volcenginecc: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.

    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
    Gateway name
    Comments string
    Gateway remarks. Length limit: 0–253 characters.
    CustomLog Volcengine.GatewayCustomLog
    Custom log configuration
    LogSpec Volcengine.GatewayLogSpec
    Log configuration
    MonitorSpec Volcengine.GatewayMonitorSpec
    Monitoring configuration information
    ProjectName string
    Project name
    ResourceSpec Volcengine.GatewayResourceSpec
    Resource specification configuration information
    SubnetIds List<string>
    Subnet ID list. Length limit: 1–2
    TraceSpec Volcengine.GatewayTraceSpec
    Link tracing configuration information.
    Type string
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    VpcId string
    VPC ID。
    Name string
    Gateway name
    Comments string
    Gateway remarks. Length limit: 0–253 characters.
    CustomLog GatewayCustomLogArgs
    Custom log configuration
    LogSpec GatewayLogSpecArgs
    Log configuration
    MonitorSpec GatewayMonitorSpecArgs
    Monitoring configuration information
    ProjectName string
    Project name
    ResourceSpec GatewayResourceSpecArgs
    Resource specification configuration information
    SubnetIds []string
    Subnet ID list. Length limit: 1–2
    TraceSpec GatewayTraceSpecArgs
    Link tracing configuration information.
    Type string
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    VpcId string
    VPC ID。
    name String
    Gateway name
    comments String
    Gateway remarks. Length limit: 0–253 characters.
    customLog GatewayCustomLog
    Custom log configuration
    logSpec GatewayLogSpec
    Log configuration
    monitorSpec GatewayMonitorSpec
    Monitoring configuration information
    projectName String
    Project name
    resourceSpec GatewayResourceSpec
    Resource specification configuration information
    subnetIds List<String>
    Subnet ID list. Length limit: 1–2
    traceSpec GatewayTraceSpec
    Link tracing configuration information.
    type String
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    vpcId String
    VPC ID。
    name string
    Gateway name
    comments string
    Gateway remarks. Length limit: 0–253 characters.
    customLog GatewayCustomLog
    Custom log configuration
    logSpec GatewayLogSpec
    Log configuration
    monitorSpec GatewayMonitorSpec
    Monitoring configuration information
    projectName string
    Project name
    resourceSpec GatewayResourceSpec
    Resource specification configuration information
    subnetIds string[]
    Subnet ID list. Length limit: 1–2
    traceSpec GatewayTraceSpec
    Link tracing configuration information.
    type string
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    vpcId string
    VPC ID。
    name str
    Gateway name
    comments str
    Gateway remarks. Length limit: 0–253 characters.
    custom_log GatewayCustomLogArgs
    Custom log configuration
    log_spec GatewayLogSpecArgs
    Log configuration
    monitor_spec GatewayMonitorSpecArgs
    Monitoring configuration information
    project_name str
    Project name
    resource_spec GatewayResourceSpecArgs
    Resource specification configuration information
    subnet_ids Sequence[str]
    Subnet ID list. Length limit: 1–2
    trace_spec GatewayTraceSpecArgs
    Link tracing configuration information.
    type str
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    vpc_id str
    VPC ID。
    name String
    Gateway name
    comments String
    Gateway remarks. Length limit: 0–253 characters.
    customLog Property Map
    Custom log configuration
    logSpec Property Map
    Log configuration
    monitorSpec Property Map
    Monitoring configuration information
    projectName String
    Project name
    resourceSpec Property Map
    Resource specification configuration information
    subnetIds List<String>
    Subnet ID list. Length limit: 1–2
    traceSpec Property Map
    Link tracing configuration information.
    type String
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    vpcId String
    VPC ID。

    Outputs

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

    BackendSpec Volcengine.GatewayBackendSpec
    Backend service configuration information
    CreatedTime string
    Gateway creation time
    Events List<Volcengine.GatewayEvent>
    GatewayId string
    Gateway instance ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Error message for gateway creation failure, deletion failure, or abnormal status
    NetworkSpec Volcengine.GatewayNetworkSpec
    Network configuration information
    Status string
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    Version string
    Gateway version.
    BackendSpec GatewayBackendSpec
    Backend service configuration information
    CreatedTime string
    Gateway creation time
    Events []GatewayEvent
    GatewayId string
    Gateway instance ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Error message for gateway creation failure, deletion failure, or abnormal status
    NetworkSpec GatewayNetworkSpec
    Network configuration information
    Status string
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    Version string
    Gateway version.
    backendSpec GatewayBackendSpec
    Backend service configuration information
    createdTime String
    Gateway creation time
    events List<GatewayEvent>
    gatewayId String
    Gateway instance ID
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Error message for gateway creation failure, deletion failure, or abnormal status
    networkSpec GatewayNetworkSpec
    Network configuration information
    status String
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    version String
    Gateway version.
    backendSpec GatewayBackendSpec
    Backend service configuration information
    createdTime string
    Gateway creation time
    events GatewayEvent[]
    gatewayId string
    Gateway instance ID
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Error message for gateway creation failure, deletion failure, or abnormal status
    networkSpec GatewayNetworkSpec
    Network configuration information
    status string
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    version string
    Gateway version.
    backend_spec GatewayBackendSpec
    Backend service configuration information
    created_time str
    Gateway creation time
    events Sequence[GatewayEvent]
    gateway_id str
    Gateway instance ID
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    Error message for gateway creation failure, deletion failure, or abnormal status
    network_spec GatewayNetworkSpec
    Network configuration information
    status str
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    version str
    Gateway version.
    backendSpec Property Map
    Backend service configuration information
    createdTime String
    Gateway creation time
    events List<Property Map>
    gatewayId String
    Gateway instance ID
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Error message for gateway creation failure, deletion failure, or abnormal status
    networkSpec Property Map
    Network configuration information
    status String
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    version String
    Gateway version.

    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: volcenginecc: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 Volcengine.GatewayBackendSpec
    Backend service configuration information
    Comments string
    Gateway remarks. Length limit: 0–253 characters.
    CreatedTime string
    Gateway creation time
    CustomLog Volcengine.GatewayCustomLog
    Custom log configuration
    Events List<Volcengine.GatewayEvent>
    GatewayId string
    Gateway instance ID
    LogSpec Volcengine.GatewayLogSpec
    Log configuration
    Message string
    Error message for gateway creation failure, deletion failure, or abnormal status
    MonitorSpec Volcengine.GatewayMonitorSpec
    Monitoring configuration information
    Name string
    Gateway name
    NetworkSpec Volcengine.GatewayNetworkSpec
    Network configuration information
    ProjectName string
    Project name
    ResourceSpec Volcengine.GatewayResourceSpec
    Resource specification configuration information
    Status string
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    SubnetIds List<string>
    Subnet ID list. Length limit: 1–2
    TraceSpec Volcengine.GatewayTraceSpec
    Link tracing configuration information.
    Type string
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    Version string
    Gateway version.
    VpcId string
    VPC ID。
    BackendSpec GatewayBackendSpecArgs
    Backend service configuration information
    Comments string
    Gateway remarks. Length limit: 0–253 characters.
    CreatedTime string
    Gateway creation time
    CustomLog GatewayCustomLogArgs
    Custom log configuration
    Events []GatewayEventArgs
    GatewayId string
    Gateway instance ID
    LogSpec GatewayLogSpecArgs
    Log configuration
    Message string
    Error message for gateway creation failure, deletion failure, or abnormal status
    MonitorSpec GatewayMonitorSpecArgs
    Monitoring configuration information
    Name string
    Gateway name
    NetworkSpec GatewayNetworkSpecArgs
    Network configuration information
    ProjectName string
    Project name
    ResourceSpec GatewayResourceSpecArgs
    Resource specification configuration information
    Status string
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    SubnetIds []string
    Subnet ID list. Length limit: 1–2
    TraceSpec GatewayTraceSpecArgs
    Link tracing configuration information.
    Type string
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    Version string
    Gateway version.
    VpcId string
    VPC ID。
    backendSpec GatewayBackendSpec
    Backend service configuration information
    comments String
    Gateway remarks. Length limit: 0–253 characters.
    createdTime String
    Gateway creation time
    customLog GatewayCustomLog
    Custom log configuration
    events List<GatewayEvent>
    gatewayId String
    Gateway instance ID
    logSpec GatewayLogSpec
    Log configuration
    message String
    Error message for gateway creation failure, deletion failure, or abnormal status
    monitorSpec GatewayMonitorSpec
    Monitoring configuration information
    name String
    Gateway name
    networkSpec GatewayNetworkSpec
    Network configuration information
    projectName String
    Project name
    resourceSpec GatewayResourceSpec
    Resource specification configuration information
    status String
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    subnetIds List<String>
    Subnet ID list. Length limit: 1–2
    traceSpec GatewayTraceSpec
    Link tracing configuration information.
    type String
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    version String
    Gateway version.
    vpcId String
    VPC ID。
    backendSpec GatewayBackendSpec
    Backend service configuration information
    comments string
    Gateway remarks. Length limit: 0–253 characters.
    createdTime string
    Gateway creation time
    customLog GatewayCustomLog
    Custom log configuration
    events GatewayEvent[]
    gatewayId string
    Gateway instance ID
    logSpec GatewayLogSpec
    Log configuration
    message string
    Error message for gateway creation failure, deletion failure, or abnormal status
    monitorSpec GatewayMonitorSpec
    Monitoring configuration information
    name string
    Gateway name
    networkSpec GatewayNetworkSpec
    Network configuration information
    projectName string
    Project name
    resourceSpec GatewayResourceSpec
    Resource specification configuration information
    status string
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    subnetIds string[]
    Subnet ID list. Length limit: 1–2
    traceSpec GatewayTraceSpec
    Link tracing configuration information.
    type string
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    version string
    Gateway version.
    vpcId string
    VPC ID。
    backend_spec GatewayBackendSpecArgs
    Backend service configuration information
    comments str
    Gateway remarks. Length limit: 0–253 characters.
    created_time str
    Gateway creation time
    custom_log GatewayCustomLogArgs
    Custom log configuration
    events Sequence[GatewayEventArgs]
    gateway_id str
    Gateway instance ID
    log_spec GatewayLogSpecArgs
    Log configuration
    message str
    Error message for gateway creation failure, deletion failure, or abnormal status
    monitor_spec GatewayMonitorSpecArgs
    Monitoring configuration information
    name str
    Gateway name
    network_spec GatewayNetworkSpecArgs
    Network configuration information
    project_name str
    Project name
    resource_spec GatewayResourceSpecArgs
    Resource specification configuration information
    status str
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    subnet_ids Sequence[str]
    Subnet ID list. Length limit: 1–2
    trace_spec GatewayTraceSpecArgs
    Link tracing configuration information.
    type str
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    version str
    Gateway version.
    vpc_id str
    VPC ID。
    backendSpec Property Map
    Backend service configuration information
    comments String
    Gateway remarks. Length limit: 0–253 characters.
    createdTime String
    Gateway creation time
    customLog Property Map
    Custom log configuration
    events List<Property Map>
    gatewayId String
    Gateway instance ID
    logSpec Property Map
    Log configuration
    message String
    Error message for gateway creation failure, deletion failure, or abnormal status
    monitorSpec Property Map
    Monitoring configuration information
    name String
    Gateway name
    networkSpec Property Map
    Network configuration information
    projectName String
    Project name
    resourceSpec Property Map
    Resource specification configuration information
    status String
    Gateway status. Options: Creating: Creating; CreatedFailed: Creation failed; Updating: Updating; Running: Running; Deleting: Deleting; DeletedFailed: Deletion failed; Abnormal: Abnormal
    subnetIds List<String>
    Subnet ID list. Length limit: 1–2
    traceSpec Property Map
    Link tracing configuration information.
    type String
    Gateway type. Options: standard: Standard gateway; serverless: Serverless gateway (not supported yet)
    version String
    Gateway version.
    vpcId String
    VPC ID。

    Supporting Types

    GatewayBackendSpec, GatewayBackendSpecArgs

    IsVkeWithFlannelCniSupported bool
    Whether VKE Flannel CNI is supported
    VkePodCidr string
    VKE Pod CIDR。
    IsVkeWithFlannelCniSupported bool
    Whether VKE Flannel CNI is supported
    VkePodCidr string
    VKE Pod CIDR。
    isVkeWithFlannelCniSupported Boolean
    Whether VKE Flannel CNI is supported
    vkePodCidr String
    VKE Pod CIDR。
    isVkeWithFlannelCniSupported boolean
    Whether VKE Flannel CNI is supported
    vkePodCidr string
    VKE Pod CIDR。
    is_vke_with_flannel_cni_supported bool
    Whether VKE Flannel CNI is supported
    vke_pod_cidr str
    VKE Pod CIDR。
    isVkeWithFlannelCniSupported Boolean
    Whether VKE Flannel CNI is supported
    vkePodCidr String
    VKE Pod CIDR。

    GatewayCustomLog, GatewayCustomLogArgs

    GatewayCustomLogCustomVariable, GatewayCustomLogCustomVariableArgs

    AliasesInLog string
    Field alias
    Key string
    Request header key
    AliasesInLog string
    Field alias
    Key string
    Request header key
    aliasesInLog String
    Field alias
    key String
    Request header key
    aliasesInLog string
    Field alias
    key string
    Request header key
    aliases_in_log str
    Field alias
    key str
    Request header key
    aliasesInLog String
    Field alias
    key String
    Request header key

    GatewayCustomLogRequestHeader, GatewayCustomLogRequestHeaderArgs

    AliasesInLog string
    Field alias
    Key string
    Request header key
    AliasesInLog string
    Field alias
    Key string
    Request header key
    aliasesInLog String
    Field alias
    key String
    Request header key
    aliasesInLog string
    Field alias
    key string
    Request header key
    aliases_in_log str
    Field alias
    key str
    Request header key
    aliasesInLog String
    Field alias
    key String
    Request header key

    GatewayCustomLogResponseHeader, GatewayCustomLogResponseHeaderArgs

    AliasesInLog string
    Field alias
    Key string
    Request header key
    AliasesInLog string
    Field alias
    Key string
    Request header key
    aliasesInLog String
    Field alias
    key String
    Request header key
    aliasesInLog string
    Field alias
    key string
    Request header key
    aliases_in_log str
    Field alias
    key str
    Request header key
    aliasesInLog String
    Field alias
    key String
    Request header key

    GatewayEvent, GatewayEventArgs

    Code string
    Event code
    CreatedTime string
    Event creation time
    Data string
    Additional information
    Description string
    Event description
    Code string
    Event code
    CreatedTime string
    Event creation time
    Data string
    Additional information
    Description string
    Event description
    code String
    Event code
    createdTime String
    Event creation time
    data String
    Additional information
    description String
    Event description
    code string
    Event code
    createdTime string
    Event creation time
    data string
    Additional information
    description string
    Event description
    code str
    Event code
    created_time str
    Event creation time
    data str
    Additional information
    description str
    Event description
    code String
    Event code
    createdTime String
    Event creation time
    data String
    Additional information
    description String
    Event description

    GatewayLogSpec, GatewayLogSpecArgs

    Enable bool
    Whether to enable log service
    ProjectId string
    Log project ID
    TopicId string
    Log topic ID. ProjectId specifies the log topic within the project
    Enable bool
    Whether to enable log service
    ProjectId string
    Log project ID
    TopicId string
    Log topic ID. ProjectId specifies the log topic within the project
    enable Boolean
    Whether to enable log service
    projectId String
    Log project ID
    topicId String
    Log topic ID. ProjectId specifies the log topic within the project
    enable boolean
    Whether to enable log service
    projectId string
    Log project ID
    topicId string
    Log topic ID. ProjectId specifies the log topic within the project
    enable bool
    Whether to enable log service
    project_id str
    Log project ID
    topic_id str
    Log topic ID. ProjectId specifies the log topic within the project
    enable Boolean
    Whether to enable log service
    projectId String
    Log project ID
    topicId String
    Log topic ID. ProjectId specifies the log topic within the project

    GatewayMonitorSpec, GatewayMonitorSpecArgs

    Enable bool
    Managed Prometheus (VMP) service
    WorkspaceId string
    Prometheus workspace ID
    Enable bool
    Managed Prometheus (VMP) service
    WorkspaceId string
    Prometheus workspace ID
    enable Boolean
    Managed Prometheus (VMP) service
    workspaceId String
    Prometheus workspace ID
    enable boolean
    Managed Prometheus (VMP) service
    workspaceId string
    Prometheus workspace ID
    enable bool
    Managed Prometheus (VMP) service
    workspace_id str
    Prometheus workspace ID
    enable Boolean
    Managed Prometheus (VMP) service
    workspaceId String
    Prometheus workspace ID

    GatewayNetworkSpec, GatewayNetworkSpecArgs

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

    GatewayNetworkSpecSubnet, GatewayNetworkSpecSubnetArgs

    Az string
    Availability zone
    SubnetId string
    Subnet ID
    SubnetName string
    Subnet name
    Az string
    Availability zone
    SubnetId string
    Subnet ID
    SubnetName string
    Subnet name
    az String
    Availability zone
    subnetId String
    Subnet ID
    subnetName String
    Subnet name
    az string
    Availability zone
    subnetId string
    Subnet ID
    subnetName string
    Subnet name
    az str
    Availability zone
    subnet_id str
    Subnet ID
    subnet_name str
    Subnet name
    az String
    Availability zone
    subnetId String
    Subnet ID
    subnetName String
    Subnet name

    GatewayResourceSpec, GatewayResourceSpecArgs

    ClbSpecCode string
    CLB specification code. CLB specifications. Options: small1: Small I; small2: Small II; medium1: Medium I; medium2: Medium II; large1: Large I; large2: Large II
    InstanceSpecCode string
    Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g
    NetworkType Volcengine.GatewayResourceSpecNetworkType
    Network type. Default value: enable public network, enable private network
    PublicNetworkBandwidth int
    Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0
    PublicNetworkBillingType string
    Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit
    Replicas int
    Node count. Value range: 2–100
    ClbSpecCode string
    CLB specification code. CLB specifications. Options: small1: Small I; small2: Small II; medium1: Medium I; medium2: Medium II; large1: Large I; large2: Large II
    InstanceSpecCode string
    Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g
    NetworkType GatewayResourceSpecNetworkType
    Network type. Default value: enable public network, enable private network
    PublicNetworkBandwidth int
    Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0
    PublicNetworkBillingType string
    Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit
    Replicas int
    Node count. Value range: 2–100
    clbSpecCode String
    CLB specification code. CLB specifications. Options: small1: Small I; small2: Small II; medium1: Medium I; medium2: Medium II; large1: Large I; large2: Large II
    instanceSpecCode String
    Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g
    networkType GatewayResourceSpecNetworkType
    Network type. Default value: enable public network, enable private network
    publicNetworkBandwidth Integer
    Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0
    publicNetworkBillingType String
    Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit
    replicas Integer
    Node count. Value range: 2–100
    clbSpecCode string
    CLB specification code. CLB specifications. Options: small1: Small I; small2: Small II; medium1: Medium I; medium2: Medium II; large1: Large I; large2: Large II
    instanceSpecCode string
    Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g
    networkType GatewayResourceSpecNetworkType
    Network type. Default value: enable public network, enable private network
    publicNetworkBandwidth number
    Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0
    publicNetworkBillingType string
    Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit
    replicas number
    Node count. Value range: 2–100
    clb_spec_code str
    CLB specification code. CLB specifications. Options: small1: Small I; small2: Small II; medium1: Medium I; medium2: Medium II; large1: Large I; large2: Large II
    instance_spec_code str
    Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g
    network_type GatewayResourceSpecNetworkType
    Network type. Default value: enable public network, enable private network
    public_network_bandwidth int
    Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0
    public_network_billing_type str
    Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit
    replicas int
    Node count. Value range: 2–100
    clbSpecCode String
    CLB specification code. CLB specifications. Options: small1: Small I; small2: Small II; medium1: Medium I; medium2: Medium II; large1: Large I; large2: Large II
    instanceSpecCode String
    Node specifications. Options: 1c2g, 2c4g, 4c8g, 8c16g
    networkType Property Map
    Network type. Default value: enable public network, enable private network
    publicNetworkBandwidth Number
    Public network bandwidth limit. This field is only used for the 'bandwidth limit billing' public network billing method. Unit: Mbps. Value range: 0–500. Default value: 0
    publicNetworkBillingType String
    Public network billing method. Options: traffic: billed by actual traffic; bandwidth: billed by bandwidth limit
    replicas Number
    Node count. Value range: 2–100

    GatewayResourceSpecNetworkType, GatewayResourceSpecNetworkTypeArgs

    EnablePrivateNetwork bool
    Whether to enable private network
    EnablePublicNetwork bool
    Whether to enable public network
    EnablePrivateNetwork bool
    Whether to enable private network
    EnablePublicNetwork bool
    Whether to enable public network
    enablePrivateNetwork Boolean
    Whether to enable private network
    enablePublicNetwork Boolean
    Whether to enable public network
    enablePrivateNetwork boolean
    Whether to enable private network
    enablePublicNetwork boolean
    Whether to enable public network
    enable_private_network bool
    Whether to enable private network
    enable_public_network bool
    Whether to enable public network
    enablePrivateNetwork Boolean
    Whether to enable private network
    enablePublicNetwork Boolean
    Whether to enable public network

    GatewayTraceSpec, GatewayTraceSpecArgs

    ApmTraceSpec Volcengine.GatewayTraceSpecApmTraceSpec
    Application performance monitoring full-link trace configuration
    Enable bool
    Whether to enable trace
    TlsTraceSpec Volcengine.GatewayTraceSpecTlsTraceSpec
    Link tracing configuration information.
    TraceType string
    Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.
    ApmTraceSpec GatewayTraceSpecApmTraceSpec
    Application performance monitoring full-link trace configuration
    Enable bool
    Whether to enable trace
    TlsTraceSpec GatewayTraceSpecTlsTraceSpec
    Link tracing configuration information.
    TraceType string
    Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.
    apmTraceSpec GatewayTraceSpecApmTraceSpec
    Application performance monitoring full-link trace configuration
    enable Boolean
    Whether to enable trace
    tlsTraceSpec GatewayTraceSpecTlsTraceSpec
    Link tracing configuration information.
    traceType String
    Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.
    apmTraceSpec GatewayTraceSpecApmTraceSpec
    Application performance monitoring full-link trace configuration
    enable boolean
    Whether to enable trace
    tlsTraceSpec GatewayTraceSpecTlsTraceSpec
    Link tracing configuration information.
    traceType string
    Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.
    apm_trace_spec GatewayTraceSpecApmTraceSpec
    Application performance monitoring full-link trace configuration
    enable bool
    Whether to enable trace
    tls_trace_spec GatewayTraceSpecTlsTraceSpec
    Link tracing configuration information.
    trace_type str
    Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.
    apmTraceSpec Property Map
    Application performance monitoring full-link trace configuration
    enable Boolean
    Whether to enable trace
    tlsTraceSpec Property Map
    Link tracing configuration information.
    traceType String
    Link tracing type. Possible values: tls: Log Service. apm: Application Performance Monitoring (APM) end-to-end version.

    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
    Log project ID
    TraceId string
    Trace ID。
    IamUserAk string
    Access key。
    IamUserSk string
    Secret key。
    ProjectId string
    Log project ID
    TraceId string
    Trace ID。
    iamUserAk String
    Access key。
    iamUserSk String
    Secret key。
    projectId String
    Log project ID
    traceId String
    Trace ID。
    iamUserAk string
    Access key。
    iamUserSk string
    Secret key。
    projectId string
    Log project ID
    traceId string
    Trace ID。
    iam_user_ak str
    Access key。
    iam_user_sk str
    Secret key。
    project_id str
    Log project ID
    trace_id str
    Trace ID。
    iamUserAk String
    Access key。
    iamUserSk String
    Secret key。
    projectId String
    Log project ID
    traceId String
    Trace ID。

    Import

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

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.