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

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

操作説明

操作の説明

DescribeNetworkInterfaces オペレーションは、MaxResults または NextToken パラメーターを指定することでページングをサポートします。使用上の注意:

最初のページをページングクエリする場合、MaxResults のみをセットして返されるエントリ数を制限します。応答内の NextToken 値は、後続のページを照会するための認証情報として使用されます。
後続のページをページングクエリする場合、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	必須	リージョン ID。 DescribeRegions を呼び出して最新のリージョンリストをクエリできます。	cn-hangzhou
Tag	array<object>	任意	タグ。
	object	任意
Key	string	任意	ネットワークインターフェースのタグキー。N の有効な値: 1～20。	TestKey
Value	string	任意	ネットワークインターフェースのタグ値。N の有効な値: 1～20。単一のタグを使用してリソースをフィルターする場合、指定されたタグを持つリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルターする場合、指定されたすべてのタグが付けられているリソース数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources 操作を呼び出してリソースをクエリしてください。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。このパラメーターを使用してリソースをフィルターする場合、リソース数は 1,000 を超えることはできません。説明デフォルトのリソースグループによるフィルターはサポートされていません。	rg-bp67acfmxazb4p****
VSwitchId	string	任意	ネットワークインターフェースの vSwitch ID。	vsw-bp16usj2p27htro3****
VpcId	string	任意	ネットワークインターフェースの仮想非公開クラウド (VPC) ID。	vpc-bp1j7w3gc1cexjqd****
PrimaryIpAddress	string	任意	ネットワークインターフェースのプライマリ非公開 IP アドレス。	192.168..
SecurityGroupId	string	任意	セカンダリ ENI のセキュリティグループ ID。セキュリティグループ ID でセカンダリ ENI の情報をクエリするには、このパラメーターを指定します。セキュリティグループ ID でプライマリ ENI の情報をクエリするには、 DescribeInstances を呼び出し、`SecurityGroupId` パラメーターを指定します。	sg-bp144yr32sx6ndw****
NetworkInterfaceName	string	任意	ネットワークインターフェースの名前。名前は 2～128 文字で、Unicode 文字分類 (英字、漢字、数字を含む) の文字を使用できます。コロン (:)、アンダースコア (_)、ピリオド (.)、ハイフン (-) を含めることができます。	test-eni-name
Type	string	任意	Elastic Network Interface (ENI) のタイプ。有効な値: Primary: プライマリネットワークインターフェース。 Secondary: セカンダリ ENI。デフォルト値: null。すべてのタイプがクエリされることを示します。	Secondary
InstanceId	string	任意	ネットワークインターフェースがアタッチされているインスタンスの ID。	i-bp1e2l6djkndyuli****
ServiceManaged	boolean	任意	ネットワークインターフェースのユーザーが Alibaba Cloud サービスまたは Virtual Network Operator (VNO) であるかどうかを示します。	true
Status	string	任意	ネットワークインターフェースのステータス。有効な値: Available: 利用可能。 Attaching: アタッチ中。 InUse: アタッチ済み。 Detaching: デタッチ中。 Deleting: 削除中。デフォルト値: null。すべてのステータスがクエリされることを示します。	Available
PageNumber `deprecated`	integer	任意	説明このパラメーターは非推奨です。ページングには MaxResults および NextToken パラメーターを使用してください。	1
PageSize `deprecated`	integer	任意	説明このパラメーターは非推奨です。ページングには MaxResults および NextToken パラメーターを使用してください。	100
NextToken	string	任意	ページネーショントークン。このパラメーターを、前の API 呼び出しで返された `NextToken` 値にセットします。返されるデータのビュー方法については、上記の操作の説明を参照してください。	AAAAAdDWBF2****
MaxResults	integer	任意	ページングにおける 1 ページあたりの最大値。有効な値: 10～500。デフォルト値: このパラメーターをセットしないか、10 未満の値にセットした場合、デフォルト値は 10 です。このパラメーターを 500 より大きい値にセットした場合、デフォルト値は 500 です。	50
PrivateIpAddress	array	任意	ネットワークインターフェースのセカンダリ非公開 IP アドレス。N の有効な値: 1～100。	192.168..
	string	任意	ネットワークインターフェースのセカンダリ非公開 IP アドレス。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:****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	この呼び出しで返されるページネーショントークン。	AAAAAdDWBF2****
