创建NAT网关--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

创建NAT网关

最近更新时间：2025.09.17 17:15:27首次发布时间：2025.09.17 17:15:27

本接口用于创建 NAT 网关。

使用说明

使用限制：
默认情况下，一个私有网络中最多可以创建 1 个 NAT 网关。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=CreateNatGateway&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateNatGateway`	接口名称。当前 API 的名称为 `CreateNatGateway`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
project	String	否	`default`	NAT 网关所属的项目。如果不设置该参数或参数值为空字符串，NAT 网关将加入默认项目 default。
name	String	否	`demo-instance`	NAT 网关的名称。命名规则如下：允许 5~20 个字符。允许汉字、大写字母、小写字母、数字和以下特殊字符：()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。不能包含空格，且不能以正斜线（/）开头。如果不设置该参数，系统会自动生成一个名称。生成的名称与 NAT 网关的 ID 相同。
vpc_identity	String	是	`vpc-lp9z2t****`	NAT 网关所属的私有网络的 ID。您可以调用 ListVPCInstances 接口查询私有网络的 ID。
payment_method	String	是	`PostPay`	NAT 网关的付费方式。取值范围： PostPay：后付费。
billing_method	String	是	`HourUsed`	NAT 网关的计费方式。取值范围： HourUsed：按小时计费。

返回参数

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

参数	类型	示例值	描述
natgw_identity	String	`natgw-xf6lpcbnxbl****`	NAT 网关的 ID。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateNatGateway&Version=2021-04-30
<其他公共参数>
{
    "name": "demo-instance",
    "vpc_identity": "vpc-lp9z2t****",
    "payment_method": "PostPay",
    "billing_method": "HourUsed"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025091217065215DA76692E580C8C****",
        "Action": "CreateNatGateway",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "natgw_identity": "natgw-xf6lpcbnxbl****"
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。