租户端 网络 私有网络（VPC） 专线网关相关接口 DescribeDirectConnectGateways

DescribeDirectConnectGateways

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名： vpc.api3.gsesgpucloud.com。

本接口（DescribeDirectConnectGateways）用于查询专线网关。

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

接口更新时间：2023-01-13 17:23:10。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeDirectConnectGateways
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
DirectConnectGatewayIds 否 否 Array of String 专线网关唯一ID，形如：dcg-9o233uri。
示例值：
Filters 否 否 Array of Filter 过滤条件，参数不支持同时指定DirectConnectGatewayIds和Filters。
  • 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 否 否 Uint64 偏移量。
    示例值：
    Limit 否 否 Uint64 返回数量。
    示例值：

    3. 输出参数

    参数名称 类型 描述
    TotalCount Uint64 符合条件的对象数。
    示例值：
    DirectConnectGatewaySet DirectConnectGateway 专线网关对象数组。
    示例值：查看
    RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

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

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