查詢一個或多個彈性網卡(ENI)的詳細資料。
介面說明
介面說明
DescribeNetworkInterfaces介面支援指定MaxResults或NextToken參數通過分頁查詢。具體使用說明:
-
分頁查詢首頁時,僅需設定
MaxResults以限制返回資訊的條目數,返回結果中的NextToken將作為查詢後續頁的憑證。 -
查詢後續頁時,將
NextToken參數設定為上一次返回結果中擷取到的NextToken作為查詢憑證,並設定MaxResults限制返回條目數。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeNetworkInterfaces |
get |
NetworkInterface
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| Tag |
array<object> |
否 |
標籤列表 |
|
|
object |
否 |
|||
| Key |
string |
否 |
彈性網卡的標籤鍵。N 的取值範圍:1~20 |
TestKey |
| Value |
string |
否 |
彈性網卡的標籤值。N 的取值範圍:1~20 使用一個標籤過濾資源,查詢到該標籤下的資源數量不能超過 1000 個;使用多個標籤過濾資源,查詢到同時綁定了多個標籤的資源數量不能超過 1000 個。如果資源數量超過 1000 個,請使用 ListTagResources 介面進行查詢。 |
TestValue |
| RegionId |
string |
是 |
所在地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| ResourceGroupId |
string |
否 |
資源群組 ID。使用該參數過濾資源時,資源數量不能超過 1000 個。 說明
不支援預設資源群組過濾。 |
rg-bp67acfmxazb4p**** |
| VSwitchId |
string |
否 |
彈性網卡所屬的交換器 ID。 |
vsw-bp16usj2p27htro3**** |
| VpcId |
string |
否 |
彈性網卡所屬的Virtual Private Cloud ID。 |
vpc-bp1j7w3gc1cexjqd**** |
| PrimaryIpAddress |
string |
否 |
彈性網卡主私網 IPv4 地址。 |
192.168.**.** |
| SecurityGroupId |
string |
否 |
輔助網卡對應的安全性群組 ID。
|
sg-bp144yr32sx6ndw**** |
| NetworkInterfaceName |
string |
否 |
彈性網卡的名稱。長度為 2~128 個字元,支援 Unicode 中 letter 分類下的字元(其中包括英文、中文和數字等)。可以包含半形冒號(:)、底線(_)、半形句號(.)或者短劃線(-)。 |
test-eni-name |
| Type |
string |
否 |
彈性網卡類型。取值範圍:
預設值:空,表示查詢所有類型。 |
Secondary |
| InstanceId |
string |
否 |
彈性網卡當前附加的執行個體 ID。 |
i-bp1e2l6djkndyuli**** |
| ServiceManaged |
boolean |
否 |
該彈性網卡的使用者是否為雲產品或虛商。 |
true |
| Status |
string |
否 |
彈性網卡的狀態。取值範圍:
預設值:空,表示查詢所有狀態。 |
Available |
PageNumber
deprecated
|
integer |
否 |
說明
該參數已廢棄,建議您通過指定 MaxResults 或 NextToken 參數時使用分頁方式查詢。 |
1 |
PageSize
deprecated
|
integer |
否 |
說明
該參數已廢棄,建議您通過指定 MaxResults 或 NextToken 參數時使用分頁方式查詢。 |
100 |
| NextToken |
string |
否 |
查詢憑證(Token),取值為上一次 API 呼叫返回的 有關本介面查看返回資料的設定方式,請參見上文介面說明。 |
AAAAAdDWBF2**** |
| MaxResults |
integer |
否 |
分頁查詢時每頁的最大條目數。取值範圍:10~500。 預設值:
|
50 |
| PrivateIpAddress |
array |
否 |
彈性網卡的輔助私網 IPv4 地址。N 的取值範圍:1~100。 |
192.168.**.** |
|
string |
否 |
彈性網卡的輔助私網 IPv4 地址。N 的取值範圍:1~100。 |
192.168.**.** |
|
| NetworkInterfaceId |
array |
否 |
彈性網卡 ID。N 的取值範圍:1~100。 |
eni-bp125p95hhdhn3ot**** |
|
string |
否 |
彈性網卡 ID。N 的取值範圍:1~100。 |
eni-bp125p95hhdhn3ot**** |
|
| Ipv6Address |
array |
否 |
彈性網卡的 IPv6 地址。N 表示可以設定多個 IPv6 地址,N 的取值範圍:1~100。 |
2408:4321:180:1701:94c7:bc38:3bfa:**** |
|
string |
否 |
彈性網卡的 IPv6 地址。N 表示可以設定多個 IPv6 地址,N 的取值範圍:1~100。 |
2408:4321:180:1701:94c7:bc38:3bfa:**** |
|
| ResourceGroupId |
string |
否 |
資源群組 ID。使用該參數過濾資源時,資源數量不能超過 1000 個。 說明
不支援預設資源群組過濾。 |
rg-bp67acfmxazb4p**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| NextToken |
string |
本次調用返回的查詢憑證值。 |
AAAAAdDWBF2**** |
| PageSize |
integer |
分頁查詢參數。 說明
該參數即將下線,推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。 |
1 |
| PageNumber |
integer |
分頁查詢參數。 說明
該參數即將下線,推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。 |
1 |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| TotalCount |
integer |
返回的彈性網卡總數。 說明
使用 |
2 |
| NetworkInterfaceSets |
object |
||
| NetworkInterfaceSet |
array<object> |
彈性網卡資訊組成的集合。 |
|
|
array<object> |
|||
| CreationTime |
string |
建立時間。按照ISO 8601標準表示,並使用 UTC +0 時間,格式為 yyyy-MM-ddTHH:mm:ssZ。 |
2019-12-25T12:31:31Z |
| VpcId |
string |
彈性網卡所屬的Virtual Private Cloud ID。 |
vpc-bp1j7w3gc1cexjqd**** |
| Type |
string |
彈性網卡的類型。取值範圍:
|
Secondary |
| Status |
string |
彈性網卡的狀態。取值範圍:
|
Available |
| NetworkInterfaceTrafficMode |
string |
彈性網卡的通訊模式。可能值:
說明
HighPerformance 參數值只支援 RDMA 增強型執行個體規格類型系列 c7re,目前僅支援在華北 2(北京)的可用性區域 K 設定該參數值。 |
Standard |
| NetworkInterfaceName |
string |
彈性網卡的名稱。 |
my-eni-name |
| MacAddress |
string |
彈性網卡的 MAC 位址。 |
00:16:3e:12:**:** |
| QueuePairNumber |
integer |
說明
該參數正在邀測中,暫未開放使用。 |
0 |
| NetworkInterfaceId |
string |
彈性網卡 ID。 |
eni-bp125p95hhdhn3ot**** |
| ServiceID |
integer |
彈性網卡對應的虛商 ID。 |
12345678910 |
| InstanceId |
string |
彈性網卡附加的執行個體 ID。 說明
由其他阿里雲服務管理和控制的彈性網卡不會返回執行個體 ID。 |
i-bp1e2l6djkndyuli**** |
| OwnerId |
string |
彈性網卡的所屬帳號 ID。 |
123456**** |
| ServiceManaged |
boolean |
該彈性網卡的使用者是否為雲產品或虛商。 |
true |
| VSwitchId |
string |
VPC 的交換器 ID。 |
vsw-bp16usj2p27htro3**** |
| Description |
string |
描述。 |
DescriptionTest |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-2ze88m67qx5z**** |
| ZoneId |
string |
可用性區域 ID。 |
cn-hangzhou-e |
| PrivateIpAddress |
string |
彈性網卡的私網 IP 位址。 |
172.17.**.** |
| QueueNumber |
integer |
彈性網卡的隊列數。
|
8 |
| PrivateIpSets |
object |
||
| PrivateIpSet |
array<object> |
PrivateIpSet 組成的集合。 |
|
|
array<object> |
|||
| PrivateIpAddress |
string |
執行個體的私網 IP 位址。 |
172.17.**.** |
| Primary |
boolean |
是否是主私網 IP 位址。可能值:
|
true |
| AssociatedPublicIp |
object |
彈性網卡關聯的彈性公網 IP。 |
|
| PublicIpAddress |
string |
彈性公網 IP 位址。 |
116.62.**.** |
| AllocationId |
string |
說明
該參數正在邀測中,暫未開放使用。 |
null |
| PrivateDnsName |
string |
執行個體的私網網域名稱。 說明
僅當執行個體的主機名稱類型 |
DnsTestName |
| Ipv6Sets |
object |
||
| Ipv6Set |
array<object> |
彈性網卡已指派的 IPv6 地址集合。 |
|
|
object |
|||
| Ipv6Address |
string |
彈性網卡已指派的 IPv6 地址。 |
2408:4321:180:1701:94c7:bc38:3bfa:**** |
| Ipv4PrefixSets |
object |
||
| Ipv4PrefixSet |
array<object> |
彈性網卡已指派的 IPv4 首碼集合。 |
|
|
object |
|||
| 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 |
| SecurityGroupIds |
object |
||
| SecurityGroupId |
array |
所屬的安全性群組集合。 |
|
|
string |
安全性群組 ID。 |
sg-bp18kz60mefsicfg**** |
|
| AssociatedPublicIp |
object |
彈性網卡輔助私人 IP 位址關聯的彈性公網 IP。 |
|
| PublicIpAddress |
string |
彈性公網 IP 位址。 |
116.62.**.** |
| AllocationId |
string |
說明
該參數正在邀測中,暫未開放使用。 |
null |
| Attachment |
object |
說明
該參數正在邀測中,暫未開放使用。 |
|
| DeviceIndex |
integer |
說明
該參數正在邀測中,暫未開放使用。 |
0 |
| InstanceId |
string |
說明
該參數正在邀測中,暫未開放使用。 |
null |
| TrunkNetworkInterfaceId |
string |
說明
該參數正在邀測中,暫未開放使用。 |
null |
| NetworkCardIndex |
integer |
網卡掛載指定的物理網卡索引。
|
0 |
| DeleteOnRelease |
boolean |
釋放執行個體時是否保留網卡。可能值:
|
true |
| SourceDestCheck |
boolean |
是否開啟源/目的檢查功能。建議您開啟該功能,以提高網路安全。可能值:
預設值:false。 說明
使用該參數前,請認真閱讀源/目的檢查。 |
false |
樣本
正常返回樣本
JSON格式
{
"NextToken": "AAAAAdDWBF2****",
"PageSize": 1,
"PageNumber": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount": 2,
"NetworkInterfaceSets": {
"NetworkInterfaceSet": [
{
"CreationTime": "2019-12-25T12:31:31Z",
"VpcId": "vpc-bp1j7w3gc1cexjqd****",
"Type": "Secondary",
"Status": "Available",
"NetworkInterfaceTrafficMode": "Standard",
"NetworkInterfaceName": "my-eni-name",
"MacAddress": "00:16:3e:12:**:**",
"QueuePairNumber": 0,
"NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
"ServiceID": 12345678910,
"InstanceId": "i-bp1e2l6djkndyuli****",
"OwnerId": "123456****",
"ServiceManaged": true,
"VSwitchId": "vsw-bp16usj2p27htro3****",
"Description": "DescriptionTest",
"ResourceGroupId": "rg-2ze88m67qx5z****",
"ZoneId": "cn-hangzhou-e",
"PrivateIpAddress": "172.17.**.**",
"QueueNumber": 8,
"PrivateIpSets": {
"PrivateIpSet": [
{
"PrivateIpAddress": "172.17.**.**",
"Primary": true,
"AssociatedPublicIp": {
"PublicIpAddress": "116.62.**.**",
"AllocationId": "null"
},
"PrivateDnsName": "DnsTestName"
}
]
},
"Ipv6Sets": {
"Ipv6Set": [
{
"Ipv6Address": "2408:4321:180:1701:94c7:bc38:3bfa:****"
}
]
},
"Ipv4PrefixSets": {
"Ipv4PrefixSet": [
{
"Ipv4Prefix": "192.168.**.0/28"
}
]
},
"Ipv6PrefixSets": {
"Ipv6PrefixSet": [
{
"Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
}
]
},
"Tags": {
"Tag": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
},
"SecurityGroupIds": {
"SecurityGroupId": [
"sg-bp18kz60mefsicfg****"
]
},
"AssociatedPublicIp": {
"PublicIpAddress": "116.62.**.**",
"AllocationId": "null"
},
"Attachment": {
"DeviceIndex": 0,
"InstanceId": "null",
"TrunkNetworkInterfaceId": "null",
"NetworkCardIndex": 0
},
"DeleteOnRelease": true,
"SourceDestCheck": false
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MissingParameter | %s | 缺失參數,請檢查參數是否完整。 |
| 400 | UnsupportedParameter | %s | 不支援參數。 |
| 400 | InvalidParameter | %s | 無效的參數。 |
| 400 | InvalidInstanceID.Malformed | %s | 參數 InstanceId 格式錯誤。 |
| 400 | InvalidOperation.InvalidEcsState | %s | 執行個體當前的狀態不支援此操作。 |
| 400 | InvalidOperation.InvalidEniState | %s | 彈性網卡當前的狀態不支援此操作。 |
| 400 | InvalidOperation.DetachPrimaryEniNotAllowed | %s | 不允許分離執行個體的主網卡。 |
| 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 | |
| 403 | MaxEniCountExceeded | %s | 已超過可以操作的最大彈性網卡數。 |
| 403 | EniPerInstanceLimitExceeded | %s | 執行個體附加的彈性網卡數量已經達到了最大限度,不能再為執行個體附加彈性網卡。 |
| 403 | InvalidOperation.AvailabilityZoneMismatch | %s | 該操作無效。 |
| 403 | InvalidOperation.VpcMismatch | %s | 您的操作無效,請確認該操作中的 VPC 與其它參數是否匹配。 |
| 403 | SecurityGroupInstanceLimitExceed | %s | 該安全性群組內已有的執行個體數量已達到最大限制。 |
| 403 | InvalidSecurityGroupId.NotVpc | %s | 參數 SecurityGroupId 無效,該安全性群組的網路類型不是專用網路。 |
| 403 | InvalidOperation.InvalidEniType | %s | 當前彈性網卡的類型不支援此操作。 |
| 403 | InvalidVpc.Empty | %s | 指定的VPC下沒有建立交換器,具體資訊請參見錯誤資訊%s預留位置的實際返回結果。 |
| 403 | Forbidden.RegionId | %s | |
| 403 | InvalidOperation.InvalidEniPageNumber | %s | |
| 403 | InvalidVpc.Indeterminacy | %s | |
| 404 | InvalidEcsId.NotFound | %s | 指定的執行個體 ID 不存在。 |
| 404 | InvalidEniId.NotFound | %s | |
| 404 | InvalidVSwitchId.NotFound | %s | 指定的交換器不存在。 |
| 404 | InvalidSecurityGroupId.NotFound | %s | 指定的安全性群組 ID 不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。