创建私网NAT网关

最近更新时间:2024-08-06 02:29:36

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(CreatePrivateNatGateway)用于创建私网NAT网关。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreatePrivateNatGateway。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
NatGatewayName String 私网网关名称
示例值:test
VpcId String 私有网络实例ID。当创建VPC类型私网NAT网关或者专线网关类型私网NAT网关时,此参数必填。
示例值:vpc-m7sr81gh
CrossDomain Boolean 跨域参数。仅当取值为True时,才会支持跨域绑定VPC。
示例值:True
Tags.N Array of Tag 实例标签
VpcType Boolean VPC类型私网NAT网关。仅当取值为True时,才会创建VPC类型私网NAT网关。
示例值:True
CcnId String 云联网类型私网NAT网关需要绑定的云联网实例ID。
示例值:ccn-jq193paf

3. 输出参数

参数名称 类型 描述
PrivateNatGatewaySet Array of PrivateNatGateway 私网网关对象。
TotalCount Integer 创建实例个数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建一个私网NAT网关

创建一个私网NAT网关

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrivateNatGateway
<公共请求参数>

{
    "NatGatewayName": "test",
    "VpcId": "vpc-m7sr81gh"
}

输出示例

{
    "Response": {
        "PrivateNatGatewaySet": [
            {
                "Status": "AVILIABLE",
                "VpcId": "vpc-noanwmed",
                "CrossDomain": false,
                "NatGatewayName": "test_nat",
                "NatGatewayId": "intranat-0g3blj80",
                "TagSet": [],
                "DirectConnectGatewayIds": [],
                "CreatedTime": "2022-10-01 00:00:00"
            }
        ],
        "RequestId": "cd37ad3b-6b94-41f4-bd83-8a2b0d801aae",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
LimitExceeded 超过配额限制。
LimitExceeded.NatGatewayPerVpcLimitExceeded 私有网络创建的NAT网关超过上限。
ResourceNotFound 资源不存在。
UnknownParameter.WithGuess 参数无法识别,可以尝试相似参数代替。
UnsupportedOperation 操作不支持。
UnsupportedOperation.CcnRouteTableNotExist 指定的路由表不存在。
UnsupportedOperation.InsufficientFunds 账户余额不足。
UnsupportedOperation.RecordExists 记录已存在。
UnsupportedOperation.RecordNotExists 记录不存在。
UnsupportedOperation.UnableCrossBorder 不支持跨境。