1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口（DescribeDirectConnectGateways）用于查询专线网关。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDirectConnectGateways。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| DirectConnectGatewayIds.N | 否 | Array of String | 专线网关唯一ID，形如：dcg-9o233uri。示例值：["dcg-dimeg9zd\r\n","dcg-6eeis68f\r\n","dcg-94cdyvfr\r\n"] |
| Filters.N | 否 | Array of Filter | 过滤条件，参数不支持同时指定DirectConnectGatewayIds和Filters。ID，形如：dcg-9o233uri。IP。NORMAL（普通型）、NAT（NAT型）。VPC（私有网络类型）、CCN（云联网类型）。ID。ID。 |
| Offset | 否 | Integer | 偏移量。 示例值：0 |
| Limit | 否 | Integer | 返回数量。 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合条件的对象数。 示例值：3 |
| DirectConnectGatewaySet | Array of DirectConnectGateway | 专线网关对象数组。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 按ID过滤查询专线网关
输入示例
https://vpc.tencentcloudapi.com/?Action=DescribeDirectConnectGateways
&DirectConnectGatewayIds.0=dcg-dimeg9zd
&DirectConnectGatewayIds.1=dcg-6eeis68f
&DirectConnectGatewayIds.2=dcg-94cdyvfr
&<公共请求参数>输出示例
{
"Response": {
"DirectConnectGatewaySet": [
{
"LocalZone": true,
"NewAfc": 1,
"EnableBGPCommunity": true,
"Zone": "demo",
"FlowDetailsUpdateTime": "demo",
"AccessNetworkType": "demo",
"VXLANSupport": [
true
],
"ModeType": "demo",
"NatGatewayId": "demo",
"DirectConnectGatewayId": "dcg-6eeis68f",
"DirectConnectGatewayName": "shiliangxie_test",
"DirectConnectGatewayIp": "10.6.223.4",
"GatewayType": "NORMAL",
"NetworkType": "CCN",
"NetworkInstanceId": "",
"VpcId": "vpc-jkmjx7pd",
"CcnId": "",
"CcnRouteType": "STATIC",
"EnableBGP": false,
"CreateTime": "2018-10-22 21:22:26",
"HaZoneList": [
"demo"
],
"EnableFlowDetails": 1
},
{
"DirectConnectGatewayId": "dcg-94cdyvfr",
"DirectConnectGatewayName": "test",
"DirectConnectGatewayIp": "10.144.25.62",
"GatewayType": "NORMAL",
"NetworkType": "CCN",
"NetworkInstanceId": "",
"EnableFlowDetails": 1,
"VpcId": "vpc-f796it7v",
"CcnId": "",
"CcnRouteType": "STATIC",
"EnableBGP": false,
"CreateTime": "2018-08-21 11:40:09",
"HaZoneList": [
"demo"
],
"LocalZone": true,
"NewAfc": 1,
"EnableBGPCommunity": true,
"Zone": "demo",
"FlowDetailsUpdateTime": "demo",
"AccessNetworkType": "demo",
"VXLANSupport": [
true
],
"ModeType": "demo",
"NatGatewayId": "demo"
},
{
"DirectConnectGatewayId": "dcg-dimeg9zd",
"DirectConnectGatewayName": "test",
"DirectConnectGatewayIp": "10.144.25.62",
"GatewayType": "NORMAL",
"NetworkType": "CCN",
"NetworkInstanceId": "ccn-atw2c2j1",
"VpcId": "vpc-eg3eig77",
"CcnId": "ccn-atw2c2j1",
"CcnRouteType": "STATIC",
"EnableFlowDetails": 1,
"EnableBGP": false,
"CreateTime": "2018-08-21 11:36:50",
"HaZoneList": [
"demo"
],
"LocalZone": true,
"NewAfc": 1,
"EnableBGPCommunity": true,
"Zone": "demo",
"FlowDetailsUpdateTime": "demo",
"AccessNetworkType": "demo",
"VXLANSupport": [
true
],
"ModeType": "demo",
"NatGatewayId": "nat"
}
],
"TotalCount": 3,
"RequestId": "1b64d03b-7d2d-4d9b-b46e-49de115ac283"
}
}示例2 多条件过滤查询专线网关列表
输入示例
https://vpc.tencentcloudapi.com/?Action=DescribeDirectConnectGateways
&Filters.0.Name=direct-connect-gateway-name
&Filters.0.Values.0=test
&Filters.1.Name=gateway-type
&Filters.1.Values.0=NORMAL
&Filters.2.Name=vpc-id
&Filters.2.Values.0=vpc-f796it7v
&Filters.2.Values.1=vpc-jkmjx7pd
&<公共请求参数>输出示例
{
"Response": {
"DirectConnectGatewaySet": [
{
"DirectConnectGatewayId": "dcg-94cdyvfr",
"DirectConnectGatewayName": "test",
"DirectConnectGatewayIp": "10.144.25.62",
"GatewayType": "NORMAL",
"NetworkType": "CCN",
"NetworkInstanceId": "",
"VpcId": "vpc-f796it7v",
"CcnId": "",
"CcnRouteType": "STATIC",
"EnableBGP": false,
"EnableFlowDetails": 1,
"CreateTime": "2018-08-21 11:40:09",
"HaZoneList": [
"demo"
],
"LocalZone": true,
"NewAfc": 1,
"EnableBGPCommunity": true,
"Zone": "demo",
"FlowDetailsUpdateTime": "demo",
"AccessNetworkType": "demo",
"VXLANSupport": [
true
],
"ModeType": "demo",
"NatGatewayId": "demo"
},
{
"DirectConnectGatewayId": "dcg-6eeis68f",
"DirectConnectGatewayName": "shiliangxie_test",
"DirectConnectGatewayIp": "10.6.223.4",
"GatewayType": "NORMAL",
"NetworkType": "CCN",
"NetworkInstanceId": "",
"VpcId": "vpc-jkmjx7pd",
"CcnId": "",
"CcnRouteType": "STATIC",
"EnableBGP": false,
"CreateTime": "2018-10-22 21:22:26",
"HaZoneList": [
"demo"
],
"LocalZone": true,
"NewAfc": 1,
"EnableBGPCommunity": true,
"Zone": "demo",
"FlowDetailsUpdateTime": "demo",
"AccessNetworkType": "demo",
"EnableFlowDetails": 1,
"VXLANSupport": [
true
],
"ModeType": "demo",
"NatGatewayId": "demo"
}
],
"TotalCount": 2,
"RequestId": "8c77ce69-68e2-4dfa-94ea-a6df5c914f52"
}
}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.ModuleError | 内部模块错误。 |
| InvalidParameter.Coexist | 参数不支持同时指定。 |
| InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
| InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
| InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.ActionNotFound | 接口不存在。 |
