DocsICP FilingConsole
Documentation

ListNetworkInterfaces

Updated at:
Copy as MD
Product
My Favorites

Queries Lingjun network interfaces (LNIs).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:ListNetworkInterfaces

list

*NetworkInterface

acs:eflo:{#regionId}:{#accountId}:NetworkInterface/*

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

The region ID.

cn-wulanchabu
NetworkInterfaceId

string

No

Lingjun network interface controller ID.

lni-bp18exxqa2rvfn45e5pz
VpdId

string

No

The ID of the VPD.

vpd-iv2zm1qf
NodeId

string

No

The ID of the machine to which the instance belongs.

r-2ze121o4uhr4np3r5t-db-5
SubnetId

string

No

The ID of the instance to which the Lingjun subnet belongs.

subnet-anhtskts
Ip

string

No

network interface controller the IP address.

203.107.46.227
PageNumber

integer

No

The number of the page to return.

1
PageSize

integer

No

The current number of pages.

10
EnablePage

boolean

No

Specifies whether pagination is required.

false
ResourceGroupId

string

No

Resource group instance ID

rg-aek2ojvzk4avjby
Tag

array<object>

No

The list of tags

object

No

The tag information.

Key

string

No

The key of the tag.

k-test
Value

string

No

The value of the tag.

v-test

Response elements

Element

Type

Description

Example

object

The response entity object.

Code

integer

The response status code.

0
Message

string

The error message. (If the instance is in the Exception state, the exception cause is prompted.)

success
RequestId

string

The request ID.

039C3C3A-3C37-5672-80D5-D8CD48C676D1
Content

object

The response data.

Total

integer

The total number of entries that are returned.

0
Data

array<object>

The response parameters.

array<object>

lingjun network interface controller information.

TenantId

string

The tenant ID.

1620939556166279

RegionId

string

The region ID.

cn-wulanchabu
NetworkInterfaceId

string

Lingjun network interface controller ID.

lni-2ze50voovmtswn328ogm
NodeId

string

The ID of the machine to which the instance belongs.

2d53f5c204e7476dae69177e7fa6f19c
VpdBaseInfo

object

Lingjun network segment (VPD) basic information.

VpdId

string

The ID of the VPD instance.

vpd-d3isyds4
VpdName

string

The name of the VPD instance.

vpd-1

Cidr

string

The network segment of Lingjun network segment (VPD).

  • We recommend that you use an RFC private endpoint as the Lingjun CIDR block, such as 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16. In scenarios where the Doringjun CIDR block is connected to each other or where the Lingjun CIDR block is connected to a VPC, make sure that the addresses do not conflict with each other.

  • You can also use a custom CIDR block other than 100.64.0.0/10, 224.0.0.0/4, 127.0.0.0/8, or 169.254.0.0/16 and their subnets as the primary IPv4 CIDR block of the VPD. This parameter is left empty by default.

10.0.0.0/16
CreateTime

string

The time when the activation code was created.

1668158213000
ZoneId

string

The zone ID.

cn-wulanchabu-b
SubnetBaseInfo

object

Lingjun subnet (Subnet) basic information.

SubnetId

string

The ID of the Subnet instance.

subnet-yjnqn5ef
SubnetName

string

The name of the Subnet instance.

subnet-1
Cidr

string

The network segment of the Subnet.

  • The network segment of the subnet must be a proper subset of the network segment of Lingjun to which it belongs, and the mask must be between 16 bits and 29 bits, which can provide 8 to 65536 addresses. For example, the CIDR block of the Lingjun CIDR block is 192.168.0.0/16, and the CIDR blocks of the subnets under the Lingjun CIDR block are 192.168.0.0/17 to 192.168.0.0/29.

  • The first and last three IP addresses of each subnet segment are reserved by the system. For example, the CIDR blocks of the subnet are 192.168.1.0/24,192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255.

For more information about CIDR blocks, see the What is CIDR? section in the "Network FAQ" topic.

This parameter is left empty by default.

10.0.0.0/24
CreateTime

string

The time when the activation code was created.

1623656472000
Ip

string

The IP address of the instance.

10.0.0.13
ServiceMac

string

The address of the service network interface controller.

00-ff-84-15-ba-67
PrivateIpAddressMacGroup

array<object>

Secondary Private IP&MAC Address Collection

object

descriptor

IpName

string

The unique IP identifier.

sip-1asjd3xg
PrivateIpAddress

string

The secondary private IP address.

10.0.0.14
IpAddressMac

string

Secondary private MAC address.

00:25:9d:00:20:20
Status

string

The status of the cache reserve instance.

Available
Description

string

The instance description.

test测试
Message

string

The error message. (If the instance is in the Exception state, the exception cause is prompted.)

success
Ethernet

array

The port number of the AD server.

string

network interface controller port information.

eth1 eth2
Status

string

The task status.

Available
Gateway

string

The gateway.

10.0.0.253
CreateTime

string

The time when the activation code was created.

1669734207000
Quota

integer

network interface controller private secondary IP quota.

6
NcType

string

The NC type.

Valid value:

  • CUSTOM_LNI_INTEGRATION: two-network one-in-one architecture Lingjun hosting network interface controller.

  • CPU: CPU machine.

  • ELASTIC_6.2: Machine

  • GPU: GPU machine.

  • DEFAULT: the old CPU machine.

  • CUSTOM_LNI: two network separation architecture Lingjun hosting network interface controller.

Valid values:

  • CUSTOM_LNI_INTEGRATION :
  • CPU :
  • ELASTIC_6.2 :
  • GPU :
  • DEFAULT :
  • CUSTOM_LNI :

GPU
NetworkInterfaceName

string

The port name.

bond0
ResourceGroupId

string

Resource group instance ID

rg-acfm4c7urez5byi
Tags

array<object>

List of tags.

object

The information about the tag.

TagKey

string

The tag key.

k-test
TagValue

string

The tag value.

v-test
AccessDeniedDetail

string

The details about the access denial.

None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "success",
  "RequestId": "039C3C3A-3C37-5672-80D5-D8CD48C676D1",
  "Content": {
    "Total": 0,
    "Data": [
      {
        "TenantId": "1620939556166279\n",
        "RegionId": "cn-wulanchabu",
        "NetworkInterfaceId": "lni-2ze50voovmtswn328ogm",
        "NodeId": "2d53f5c204e7476dae69177e7fa6f19c",
        "VpdBaseInfo": {
          "VpdId": "vpd-d3isyds4",
          "VpdName": "vpd-1\n",
          "Cidr": "10.0.0.0/16",
          "CreateTime": "1668158213000"
        },
        "ZoneId": "cn-wulanchabu-b",
        "SubnetBaseInfo": {
          "SubnetId": "subnet-yjnqn5ef",
          "SubnetName": "subnet-1",
          "Cidr": "10.0.0.0/24",
          "CreateTime": "1623656472000"
        },
        "Ip": "10.0.0.13",
        "ServiceMac": "00-ff-84-15-ba-67",
        "PrivateIpAddressMacGroup": [
          {
            "IpName": "sip-1asjd3xg",
            "PrivateIpAddress": "10.0.0.14",
            "IpAddressMac": "00:25:9d:00:20:20",
            "Status": "Available",
            "Description": "test测试",
            "Message": "success"
          }
        ],
        "Ethernet": [
          "eth1 eth2"
        ],
        "Status": "Available",
        "Gateway": "10.0.0.253",
        "CreateTime": "1669734207000",
        "Quota": 6,
        "NcType": "GPU",
        "NetworkInterfaceName": "bond0",
        "ResourceGroupId": "rg-acfm4c7urez5byi",
        "Tags": [
          {
            "TagKey": "k-test",
            "TagValue": "v-test"
          }
        ]
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.