调用DescribeNatGateways查询已创建的NAT网关。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ens:DescribeNatGateways | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| EnsRegionId | string | 否 | ENS 节点 ID。 | cn-wuxi-9 |
| NatGatewayId | string | 否 | NAT 网关的 ID。 | nat-5t7nh1cfm6kxiszlttr38**** |
| NetworkId | string | 否 | 网络 ID。 | n-2zeuphj08tt7q3brd**** |
| VSwitchId | string | 否 | 交换机 ID。 | vsw-5rllcjb3ol6duzjdnbm1o**** |
| Name | string | 否 | NAT 网关实例名称。 | test0 |
| NatGatewayIds | array | 否 | NAT 网关的 ID 数组。数组长度：1~100。 | |
| string | 否 | NAT 网关的 ID。 | nat-5****4ik | |
| EnsRegionIds | array | 否 | ENS 节点 ID 数组。数组长度：1~100。 | |
| string | 否 | ENS 节点 ID。 | cn-chengdu-telecom-4 | |
| PageNumber | integer | 否 | 查询列表的页码。起始值为 1。 默认值：1。 | 1 |
| PageSize | integer | 否 | 分页查询时设置的每页行数，最大值为 100 行。 默认值：10。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "2818A8F4-5E2B-5611-8732-5ACF7B677059",
"PageNumber": 1,
"TotalCount": 49,
"PageSize": 10,
"NatGateways": [
{
"EnsRegionId": "cn-xiangyang-5",
"NatGatewayId": "nat-5t7nh1cfm6kxiszlttr38****",
"NetworkId": "n-5s2ml1olj0kzaws9n1yrj****",
"VSwitchId": "vsw-5szpp1os9m55myirbflfw****",
"Name": "test0",
"CreationTime": "2021-11-22T07:03:32Z",
"Spec": "enat.default",
"Status": "Available",
"IpLists": [
{
"UsingStatus": "Idle",
"IpAddress": "8.XX.XX.162",
"AllocationId": "eip-50g****"
}
],
"Tags": [
{
"Value": "",
"Key": "",
"TagKey": "",
"TagValue": ""
}
]
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Invalid%s | The specified parameter %s is invalid. | 参数不正确 |
| 400 | Missing%s | You must specify the parameter %s. | 参数为必填 |
| 400 | ens.interface.error | Failed to call API. | 接口调用发生异常。 |
| 400 | NoPermission | Permission denied. | 没有足够的权限，请联系云账号管理员授予您相应权限。 |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-03-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |