DescribeNetworkInterfaceAttribute - 查詢網卡屬性 - Elastic Compute Service

指定彈性網卡ID，查詢一個網卡的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeNetworkInterfaceAttribute

get

*NetworkInterface

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	彈性網卡所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
Tag	array<object>	否	說明該參數暫未開放使用。
	object	否	說明該參數暫未開放使用。
Key	string	否	說明該參數暫未開放使用。	TestKey
Value	string	否	說明該參數暫未開放使用。	TestValue
RegionId	string	是	彈性網卡所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。	cn-hangzhou
NetworkInterfaceId	string	是	彈性網卡 ID。	eni-bp67acfmxazb4p****
Attribute	string	否	彈性網卡屬性，取值範圍： attachment：查詢中繼網卡的成員網卡的掛載資訊（該參數正在邀測中，暫未開放使用）。 connectionTrackingConfiguration：網路連接跟蹤配置資訊。預設值：	attachment

返回參數

名稱	類型	描述	樣本值
	object	網卡資訊集合。
CreationTime	string	彈性網卡的建立時間。	2019-12-25T12:31:31Z
VpcId	string	彈性網卡所屬的Virtual Private Cloud ID。	vpc-bp67acfmxazb4p****
Type	string	彈性網卡類型。可能值： Primary：主網卡。 Secondary：輔助彈性網卡。	Secondary
Status	string	彈性網卡的狀態。可能值： Available：可用。 Attaching：附加中。 InUse：已附加。 Detaching：分離中。 Deleting：刪除中。預設值：空，表示查詢所有狀態。	Available
NetworkInterfaceTrafficMode	string	彈性網卡的通訊模式。可能值： Standard：使用 TCP 通訊模式。 HighPerformance：開啟 ERI（Elastic RDMA Interface）介面，使用 RDMA 通訊模式。說明 HighPerformance 參數值只支援 RDMA 增強型執行個體規格類型系列 c7re。	Standard
NetworkInterfaceName	string	彈性網卡的名稱。	my-eni-name
MacAddress	string	彈性網卡的 MAC 位址。	00:16:3e:12::
QueuePairNumber	integer	說明該參數正在邀測中，暫未開放使用。	22
NetworkInterfaceId	string	彈性網卡的 ID。	eni-bp125p95hhdhn3ot****
ServiceID	integer	彈性網卡對應的虛商 ID。	12345678910
InstanceId	string	彈性網卡附加的執行個體 ID。說明由其他阿里雲服務管理和控制的彈性網卡不會返回執行個體 ID。	i-bp1e2l6djkndyuli****
OwnerId	string	彈性網卡的所屬帳號 ID。	123456****
ServiceManaged	boolean	該彈性網卡的使用者是否為雲產品或虛商。	true
VSwitchId	string	彈性網卡所屬的交換器 ID。	vsw-bp1s5fnvk4gn2tws0****
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Description	string	彈性網卡描述。	testDescription
ResourceGroupId	string	執行個體所屬的企業資源組 ID。使用該參數過濾資源時，資源數量不能超過 1000 個。說明不支援預設資源群組過濾。	rg-bp67acfmxazb4p****
ZoneId	string	可用性區域 ID。	cn-hangzhou-g
PrivateIpAddress	string	彈性網卡的私網 IP 位址。	10.1..
QueueNumber	integer	彈性網卡的隊列數。彈性網卡為主網卡：返回執行個體規格預設的主網卡隊列數。彈性網卡為輔助網卡：輔助網卡是已附加（InUse）狀態：輔助網卡沒有修改過隊列數，則返回執行個體規格預設的輔助網卡隊列數。輔助網卡修改過隊列數，則返回修改後的隊列數。輔助網卡是可用（Available）狀態：輔助網卡未修改過隊列數，則傳回值為空白。輔助網卡修改過隊列數，則返回修改後的隊列數。	8
SecurityGroupIds	object
SecurityGroupId	array	彈性網卡所屬的安全性群組集合。
	string	彈性網卡所屬的安全性群組。	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	彈性網卡輔助私人 IP 位址關聯的彈性公網 IP。
PublicIpAddress	string	彈性公網 IP 位址。	116.62..
AllocationId	string	彈性公網 IP 的 ID。	null
Attachment	object	說明該參數正在邀測中，暫未開放使用。
DeviceIndex	integer	說明該參數正在邀測中，暫未開放使用。	hide
InstanceId	string	說明該參數正在邀測中，暫未開放使用。	hide
TrunkNetworkInterfaceId	string	說明該參數正在邀測中，暫未開放使用。	hide
MemberNetworkInterfaceIds	object
MemberNetworkInterfaceId	array	說明該參數正在邀測中，暫未開放使用。
	string	說明該參數正在邀測中，暫未開放使用。	hide
