全部产品
Search
文档中心

NAT 网关:DescribeNatGatewayAssociateNetworkInterfaces - 查询VPC NAT关联的弹性网卡列表

更新时间:Nov 28, 2024

VPC NAT网关作为服务资源对象被私网连接服务引用场景下,查询VPC NAT关联的弹性网卡列表,目前该特性暂不开放使用。

调试

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

授权信息

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

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

请求参数

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

NAT 网关所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
NatGatewayIdstring

要查询的 NAT 网关的 ID。

ngw-bp1uewa15k4iy5770****
ResourceGroupIdstring

资源组 ID。

rg-acfmxazdjdhd****
Tagarray<object>

资源标签列表。

object

标签列表。

Keystring

实例的标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

实例的标签键。最多支持输入 20 个标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
5A2CFF0E-5718-45B5-9D4D-70B3FF****
Filterarray<object>

过滤信息,支持传入键值对查询结果进行过滤。

object

过滤信息。

Keystring

入参中的 Filter Key 的取值:

  • ResourceId
说明 Value 中需要填入需要查询的服务资源 ID。
  • NetworkInterfaceId
说明 Value 中需要填入需要查询的弹性网卡 ID。
  • ResourceOwnerId
说明 Value 中需要填入需要查询的服务资源归属的用户 UID。
ResourceId
Valuestring

Value 支持传入多个值,逗号隔开

ep-8psre8c8936596cd****
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

2315DEB7-5E92-423A-91F7-4C1EC9AD****
NextTokenstring

是否拥有下一个查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一个查询开始的令牌。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100,默认值为 20

20
NatGatewayIdstring

VPC NAT 网关的实例 ID。

ngw-bp1uewa15k4iy5770****
TotalCountinteger

总记录数。

1
AssociateNetworkInterfacesarray<object>

VPC NAT 网关关联的弹性网卡列表。

AssociateNetworkInterfaceobject

关联弹性网卡信息详情。

NetworkInterfaceIdstring

弹性网卡 ID。

eni-gw8g131ef2dnbu3k****
ResourceIdstring

服务资源 ID。

ep-8psre8c8936596cd****
ResourceTypestring

服务资源类型。

PrivateLink
ResourceOwnerIdstring

服务资源归属的用户 UID。

138859086900****
IPv4Setsarray<object>

弹性网卡的 IPv4 地址集合。

IPv4Setobject

弹性网卡 IPv4 地址信息。

IPv4Addressstring

弹性网卡的私网 IP 地址。

172.17.**.**
Primaryboolean

是否是主私网 IP 地址。可能值:

  • true:主私网 IP

  • false:辅助私网 IP

true
TunnelIndexstring

隧道索引 ID。

41a5489ea2a0****

示例

正常返回示例

JSON格式

{
  "RequestId": "2315DEB7-5E92-423A-91F7-4C1EC9AD****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "MaxResults": 20,
  "NatGatewayId": "ngw-bp1uewa15k4iy5770****",
  "TotalCount": 1,
  "AssociateNetworkInterfaces": {
    "AssociateNetworkInterface": [
      {
        "NetworkInterfaceId": "eni-gw8g131ef2dnbu3k****",
        "ResourceId": "ep-8psre8c8936596cd****",
        "ResourceType": "PrivateLink",
        "ResourceOwnerId": "138859086900****",
        "IPv4Sets": {
          "IPv4Set": [
            {
              "IPv4Address": "172.17.**.**",
              "Primary": true
            }
          ]
        },
        "TunnelIndex": "41a5489ea2a0****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InstanceNotExist.NatGatewayIdThe NAT gateway instance is not exist.NAT网关实例不存在

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

变更历史

变更时间变更内容概要操作
2024-10-23OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情