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

指定されたエラスティックネットワークインターフェース (ENI) の詳細を取得します。

今すぐお試しください

この 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:DescribeNetworkInterfaceAttribute

get

*NetworkInterface

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	ENI が配置されているリージョンの ID。 DescribeRegions を呼び出して、Alibaba Cloud の最新のリージョンリストを取得できます。	cn-hangzhou
Tag	array<object>	任意	説明このパラメーターはまだ利用できません。
	object	任意	説明このパラメーターはまだ利用できません。
Key	string	任意	説明このパラメーターはまだ利用できません。	TestKey
Value	string	任意	説明このパラメーターはまだ利用できません。	TestValue
RegionId	string	必須	ENI が配置されているリージョンの ID。 DescribeRegions を呼び出して、Alibaba Cloud の最新のリージョンリストを取得できます。	cn-hangzhou
NetworkInterfaceId	string	必須	ENI の ID。	eni-bp67acfmxazb4p****
Attribute	string	任意	クエリする ENI の属性。有効値： `attachment`：トランクネットワークインターフェースにアタッチされているメンバーネットワークインターフェースのアタッチメント情報をクエリします。この値は招待制でのみ利用可能です。 `connectionTrackingConfiguration`：接続追跡設定。	attachment

レスポンスフィールド

フィールド	型	説明	例
	object	ENI の詳細。
CreationTime	string	ENI が作成された時間。	2019-12-25T12:31:31Z
VpcId	string	ENI を含む Virtual Private Cloud (VPC) の ID。	vpc-bp67acfmxazb4p****
Type	string	ENI のタイプ。有効値： Primary：プライマリ ENI。 Secondary：セカンダリ ENI。	Secondary
Status	string	ENI のステータス。有効値： Available：ENI は利用可能です。 Attaching：ENI はインスタンスにアタッチ中です。 InUse：ENI はインスタンスにアタッチされています。 Detaching：ENI はインスタンスからデタッチ中です。 Deleting：ENI は削除中です。デフォルト値：null。これは、すべての状態の ENI がクエリされることを示します。	Available
NetworkInterfaceTrafficMode	string	ENI のトラフィックモード。有効値： Standard：ENI は TCP トラフィックモードを使用します。 HighPerformance：ENI は、Elastic RDMA Interface (ERI) 機能を有効にしたリモートダイレクトメモリアクセス (RDMA) トラフィックモードを使用します。説明この機能は、RDMA 拡張インスタンスの c7re インスタンスファミリーでのみサポートされています。	Standard
NetworkInterfaceName	string	ENI の名前。	my-eni-name
MacAddress	string	ENI の MAC アドレス。	00:16:3e:12::
QueuePairNumber	integer	説明このパラメーターは招待制プレビューであり、一般公開されていません。	22
NetworkInterfaceId	string	ENI の ID。	eni-bp125p95hhdhn3ot****
ServiceID	integer	ENI に対応するディストリビューターの ID。	12345678910
InstanceId	string	ENI がアタッチされているインスタンスの ID。説明他の Alibaba Cloud サービスによって管理および制御されている ENI の場合、インスタンス ID は返されません。	i-bp1e2l6djkndyuli****
OwnerId	string	ENI が属するアカウントの ID。	123456****
ServiceManaged	boolean	ENI が Alibaba Cloud サービスまたはディストリビューターによって使用されているかどうかを示します。	true
VSwitchId	string	ENI が接続されている vSwitch の ID。	vsw-bp1s5fnvk4gn2tws0****
RequestId	string	リクエスト ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Description	string	ENI の説明。	testDescription
ResourceGroupId	string	インスタンスが属するリソースグループの ID。このパラメーターを使用してリソースをフィルター処理する場合、リソースの数は 1,000 を超えることはできません。説明デフォルトのリソースグループ内のリソースはフィルター処理できません。	rg-bp67acfmxazb4p****
ZoneId	string	ゾーンの ID。	cn-hangzhou-g
PrivateIpAddress	string	ENI のプライベート IP アドレス。	10.1..
QueueNumber	integer	ENI のキューの数。 ENI がプライマリ ENI の場合、インスタンスタイプのプライマリ ENI のデフォルトのキュー数が返されます。 ENI がセカンダリ ENI の場合：セカンダリ ENI が InUse 状態の場合：セカンダリ ENI のキュー数が変更されていない場合、インスタンスタイプのセカンダリ ENI のデフォルトのキュー数が返されます。セカンダリ ENI のキュー数が変更された場合、新しい値が返されます。セカンダリ ENI が Available 状態の場合：セカンダリ ENI のキュー数が変更されていない場合、このパラメーターは空になります。セカンダリ ENI のキュー数が変更された場合、新しい値が返されます。	8
SecurityGroupIds	object
SecurityGroupId	array	ENI が属するセキュリティグループ。
	string	ENI が属するセキュリティグループの ID。	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	ENI のセカンダリプライベート IP アドレスに関連付けられている EIP。