NetworkCardIndex	integer	網卡掛載指定的物理網卡索引。如果網卡是未掛載（Available）狀態或者掛載時未指定索引，則不返回此值。如果網卡是已掛載（InUse）狀態且掛載時指定，此值表示網卡掛載指定的物理網卡索引。	0
PrivateIpSets	object
PrivateIpSet	array<object>	彈性網卡的私網 IP 位址資訊集合。
	array<object>	彈性網卡的私網 IP 位址資訊。
PrivateIpAddress	string	彈性網卡的私網 IP 位址。	172.17..
Primary	boolean	是否是主私網 IP 位址。可能值： true：主私網 IP。 false：輔助私網 IP。	true
AssociatedPublicIp	object	彈性網卡輔助私人 IP 位址關聯的彈性公網 IP。
PublicIpAddress	string	彈性公網 IP 位址。	116.62..
AllocationId	string	說明該參數正在邀測中，暫未開放使用。	null
Ipv6Sets	object
Ipv6Set	array<object>	彈性網卡已指派的 IPv6 地址清單。
	object	彈性網卡已指派的 ipv6 地址。
Ipv6Address	string	為彈性網卡指定的 IPv6 地址。	2001:db8:1234:1a00::****
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	彈性網卡已指派的 IPv4 首碼集合。
	object	已指派的 IPv4 首碼。
Ipv4Prefix	string	彈性網卡已指派的 IPv4 首碼。	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	彈性網卡已指派的 IPv6 首碼集合。
	object
Ipv6Prefix	string	彈性網卡已指派的 IPv6 首碼。	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	彈性網卡的標籤集合。
	object	彈性網卡的標籤資訊。
TagValue	string	標籤值。	TestValue
TagKey	string	標籤鍵。	TestKey
BondInterfaceSpecification	object	說明該參數正在邀測中，暫未開放使用。
BondMode	string	說明該參數正在邀測中，暫未開放使用。	null
SlaveInterfaceSpecification	object
SlaveInterfaceSpecificationSet	array<object>	說明該參數正在邀測中，暫未開放使用。
	object	說明該參數正在邀測中，暫未開放使用。
SlaveNetworkInterfaceId	string	說明該參數正在邀測中，暫未開放使用。	null
WorkState	string	說明該參數正在邀測中，暫未開放使用。	null
BondNetworkInterfaceId	string	說明該參數正在邀測中，暫未開放使用。	null
SlaveInterfaceSpecification	object	說明該參數正在邀測中，暫未開放使用。
SlaveNetworkInterfaceId	string	說明該參數正在邀測中，暫未開放使用。	null
WorkState	string	說明該參數正在邀測中，暫未開放使用。	null
BondNetworkInterfaceId	string	說明該參數正在邀測中，暫未開放使用。	null
DeleteOnRelease	boolean	釋放執行個體時是否保留網卡。可能值： true：不保留。 false：保留。	true
TcpOptionAddressEnabled	string	說明該參數正在邀測中，暫未開放使用。	null
NetworkInterfaceTrafficConfig	object	彈性網卡通訊參數
NetworkInterfaceTrafficMode	string	彈性網卡的通訊模式。	HighPerformance
QueueNumber	integer	彈性網卡隊列數。	8
QueuePairNumber	integer	RDMA 網卡隊列數。	8
ConnectionTrackingConfiguration	object	網路連接跟蹤配置資訊集合。使用該參數前，請認真閱讀連線逾時管理。說明僅當入參`Attribute`取值為：`connectionTrackingConfiguration`時，返回該參數。
TcpEstablishedTimeout	integer	已建狀態的 TCP 連線逾時時間，單位：s（秒）。可能值：[30, 60, 80, 100, 200, 300, 500, 700, 910]。	910
TcpClosedAndTimeWaitTimeout	integer	TCP 等待與關閉逾時時間，單位：s（秒）。可能值：3~15 內的整數。說明如果您的 ECS 執行個體配合 NLB/CLB 使用，`TIME_WAIT`狀態的連線逾時時間預設值為 15 秒。	3
UdpTimeout	integer	UDP 流逾時時間。單位：s（秒）。可能值：[10, 20, 30, 60, 80, 100]。說明如果您的 ECS 執行個體配合 NLB/CLB 使用，預設值為 100 秒。	30
SourceDestCheck	boolean	該參數暫未開放使用。	false
EnhancedNetwork	object	該參數暫未開放使用。
EnableSriov	boolean	該參數暫未開放使用。	false
EnableRss	boolean	說明該參數暫未開放使用。	true
VirtualFunctionTotalQueueNumber	integer
VirtualFunctionQuantity	integer
QoSConfig	object	QoS 限速設定
EnableQoS	boolean	是否啟用 QoS 限速設定
QoS	object	QoS 限速設定
BandwidthTx	integer	最大內網出方向頻寬節流設定	50000
BandwidthRx	integer	最大內網入方向頻寬節流設定	50000
PpsTx	integer	內網出方向網路收發包能力	50000
PpsRx	integer	內網入方向網路收發包能力	50000
ConcurrentConnections	integer	會話數量的最大值	50000

