DescribeNatGateways

1. 接口描述

本接口用于查询NAT网关列表。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
regionId	否	String	节点ID。
vpcId	否	String	根据NAT网关所属的VPC网络 ID过滤。
natGatewayIds	否	Array of String	NAT网关ID集合。 实例ID数量上限为100个。
name	否	String	NAT网关名称。 可以在末尾加入*以支持模糊匹配。
status	否	NatStatus	NAT网关状态。
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。
pageNum	否	Integer	返回的分页页码。 默认为1。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
totalCount	Integer	满足过滤条件的NAT网关总数。
dataSet	Array of NatGateway	返回的NAT网关列表。

4. 代码示例

示例

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeNatGateways
<Common Request Params>

Request:
{
  "regionId" : "sample",
  "vpcId" : "sample",
  "natGatewayIds" : null,
  "name" : "sample",
  "status" : "CREATING",
  "pageSize" : null,
  "pageNum" : null
}

Response:
{
  "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453",
  "response": {
    "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453",
    "totalCount": 1,
      "dataSet": [
        {
          "natGatewayId": "<natGatewayId>",
          "vpcId": "<vpcId>",
          "regionId": "asia-east-1",
          "status": "RUNNING",
          "name": "name",
          "subnetIds": ["<subnetId>"],
          "eipIds": ["<eipId>"],
          "resourceGroupId": "resourceGroupId",
          "resourceGroupName": "resourceGroupName",
          "createTime": "2025-04-01T01:01:01Z",
          "expiredTime": "2025-04-01T01:01:01Z"
        }
      ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码