DescribeNatGateways - 查询NAT网关属性

调用DescribeNatGateways查询已创建的NAT网关。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeNatGateways
*全部资源
*

请求参数

名称类型必填描述示例值
EnsRegionIdstring

ENS 节点 ID。

cn-wuxi-9
NatGatewayIdstring

NAT 网关的 ID。

nat-5t7nh1cfm6kxiszlttr38****
NetworkIdstring

网络 ID。

n-2zeuphj08tt7q3brd****
VSwitchIdstring

交换机 ID。

vsw-5rllcjb3ol6duzjdnbm1o****
Namestring

NAT 网关实例名称。

test0
PageNumberinteger

查询列表的页码。起始值为 1

默认值:1

1
PageSizeinteger

分页查询时设置的每页行数,最大值为 100 行。

默认值:10

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

2818A8F4-5E2B-5611-8732-5ACF7B677059
PageNumberinteger

当前查询页码。

1
TotalCountinteger

查询的 NAT 网关列表条目数。

49
PageSizeinteger

分页查询时每页的行数。

10
NatGatewaysarray<object>

NAT 网关的详细信息。

NatGatewayobject

NAT 网关的详细信息。

EnsRegionIdstring

ENS 节点 ID。

cn-xiangyang-5
NatGatewayIdstring

NAT 网关的 ID。

nat-5t7nh1cfm6kxiszlttr38****
NetworkIdstring

网路 ID。

n-5s2ml1olj0kzaws9n1yrj****
VSwitchIdstring

交换机 ID。

vsw-5szpp1os9m55myirbflfw****
Namestring

NAT 网关实例名称。

test0
CreationTimestring

创建时间。UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-11-22T07:03:32Z
Specstring

NAT 实例规格。

enat.default

示例

正常返回示例

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"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorAn error occurred while call the API.-
400Invalid%sThe specified parameter %s is invalid.参数不正确
400Missing%sYou must specify the parameter %s.参数为必填
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史