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

volcenginecc.apig.GatewayService

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

    A service is a set of routes exposed as entry points to distinguish traffic sources and protocols, enabling business, environment, and logical tenant isolation. Services can bind independent access domains, allowing access by domain.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  apigGatewayServiceDemo:
    type: volcenginecc:apig:GatewayService
    name: ApigGatewayServiceDemo
    properties:
      serviceName: ccapi-terraform-1
      gatewayId: gd6l9lbilgrmdxxxxxx
      protocols:
        - HTTP
        - HTTPS
      authSpec:
        enable: true
      comments: test
      serviceType: AIProvider
      serviceNetworkSpec:
        enable_public_network: true
        enable_private_network: false
        private_network_ip: []

    Create GatewayService Resource

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

    Constructor syntax

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

@overload
def GatewayService(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   auth_spec: Optional[GatewayServiceAuthSpecArgs] = None,
                   gateway_id: Optional[str] = None,
                   protocols: Optional[Sequence[str]] = None,
                   service_name: Optional[str] = None,
                   comments: Optional[str] = None,
                   custom_domains: Optional[Sequence[GatewayServiceCustomDomainArgs]] = None,
                   domain_type: Optional[str] = None,
                   service_network_spec: Optional[GatewayServiceServiceNetworkSpecArgs] = None,
                   service_type: Optional[str] = None)
    func NewGatewayService(ctx *Context, name string, args GatewayServiceArgs, opts ...ResourceOption) (*GatewayService, error)
    public GatewayService(string name, GatewayServiceArgs args, CustomResourceOptions? opts = null)
    public GatewayService(String name, GatewayServiceArgs args)
