有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCustomerGateways。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
CustomerGatewayIds.N Array of String 对端网关ID,例如:cgw-2wqq41m9。每次请求的实例的上限为100。参数不支持同时指定CustomerGatewayIds和Filters。
示例值:cgw-2wqq41m9
Filters.N Array of Filter 过滤条件,详见下表:实例过滤条件表。每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定CustomerGatewayIds和Filters。
  • customer-gateway-id - String - (过滤条件)用户网关唯一ID形如:cgw-mgp33pll
  • customer-gateway-name - String - (过滤条件)用户网关名称形如:test-cgw
  • ip-address - String - (过滤条件)公网地址形如:58.211.1.12

  • 示例值:null
    Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。
    示例值:10

    3. 输出参数

    参数名称 类型 描述
    CustomerGatewaySet Array of CustomerGateway 对端网关对象列表。
    示例值: [ { "CustomerGatewayId": "cgw-mgp33pll", "IpAddress": "58.211.1.12", "CustomerGatewayName": "test-cgw", "CreatedTime": "2018-03-25 17:52:39" } ]
    TotalCount Integer 符合条件的实例数量。
    示例值:1
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询对端网关

    查询对端网关

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeCustomerGateways
    <公共请求参数>
    
    {
        "CustomerGatewayIds": [
            "cgw-mgp33pll"
        ],
        "Filters": [
            {
                "Name": "customer-gateway-name",
                "Values": [
                    "test-cgw"
                ]
            }
        ],
        "Offset": 1,
        "Limit": 1
    }

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.ModuleError 内部模块错误。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。