1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateDirectConnectGateway)用于创建专线网关。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDirectConnectGateway。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DirectConnectGatewayName | 是 | String | 专线网关名称 示例值:test |
NetworkType | 是 | String | 关联网络类型,可选值: 示例值:VPC |
NetworkInstanceId | 是 | String | 示例值:vpc-m7sr81gh |
GatewayType | 否 | String | 网关类型,可选值: 示例值:NAT |
ModeType | 否 | String | 云联网路由发布模式,可选值:standard (标准模式)、exquisite (精细模式)。只有云联网类型专线网关才支持ModeType 。示例值:standard |
Zone | 否 | String | 专线网关可用区 示例值:ap-guangzhou-1 |
HaZoneGroupId | 否 | String | 专线网关高可用区容灾组ID 示例值:ha_gourp_1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DirectConnectGateway | DirectConnectGateway | 专线网关对象。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建一个关联VPC的NAT型专线网关
输入示例
https://vpc.tencentcloudapi.com/?Action=CreateDirectConnectGateway
&DirectConnectGatewayName=test
&NetworkType=VPC
&NetworkInstanceId=vpc-m7sr81gh
&GatewayType=NAT
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectGateway": {
"DirectConnectGatewayId": "dcg-gjug0kul",
"DirectConnectGatewayName": "test",
"DirectConnectGatewayIp": "10.21.0.5",
"EnableBGPCommunity": false,
"VpcId": "vpc-m7sr81gh",
"CcnId": "",
"EnableBGP": false,
"CcnRouteType": "BGP",
"NetworkType": "VPC",
"NetworkInstanceId": "vpc-m7sr81gh",
"GatewayType": "NAT",
"VXLANSupport": [
true
],
"NatGatewayId": "nat-m7dr11gc",
"LocalZone": false,
"Zone": "ap-guangzhou-1",
"ModeType": "standard",
"NewAfc": 0,
"FlowDetailsUpdateTime": "xx",
"EnableFlowDetails": 0,
"AccessNetworkType": "Unknown",
"CreateTime": "2020-09-22 00:00:00"
},
"RequestId": "b8351d12-3c82-4d4b-9d88-972e02ca4620"
}
}
示例2 创建一个关联CCN的标准型专线网关
输入示例
https://vpc.tencentcloudapi.com/?Action=CreateDirectConnectGateway
&DirectConnectGatewayName=test
&NetworkType=CCN
&NetworkInstanceId=ccn-8j0phqix
&GatewayType=NORMAL
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectGateway": {
"DirectConnectGatewayId": "dcg-3vwxt61v",
"DirectConnectGatewayName": "test",
"VpcId": "vpc-ilii3ejt",
"NetworkType": "CCN",
"NetworkInstanceId": "ccn-c1aopa13",
"GatewayType": "NORMAL",
"EnableBGPCommunity": true,
"EnableBGP": true,
"CcnId": "ccn-8j0phqix",
"CcnRouteType": "BGP",
"NatGatewayId": "",
"DirectConnectGatewayIp": "10.21.0.5",
"LocalZone": false,
"Zone": "ap-guangzhou-1",
"ModeType": "standard",
"VXLANSupport": [
true
],
"CreateTime": "0000-00-00 00:00:00",
"NewAfc": 1,
"FlowDetailsUpdateTime": "xx",
"EnableFlowDetails": 0,
"AccessNetworkType": "VXLAN"
},
"RequestId": "b8351d12-3c82-4d4b-9d88-972e02ca4620"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.VpgHaGroupNotFound | 专线网关跨可用区容灾组不存在。 |
InvalidParameterValue.Empty | 缺少参数。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
LimitExceeded | 超过配额限制。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.AppIdMismatch | 资源不在指定的AppId下。 |
UnsupportedOperation.CcnRouteTableNotExist | 指定的路由表不存在。 |
UnsupportedOperation.UnableCrossBorder | 不支持跨境。 |