public GatewayService(String name, GatewayServiceArgs args, CustomResourceOptions options)

    type: volcenginecc:apig:GatewayService
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 GatewayServiceArgs
    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 GatewayServiceArgs
    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 GatewayServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayServiceArgs
    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 gatewayServiceResource = new Volcenginecc.Apig.GatewayService("gatewayServiceResource", new()
{
    AuthSpec = new Volcenginecc.Apig.Inputs.GatewayServiceAuthSpecArgs
    {
        Enable = false,
    },
    GatewayId = "string",
    Protocols = new[]
    {
        "string",
    },
    ServiceName = "string",
    Comments = "string",
    CustomDomains = new[]
    {
        null,
    },
    DomainType = "string",
    ServiceNetworkSpec = new Volcenginecc.Apig.Inputs.GatewayServiceServiceNetworkSpecArgs
    {
        EnablePrivateNetwork = false,
        EnablePublicNetwork = false,
        PrivateNetworkIps = new[]
        {
            "string",
        },
    },
    ServiceType = "string",
});

    example, err := apig.NewGatewayService(ctx, "gatewayServiceResource", &apig.GatewayServiceArgs{
	AuthSpec: &apig.GatewayServiceAuthSpecArgs{
		Enable: pulumi.Bool(false),
	},
	GatewayId: pulumi.String("string"),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceName: pulumi.String("string"),
	Comments:    pulumi.String("string"),
	CustomDomains: apig.GatewayServiceCustomDomainArray{
		&apig.GatewayServiceCustomDomainArgs{},
	},
	DomainType: pulumi.String("string"),
	ServiceNetworkSpec: &apig.GatewayServiceServiceNetworkSpecArgs{
		EnablePrivateNetwork: pulumi.Bool(false),
		EnablePublicNetwork:  pulumi.Bool(false),
		PrivateNetworkIps: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	ServiceType: pulumi.String("string"),
})

    var gatewayServiceResource = new GatewayService("gatewayServiceResource", GatewayServiceArgs.builder()
    .authSpec(GatewayServiceAuthSpecArgs.builder()
        .enable(false)
        .build())
    .gatewayId("string")
    .protocols("string")
    .serviceName("string")
    .comments("string")
    .customDomains(GatewayServiceCustomDomainArgs.builder()
        .build())
    .domainType("string")
    .serviceNetworkSpec(GatewayServiceServiceNetworkSpecArgs.builder()
        .enablePrivateNetwork(false)
        .enablePublicNetwork(false)
        .privateNetworkIps("string")
        .build())
    .serviceType("string")
    .build());

    gateway_service_resource = volcenginecc.apig.GatewayService("gatewayServiceResource",
    auth_spec={
        "enable": False,
    },
    gateway_id="string",
    protocols=["string"],
    service_name="string",
    comments="string",
    custom_domains=[{}],
    domain_type="string",
    service_network_spec={
        "enable_private_network": False,
        "enable_public_network": False,
        "private_network_ips": ["string"],
    },
    service_type="string")

    const gatewayServiceResource = new volcenginecc.apig.GatewayService("gatewayServiceResource", {
    authSpec: {
        enable: false,
    },
    gatewayId: "string",
    protocols: ["string"],
    serviceName: "string",
    comments: "string",
    customDomains: [{}],
    domainType: "string",
    serviceNetworkSpec: {
        enablePrivateNetwork: false,
        enablePublicNetwork: false,
        privateNetworkIps: ["string"],
    },
    serviceType: "string",
});

    type: volcenginecc:apig:GatewayService
properties:
    authSpec:
        enable: false
    comments: string
    customDomains:
        - {}
    domainType: string
    gatewayId: string
    protocols:
        - string
    serviceName: string
    serviceNetworkSpec:
        enablePrivateNetwork: false
        enablePublicNetwork: false
        privateNetworkIps:
            - string
    serviceType: string

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

    AuthSpec Volcengine.GatewayServiceAuthSpec
    Authentication configuration.
    GatewayId string
    Gateway ID.
    Protocols List<string>
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    ServiceName string
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    Comments string
    Remarks. Length must be 0–253 characters.
    CustomDomains List<Volcengine.GatewayServiceCustomDomain>
    DomainType string
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    ServiceNetworkSpec Volcengine.GatewayServiceServiceNetworkSpec
    Default domain network configuration..
    ServiceType string
    Service type. Options: AIProvider: AI model proxy.
    AuthSpec GatewayServiceAuthSpecArgs
    Authentication configuration.
    GatewayId string
    Gateway ID.
    Protocols []string
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    ServiceName string
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    Comments string
    Remarks. Length must be 0–253 characters.
    CustomDomains []GatewayServiceCustomDomainArgs
    DomainType string
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    ServiceNetworkSpec GatewayServiceServiceNetworkSpecArgs
    Default domain network configuration..
    ServiceType string
    Service type. Options: AIProvider: AI model proxy.
    authSpec GatewayServiceAuthSpec
    Authentication configuration.
    gatewayId String
    Gateway ID.
    protocols List<String>
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    serviceName String
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    comments String
    Remarks. Length must be 0–253 characters.
    customDomains List<GatewayServiceCustomDomain>
    domainType String
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    serviceNetworkSpec GatewayServiceServiceNetworkSpec
    Default domain network configuration..
    serviceType String
    Service type. Options: AIProvider: AI model proxy.
    authSpec GatewayServiceAuthSpec
    Authentication configuration.
    gatewayId string
    Gateway ID.
    protocols string[]
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    serviceName string
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    comments string
    Remarks. Length must be 0–253 characters.
    customDomains GatewayServiceCustomDomain[]
    domainType string
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    serviceNetworkSpec GatewayServiceServiceNetworkSpec
    Default domain network configuration..
    serviceType string
    Service type. Options: AIProvider: AI model proxy.
    auth_spec GatewayServiceAuthSpecArgs
    Authentication configuration.
    gateway_id str
    Gateway ID.
    protocols Sequence[str]
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    service_name str
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    comments str
    Remarks. Length must be 0–253 characters.
    custom_domains Sequence[GatewayServiceCustomDomainArgs]
    domain_type str
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    service_network_spec GatewayServiceServiceNetworkSpecArgs
    Default domain network configuration..
    service_type str
    Service type. Options: AIProvider: AI model proxy.
    authSpec Property Map
    Authentication configuration.
    gatewayId String
    Gateway ID.
    protocols List<String>
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    serviceName String
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    comments String
    Remarks. Length must be 0–253 characters.
    customDomains List<Property Map>
    domainType String
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    serviceNetworkSpec Property Map
    Default domain network configuration..
    serviceType String
    Service type. Options: AIProvider: AI model proxy.

    Outputs

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

    CreatedTime string
    Creation time.
    DomainSpec Volcengine.GatewayServiceDomainSpec
    Domain details.
    Domains List<Volcengine.GatewayServiceDomain>
    GatewayName string
    Gateway name.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Error message for service creation failure, deletion failure, or abnormal status.
    ServiceId string
    Service ID.
    Status string
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    CreatedTime string
    Creation time.
    DomainSpec GatewayServiceDomainSpec
    Domain details.
    Domains []GatewayServiceDomain
    GatewayName string
    Gateway name.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    Error message for service creation failure, deletion failure, or abnormal status.
    ServiceId string
    Service ID.
    Status string
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    createdTime String
    Creation time.
    domainSpec GatewayServiceDomainSpec
    Domain details.
    domains List<GatewayServiceDomain>
    gatewayName String
    Gateway name.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Error message for service creation failure, deletion failure, or abnormal status.
    serviceId String
    Service ID.
    status String
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    createdTime string
    Creation time.
    domainSpec GatewayServiceDomainSpec
    Domain details.
    domains GatewayServiceDomain[]
    gatewayName string
    Gateway name.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    Error message for service creation failure, deletion failure, or abnormal status.
    serviceId string
    Service ID.
    status string
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    created_time str
    Creation time.
    domain_spec GatewayServiceDomainSpec
    Domain details.
    domains Sequence[GatewayServiceDomain]
    gateway_name str
    Gateway name.
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    Error message for service creation failure, deletion failure, or abnormal status.
    service_id str
    Service ID.
    status str
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    createdTime String
    Creation time.
    domainSpec Property Map
    Domain details.
    domains List<Property Map>
    gatewayName String
    Gateway name.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    Error message for service creation failure, deletion failure, or abnormal status.
    serviceId String
    Service ID.
    status String
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.

    Look up Existing GatewayService Resource

    Get an existing GatewayService 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?: GatewayServiceState, opts?: CustomResourceOptions): GatewayService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_spec: Optional[GatewayServiceAuthSpecArgs] = None,
        comments: Optional[str] = None,
        created_time: Optional[str] = None,
        custom_domains: Optional[Sequence[GatewayServiceCustomDomainArgs]] = None,
        domain_spec: Optional[GatewayServiceDomainSpecArgs] = None,
        domain_type: Optional[str] = None,
        domains: Optional[Sequence[GatewayServiceDomainArgs]] = None,
        gateway_id: Optional[str] = None,
        gateway_name: Optional[str] = None,
        message: Optional[str] = None,
        protocols: Optional[Sequence[str]] = None,
        service_id: Optional[str] = None,
        service_name: Optional[str] = None,
        service_network_spec: Optional[GatewayServiceServiceNetworkSpecArgs] = None,
        service_type: Optional[str] = None,
        status: Optional[str] = None) -> GatewayService
    func GetGatewayService(ctx *Context, name string, id IDInput, state *GatewayServiceState, opts ...ResourceOption) (*GatewayService, error)
    public static GatewayService Get(string name, Input<string> id, GatewayServiceState? state, CustomResourceOptions? opts = null)
    public static GatewayService get(String name, Output<String> id, GatewayServiceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:apig:GatewayService    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:
    AuthSpec Volcengine.GatewayServiceAuthSpec
    Authentication configuration.
    Comments string
    Remarks. Length must be 0–253 characters.
    CreatedTime string
    Creation time.
    CustomDomains List<Volcengine.GatewayServiceCustomDomain>
    DomainSpec Volcengine.GatewayServiceDomainSpec
    Domain details.
    DomainType string
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    Domains List<Volcengine.GatewayServiceDomain>
    GatewayId string
    Gateway ID.
    GatewayName string
    Gateway name.
    Message string
    Error message for service creation failure, deletion failure, or abnormal status.
    Protocols List<string>
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    ServiceId string
    Service ID.
    ServiceName string
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    ServiceNetworkSpec Volcengine.GatewayServiceServiceNetworkSpec
    Default domain network configuration..
    ServiceType string
    Service type. Options: AIProvider: AI model proxy.
    Status string
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    AuthSpec GatewayServiceAuthSpecArgs
    Authentication configuration.
    Comments string
    Remarks. Length must be 0–253 characters.
    CreatedTime string
    Creation time.
    CustomDomains []GatewayServiceCustomDomainArgs
    DomainSpec GatewayServiceDomainSpecArgs
    Domain details.
    DomainType string
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    Domains []GatewayServiceDomainArgs
    GatewayId string
    Gateway ID.
    GatewayName string
    Gateway name.
    Message string
    Error message for service creation failure, deletion failure, or abnormal status.
    Protocols []string
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    ServiceId string
    Service ID.
    ServiceName string
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    ServiceNetworkSpec GatewayServiceServiceNetworkSpecArgs
    Default domain network configuration..
    ServiceType string
    Service type. Options: AIProvider: AI model proxy.
    Status string
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    authSpec GatewayServiceAuthSpec
    Authentication configuration.
    comments String
    Remarks. Length must be 0–253 characters.
    createdTime String
    Creation time.
    customDomains List<GatewayServiceCustomDomain>
    domainSpec GatewayServiceDomainSpec
    Domain details.
    domainType String
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    domains List<GatewayServiceDomain>
    gatewayId String
    Gateway ID.
    gatewayName String
    Gateway name.
    message String
    Error message for service creation failure, deletion failure, or abnormal status.
    protocols List<String>
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    serviceId String
    Service ID.
    serviceName String
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    serviceNetworkSpec GatewayServiceServiceNetworkSpec
    Default domain network configuration..
    serviceType String
    Service type. Options: AIProvider: AI model proxy.
    status String
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    authSpec GatewayServiceAuthSpec
    Authentication configuration.
    comments string
    Remarks. Length must be 0–253 characters.
    createdTime string
    Creation time.
    customDomains GatewayServiceCustomDomain[]
    domainSpec GatewayServiceDomainSpec
    Domain details.
    domainType string
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    domains GatewayServiceDomain[]
    gatewayId string
    Gateway ID.
    gatewayName string
    Gateway name.
    message string
    Error message for service creation failure, deletion failure, or abnormal status.
    protocols string[]
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    serviceId string
    Service ID.
    serviceName string
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    serviceNetworkSpec GatewayServiceServiceNetworkSpec
    Default domain network configuration..
    serviceType string
    Service type. Options: AIProvider: AI model proxy.
    status string
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    auth_spec GatewayServiceAuthSpecArgs
    Authentication configuration.
    comments str
    Remarks. Length must be 0–253 characters.
    created_time str
    Creation time.
    custom_domains Sequence[GatewayServiceCustomDomainArgs]
    domain_spec GatewayServiceDomainSpecArgs
    Domain details.
    domain_type str
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    domains Sequence[GatewayServiceDomainArgs]
    gateway_id str
    Gateway ID.
    gateway_name str
    Gateway name.
    message str
    Error message for service creation failure, deletion failure, or abnormal status.
    protocols Sequence[str]
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    service_id str
    Service ID.
    service_name str
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    service_network_spec GatewayServiceServiceNetworkSpecArgs
    Default domain network configuration..
    service_type str
    Service type. Options: AIProvider: AI model proxy.
    status str
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.
    authSpec Property Map
    Authentication configuration.
    comments String
    Remarks. Length must be 0–253 characters.
    createdTime String
    Creation time.
    customDomains List<Property Map>
    domainSpec Property Map
    Domain details.
    domainType String
    Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
    domains List<Property Map>
    gatewayId String
    Gateway ID.
    gatewayName String
    Gateway name.
    message String
    Error message for service creation failure, deletion failure, or abnormal status.
    protocols List<String>
    Supported protocols. Options: HTTP: HTTP. HTTPS: HTTPS.
    serviceId String
    Service ID.
    serviceName String
    Service name. Supports uppercase and lowercase letters, numbers, and hyphens (-). Length must be 2–128 characters. Cannot start with a hyphen (-).
    serviceNetworkSpec Property Map
    Default domain network configuration..
    serviceType String
    Service type. Options: AIProvider: AI model proxy.
    status String
    Creating: Creating. CreatedFailed: Creation failed. Running: Running. Deleting: Deleting. DeletedFailed: Deletion failed. Abnormal: Abnormal.

    Supporting Types

    GatewayServiceAuthSpec, GatewayServiceAuthSpecArgs

    Enable bool
    Whether authentication is enabled.
    Enable bool
    Whether authentication is enabled.
    enable Boolean
    Whether authentication is enabled.
    enable boolean
    Whether authentication is enabled.
    enable bool
    Whether authentication is enabled.
    enable Boolean
    Whether authentication is enabled.

    GatewayServiceDomain, GatewayServiceDomainArgs

    Domain string
    Domain.
    Type string
    Domain type. Options: public: Public network. private: Private network.
    Domain string
    Domain.
    Type string
    Domain type. Options: public: Public network. private: Private network.
    domain String
    Domain.
    type String
    Domain type. Options: public: Public network. private: Private network.
    domain string
    Domain.
    type string
    Domain type. Options: public: Public network. private: Private network.
    domain str
    Domain.
    type str
    Domain type. Options: public: Public network. private: Private network.
    domain String
    Domain.
    type String
    Domain type. Options: public: Public network. private: Private network.

    GatewayServiceDomainSpec, GatewayServiceDomainSpecArgs

    EnablePublicResolution bool
    Enable public resolution for private network domains.
    EnablePublicResolution bool
    Enable public resolution for private network domains.
    enablePublicResolution Boolean
    Enable public resolution for private network domains.
    enablePublicResolution boolean
    Enable public resolution for private network domains.
    enable_public_resolution bool
    Enable public resolution for private network domains.
    enablePublicResolution Boolean
    Enable public resolution for private network domains.

    GatewayServiceServiceNetworkSpec, GatewayServiceServiceNetworkSpecArgs

    EnablePrivateNetwork bool
    Enable private network.
    EnablePublicNetwork bool
    Enable public network.
    PrivateNetworkIps List<string>
    Target IP for private network domain resolution.
    EnablePrivateNetwork bool
    Enable private network.
    EnablePublicNetwork bool
    Enable public network.
    PrivateNetworkIps []string
    Target IP for private network domain resolution.
    enablePrivateNetwork Boolean
    Enable private network.
    enablePublicNetwork Boolean
    Enable public network.
    privateNetworkIps List<String>
    Target IP for private network domain resolution.
    enablePrivateNetwork boolean
    Enable private network.
    enablePublicNetwork boolean
    Enable public network.
    privateNetworkIps string[]
    Target IP for private network domain resolution.
    enable_private_network bool
    Enable private network.
    enable_public_network bool
    Enable public network.
    private_network_ips Sequence[str]
    Target IP for private network domain resolution.
    enablePrivateNetwork Boolean
    Enable private network.
    enablePublicNetwork Boolean
    Enable public network.
    privateNetworkIps List<String>
    Target IP for private network domain resolution.

    Import

    $ pulumi import volcenginecc:apig/gatewayService:GatewayService example "service_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.