volcenginecc v0.0.4, Nov 3 25

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcenginecc.apig.getGatewayService

Start a Neo task

Explain and create a volcenginecc.apig.getGatewayService resource

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

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: 认证配置。
Comments string: 备注，长度限制为0~253个字符。
CreatedTime string: 创建时间。
CustomDomains List<Volcengine.GetGatewayServiceCustomDomain>: 自定义域名列表。
DomainSpec Volcengine.GetGatewayServiceDomainSpec: 域名详情。
Domains List<Volcengine.GetGatewayServiceDomain>: 默认域名。
GatewayId string: 网关ID。
GatewayName string: 网关名称。
Id string: Uniquely identifies the resource.
Message string: 服务创建失败、删除失败或异常时的错误信息。
Protocols List<string>: 服务支持的协议。取值：HTTP：HTTP。HTTPS：HTTPS。
ServiceId string: 服务ID。
ServiceName string: 服务名称。支持大小写字母、数字和中划线（-），长度限制为2~128个字符。不能以中划线（-）开头。。
Status string: Creating：创建中。CreatedFailed：创建失败。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。

AuthSpec GetGatewayServiceAuthSpec: 认证配置。
Comments string: 备注，长度限制为0~253个字符。
CreatedTime string: 创建时间。
CustomDomains []GetGatewayServiceCustomDomain: 自定义域名列表。
DomainSpec GetGatewayServiceDomainSpec: 域名详情。
Domains []GetGatewayServiceDomain: 默认域名。
GatewayId string: 网关ID。
GatewayName string: 网关名称。
Id string: Uniquely identifies the resource.
Message string: 服务创建失败、删除失败或异常时的错误信息。
Protocols []string: 服务支持的协议。取值：HTTP：HTTP。HTTPS：HTTPS。
ServiceId string: 服务ID。
ServiceName string: 服务名称。支持大小写字母、数字和中划线（-），长度限制为2~128个字符。不能以中划线（-）开头。。
Status string: Creating：创建中。CreatedFailed：创建失败。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。

authSpec GetGatewayServiceAuthSpec: 认证配置。
comments String: 备注，长度限制为0~253个字符。
createdTime String: 创建时间。
customDomains List<GetGatewayServiceCustomDomain>: 自定义域名列表。
domainSpec GetGatewayServiceDomainSpec: 域名详情。
domains List<GetGatewayServiceDomain>: 默认域名。
gatewayId String: 网关ID。
gatewayName String: 网关名称。
id String: Uniquely identifies the resource.
message String: 服务创建失败、删除失败或异常时的错误信息。
protocols List<String>: 服务支持的协议。取值：HTTP：HTTP。HTTPS：HTTPS。
serviceId String: 服务ID。
serviceName String: 服务名称。支持大小写字母、数字和中划线（-），长度限制为2~128个字符。不能以中划线（-）开头。。
status String: Creating：创建中。CreatedFailed：创建失败。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。

authSpec GetGatewayServiceAuthSpec: 认证配置。
comments string: 备注，长度限制为0~253个字符。
createdTime string: 创建时间。
customDomains GetGatewayServiceCustomDomain[]: 自定义域名列表。
domainSpec GetGatewayServiceDomainSpec: 域名详情。
domains GetGatewayServiceDomain[]: 默认域名。
gatewayId string: 网关ID。
gatewayName string: 网关名称。
id string: Uniquely identifies the resource.
message string: 服务创建失败、删除失败或异常时的错误信息。
protocols string[]: 服务支持的协议。取值：HTTP：HTTP。HTTPS：HTTPS。
serviceId string: 服务ID。
serviceName string: 服务名称。支持大小写字母、数字和中划线（-），长度限制为2~128个字符。不能以中划线（-）开头。。
status string: Creating：创建中。CreatedFailed：创建失败。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。

auth_spec GetGatewayServiceAuthSpec: 认证配置。
comments str: 备注，长度限制为0~253个字符。
created_time str: 创建时间。
custom_domains Sequence[GetGatewayServiceCustomDomain]: 自定义域名列表。
domain_spec GetGatewayServiceDomainSpec: 域名详情。
domains Sequence[GetGatewayServiceDomain]: 默认域名。
gateway_id str: 网关ID。
gateway_name str: 网关名称。
id str: Uniquely identifies the resource.
message str: 服务创建失败、删除失败或异常时的错误信息。
protocols Sequence[str]: 服务支持的协议。取值：HTTP：HTTP。HTTPS：HTTPS。
service_id str: 服务ID。
service_name str: 服务名称。支持大小写字母、数字和中划线（-），长度限制为2~128个字符。不能以中划线（-）开头。。
status str: Creating：创建中。CreatedFailed：创建失败。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。

authSpec Property Map: 认证配置。
comments String: 备注，长度限制为0~253个字符。
createdTime String: 创建时间。
customDomains List<Property Map>: 自定义域名列表。
domainSpec Property Map: 域名详情。
domains List<Property Map>: 默认域名。
gatewayId String: 网关ID。
gatewayName String: 网关名称。
id String: Uniquely identifies the resource.
message String: 服务创建失败、删除失败或异常时的错误信息。
protocols List<String>: 服务支持的协议。取值：HTTP：HTTP。HTTPS：HTTPS。
serviceId String: 服务ID。
serviceName String: 服务名称。支持大小写字母、数字和中划线（-），长度限制为2~128个字符。不能以中划线（-）开头。。
status String: Creating：创建中。CreatedFailed：创建失败。Running：运行中。Deleting：删除中。DeletedFailed：删除失败。Abnormal：异常。

Supporting Types

GetGatewayServiceAuthSpec

Enable bool: 是否开启认证。

Enable bool: 是否开启认证。

enable Boolean: 是否开启认证。

enable boolean: 是否开启认证。

enable bool: 是否开启认证。

enable Boolean: 是否开启认证。

GetGatewayServiceCustomDomain

Domain string: 自定义域名。
DomainId string: 自定义域名ID。

Domain string: 自定义域名。
DomainId string: 自定义域名ID。

domain String: 自定义域名。
domainId String: 自定义域名ID。

domain string: 自定义域名。
domainId string: 自定义域名ID。

domain str: 自定义域名。
domain_id str: 自定义域名ID。

domain String: 自定义域名。
domainId String: 自定义域名ID。

GetGatewayServiceDomain

Domain string: 域名。
Type string: 域名类型。取值：public：公网。private：私网。

Domain string: 域名。
Type string: 域名类型。取值：public：公网。private：私网。

domain String: 域名。
type String: 域名类型。取值：public：公网。private：私网。

domain string: 域名。
type string: 域名类型。取值：public：公网。private：私网。

domain str: 域名。
type str: 域名类型。取值：public：公网。private：私网。

domain String: 域名。
type String: 域名类型。取值：public：公网。private：私网。

GetGatewayServiceDomainSpec

EnablePublicResolution bool: 开启私网域名公网解析。

EnablePublicResolution bool: 开启私网域名公网解析。

enablePublicResolution Boolean: 开启私网域名公网解析。

enablePublicResolution boolean: 开启私网域名公网解析。

enable_public_resolution bool: 开启私网域名公网解析。

enablePublicResolution Boolean: 开启私网域名公网解析。

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

volcenginecc v0.0.4 published on Monday, Nov 3, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.apig.getGatewayService

On this page

On this page

Using getGatewayService

getGatewayService Result

Supporting Types

GetGatewayServiceAuthSpec

GetGatewayServiceCustomDomain

GetGatewayServiceDomain

GetGatewayServiceDomainSpec

Package Details

On this page

On this page