查询对端网关

最近更新时间:2018-10-26 15:00:52

1. 接口描述

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

本接口(DescribeCustomerGateways)用于查询对端网关列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCustomerGateways
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
CustomerGatewayIds.N Array of String 对端网关ID,例如:cgw-2wqq41m9。每次请求的实例的上限为100。参数不支持同时指定CustomerGatewayIds和Filters。
Filters.N Array of Filter 过滤条件,详见下表:实例过滤条件表。每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定CustomerGatewayIds和Filters。
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
Limit Integer 返回数量,默认为20,最大值为100。

3. 输出参数

参数名称 类型 描述
CustomerGatewaySet Array of CustomerGateway 对端网关对象列表
TotalCount Integer 符合条件的实例数量。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询对端网关

输入示例

https://vpc.tencentcloudapi.com/?Action=DescribeCustomerGateways
&Version=2017-03-12
&<公共请求参数>

输出示例

{
  "Response": {
    "CustomerGatewaySet": [
      {
        "CreatedTime": "2018-03-25 17:52:39",
        "CustomerGatewayId": "cgw-mgp33pll",
        "CustomerGatewayName": "test-cgw",
        "IpAddress": "58.211.1.12"
      }
    ],
    "RequestId": "e5500b60-4964-43c7-8a6c-4bff98f59aeb",
    "TotalCount": 1
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue.Malformed 入参格式不合法。
ResourceNotFound 资源不存在。