DescribeNetworkInterfaces - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上の Elastic Network Interface (ENI) の詳細を照会します。

操作説明

注意事項

DescribeNetworkInterfaces 操作を呼び出す際に MaxResults または NextToken パラメーターを指定することで、ページングクエリを実行できます。次の点にご注意ください：

ページングクエリ中に、DescribeNetworkInterfaces 操作を呼び出して結果の最初のページを取得する場合、MaxResults を設定して呼び出しで返される最大エントリ数を指定します。NextToken の戻り値は、次の呼び出しで新しい結果ページを取得するために使用できるページネーショントークンです。
DescribeNetworkInterfaces 操作を呼び出して新しい結果ページを取得する場合、NextToken を前の呼び出しで返された NextToken 値に設定し、MaxResults を設定してこの呼び出しで返される最大エントリ数を指定します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeNetworkInterfaces

get

NetworkInterface

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	ENI のリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
Tag	array<object>	任意	クエリに使用するタグ。
	object	任意
Key	string	任意	ENI のタグ N のキー。N の有効値：1～20。	TestKey
Value	string	任意	ENI のタグ N の値。N の有効値：1～20。単一のタグを指定して ENI を照会する場合、このタグを持つ最大 1,000 個の ENI が返されます。複数のタグを指定して ENI を照会する場合、これらのすべてのタグを持つ最大 1,000 個の ENI が返されます。指定されたタグを持つ 1,000 を超えるリソースを照会するには、ListTagResources 操作を呼び出してください。	TestValue
RegionId	string	必須	ENI のリージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
ResourceGroupId	string	任意	ENI が属するリソースグループの ID。このパラメーターを指定してリソースを照会する場合、指定されたリソースグループに属する最大 1,000 個のリソースが返されます。説明デフォルトリソースグループ内のリソースは、このパラメーターの設定に関係なく応答に表示されます。	rg-bp67acfmxazb4p****
VSwitchId	string	任意	ENI が関連付けられている vSwitch の ID。	vsw-bp16usj2p27htro3****
VpcId	string	任意	ENI が属する VPC (Virtual Private Cloud) の ID。	vpc-bp1j7w3gc1cexjqd****
PrimaryIpAddress	string	任意	ENI のプライマリプライベート IPv4 アドレス。	192.168..
SecurityGroupId	string	任意	セカンダリ ENI が属するセキュリティグループの ID。セキュリティグループの ID に基づいてセカンダリ ENI の詳細を照会するには、このパラメーターを指定します。セキュリティグループの ID に基づいてプライマリ ENI の詳細を照会するには、DescribeInstances 操作を呼び出して `SecurityGroupId` パラメーターを指定します。	sg-bp144yr32sx6ndw****
NetworkInterfaceName	string	任意	ENI の名前。	test-eni-name
Type	string	任意	ENI のタイプ。有効値： Primary Secondary このパラメーターはデフォルトで空であり、プライマリ ENI とセカンダリ ENI の両方が照会されることを示します。	Secondary
InstanceId	string	任意	ENI がアタッチされているインスタンスの ID。	i-bp1e2l6djkndyuli****
ServiceManaged	boolean	任意	ENI のユーザーが Alibaba Cloud サービスかディストリビューターかを指定します。	true
Status	string	任意	ENI の状態。有効値： Available：ENI は利用可能です。 Attaching：ENI はインスタンスにアタッチ中です。 InUse：ENI はインスタンスにアタッチされています。 Detaching：ENI はインスタンスからデタッチ中です。 Deleting：ENI は削除中です。このパラメーターはデフォルトで空であり、すべての状態の ENI が照会されることを示します。	Available
PageNumber `deprecated`	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。説明このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults を使用することを推奨します。	1
PageSize `deprecated`	integer	任意	1 ページあたりのエントリ数。有効値：1～1000。デフォルト値：10。説明このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults を使用することを推奨します。	100
NextToken	string	任意	クエリトークン。この操作の前回の呼び出しで返された `NextToken` 値に設定します。この操作によって返される応答の確認方法の詳細については、このドキュメントの冒頭にある「注意事項」をご参照ください。	AAAAAdDWBF2****
MaxResults	integer	任意	各ページで返すエントリの最大数。有効値：10～500。デフォルト値：このパラメーターが指定されていない場合、または 10 未満の値に設定されている場合、デフォルト値は 10 です。このパラメーターが 500 を超える値に設定されている場合、デフォルト値は 500 です。	50
PrivateIpAddress	array	任意	ENI のセカンダリプライベート IPv4 アドレスで構成される配列。複数のセカンダリプライベート IPv4 アドレスを指定できます。N の有効値：1～100。	192.168..
	string	任意	ENI のセカンダリプライベート IPv4 アドレス。複数のセカンダリプライベート IPv4 アドレスを指定できます。N の有効値：1～100。	192.168..
NetworkInterfaceId	array	任意	ENI の ID で構成される配列。複数の ENI ID を指定します。N の有効値：1～100。	eni-bp125p95hhdhn3ot****
	string	任意	ENI N の ID。複数の ENI ID を指定します。N の有効値：1～100。	eni-bp125p95hhdhn3ot****
