volcenginecc.apig.getGatewayService

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getGatewayService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGatewayService(args: GetGatewayServiceArgs, opts?: InvokeOptions): Promise<GetGatewayServiceResult>
function getGatewayServiceOutput(args: GetGatewayServiceOutputArgs, opts?: InvokeOptions): Output<GetGatewayServiceResult>

def get_gateway_service(id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetGatewayServiceResult
def get_gateway_service_output(id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetGatewayServiceResult]

func LookupGatewayService(ctx *Context, args *LookupGatewayServiceArgs, opts ...InvokeOption) (*LookupGatewayServiceResult, error)
func LookupGatewayServiceOutput(ctx *Context, args *LookupGatewayServiceOutputArgs, opts ...InvokeOption) LookupGatewayServiceResultOutput

> Note: This function is named LookupGatewayService in the Go SDK.

public static class GetGatewayService 
{
    public static Task<GetGatewayServiceResult> InvokeAsync(GetGatewayServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayServiceResult> Invoke(GetGatewayServiceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayServiceResult> getGatewayService(GetGatewayServiceArgs args, InvokeOptions options)
public static Output<GetGatewayServiceResult> getGatewayService(GetGatewayServiceArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:apig/getGatewayService:getGatewayService
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getGatewayService Result

The following output properties are available:

AuthSpec Volcengine.GetGatewayServiceAuthSpec: Authentication configuration.
Comments string: Remarks. Length must be 0–253 characters.
CreatedTime string: Creation time.
CustomDomains List<Volcengine.GetGatewayServiceCustomDomain>: Custom domain list.
DomainSpec Volcengine.GetGatewayServiceDomainSpec: Domain details.
DomainType string: Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
Domains List<Volcengine.GetGatewayServiceDomain>: Default domain.
GatewayId string: Gateway ID.
GatewayName string: Gateway name.
Id string: Uniquely identifies the resource.
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.GetGatewayServiceServiceNetworkSpec: 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 GetGatewayServiceAuthSpec: Authentication configuration.
Comments string: Remarks. Length must be 0–253 characters.
CreatedTime string: Creation time.
CustomDomains []GetGatewayServiceCustomDomain: Custom domain list.
DomainSpec GetGatewayServiceDomainSpec: Domain details.
DomainType string: Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
Domains []GetGatewayServiceDomain: Default domain.
GatewayId string: Gateway ID.
GatewayName string: Gateway name.
Id string: Uniquely identifies the resource.
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 GetGatewayServiceServiceNetworkSpec: 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 GetGatewayServiceAuthSpec: Authentication configuration.
comments String: Remarks. Length must be 0–253 characters.
createdTime String: Creation time.
customDomains List<GetGatewayServiceCustomDomain>: Custom domain list.
domainSpec GetGatewayServiceDomainSpec: Domain details.
domainType String: Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
domains List<GetGatewayServiceDomain>: Default domain.
gatewayId String: Gateway ID.
gatewayName String: Gateway name.
id String: Uniquely identifies the resource.
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 GetGatewayServiceServiceNetworkSpec: 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 GetGatewayServiceAuthSpec: Authentication configuration.
comments string: Remarks. Length must be 0–253 characters.
createdTime string: Creation time.
customDomains GetGatewayServiceCustomDomain[]: Custom domain list.
domainSpec GetGatewayServiceDomainSpec: Domain details.
domainType string: Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
domains GetGatewayServiceDomain[]: Default domain.
gatewayId string: Gateway ID.
gatewayName string: Gateway name.
id string: Uniquely identifies the resource.
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 GetGatewayServiceServiceNetworkSpec: 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 GetGatewayServiceAuthSpec: Authentication configuration.
comments str: Remarks. Length must be 0–253 characters.
created_time str: Creation time.
custom_domains Sequence[GetGatewayServiceCustomDomain]: Custom domain list.
domain_spec GetGatewayServiceDomainSpec: Domain details.
domain_type str: Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
domains Sequence[GetGatewayServiceDomain]: Default domain.
gateway_id str: Gateway ID.
gateway_name str: Gateway name.
id str: Uniquely identifies the resource.
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 GetGatewayServiceServiceNetworkSpec: 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>: Custom domain list.
domainSpec Property Map: Domain details.
domainType String: Domain type. Options: DefaultDomain: Default domain. CustomDomain: Custom domain.
domains List<Property Map>: Default domain.
gatewayId String: Gateway ID.
gatewayName String: Gateway name.
id String: Uniquely identifies the resource.
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

GetGatewayServiceAuthSpec

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.

GetGatewayServiceCustomDomain

Domain string: Custom domain.
DomainId string: Custom domain ID.

Domain string: Custom domain.
DomainId string: Custom domain ID.

domain String: Custom domain.
domainId String: Custom domain ID.

domain string: Custom domain.
domainId string: Custom domain ID.

domain str: Custom domain.
domain_id str: Custom domain ID.

domain String: Custom domain.
domainId String: Custom domain ID.

GetGatewayServiceDomain

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.

GetGatewayServiceDomainSpec

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.

GetGatewayServiceServiceNetworkSpec

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.