樣本

正常返回樣本

JSON格式

{
  "CreationTime": "2019-12-25T12:31:31Z",
  "VpcId": "vpc-bp67acfmxazb4p****",
  "Type": "Secondary",
  "Status": "Available",
  "NetworkInterfaceTrafficMode": "Standard",
  "NetworkInterfaceName": "my-eni-name",
  "MacAddress": "00:16:3e:12:**:**",
  "QueuePairNumber": 22,
  "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
  "ServiceID": 12345678910,
  "InstanceId": "i-bp1e2l6djkndyuli****",
  "OwnerId": "123456****",
  "ServiceManaged": true,
  "VSwitchId": "vsw-bp1s5fnvk4gn2tws0****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Description": "testDescription",
  "ResourceGroupId": "rg-bp67acfmxazb4p****",
  "ZoneId": "cn-hangzhou-g",
  "PrivateIpAddress": "10.1.**.**",
  "QueueNumber": 8,
  "SecurityGroupIds": {
    "SecurityGroupId": [
      "sg-bp18kz60mefsicfg****"
    ]
  },
  "AssociatedPublicIp": {
    "PublicIpAddress": "116.62.**.**",
    "AllocationId": "null"
  },
  "Attachment": {
    "DeviceIndex": 0,
    "InstanceId": "hide",
    "TrunkNetworkInterfaceId": "hide",
    "MemberNetworkInterfaceIds": {
      "MemberNetworkInterfaceId": [
        "hide"
      ]
    },
    "NetworkCardIndex": 0
  },
  "PrivateIpSets": {
    "PrivateIpSet": [
      {
        "PrivateIpAddress": "172.17.**.**",
        "Primary": true,
        "AssociatedPublicIp": {
          "PublicIpAddress": "116.62.**.**",
          "AllocationId": "null"
        }
      }
    ]
  },
  "Ipv6Sets": {
    "Ipv6Set": [
      {
        "Ipv6Address": "2001:db8:1234:1a00::****"
      }
    ]
  },
  "Ipv4PrefixSets": {
    "Ipv4PrefixSet": [
      {
        "Ipv4Prefix": "192.168.**.0/28"
      }
    ]
  },
  "Ipv6PrefixSets": {
    "Ipv6PrefixSet": [
      {
        "Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
      }
    ]
  },
  "Tags": {
    "Tag": [
      {
        "TagValue": "TestValue",
        "TagKey": "TestKey"
      }
    ]
  },
  "BondInterfaceSpecification": {
    "BondMode": "null",
    "SlaveInterfaceSpecification": {
      "SlaveInterfaceSpecificationSet": [
        {
          "SlaveNetworkInterfaceId": "null",
          "WorkState": "null",
          "BondNetworkInterfaceId": "null"
        }
      ]
    }
  },
  "SlaveInterfaceSpecification": {
    "SlaveNetworkInterfaceId": "null",
    "WorkState": "null",
    "BondNetworkInterfaceId": "null"
  },
  "DeleteOnRelease": true,
  "TcpOptionAddressEnabled": "null",
  "NetworkInterfaceTrafficConfig": {
    "NetworkInterfaceTrafficMode": "HighPerformance",
    "QueueNumber": 8,
    "QueuePairNumber": 8
  },
  "ConnectionTrackingConfiguration": {
    "TcpEstablishedTimeout": 910,
    "TcpClosedAndTimeWaitTimeout": 3,
    "UdpTimeout": 30
  },
  "SourceDestCheck": false,
  "EnhancedNetwork": {
    "EnableSriov": false,
    "EnableRss": true,
    "VirtualFunctionTotalQueueNumber": 0,
    "VirtualFunctionQuantity": 0
  },
  "QoSConfig": {
    "EnableQoS": true,
    "QoS": {
      "BandwidthTx": 50000,
      "BandwidthRx": 50000,
      "PpsTx": 50000,
      "PpsRx": 50000,
      "ConcurrentConnections": 50000
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParameter	%s	缺失參數，請檢查參數是否完整。
400	UnsupportedParameter	%s	不支援參數。
400	InvalidParameter	%s	無效的參數。
400	InvalidInstanceID.Malformed	%s	參數 InstanceId 格式錯誤。
400	Forbidden.RegionId	%s	當前地區暫時沒有提供該服務。
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	指定的 RegionId 不合法。
403	InvalidUserType.NotSupported	%s	您當前的帳號不支援此操作。
403	Abs.InvalidAccount.NotFound	%s	您的阿里雲帳號不存在，或者您的 AccessKey 已經到期。
403	Forbidden.NotSupportRAM	%s	暫不支援RAM使用者執行該操作。
403	Forbidden.SubUser	%s	您的帳號沒有操作此資源的許可權，請向主帳號申請相關的許可權。
403	InvalidParameter	%s
404	InvalidEniId.NotFound	%s

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。