Ipv6Address	array	任意	ENI の IPv6 アドレスで構成される配列。複数の IPv6 アドレスを指定できます。N の有効値：1～100。	2408:4321:180:1701:94c7:bc38:3bfa:****
	string	任意	ENI の IPv6 アドレス N。複数の IPv6 アドレスを指定できます。N の有効値：1～100。	2408:4321:180:1701:94c7:bc38:3bfa:****
ResourceGroupId	string	任意	ENI が属するリソースグループの ID。このパラメーターを指定してリソースを照会する場合、指定されたリソースグループに属する最大 1,000 個のリソースが返されます。説明デフォルトリソースグループ内のリソースは、このパラメーターの設定に関係なく応答に表示されます。	rg-bp67acfmxazb4p****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	ページネーショントークン。次のリクエストで使用して、新しい結果ページを取得できます。	AAAAAdDWBF2****
PageSize	integer	1 ページあたりに返されるエントリ数。説明このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults パラメーターを使用することを推奨します。	1
PageNumber	integer	返されたページのページ番号。説明このパラメーターは将来削除される予定です。ページングクエリには NextToken と MaxResults パラメーターを使用することを推奨します。	1
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	ENI の総数。説明 `MaxResults` と `NextToken` パラメーターを指定してページングクエリを実行する場合、`TotalCount` 応答パラメーターの値は無効になります。	2
NetworkInterfaceSets	object
NetworkInterfaceSet	array<object>	ENI の詳細。
	array<object>
CreationTime	string	セキュリティグループが作成された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。	2019-12-25T12:31:31Z
VpcId	string	ENI が属する VPC の ID。	vpc-bp1j7w3gc1cexjqd****
Type	string	ENI のタイプ。	Secondary
Status	string	ENI の状態。	Available
NetworkInterfaceTrafficMode	string	ENI の通信モード。有効値： Standard：TCP 通信モードが使用されます。 HighPerformance：Elastic RDMA Interface (ERI) が有効になり、リモートダイレクトメモリアクセス (RDMA) 通信モードが使用されます。説明このパラメーターは、ENI が北京ゾーン K にある c7re RDMA 対応インスタンスにアタッチされている場合にのみ HighPerformance の値を持つことができます。	Standard
NetworkInterfaceName	string	ENI の名前。	my-eni-name
MacAddress	string	ENI の MAC アドレス。	00:16:3e:12::
QueuePairNumber	integer	説明このパラメーターは招待制プレビューであり、公開されていません。	0
NetworkInterfaceId	string	ENI の ID。	eni-bp125p95hhdhn3ot****
ServiceID	integer	ENI が属するディストリビューターの ID。	12345678910
InstanceId	string	ENI がアタッチされている Elastic Compute Service (ECS) インスタンスの ID。説明 ENI が他の Alibaba Cloud サービスによって管理されている場合、インスタンス ID は返されません。	i-bp1e2l6djkndyuli****
OwnerId	string	ENI が属するアカウントの ID。	123456****
ServiceManaged	boolean	ENI のユーザーが Alibaba Cloud サービスかディストリビューターかを示します。	true
VSwitchId	string	vSwitch の ID。	vsw-bp16usj2p27htro3****
Description	string	ENI の説明。	DescriptionTest
ResourceGroupId	string	ENI が属するリソースグループの ID。	rg-2ze88m67qx5z****
ZoneId	string	ENI のゾーン ID。	cn-hangzhou-e
PrivateIpAddress	string	ENI のプライマリプライベート IP アドレス。	172.17..
QueueNumber	integer	ENI がサポートするキューの数。 ENI が InUse 状態のセカンダリ ENI であり、ENI がサポートするキューの数が変更されていない場合、インスタンスタイプがサポートするセカンダリ ENI あたりのデフォルトのキュー数が返されます。 ENI がセカンダリ ENI であり、ENI がサポートするキューの数が変更された場合、新しいキュー数が返されます。 ENI が Available 状態のセカンダリ ENI であり、ENI がサポートするキューの数が変更されていない場合、空の値が返されます。 ENI がプライマリ ENI の場合、インスタンスタイプがサポートするプライマリ ENI あたりのデフォルトのキュー数が返されます。	8
PrivateIpSets	object
PrivateIpSet	array<object>	ENI のプライベート IP アドレスに関する詳細。
	array<object>
PrivateIpAddress	string	ENI のプライベート IP アドレス。	172.17..
Primary	boolean	プライベート IP アドレスがプライマリプライベート IP アドレスであるかどうかを示します。有効値： true：IP アドレスはプライマリプライベート IP アドレスです。 false：IP アドレスはセカンダリプライベート IP アドレスです。	true
AssociatedPublicIp	object	プライベート IP アドレスに関連付けられている Elastic IP アドレス (EIP)。
PublicIpAddress	string	EIP。	116.62..
AllocationId	string	説明このパラメーターは招待制プレビューであり、公開されていません。	null
PrivateDnsName	string	ECS インスタンスのプライベートドメイン名。説明プライベートドメイン名は、`HostnameType` が `IP` または `InstanceId` に設定されている場合にのみ、特定の形式で返すことができます。	DnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	ENI の IPv6 アドレス。
	object	説明このパラメーターは招待制プレビューであり、利用できません。
