查询专线网关

最近更新时间:2019-01-17 20:23:20

1. 接口描述

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

本接口(DescribeDirectConnectGateways)用于查询专线网关。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDirectConnectGateways
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
DirectConnectGatewayIds.N Array of String 专线网关唯一ID,形如:dcg-9o233uri
Filters.N Array of Filter 过滤条件,参数不支持同时指定DirectConnectGatewayIdsFilters
  • direct-connect-gateway-id - String - 专线网关唯一ID,形如:dcg-9o233uri
  • direct-connect-gateway-name - String - 专线网关名称,默认模糊查询。
  • direct-connect-gateway-ip - String - 专线网关IP
  • gateway-type - String - 网关类型,可选值:NORMAL(普通型)、NAT(NAT型)。
  • network-type- String - 网络类型,可选值:VPC(私有网络类型)、CCN(云联网类型)。
  • ccn-id - String - 专线网关所在云联网ID
  • vpc-id - String - 专线网关所在私有网络ID
  • Offset Integer 偏移量。
    Limit Integer 返回数量。

    3. 输出参数

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

    4. 示例

    示例1 按ID过滤查询专线网关

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeDirectConnectGateways
    &DirectConnectGatewayIds.0=dcg-dimeg9zd
    &DirectConnectGatewayIds.1=dcg-6eeis68f
    &DirectConnectGatewayIds.2=dcg-94cdyvfr
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "DirectConnectGatewaySet": [
          {
            "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"
          },
          {
            "DirectConnectGatewayId": "dcg-94cdyvfr",
            "DirectConnectGatewayName": "test",
            "DirectConnectGatewayIp": "10.144.25.62",
            "GatewayType": "NORMAL",
            "NetworkType": "CCN",
            "NetworkInstanceId": "",
            "VpcId": "vpc-f796it7v",
            "CcnId": "",
            "CcnRouteType": "STATIC",
            "EnableBGP": false,
            "CreateTime": "2018-08-21 11:40:09"
          },
          {
            "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",
            "EnableBGP": false,
            "CreateTime": "2018-08-21 11:36:50"
          }
        ],
        "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,
            "CreateTime": "2018-08-21 11:40:09"
          },
          {
            "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"
          }
        ],
        "TotalCount": 2,
        "RequestId": "8c77ce69-68e2-4dfa-94ea-a6df5c914f52"
      }
    }

    5. 开发者资源

    API Explorer

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

    SDK

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

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue 参数值不合法。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.TooLong 无效参数值。参数值太长。

    如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >