创建 API 网关实例。 ## 请求说明 API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://docs.volcengine.com/docs/6569/2603628?lang=zh&TagIDs=2%2C286) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://apig.cn\-beijing.volcengineapi.com?Action=CreateGateway&Version=2021\-03\-03 ## 调试 [去调试](https://api.volcengine.com/api-explorer/debug?action=CreateGateway&serviceCode=apig&version=2021-03-03&groupName=) ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |CreateGateway |接口名称。当前 API 的名称为 `CreateGateway`。 | |Version |String |是 |2021\-03\-03 |接口版本。当前 API 的版本为 `2021-03-03`。 | |Name |String |是 |test |网关实例名称。

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

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

* 不能以中划线（\-）开头。 | |Region |String |是 |cn\-beijing |网关实例所属地域。 | |NetworkSpec |Object of [BriefNetworkSpec](https://docs.volcengine.com/docs/6569/1337085#briefnetworkspec) |是 |\- |网络配置。 | |ResourceSpec |Object of [ResourceSpec](https://docs.volcengine.com/docs/6569/1337085#resourcespec) |否 |\- |规格配置。 | |MonitorSpec |Object of [MonitorSpec](https://docs.volcengine.com/docs/6569/1337085#monitorspec) |否 |\- |监控配置。 | |LogSpec |Object of [LogSpec](https://docs.volcengine.com/docs/6569/1337085#logspec) |否 |\- |日志配置。 | |Comments |String |否 |test |网关实例备注信息。

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

* 不填默认为空。 | |Type |String |否 |standard |网关实例类型，取值：

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

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

* **elastic**：弹性网关，实例资源被多用户共享，资源本身可根据业务使用情况进行资源的弹性扩容，无需感知资源底层负载。 | |ProjectName |String |否 |default |网关实例所属项目名称。默认值为 default。 | |TraceSpec |Object of [TraceSpec](https://docs.volcengine.com/docs/6569/1337085#tracespec) |否 |\- |链路追踪配置。 | ### BriefNetworkSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |VpcId |String |是 |vpc\-rrd\*\*\*\* |网关实例所在的私有网络的 ID。 | |SubnetIds |Array of String |是 |["subnet\-5g3\*\*\*\*","subnet\-2fe\*\*\*\*"] |私有网络子网 ID 列表。

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

* 最少需要输入两个不同可用区的子网。 | ### ResourceSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |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 of [NetworkType](https://docs.volcengine.com/docs/6569/1337085#networktype) |否 |\- |网络类型。 | ### MonitorSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Enable |Boolean |是 |true |是否开启托管 Prometheus（VMP）服务。取值：

* **true**：开启。

* **false**：不开启。 | |WorkspaceID |String |是 |e28ae\*\*\*\* |Prometheus 工作区 ID。详情请参见 [创建通用工作区](https://www.volcengine.com/docs/6731/1037488?lang=zh)。

说明

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

| ### LogSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Enable |Boolean |是 |true |是否开启日志服务。取值：

* **true**：开启。

* **false**：不开启。 | |ProjectId |String |是 |fc69\*\*\*\* |日志项目 ID。详情请参见 [创建日志项目](https://www.volcengine.com/docs/6470/112174?lang=zh)。

说明

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

说明

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

| ### TraceSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Enable |Boolean |是 |true |是否开启链路追踪。取值：

* **true**：开启。

* **false**：不开启。 | |TraceType |String |是 |tls |链路追踪类型，取值：

* **tls**：日志服务。

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

说明

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

说明

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

说明

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

| ### NetworkType |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |EnablePublicNetwork |Boolean |是 |true |是否开启公网。取值：

* **true**：开启。

* **false**：不开启。 | |EnablePrivateNetwork |Boolean |是 |true |是否开启私网。取值：

* **true**：开启。

* **false**：不开启。 | ### TLSTraceSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |TraceId |String |否 |0fda\*\*\*\* |Trace ID，取值为空时会生成一个 Trace ID 并创建 Trace 实例。详情请参见 [创建Trace实例](https://www.volcengine.com/docs/6470/2117571?lang=zh)。 | |ProjectId |String |是 |fc69\*\*\*\* |日志项目 ID。详情请参见 [创建日志项目](https://www.volcengine.com/docs/6470/112174?lang=zh)。 | |IAMUserAK |String |否 |AKLTZ\*\*\*\* |密钥 ID（Access Key ID）。详情请参见 [创建访问密钥](https://www.volcengine.com/docs/6257/65000?lang=zh)。 | |IAMUserSK |String |否 |WTJU\*\*\*\* |私有密钥（Secret Access Key）。详情请参见 [创建访问密钥](https://www.volcengine.com/docs/6257/65000?lang=zh)。 | ### APMTraceSpec |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |APIKey |String |是 |ark\-96\*\*\*\* |API Key。详情请参见 [创建 API Key](https://www.volcengine.com/docs/86958/1913532?lang=zh)。 | ## 请求示例 ```json POST https://apig.cn-beijing.volcengineapi.com?Action=CreateGateway&Version=2021-03-03 Content-Type: application/json { "Name": "test", "Region": "cn-beijing", "NetworkSpec": { "VpcId": "vpc-rrd****", "SubnetIds": [ "subnet-5g3****", "subnet-2fe****" ] }, "ResourceSpec": { "Replicas": 3, "CLBSpecCode": "small_1", "NetworkType": { "EnablePublicNetwork": true, "EnablePrivateNetwork": true }, "InstanceSpecCode": "2c4g", "PublicNetworkBandwidth": 20, "PublicNetworkBillingType": "traffic" }, "MonitorSpec": { "Enable": true, "WorkspaceID": "e28ae****" }, "LogSpec": { "Enable": true, "TopicId": "b****", "ProjectId": "fc69****" }, "Comments": "test", "Type": "standard", "ProjectName": "default", "TraceSpec": { "Enable": true, "TraceType": "tls", "APMTraceSpec": { "APIKey": "ark-96****" }, "TLSTraceSpec": { "TraceId": "0fda****", "IAMUserAK": "AKLTZ****", "IAMUserSK": "WTJU****", "ProjectId": "fc69****" } } } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |gd8\*\*\*\* |网关实例 ID。 | ## 返回示例 ```json Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateGateway", "Version": "2021-03-03", "Service": "apig", "Region": "cn-beijing" }, "Result": { "Id": "gd8****" } } ``` ## 错误码本接口错误码如下表所示，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6569/1337089)。 |**HTTP 状态码** |**错误码** |**错误信息** |**说明** | |---|---|---|---| |400 |BalanceNotEnough |The balance in your account and the available vouchers total less than 100 yuan. |当前账户余额不足。请充值账户后重试。 |