Ipv6Address	string	ENI の IPv6 アドレス。	2408:4321:180:1701:94c7:bc38:3bfa:****
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	ENI の IPv4 プレフィックス。
	object	説明このパラメーターは招待制プレビューであり、利用できません。
Ipv4Prefix	string	ENI の IPv4 プレフィックス。	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	ENI の IPv6 プレフィックス。
	object	説明このパラメーターは招待制プレビューであり、利用できません。
Ipv6Prefix	string	ENI の IPv6 プレフィックス。	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	ENI のタグ。
	object
TagValue	string	タグ値。	TestValue
TagKey	string	タグキー。	TestKey
SecurityGroupIds	object
SecurityGroupId	array	ENI が属するセキュリティグループ。
	string	セキュリティグループの ID。	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	ENI のセカンダリプライベート IP アドレスに関連付けられている EIP。
PublicIpAddress	string	EIP。	116.62..
AllocationId	string	説明このパラメーターは招待制プレビューであり、公開されていません。	null
Attachment	object	説明このパラメーターは招待制プレビューであり、公開されていません。
DeviceIndex	integer	説明このパラメーターは招待制プレビューであり、公開されていません。	0
InstanceId	string	説明このパラメーターは招待制プレビューであり、公開されていません。	null
TrunkNetworkInterfaceId	string	説明このパラメーターは招待制プレビューであり、公開されていません。	null
NetworkCardIndex	integer	ネットワークカードのインデックス。 ENI が Available 状態の場合、または ENI がアタッチされたときにネットワークカードのインデックスが指定されなかった場合、このパラメーターは空になります。 ENI が InUse 状態であり、ENI がアタッチされたときにネットワークカードのインデックスが指定された場合、指定されたネットワークカードのインデックスがこのパラメーターの値として返されます。	0
DeleteOnRelease	boolean	関連付けられたインスタンスがリリースされたときに ENI を保持するかどうかを示します。有効値： true false	true
SourceDestCheck	boolean	送信元/宛先 IP アドレスチェック機能が有効になっているかどうかを示します。ネットワークセキュリティを向上させるには、この機能を有効にします。有効値： true false デフォルト値：false。説明このパラメーターを使用する前に、「送信元/宛先 IP アドレスチェック」をご参照ください。	false

例

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

{
    "NetworkInterfaceSets": {
        "NetworkInterfaceSet": [
            {
                "AssociatedPublicIp": {
                },
                "CreationTime": "2017-11-24T06:14:22Z",
                "InstanceId": "AY121018033933eaxxxxx",
                "MacAddress": "00:16:3e:0f:XX:XX",
                "NetworkInterfaceId": "eni-bp17pdijfczaxZZZZxxxxx",
                "PrivateIpAddress": "XXX.XXX.XX.XX",
                "PrivateIpSets": {
                    "PrivateIpSet": [
                        {
                            "AssociatedPublicIp": {
                            },
                            "Primary": true,
                            "PrivateIpAddress": "XXX.XXX.XX.XX"
                        }
                    ]
                },
                "SecurityGroupIds": {
                    "SecurityGroupId": [
                        "sg-bp144yr32sx6ndwxxxxx"
                    ]
                },
                "Status": "Available",
                "Type": "Secondary",
                "VpcId": "vpc-bp1j7w3gc1cexjqdxxxxx",
                "VSwitchId": "vsw-bp16usj2p27htro3xxxxx",
                "ZoneId": "cn-hangzhou-e"
            }
        ]
    },
    "PageNumber": 1,
    "PageSize": 100,
    "RequestId": "CEE5C347-0B64-4535-A061-95BE95Axxxxx",
    "TotalCount": 1
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter	%s
400	UnsupportedParameter	%s
400	InvalidParameter	%s
400	InvalidInstanceID.Malformed	%s
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.
403	InvalidUserType.NotSupported	%s
403	Abs.InvalidAccount.NotFound	%s
403	Forbidden.NotSupportRAM	%s
403	Forbidden.SubUser	%s
403	InvalidParameter	%s
403	MaxEniCountExceeded	%s
403	EniPerInstanceLimitExceeded	%s
403	InvalidOperation.AvailabilityZoneMismatch	%s
403	InvalidOperation.VpcMismatch	%s
403	SecurityGroupInstanceLimitExceed	%s
403	InvalidSecurityGroupId.NotVpc	%s	参数SecurityGroupId无效，该安全组的网络类型不是专有网络。
403	InvalidOperation.InvalidEniType	%s
403	InvalidVpc.Empty	%s
403	Forbidden.RegionId	%s
403	InvalidOperation.InvalidEniPageNumber	%s
403	InvalidVpc.Indeterminacy	%s
404	InvalidEcsId.NotFound	%s
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s
404	InvalidSecurityGroupId.NotFound	%s

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。