1. 接口描述
接口请求域名: dc.tencentcloudapi.com 。
创建专用通道。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDirectConnectTunnel。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
DirectConnectId | 是 | String | 物理专线ID,例如:dc-kd7d06of。 示例值:dc-abcdefgh |
DirectConnectTunnelName | 是 | String | 专用通道名称。 示例值:Test |
DirectConnectOwnerAccount | 否 | String | 物理专线owner,缺省为当前客户(物理专线 owner) 共享专线时这里需要填写共享专线的开发商账号 ID。 示例值:12325464 |
NetworkType | 否 | String | 网络类型,枚举:VPC、CCN、NAT;默认为VPC。VPC:私有网络;CCN:云联网;NAT:NAT网络)。 示例值:VPC |
NetworkRegion | 否 | String | 网络地域。 示例值:ap-guangzhou |
VpcId | 否 | String | 私有网络统一ID,在NetworkType为VPC时必填,且与专线网关所属的VPCID一致;NetworkType为其它组网类型时可不填,内部会统一处理。 示例值:vpc-abcdefgh |
DirectConnectGatewayId | 否 | String | 专线网关ID,例如 dcg-d545ddf。 示例值:dcg-abcdefgh |
Bandwidth | 否 | Integer | 专线带宽,单位:Mbps;默认是物理专线带宽值。 示例值:100 |
RouteType | 否 | String | 路由类型,枚举:BGP、STATIC;默认为BGP 。(BGP :BGP路由;STATIC:静态)。 示例值:BGP |
BgpPeer | 否 | BgpPeer | BgpPeer,用户侧bgp信息,包括Asn和AuthKey。 |
RouteFilterPrefixes.N | 否 | Array of RouteFilterPrefix | 静态路由,用户IDC的网段地址。 |
Vlan | 否 | Integer | vlan,范围:0 ~ 3000。 0:不开启子接口,默认值是非0。 示例值:100 |
TencentAddress | 否 | String | TencentAddress,腾讯侧互联 IP。 示例值:192.168.1.2/30 |
CustomerAddress | 否 | String | CustomerAddress,用户侧互联 IP。 示例值:192.168.1.1/30 |
TencentBackupAddress | 否 | String | TencentBackupAddress,腾讯侧备用互联 IP。 示例值:192.168.1.1/30 |
CloudAttachId | 否 | String | 高速上云服务ID。 示例值:cas-xxxxxxxx |
BfdEnable | 否 | Integer | 是否开启BFD。 示例值:0 |
NqaEnable | 否 | Integer | 是否开启NQA。 示例值:0 |
BfdInfo | 否 | BFDInfo | BFD配置信息。 |
NqaInfo | 否 | NQAInfo | NQA配置信息。 |
Tags.N | 否 | Array of Tag | 标签键值对 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DirectConnectTunnelIdSet | Array of String | 专用通道ID。 示例值:["dcx-abcdefgh"] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建云交换服务通道
创建云交换服务通道
输入示例
POST / HTTP/1.1
Host: dc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDirectConnectTunnel
<公共请求参数>
{
"DirectConnectId": "dc-juystu9z",
"DirectConnectTunnelName": "testvif",
"NetworkType": "CCN",
"NetworkRegion": "ap-guangzhou",
"DirectConnectGatewayId": "dcg-du8uzrih",
"Bandwidth": 100,
"RouteType": "BGP",
"Vlan": 1001
}
输出示例
{
"Response": {
"DirectConnectTunnelIdSet": [
"dcx-inx9ty4u"
],
"RequestId": "4539586b-d0d7-49bb-b351-2036da9ac277"
}
}
示例2 BGP路由模式和云联网专用通道
BGP路由模式和云联网专用通道
输入示例
https://dc.tencentcloudapi.com/?Action=CreateDirectConnectTunnel
&DirectConnectId=dc-abcdefgh
&DirectConnectTunnelName=Test
&NetworkType=CCN
&NetworkRegion=ap-guangzhou
&DirectConnectGatewayId=dcg-abcdefgh
&Bandwidth=100
&RouteType=BGP
&Vlan=100
&TencentAddress=192.168.1.2/30
&CustomerAddress=192.168.1.1/30
&BgpPeer.Asn=65128
&BgpPeer.AuthKey=abcdefg
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelIdSet": [
"dcx-abcdefgh"
],
"RequestId": "24a0d7e5-4c13-49be-aa16-94f698fbef3e"
}
}
示例3 BGP路由模式和共享专线的专用通道
BGP路由模式和共享专线的专用通道
输入示例
https://dc.tencentcloudapi.com/?Action=CreateDirectConnectTunnel
&DirectConnectId=dc-abcdefgh
&DirectConnectTunnelName=Test
&DirectConnectOwnerAccount=240791248
&NetworkType=VPC
&NetworkRegion=ap-guangzhou
&VpcId=vpc-abcdefgh
&DirectConnectGatewayId=dcg-abcdefgh
&Bandwidth=100
&RouteType=BGP
&Vlan=100
&TencentAddress=192.168.1.2/30
&CustomerAddress=192.168.1.1/30
&BgpPeer.Asn=65128
&BgpPeer.AuthKey=abcdefg
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelIdSet": [
"dcx-abcdefgh"
],
"RequestId": "24a0d7e5-4c13-49be-aa16-94f698fbef3e"
}
}
示例4 STATIC路由模式和黑石VPC的专用通道
STATIC路由模式和黑石VPC的专用通道
输入示例
https://dc.tencentcloudapi.com/?Action=CreateDirectConnectTunnel
&DirectConnectId=dc-abcdefgh
&DirectConnectTunnelName=Test
&NetworkType=BMVPC
&NetworkRegion=ap-guangzhou
&VpcId=vpc-abcdefgh
&Bandwidth=100
&RouteType=STATIC
&Vlan=100
&TencentAddress=192.168.1.2/30
&CustomerAddress=192.168.1.1/30
&RouteFilterPrefixes.0.Cidr=192.168.0.0/24
&RouteFilterPrefixes.1.Cidr=192.168.0.0/24
&RouteFilterPrefixes.2.Cidr=192.168.0.0/24
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelIdSet": [
"dcx-abcdefgh"
],
"RequestId": "24a0d7e5-4c13-49be-aa16-94f698fbef3e"
}
}
示例5 BGP路由模式和私有网络VPC的专用通道
BGP路由模式和私有网络VPC的专用通道
输入示例
https://dc.tencentcloudapi.com/?Action=CreateDirectConnectTunnel
&DirectConnectId=dc-abcdefgh
&DirectConnectTunnelName=Test
&NetworkType=VPC
&NetworkRegion=ap-guangzhou
&VpcId=vpc-abcdefgh
&DirectConnectGatewayId=dcg-abcdefgh
&Bandwidth=100
&RouteType=BGP
&Vlan=100
&TencentAddress=192.168.1.2/30
&CustomerAddress=192.168.1.1/30
&BgpPeer.Asn=65128
&BgpPeer.AuthKey=abcdefg
&<公共请求参数>
输出示例
{
"Response": {
"DirectConnectTunnelIdSet": [
"dcx-abcdefgh"
],
"RequestId": "24a0d7e5-4c13-49be-aa16-94f698fbef3e"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.AddressError | 互联IP错误。 |
InvalidParameter.DirectConnectIdIsNotUin | 物理专线不属于该账号。 |
InvalidParameter.UinIsNotExist | 该账号ID不存在。 |
InvalidParameter.VlanConflict | vlan冲突。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.VlanConfLict | vlan冲突。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.DirectConnectLimitExceeded | 物理专线数已达上限。 |
LimitExceeded.DirectConnectTunnelLimitExceeded | 物理专线的专用通道数已达上限。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse.DcVpcIsExist | 物理专线的vpc已经存在。 |
ResourceUnavailable.InsufficientBalance | 对不起您的账号已欠费,欠费状态下无法开通产品,请您先行充值。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.CrossBorderDirectConnectTunnel | 不允许创建跨境专用通道,请您联系我们。 |