PageSize	integer	ページングパラメーター。説明このパラメーターは非推奨予定です。ページングには NextToken および MaxResults を使用してください。	1
PageNumber	integer	ページングパラメーター。説明このパラメーターは非推奨予定です。ページングには NextToken および MaxResults を使用してください。	1
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	返される Elastic Network Interface (ENI) の総数。説明ページングに `MaxResults` および `NextToken` パラメーターを使用する場合、返される `TotalCount` 値は無意味です。	2
NetworkInterfaceSets	object
NetworkInterfaceSet	array<object>	ネットワークインターフェース情報のコレクション。
	array<object>
CreationTime	string	作成時間。時間は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式です。時間は協定世界時 (UTC)+0 で表示されます。	2019-12-25T12:31:31Z
VpcId	string	ネットワークインターフェースの仮想非公開クラウド (VPC) ID。	vpc-bp1j7w3gc1cexjqd****
Type	string	Elastic Network Interface (ENI) のタイプ。有効な値: Primary: プライマリネットワークインターフェース。 Secondary: セカンダリ ENI。	Secondary
Status	string	ネットワークインターフェースのステータス。有効な値: Available: 利用可能。 Attaching: アタッチ中。 InUse: アタッチ済み。 Detaching: デタッチ中。 Deleting: 削除中。	Available
NetworkInterfaceTrafficMode	string	ネットワークインターフェースの通信モード。有効な値: Standard: 標準 TCP 通信モードが使用されます。 HighPerformance: Elastic RDMA Interface (ERI) が有効化されており、RDMA 通信モードが使用されます。説明 HighPerformance 値は c7re RDMA 強化インスタンスファミリーでのみサポートされています。現在、この値は中国 (北京) リージョンのゾーン K でのみ指定できます。	標準
NetworkInterfaceName	string	ネットワークインターフェースの名前。	my-eni-name
MacAddress	string	ネットワークインターフェースの MAC アドレス。	00:16:3e:12::
QueuePairNumber	integer	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	0
NetworkInterfaceId	string	ネットワークインターフェースの ID。	eni-bp125p95hhdhn3ot****
ServiceID	integer	ネットワークインターフェースが属する Virtual Network Operator (VNO) の ID。	12345678910
InstanceId	string	ネットワークインターフェースがアタッチされているインスタンスの ID。説明他の Alibaba Cloud サービスによって管理および制御されるネットワークインターフェースは、インスタンス ID を返しません。	i-bp1e2l6djkndyuli****
OwnerId	string	ネットワークインターフェースを所有するアカウントの ID。	123456****
ServiceManaged	boolean	ネットワークインターフェースのユーザーが Alibaba Cloud サービスまたは Virtual Network Operator (VNO) であるかどうかを示します。	true
VSwitchId	string	VPC の vSwitch ID。	vsw-bp16usj2p27htro3****
Description	string	説明。	DescriptionTest
ResourceGroupId	string	リソースグループの ID。	rg-2ze88m67qx5z****
ZoneId	string	ゾーンの ID。	cn-hangzhou-e
PrivateIpAddress	string	ネットワークインターフェースの非公開 IP アドレス。	172.17..
QueueNumber	integer	Elastic Network Interface (ENI) のキュー数。セカンダリネットワークインターフェースがアタッチ済み (InUse) 状態で、キュー数が変更済みでない場合、インスタンスタイプのセカンダリ ENI のデフォルトキュー数が返されます。セカンダリネットワークインターフェースのキュー数が変更済みの場合、変更後のキュー数が返されます。セカンダリネットワークインターフェースが未アタッチ (Available) 状態で、キュー数が変更済みでない場合、空の値が返されます。プライマリネットワークインターフェースの場合、インスタンスタイプのプライマリ NIC のデフォルトキュー数が返されます。	8
PrivateIpSets	object
PrivateIpSet	array<object>	PrivateIpSet オブジェクトのコレクション。
	array<object>
PrivateIpAddress	string	インスタンスの非公開 IP アドレス。	172.17..
Primary	boolean	IP アドレスがプライマリ非公開 IP アドレスであるかどうかを示します。有効な値: true: プライマリ非公開 IP アドレス。 false: セカンダリ非公開 IP アドレス。	true
AssociatedPublicIp	object	ネットワークインターフェースに関連付けられた EIP。
PublicIpAddress	string	EIP アドレス。	116.62..
AllocationId	string	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	null
PrivateDnsName	string	インスタンスの非公開ドメイン名。説明この値は、インスタンスのホスト名タイプ `HostnameType` が `IP` 形式または `InstanceId` 形式にセットされている場合にのみ返されます。	DnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	ネットワークインターフェースに割り当てられた IPv6 アドレス。
	object