PublicIpAddress	string	EIP。	116.62..
AllocationId	string	EIP の ID。	null
Attachment	object	説明このパラメーターは招待制プレビューであり、一般公開されていません。
DeviceIndex	integer	説明このパラメーターは招待制プレビューであり、一般公開されていません。	hide
InstanceId	string	説明このパラメーターは招待制プレビューであり、一般公開されていません。	hide
TrunkNetworkInterfaceId	string	説明このパラメーターは招待制プレビューであり、一般公開されていません。	hide
MemberNetworkInterfaceIds	object
MemberNetworkInterfaceId	array	説明このパラメーターは招待制プレビューであり、一般公開されていません。
	string	説明このパラメーターは招待制プレビューであり、一般公開されていません。	hide
NetworkCardIndex	integer	ENI がアタッチされているネットワークインターフェースコントローラー (NIC) のインデックス。 ENI が `Available` 状態の場合、または ENI がアタッチされたときにインデックスが指定されなかった場合、このパラメーターは返されません。 ENI が `InUse` 状態であり、ENI がアタッチされたときにインデックスが指定された場合、このパラメーターの値は NIC のインデックスを示します。	0
PrivateIpSets	object
PrivateIpSet	array<object>	ENI のプライベート IP アドレス。
	array<object>	ENI のプライベート IP アドレスに関する情報。
PrivateIpAddress	string	ENI のプライベート IP アドレス。	172.17..
Primary	boolean	IP アドレスがプライマリプライベート IP アドレスであるかどうかを示します。有効値： true：IP アドレスはプライマリプライベート IP アドレスです。 false：IP アドレスはセカンダリプライベート IP アドレスです。	true
AssociatedPublicIp	object	ENI のセカンダリプライベート IP アドレスに関連付けられている EIP。
PublicIpAddress	string	EIP。	116.62..
AllocationId	string	説明このパラメーターは招待制プレビューであり、一般公開されていません。	null
Ipv6Sets	object
Ipv6Set	array<object>	ENI に割り当てられた IPv6 アドレス。
	object	ENI に割り当てられた IPv6 アドレス。
Ipv6Address	string	ENI に割り当てられた IPv6 アドレス。	2001:db8:1234:1a00::****
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	ENI に割り当てられた IPv4 プレフィックス。
	object	割り当てられた IPv4 プレフィックス。
Ipv4Prefix	string	ENI に割り当てられた IPv4 プレフィックス。	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	ENI に割り当てられた IPv6 プレフィックス。
	object	割り当てられた IPv6 プレフィックス。
Ipv6Prefix	string	ENI に割り当てられた IPv6 プレフィックス。	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	ENI のタグ。
	object	ENI のタグに関する情報。
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	インスタンスがリリースされたときに ENI を保持するかどうかを示します。有効値： true：ENI は保持されません。 false：ENI は保持されます。	true
TcpOptionAddressEnabled	string	説明このパラメーターは招待制プレビューであり、一般公開されていません。	null
NetworkInterfaceTrafficConfig	object	ENI の通信パラメーター。
NetworkInterfaceTrafficMode	string	ENI のトラフィックモード。	HighPerformance
QueueNumber	integer	ENI のキューの数。	8
QueuePairNumber	integer	RDMA 対応 ENI のキューの数。	8
ConnectionTrackingConfiguration	object	接続追跡設定。このパラメーターを使用する前に、「接続タイムアウト」をご参照ください。説明このパラメーターは、`Attribute` が `connectionTrackingConfiguration` に設定されている場合にのみ返されます。
TcpEstablishedTimeout	integer	`ESTABLISHED` 状態の TCP 接続のタイムアウト期間。単位：秒。有効値：30～910。	910
TcpClosedAndTimeWaitTimeout	integer	`FIN-WAIT` および `TIME-WAIT` 状態の TCP 接続のタイムアウト期間。単位：秒。有効値：3～15。説明ご利用の ECS インスタンスが Network Load Balancer (NLB) または Classic Load Balancer (CLB) インスタンスと共に使用される場合、`TIME_WAIT` 状態の接続のデフォルトのタイムアウト期間は 15 秒です。	3
UdpTimeout	integer	UDP ストリームのタイムアウト期間。単位：秒。有効値：10～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

例

成功レスポンス

JSONJSON

{
  "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": false,
    "QoS": {
      "BandwidthTx": 50000,
      "BandwidthRx": 50000,
      "PpsTx": 50000,
      "PpsRx": 50000,
      "ConcurrentConnections": 50000
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	%s
400	UnsupportedParameter	%s
400	InvalidParameter	%s
400	InvalidInstanceID.Malformed	%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
404	InvalidEniId.NotFound	%s

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

変更履歴

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