1. 接口描述
本接口（DescribeDirectConnectGateway）用于查询专线网关。
接口请求域名：vpc.api.qcloud.com
2. 输入参数
以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，详情请参见 公共请求参数 页面。其中，此接口的 Action 字段为 DescribeDirectConnectGateway。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| vpcId | 否 | String | 系统分配的私有网络 ID，例如：vpc-dfg5445。 |
| directConnectGatewayId | 否 | String | 系统分配的专线网关 ID，例如：dcg-4d545d。 |
| directConnectGatewayName | 否 | String | 专线网关名称，支持模糊查询。 |
| offset | 否 | Int | 初始行的偏移量，默认为0。 |
| limit | 否 | Int | 每页行数，默认为20，最大支持50。 |
| orderField | 否 | String | 按某个字段排序，目前仅支持 createTime，directConnectGatewayName 排序，默认按 createTime 排序。 |
| orderDirection | 否 | String | 升序（asc）还是降序（desc），默认：desc。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | Int | 公共错误码，0表示成功，其他值表示失败。详见错误码页面的 公共错误码。 |
| message | String | 模块错误信息描述，与接口相关。 |
| totalCount | Int | 查询的专线网关总数。 |
| data.n | Array | VPC 信息组。 |
| data.n.vpcId | String | 系统分配的 vpcId，例如：gz_vpc_266。 |
| data.n.unVpcId | String | 系统分配的 vpc 统一 ID，例如：vpc-d454dd。 |
| data.n.directConnectGatewayName | String | 专线网关名称。 |
| data.n.directConnectGatewayId | String | 系统分配的专线网关 ID，例如：dcg-dgd454。 |
| data.n.type | Int | 专线网关类型；0：非 NAT 网关；1：NAT 网关。 |
| data.n.snatNum | Int | 本端 IP 转换规则个数。 |
| data.n.dnatNum | Int | 对端 IP 转换规则个数。 |
| data.n.snaptNum | Int | 本端源 IP 端口转换规则个数。 |
| data.n.dnaptNum | Int | 本端目的 IP 端口转换规则个数。 |
| data.n.createTime | String | 创建时间。 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码，更多公共错误码详见 VPC错误码。
| 错误码 | 描述 |
|---|---|
| InvalidVpc.NotFound | 无效的 VPC，VPC 资源不存在，请再次核实您输入的资源信息是否正确。 |
| InvalidDirectConnectGateway.NotFound | 无效的专线网关。专线网关资源不存在，请再次核实您输入的资源信息是否正确。 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=DescribeDirectConnectGateway &<公共请求参数> &vpcId=vpc-dfgg190 &directConnectGatewayId=dcg-ddf14d
输出
{
"code":"0",
"message":"",
"totalCount": 1,
"data": [
{
"vpcId": "gz_vpc_20",
"vpcName": "vpc20联调dondon666",
"directConnectGatewayId": "dcg-46i442a7",
"directConnectGatewayName": "apollan",
"directConnectGatewayIp": "10.212.253.59",
"snatNum": 1,
"dnatNum": 0,
"snaptNum": 0,
"dnaptNum": 0,
"createTime": "2016-06-29 19:20:45",
"vpcCidrBlock": "172.17.0.0/16",
"unVpcId": "vpc-kx49lmyv",
"type": 1
}
]
}
