创建 API 网关实例。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=CreateGateway&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：CreateGateway

要执行的操作，取值：CreateGateway。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

Name string 必选示例值：test

网关实例名称。

同一个地域下，名称必须唯一。

支持大小写字母、数字和中划线（-），长度限制为 2~63 个字符。

不能以中划线（-）开头。

Region string 必选示例值：cn-beijing

网关实例所属地域。

NetworkSpec object 可选示例值：-

网络配置。

VpcId string 必选示例值：vpc-rrd****

网关实例所在的私有网络的 ID。

SubnetIds string[] 可选示例值：["subnet-5g3****","subnet-2fe****"]

私有网络子网 ID 列表。

子网必须是上述私有网络的子网。

最少需要输入两个不同可用区的子网。

ResourceSpec object 可选示例值：-

规格配置。

Replicas integer 必选示例值：3

节点数量。整数形式，取值范围为 2~100。

InstanceSpecCode string 必选示例值：2c4g

节点规格，取值：

1c2g。

2c4g。

4c8g。

8c16g。

CLBSpecCode string 必选示例值：small_1

CLB 规格，取值：

small_1：小型 I。

small_2：小型 II。

medium_1：中型 I。

medium_2：中型 II。

large_1：大型 I。

large_2：大型 II。

PublicNetworkBillingType string 必选示例值：traffic

公网网络计费方式，取值：

traffic：按实际流量计费。

bandwidth：按带宽上限计费。

PublicNetworkBandwidth integer 可选示例值：20

公网带宽上限。单位为 Mbps，取值范围为 0~500，默认值为 0，表示不设置带宽上限，流量可占用全部带宽。

说明

当ResourceSpec.PublicNetworkBillingType取值为 bandwidth 时，需要配置本参数。

NetworkType object 可选示例值：-

网络类型。

EnablePublicNetwork boolean 必选示例值：true

是否开启公网。取值：

true：开启。

false：不开启。

EnablePrivateNetwork boolean 必选示例值：true

是否开启私网。取值：

true：开启。

false：不开启。

MonitorSpec object 可选示例值：-

监控配置。

Enable boolean 必选示例值：true

是否开启托管 Prometheus（VMP）服务。取值：

true：开启。

false：不开启。

WorkspaceID string 必选示例值：e28ae****

Prometheus 工作区 ID。详情请参见创建通用工作区。

说明

当MonitorSpec.Enable值为 true 时，需要配置本参数。

LogSpec object 可选示例值：-

日志配置。

Enable boolean 必选示例值：true

是否开启日志服务。取值：

true：开启。

false：不开启。

ProjectId string 必选示例值：fc69****

日志项目 ID。详情请参见创建日志项目。

说明

当LogSpec.Enable值为 true 时，需要配置本参数。

TopicId string 可选示例值：b****

日志主题 ID，取值为空时会在当前项目中生成名称为“网关实例 ID - accessLog”的主题。详情请参见创建日志主题。

说明

当LogSpec.Enable值为 true 时，需要配置本参数。

Comments string 可选示例值：test

网关实例备注信息。

字符串形式，长度限制为 0~253 个字符。

不填默认为空。

Type string 可选示例值：standard

网关实例类型，取值：

standard：（默认值）标准网关，提供完整的网关功能，支持对接多种后端服务。

serverless：对于火山引擎函数服务（veFaaS），API 网关特别提供了 Serverless 类型的网关实例。

elastic：弹性网关，实例资源被多用户共享，资源本身可根据业务使用情况进行资源的弹性扩容，无需感知资源底层负载。

ProjectName string 可选示例值：default

网关实例所属项目名称。默认值为 default。

TraceSpec object 可选示例值：-

链路追踪配置。

Enable boolean 必选示例值：true

是否开启链路追踪。取值：

true：开启。

false：不开启。

TraceType string 必选示例值：tls

链路追踪类型，取值：

tls：日志服务。

apm：应用性能监控全链路版。

说明

当TraceSpec.Enable值为 true 时，需要配置本参数。

TLSTraceSpec object 可选示例值：-

日志服务链路追踪配置。

说明

当TraceSpec.TraceType值为 tls 时，需要配置本参数。

TraceId string 可选示例值：0fda****

Trace ID，取值为空时会生成一个 Trace ID 并创建 Trace 实例。详情请参见创建 Trace 实例。

ProjectId string 必选示例值：fc69****

日志项目 ID。详情请参见创建日志项目。

IAMUserAK string 可选示例值：AKLTZ****

密钥 ID（Access Key ID）。详情请参见创建访问密钥。

IAMUserSK string 可选示例值：WTJU****

私有密钥（Secret Access Key）。详情请参见创建访问密钥。

APMTraceSpec object 可选示例值：-

应用性能监控全链路版链路追踪配置。

说明

当TraceSpec.TraceType值为 apm 时，需要配置本参数。

APIKey string 必选示例值：ark-96****

API Key。详情请参见创建 API Key。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Id string 示例值：gd8****

网关实例 ID。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	BalanceNotEnough	The balance in your account and the available vouchers total less than 100 yuan.	当前账户余额不足。请充值账户后重试。
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
400	MissingParameter	The required parameter %s is missing.	缺少必要的请求参数。请确认参数后重试。
400	QuotaExceeded	%s has exceeded the quota.	指定资源的配额达到上限。请提升相关资源配额或删除无用资源，预留出配额后重试。
403	OperationDenied	Operation is denied because %s.	操作不合法。请修改后重试。
404	ResourceNotFound	The specified resource %s %s cannot be found.	指定资源找不到。请确认参数后重试。
409	DuplicatedResource	Resource %s %s already exists.	资源已重复。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。