Ipv6Address	string	ネットワークインターフェースに割り当てられた IPv6 アドレス。	2408:4321:180:1701:94c7:bc38:3bfa:****
Primary	boolean
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	ENI が属するセキュリティグループ。
	string	セキュリティグループ ID。	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	ネットワークインターフェースのセカンダリ非公開 IP アドレスに関連付けられた EIP。
PublicIpAddress	string	EIP アドレス。	116.62..
AllocationId	string	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	null
Attachment	object	説明このパラメーターは招待プレビュー中であり、一般公開されていません。
DeviceIndex	integer	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	0
InstanceId	string	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	null
TrunkNetworkInterfaceId	string	説明このパラメーターは招待プレビュー中であり、一般公開されていません。	null
NetworkCardIndex	integer	ENI がアタッチされているネットワークカードのインデックス。 ENI が Available 状態であるか、アタッチ時にインデックスが指定されなかった場合、この値は返されません。 ENI が InUse 状態で、アタッチ時にインデックスが指定された場合、この値は ENI がアタッチされているネットワークカードのインデックスを示します。	0
DeleteOnRelease	boolean	関連付けられたインスタンスがリリースされたときに ENI が保持されるかどうかを示します。有効な値: true: ENI は保持されません。 false: ENI は保持されます。	true
SourceDestCheck	boolean	ソース/送信先チェックが有効かどうかを示します。ネットワークセキュリティを強化するために、この特徴を有効にすることを推奨します。有効な値: true: 有効。 false: 無効。デフォルト値: false。説明このパラメーターを使用する前に、ソース/送信先チェックを読み取りください。	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": "標準",
        "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:****",
              "Primary": false
            }
          ]
        },
        "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 ステータスコード	エラーコード	エラーメッセージ	説明
400	MissingParameter	%s	指定されたパラメーターのうち少なくとも 1 つを指定する必要があります。すべてを空にすることはできません。
400	UnsupportedParameter	%s	指定されたパラメーターはサポートされていません。
400	InvalidParameter	%s	指定されたパラメーターの組み合わせが有効ではありません。
400	InvalidInstanceID.Malformed	%s
400	InvalidOperation.InvalidEcsState	%s	現在のインスタンスステータスでは、この操作はサポートされていません。
400	InvalidOperation.InvalidEniState	%s	現在の ENI のステータスでは、ENI の属性を変更できません。
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	インスタンスからプライマリ ENI をデタッチすることは許可されていません。
400	Forbidden.RegionId	%s	現在のリージョンでは、このサービスを一時的にご利用いただけません。
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.
403	InvalidUserType.NotSupported	%s	ユーザータイプパラメーターが無効です。
403	Abs.InvalidAccount.NotFound	%s	Alibaba Cloud アカウントが存在しないか、AccessKey が有効期限切れです。
403	Forbidden.NotSupportRAM	%s	Resource Access Management (RAM) ソースユーザーはこの操作を実行することはサポートされていません。
403	Forbidden.SubUser	%s	お使いのアカウントには、このリソースを操作する権限がありません。Alibaba Cloud アカウントに必須の権限をリクエストしてください。
403	InvalidParameter	%s
403	MaxEniCountExceeded	%s	操作可能な Elastic Network Interface (ENI) の最大値を超えています。
403	EniPerInstanceLimitExceeded	%s	インスタンスにアタッチされている Elastic Network Interface (ENI) の数が最大値に達しました。これ以上インスタンスに Elastic Network Interface (ENI) をアタッチできません。
403	InvalidOperation.AvailabilityZoneMismatch	%s	ネットワークインターフェースコントローラー (NIC) と ECS インスタンスの vSwitch が異なるゾーンにあるため、同じゾーンにありません。
403	InvalidOperation.VpcMismatch	%s	ネットワークインターフェースの VPC がセキュリティグループの VPC と一致しません。
403	SecurityGroupInstanceLimitExceed	%s	セキュリティグループ内のインスタンス数が最大値に達しました。
403	InvalidSecurityGroupId.NotVpc	%s	参数SecurityGroupId无效，该安全组的网络类型不是专有网络。
403	InvalidOperation.InvalidEniType	%s	現在の Elastic Network Interface (ENI) のタイプでは、この操作はサポートされていません。
403	InvalidVpc.Empty	%s	指定された VPC に vSwitch が作成されていません。詳細については、エラーメッセージ内の %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	指定された vSwitch が存在しません。
404	InvalidSecurityGroupId.NotFound	%s	指定されたセキュリティグループが存在しません。

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

変更履歴

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