创建专线网关

最近更新时间:2018-10-26 15:01:01

1. 接口描述

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

本接口(CreateDirectConnectGateway)用于创建专线网关。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateDirectConnectGateway
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DirectConnectGatewayName String 专线网关名称
NetworkType String 关联网络类型,可选值:
  • VPC - 私有网络
  • CCN - 云联网
  • NetworkInstanceId String
  • NetworkType 为 VPC 时,这里传值为私有网络实例ID
  • NetworkType 为 NAT 时,这里传值为云联网实例ID
  • GatewayType String 网关类型,可选值:
  • NORMAL - (默认)标准型,注:云联网只支持标准型
  • NAT - NAT型
  • NAT类型支持网络地址转换配置,类型确定后不能修改;一个私有网络可以创建一个NAT类型的专线网关和一个非NAT类型的专线网关

    3. 输出参数

    参数名称 类型 描述
    DirectConnectGateway DirectConnectGateway 专线网关对象。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建一个关联VPC的NAT型专线网关

    输入示例

    https://vpc.tencentcloudapi.com/?Action=CreateDirectConnectGateway
    &<公共请求参数>
    &DirectConnectGatewayName=test
    &NetworkType=VPC
    &NetworkInstanceId=vpc-m7sr81gh
    &GatewayType=NAT

    输出示例

    {
      "Response": {
        "DirectConnectGateway": {
          "CreatedTime": "0000-00-00 00:00:00",
          "DirectConnectGatewayId": "dcg-gjug0kul",
          "DirectConnectGatewayName": "test",
          "DirectConnectTunnelCount": 8,
          "GatewayType": "NAT",
          "NetworkInstanceId": "vpc-m7sr81gh",
          "NetworkType": "VPC",
          "VpcId": "vpc-m7sr81gh"
        },
        "RequestId": "b8351d12-3c82-4d4b-9d88-972e02ca4620"
      }
    }

    示例2 创建一个关联CCN的标准型专线网关

    输入示例

    https://vpc.tencentcloudapi.com/?Action=CreateDirectConnectGateway
    &<公共请求参数>
    &DirectConnectGatewayName=test
    &NetworkType=CCN
    &NetworkInstanceId=ccn-8j0phqix

    输出示例

    {
      "Response": {
        "DirectConnectGateway": {
          "CreateTime": "0000-00-00 00:00:00",
          "DirectConnectGatewayId": "dcg-3vwxt61v",
          "DirectConnectGatewayName": "test",
          "DirectConnectTunnelCount": 0,
          "GatewayType": "NORMAL",
          "NetworkInstanceId": "ccn-c1aopa13",
          "NetworkType": "CCN",
          "VpcId": "vpc-ilii3ejt"
        },
        "RequestId": "b8351d12-3c82-4d4b-9d88-972e02ca4620"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码