bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
Data Source schema for Byteplus::APIG::Gateway
Using getGateway
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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>def get_gateway(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput> Note: This function is named LookupGateway in the Go SDK.
public static class GetGateway
{
public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
fn::invoke:
function: bytepluscc:apig/getGateway:getGateway
arguments:
# arguments dictionaryThe 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.
getGateway Result
The following output properties are available:
- Backend
Spec Byteplus.Get Gateway Backend Spec - 后端服务配置信息。
- Comments string
- 网关备注信息。长度限制为0~253个字符。
- Created
Time string - 网关创建时间。
- Custom
Log Byteplus.Get Gateway Custom Log - 自定义日志配置。
- Events
List<Byteplus.
Get Gateway Event> - 事件。
- Gateway
Id string - 网关实例ID。
- Id string
- Uniquely identifies the resource.
- Log
Spec Byteplus.Get Gateway Log Spec - 日志配置。
- Message string
- 网关创建失败、删除失败或异常时的错误信息。
- Monitor
Spec Byteplus.Get Gateway Monitor Spec - 监控配置信息。
- Name string
- 网关名称。
- Network
Spec Byteplus.Get Gateway Network Spec - 网络配置信息。
- Project
Name string - 项目名称。
- Resource
Spec Byteplus.Get Gateway Resource Spec - 资源规格配置信息。
- Status string
- 网关状态,取值:Creating:创建中。CreatedFailed:创建失败。Updating:更新中。Running:运行中。Deleting:删除中。DeletedFailed:删除失败。Abnormal:异常。
- Subnet
Ids List<string> - 子网ID列表。长度限制为1~2个。
- Trace
Spec Byteplus.Get Gateway Trace Spec - 链路追踪配置信息。
- Type string
- 网关类型,取值:standard:标准网关。serverless:Serverless网关(暂不支持)。
- Version string
- 网关版本。
- Vpc
Id string - VPC ID。
- Backend
Spec GetGateway Backend Spec - 后端服务配置信息。
- Comments string
- 网关备注信息。长度限制为0~253个字符。
- Created
Time string - 网关创建时间。
- Custom
Log GetGateway Custom Log - 自定义日志配置。
- Events
[]Get
Gateway Event - 事件。
- Gateway
Id string - 网关实例ID。
- Id string
- Uniquely identifies the resource.
- Log
Spec GetGateway Log Spec - 日志配置。
- Message string
- 网关创建失败、删除失败或异常时的错误信息。
- Monitor
Spec GetGateway Monitor Spec - 监控配置信息。
- Name string
- 网关名称。
- Network
Spec GetGateway Network Spec - 网络配置信息。
- Project
Name string - 项目名称。
- Resource
Spec GetGateway Resource Spec - 资源规格配置信息。
- Status string
- 网关状态,取值:Creating:创建中。CreatedFailed:创建失败。Updating:更新中。Running:运行中。Deleting:删除中。DeletedFailed:删除失败。Abnormal:异常。
- Subnet
Ids []string - 子网ID列表。长度限制为1~2个。
- Trace
Spec GetGateway Trace Spec - 链路追踪配置信息。
- Type string
- 网关类型,取值:standard:标准网关。serverless:Serverless网关(暂不支持)。
- Version string
- 网关版本。
- Vpc
Id string - VPC ID。
- backend
Spec GetGateway Backend Spec - 后端服务配置信息。
- comments String
- 网关备注信息。长度限制为0~253个字符。
- created
Time String - 网关创建时间。
- custom
Log GetGateway Custom Log - 自定义日志配置。
- events
List<Get
Gateway Event> - 事件。
- gateway
Id String - 网关实例ID。
- id String
- Uniquely identifies the resource.
- log
Spec GetGateway Log Spec - 日志配置。
- message String
- 网关创建失败、删除失败或异常时的错误信息。
- monitor
Spec GetGateway Monitor Spec - 监控配置信息。
- name String
- 网关名称。
- network
Spec GetGateway Network Spec - 网络配置信息。
- project
Name String - 项目名称。
- resource
Spec GetGateway Resource Spec - 资源规格配置信息。
- status String
- 网关状态,取值:Creating:创建中。CreatedFailed:创建失败。Updating:更新中。Running:运行中。Deleting:删除中。DeletedFailed:删除失败。Abnormal:异常。
- subnet
Ids List<String> - 子网ID列表。长度限制为1~2个。
- trace
Spec GetGateway Trace Spec - 链路追踪配置信息。
- type String
- 网关类型,取值:standard:标准网关。serverless:Serverless网关(暂不支持)。
- version String
- 网关版本。
- vpc
Id String - VPC ID。
- backend
Spec GetGateway Backend Spec - 后端服务配置信息。
- comments string
- 网关备注信息。长度限制为0~253个字符。
- created
Time string - 网关创建时间。
- custom
Log GetGateway Custom Log - 自定义日志配置。
- events
Get
Gateway Event[] - 事件。
- gateway
Id string - 网关实例ID。
- id string
- Uniquely identifies the resource.
- log
Spec GetGateway Log Spec - 日志配置。
- message string
- 网关创建失败、删除失败或异常时的错误信息。
- monitor
Spec GetGateway Monitor Spec - 监控配置信息。
- name string
- 网关名称。
- network
Spec GetGateway Network Spec - 网络配置信息。
- project
Name string - 项目名称。
- resource
Spec GetGateway Resource Spec - 资源规格配置信息。
- status string
- 网关状态,取值:Creating:创建中。CreatedFailed:创建失败。Updating:更新中。Running:运行中。Deleting:删除中。DeletedFailed:删除失败。Abnormal:异常。
- subnet
Ids string[] - 子网ID列表。长度限制为1~2个。
- trace
Spec GetGateway Trace Spec - 链路追踪配置信息。
- type string
- 网关类型,取值:standard:标准网关。serverless:Serverless网关(暂不支持)。
- version string
- 网关版本。
- vpc
Id string - VPC ID。
- backend_
spec GetGateway Backend Spec - 后端服务配置信息。
- comments str
- 网关备注信息。长度限制为0~253个字符。
- created_
time str - 网关创建时间。
- custom_
log GetGateway Custom Log - 自定义日志配置。
- events
Sequence[Get
Gateway Event] - 事件。
- gateway_
id str - 网关实例ID。
- id str
- Uniquely identifies the resource.
- log_
spec GetGateway Log Spec - 日志配置。
- message str
- 网关创建失败、删除失败或异常时的错误信息。
- monitor_
spec GetGateway Monitor Spec - 监控配置信息。
- name str
- 网关名称。
- network_
spec GetGateway Network Spec - 网络配置信息。
- project_
name str - 项目名称。
- resource_
spec GetGateway Resource Spec - 资源规格配置信息。
- status str
- 网关状态,取值:Creating:创建中。CreatedFailed:创建失败。Updating:更新中。Running:运行中。Deleting:删除中。DeletedFailed:删除失败。Abnormal:异常。
- subnet_
ids Sequence[str] - 子网ID列表。长度限制为1~2个。
- trace_
spec GetGateway Trace Spec - 链路追踪配置信息。
- type str
- 网关类型,取值:standard:标准网关。serverless:Serverless网关(暂不支持)。
- version str
- 网关版本。
- vpc_
id str - VPC ID。
- backend
Spec Property Map - 后端服务配置信息。
- comments String
- 网关备注信息。长度限制为0~253个字符。
- created
Time String - 网关创建时间。
- custom
Log Property Map - 自定义日志配置。
- events List<Property Map>
- 事件。
- gateway
Id String - 网关实例ID。
- id String
- Uniquely identifies the resource.
- log
Spec Property Map - 日志配置。
- message String
- 网关创建失败、删除失败或异常时的错误信息。
- monitor
Spec Property Map - 监控配置信息。
- name String
- 网关名称。
- network
Spec Property Map - 网络配置信息。
- project
Name String - 项目名称。
- resource
Spec Property Map - 资源规格配置信息。
- status String
- 网关状态,取值:Creating:创建中。CreatedFailed:创建失败。Updating:更新中。Running:运行中。Deleting:删除中。DeletedFailed:删除失败。Abnormal:异常。
- subnet
Ids List<String> - 子网ID列表。长度限制为1~2个。
- trace
Spec Property Map - 链路追踪配置信息。
- type String
- 网关类型,取值:standard:标准网关。serverless:Serverless网关(暂不支持)。
- version String
- 网关版本。
- vpc
Id String - VPC ID。
Supporting Types
GetGatewayBackendSpec
- Is
Vke boolWith Flannel Cni Supported - 是否支持VKE Flannel CNI。
- Vke
Pod stringCidr - VKE Pod CIDR。
- Is
Vke boolWith Flannel Cni Supported - 是否支持VKE Flannel CNI。
- Vke
Pod stringCidr - VKE Pod CIDR。
- is
Vke BooleanWith Flannel Cni Supported - 是否支持VKE Flannel CNI。
- vke
Pod StringCidr - VKE Pod CIDR。
- is
Vke booleanWith Flannel Cni Supported - 是否支持VKE Flannel CNI。
- vke
Pod stringCidr - VKE Pod CIDR。
- is_
vke_ boolwith_ flannel_ cni_ supported - 是否支持VKE Flannel CNI。
- vke_
pod_ strcidr - VKE Pod CIDR。
- is
Vke BooleanWith Flannel Cni Supported - 是否支持VKE Flannel CNI。
- vke
Pod StringCidr - VKE Pod CIDR。
GetGatewayCustomLog
GetGatewayCustomLogCustomVariable
- Aliases
In stringLog - 字段别名。
- Key string
- 请求头键。
- Aliases
In stringLog - 字段别名。
- Key string
- 请求头键。
- aliases
In StringLog - 字段别名。
- key String
- 请求头键。
- aliases
In stringLog - 字段别名。
- key string
- 请求头键。
- aliases_
in_ strlog - 字段别名。
- key str
- 请求头键。
- aliases
In StringLog - 字段别名。
- key String
- 请求头键。
GetGatewayCustomLogRequestHeader
- Aliases
In stringLog - 字段别名。
- Key string
- 请求头键。
- Aliases
In stringLog - 字段别名。
- Key string
- 请求头键。
- aliases
In StringLog - 字段别名。
- key String
- 请求头键。
- aliases
In stringLog - 字段别名。
- key string
- 请求头键。
- aliases_
in_ strlog - 字段别名。
- key str
- 请求头键。
- aliases
In StringLog - 字段别名。
- key String
- 请求头键。
GetGatewayCustomLogResponseHeader
- Aliases
In stringLog - 字段别名。
- Key string
- 请求头键。
- Aliases
In stringLog - 字段别名。
- Key string
- 请求头键。
- aliases
In StringLog - 字段别名。
- key String
- 请求头键。
- aliases
In stringLog - 字段别名。
- key string
- 请求头键。
- aliases_
in_ strlog - 字段别名。
- key str
- 请求头键。
- aliases
In StringLog - 字段别名。
- key String
- 请求头键。
GetGatewayEvent
- Code string
- 事件代码。
- Created
Time string - 事件创建时间。
- Data string
- 附带信息。
- Description string
- 事件描述。
- Code string
- 事件代码。
- Created
Time string - 事件创建时间。
- Data string
- 附带信息。
- Description string
- 事件描述。
- code String
- 事件代码。
- created
Time String - 事件创建时间。
- data String
- 附带信息。
- description String
- 事件描述。
- code string
- 事件代码。
- created
Time string - 事件创建时间。
- data string
- 附带信息。
- description string
- 事件描述。
- code str
- 事件代码。
- created_
time str - 事件创建时间。
- data str
- 附带信息。
- description str
- 事件描述。
- code String
- 事件代码。
- created
Time String - 事件创建时间。
- data String
- 附带信息。
- description String
- 事件描述。
GetGatewayLogSpec
- enable bool
- 是否开启日志服务。
- project_
id str - 日志项目ID。
- topic_
id str - 日志主题ID。ProjectId 指定项目里面的日志主题。
GetGatewayMonitorSpec
- Enable bool
- 托管Prometheus(VMP)服务。
- Workspace
Id string - Prometheus工作区ID。
- Enable bool
- 托管Prometheus(VMP)服务。
- Workspace
Id string - Prometheus工作区ID。
- enable Boolean
- 托管Prometheus(VMP)服务。
- workspace
Id String - Prometheus工作区ID。
- enable boolean
- 托管Prometheus(VMP)服务。
- workspace
Id string - Prometheus工作区ID。
- enable bool
- 托管Prometheus(VMP)服务。
- workspace_
id str - Prometheus工作区ID。
- enable Boolean
- 托管Prometheus(VMP)服务。
- workspace
Id String - Prometheus工作区ID。
GetGatewayNetworkSpec
- Subnets
List<Byteplus.
Get Gateway Network Spec Subnet> - 子网配置信息列表。
- Vpc
Id string - VPC ID。
- Vpc
Name string - VPC名称。
- Subnets
[]Get
Gateway Network Spec Subnet - 子网配置信息列表。
- Vpc
Id string - VPC ID。
- Vpc
Name string - VPC名称。
- subnets
List<Get
Gateway Network Spec Subnet> - 子网配置信息列表。
- vpc
Id String - VPC ID。
- vpc
Name String - VPC名称。
- subnets
Get
Gateway Network Spec Subnet[] - 子网配置信息列表。
- vpc
Id string - VPC ID。
- vpc
Name string - VPC名称。
- subnets
Sequence[Get
Gateway Network Spec Subnet] - 子网配置信息列表。
- vpc_
id str - VPC ID。
- vpc_
name str - VPC名称。
- subnets List<Property Map>
- 子网配置信息列表。
- vpc
Id String - VPC ID。
- vpc
Name String - VPC名称。
GetGatewayNetworkSpecSubnet
- Az string
- 可用区。
- Subnet
Id string - 子网ID。
- Subnet
Name string - 子网名称。
- Az string
- 可用区。
- Subnet
Id string - 子网ID。
- Subnet
Name string - 子网名称。
- az String
- 可用区。
- subnet
Id String - 子网ID。
- subnet
Name String - 子网名称。
- az string
- 可用区。
- subnet
Id string - 子网ID。
- subnet
Name string - 子网名称。
- az str
- 可用区。
- subnet_
id str - 子网ID。
- subnet_
name str - 子网名称。
- az String
- 可用区。
- subnet
Id String - 子网ID。
- subnet
Name String - 子网名称。
GetGatewayResourceSpec
- Clb
Spec stringCode - CLB规格编码。CLB规格,取值:small1:小型 I。small2:小型 II。medium1:中型 I。medium2:中型 II。large1:大型 I。large2:大型 II。
- Instance
Spec stringCode - 节点规格,取值:1c2g。2c4g。4c8g。8c16g。
- Network
Type Byteplus.Get Gateway Resource Spec Network Type - 网络类型。默认值为开启公网,开启私网。
- Public
Network intBandwidth - 公网带宽上限,该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
- Public
Network stringBilling Type - 公网网络计费方式,取值:traffic:按实际流量计费。bandwidth:按带宽上限计费。
- Replicas int
- 节点数量。取值限制为2~100。
- Clb
Spec stringCode - CLB规格编码。CLB规格,取值:small1:小型 I。small2:小型 II。medium1:中型 I。medium2:中型 II。large1:大型 I。large2:大型 II。
- Instance
Spec stringCode - 节点规格,取值:1c2g。2c4g。4c8g。8c16g。
- Network
Type GetGateway Resource Spec Network Type - 网络类型。默认值为开启公网,开启私网。
- Public
Network intBandwidth - 公网带宽上限,该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
- Public
Network stringBilling Type - 公网网络计费方式,取值:traffic:按实际流量计费。bandwidth:按带宽上限计费。
- Replicas int
- 节点数量。取值限制为2~100。
- clb
Spec StringCode - CLB规格编码。CLB规格,取值:small1:小型 I。small2:小型 II。medium1:中型 I。medium2:中型 II。large1:大型 I。large2:大型 II。
- instance
Spec StringCode - 节点规格,取值:1c2g。2c4g。4c8g。8c16g。
- network
Type GetGateway Resource Spec Network Type - 网络类型。默认值为开启公网,开启私网。
- public
Network IntegerBandwidth - 公网带宽上限,该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
- public
Network StringBilling Type - 公网网络计费方式,取值:traffic:按实际流量计费。bandwidth:按带宽上限计费。
- replicas Integer
- 节点数量。取值限制为2~100。
- clb
Spec stringCode - CLB规格编码。CLB规格,取值:small1:小型 I。small2:小型 II。medium1:中型 I。medium2:中型 II。large1:大型 I。large2:大型 II。
- instance
Spec stringCode - 节点规格,取值:1c2g。2c4g。4c8g。8c16g。
- network
Type GetGateway Resource Spec Network Type - 网络类型。默认值为开启公网,开启私网。
- public
Network numberBandwidth - 公网带宽上限,该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
- public
Network stringBilling Type - 公网网络计费方式,取值:traffic:按实际流量计费。bandwidth:按带宽上限计费。
- replicas number
- 节点数量。取值限制为2~100。
- clb_
spec_ strcode - CLB规格编码。CLB规格,取值:small1:小型 I。small2:小型 II。medium1:中型 I。medium2:中型 II。large1:大型 I。large2:大型 II。
- instance_
spec_ strcode - 节点规格,取值:1c2g。2c4g。4c8g。8c16g。
- network_
type GetGateway Resource Spec Network Type - 网络类型。默认值为开启公网,开启私网。
- public_
network_ intbandwidth - 公网带宽上限,该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
- public_
network_ strbilling_ type - 公网网络计费方式,取值:traffic:按实际流量计费。bandwidth:按带宽上限计费。
- replicas int
- 节点数量。取值限制为2~100。
- clb
Spec StringCode - CLB规格编码。CLB规格,取值:small1:小型 I。small2:小型 II。medium1:中型 I。medium2:中型 II。large1:大型 I。large2:大型 II。
- instance
Spec StringCode - 节点规格,取值:1c2g。2c4g。4c8g。8c16g。
- network
Type Property Map - 网络类型。默认值为开启公网,开启私网。
- public
Network NumberBandwidth - 公网带宽上限,该字段仅用于“按带宽上限收费”公网网络计费方式。单位为Mbps。取值限制为0~500。默认值为0。
- public
Network StringBilling Type - 公网网络计费方式,取值:traffic:按实际流量计费。bandwidth:按带宽上限计费。
- replicas Number
- 节点数量。取值限制为2~100。
GetGatewayResourceSpecNetworkType
- Enable
Private boolNetwork - 是否启用私网。
- Enable
Public boolNetwork - 是否启用公网。
- Enable
Private boolNetwork - 是否启用私网。
- Enable
Public boolNetwork - 是否启用公网。
- enable
Private BooleanNetwork - 是否启用私网。
- enable
Public BooleanNetwork - 是否启用公网。
- enable
Private booleanNetwork - 是否启用私网。
- enable
Public booleanNetwork - 是否启用公网。
- enable_
private_ boolnetwork - 是否启用私网。
- enable_
public_ boolnetwork - 是否启用公网。
- enable
Private BooleanNetwork - 是否启用私网。
- enable
Public BooleanNetwork - 是否启用公网。
GetGatewayTraceSpec
- Apm
Trace Byteplus.Spec Get Gateway Trace Spec Apm Trace Spec - 应用性能监控全链路版链路追踪配置。
- Enable bool
- 是否启用链路追踪。
- Tls
Trace Byteplus.Spec Get Gateway Trace Spec Tls Trace Spec - 链路追踪配置信息。
- Trace
Type string - 链路追踪类型,取值:tls:日志服务。apm:应用性能监控全链路版。
- Apm
Trace GetSpec Gateway Trace Spec Apm Trace Spec - 应用性能监控全链路版链路追踪配置。
- Enable bool
- 是否启用链路追踪。
- Tls
Trace GetSpec Gateway Trace Spec Tls Trace Spec - 链路追踪配置信息。
- Trace
Type string - 链路追踪类型,取值:tls:日志服务。apm:应用性能监控全链路版。
- apm
Trace GetSpec Gateway Trace Spec Apm Trace Spec - 应用性能监控全链路版链路追踪配置。
- enable Boolean
- 是否启用链路追踪。
- tls
Trace GetSpec Gateway Trace Spec Tls Trace Spec - 链路追踪配置信息。
- trace
Type String - 链路追踪类型,取值:tls:日志服务。apm:应用性能监控全链路版。
- apm
Trace GetSpec Gateway Trace Spec Apm Trace Spec - 应用性能监控全链路版链路追踪配置。
- enable boolean
- 是否启用链路追踪。
- tls
Trace GetSpec Gateway Trace Spec Tls Trace Spec - 链路追踪配置信息。
- trace
Type string - 链路追踪类型,取值:tls:日志服务。apm:应用性能监控全链路版。
- apm_
trace_ Getspec Gateway Trace Spec Apm Trace Spec - 应用性能监控全链路版链路追踪配置。
- enable bool
- 是否启用链路追踪。
- tls_
trace_ Getspec Gateway Trace Spec Tls Trace Spec - 链路追踪配置信息。
- trace_
type str - 链路追踪类型,取值:tls:日志服务。apm:应用性能监控全链路版。
- apm
Trace Property MapSpec - 应用性能监控全链路版链路追踪配置。
- enable Boolean
- 是否启用链路追踪。
- tls
Trace Property MapSpec - 链路追踪配置信息。
- trace
Type String - 链路追踪类型,取值:tls:日志服务。apm:应用性能监控全链路版。
GetGatewayTraceSpecApmTraceSpec
- Api
Key string - API Key。
- Api
Key string - API Key。
- api
Key String - API Key。
- api
Key string - API Key。
- api_
key str - API Key。
- api
Key String - API Key。
GetGatewayTraceSpecTlsTraceSpec
- iam_
user_ strak - Access key。
- iam_
user_ strsk - Secret key。
- project_
id str - 日志项目ID。
- trace_
id str - Trace ID。
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
bytepluscc v0.0.11 published on Wednesday, Jan 21, 2026 by Byteplus
