调用DescribeNetworkInterfaces查看网卡列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ens:DescribeNetworkInterfaces |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| NetworkInterfaceId |
string |
否 |
弹性网卡 ID。 |
eni-58z57orgmt6d1**** |
| InstanceId |
string |
否 |
实例 ID。 |
i-5t7z99n32gplriv |
| NetworkId |
string |
否 |
网络 ID。 |
n-2zeuphj08tt7q3brd**** |
| VSwitchId |
string |
否 |
交换机 ID。 |
vsw-12345 |
| EnsRegionId |
string |
否 |
实例所属地域 ID。 |
cn-tianjin-cmcc |
| SecurityGroupId |
string |
否 |
辅助网卡对应的安全组 ID。 如果您需要通过安全组 ID 查询辅助网卡的信息,请指定该参数。 |
sg-5p1fg655nh68xyz9i*** |
| PrimaryIpAddress |
string |
否 |
弹性网卡主 IP 地址。 |
10.XXX.XXX.5 |
| Type |
string |
否 |
弹性网卡类型。取值范围:
默认值:空,表示查询所有类型。 |
Secondary |
| NetworkInterfaceName |
string |
否 |
弹性网卡的名称。 |
test-01 |
| Status |
string |
否 |
弹性网卡的状态。取值范围:
默认值:空,表示查询所有状态。 |
Available |
| PageNumber |
string |
否 |
实例状态列表的页码,起始值为 1。 默认值:1。 |
1 |
| PageSize |
string |
否 |
分页查询时每页的行数,最大值为 100,默认值为 50。 |
50 |
| Ipv6Address |
array |
否 |
弹性网卡的 IPv6 地址。N 表示可以设置多个 IPv6 地址,N 的取值范围:1~100。 |
|
|
string |
否 |
弹性网卡的 IPv6 地址。 |
2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6 |
|
| EnsRegionIds |
array |
否 |
ENS 节点 ID 列表。N 表示可以设置多个节点 ID,N 的取值范围:1~100。 |
|
|
string |
否 |
ENS 节点 ID。 |
cn-fuzhou-1 |
|
| NetworkInterfaceIds |
array |
否 |
弹性网卡 ID 列表。N 表示可以设置多个弹性网卡 ID,N 的取值范围:1~100。 |
|
|
string |
否 |
弹性网卡 ID。 |
eni-5**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
弹性网卡信息组成的集合。 |
||
| NetworkInterfaceSets |
object |
||
| NetworkInterfaceSet |
array<object> |
弹性网卡信息组成的集合。 |
|
|
array<object> |
弹性网卡信息组成的集合。 |
||
| CreationTime |
string |
创建时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:yyyy-MM-ddThh:mmZ。 |
2022-02-22T03:53:25Z |
| EnsRegionId |
string |
ENS 的节点 ID。 |
id-jakarta-1 |
| InstanceId |
string |
弹性网卡绑定的实例 ID。 |
i-5siavnr3 |
| MacAddress |
string |
弹性网卡的 MAC 地址。 |
00:16:XXX:XXX:60:0a |
| NetworkInterfaceId |
string |
弹性网卡 ID。 |
eni-uf686a5 |
| PrimaryIp |
string |
主私网 IP。 |
10.XXX.XXX.25 |
| PrimaryIpType |
string |
主 IP 地址类型。取值:
|
Private |
| Status |
string |
网卡的状态,取值:
|
InUse |
| NetworkId |
string |
网络 ID。 |
n-5w0qd03adw**** |
| VSwitchId |
string |
交换机 ID。 |
vsw-5rqswx1trlsj9 |
| PrivateIpSets |
object |
||
| PrivateIpSet |
array<object> |
PrivateIpSet 组成的集合。 |
|
|
object |
PrivateIpSet 组成的集合。 |
||
| PrivateIpAddress |
string |
私网 IP。 |
192.XXX.XXX.130 |
| Primary |
boolean |
是否是主私网 IP 地址。可能值:
|
true |
| PrivateIpStatus |
string |
私有 IP 状态,取值:
|
Available |
| NetworkInterfaceName |
string |
弹性网卡的名称。 |
primaryTest |
| Description |
string |
弹性网卡的描述。 |
test-description |
| SecurityGroupIds |
object |
||
| SecurityGroup |
array |
安全组 ID。 |
|
|
string |
安全组 ID。 |
sg-5p1bozeiw711a1*** |
|
| Type |
string |
弹性网卡类型。取值范围:
|
Primary |
| Ipv6Sets |
object |
||
| Ipv6Set |
array<object> |
弹性网卡已分配的 IPv6 地址集合。 |
|
|
object |
弹性网卡已分配的 IPv6 地址集合。 |
||
| Ipv6Address |
string |
弹性网卡已分配的 IPv6 地址。 |
2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6 |
| VmncLearn |
boolean |
||
| PageNumber |
integer |
实例状态列表的页码,起始值为:1,默认值:1。 |
1 |
| PageSize |
integer |
分页查询时每页的行数,最大值为 50,默认值为 10。 |
50 |
| TotalCount |
integer |
列表数据总数。 |
49 |
| RequestId |
string |
请求 ID。 |
708AF9CE-FF92-5DF9-93F8-B7754AB1061A |
示例
正常返回示例
JSON格式
{
"NetworkInterfaceSets": {
"NetworkInterfaceSet": [
{
"CreationTime": "2022-02-22T03:53:25Z",
"EnsRegionId": "id-jakarta-1",
"InstanceId": "i-5siavnr3",
"MacAddress": "00:16:XXX:XXX:60:0a",
"NetworkInterfaceId": "eni-uf686a5",
"PrimaryIp": "10.XXX.XXX.25",
"PrimaryIpType": "Private",
"Status": "InUse",
"NetworkId": "n-5w0qd03adw****",
"VSwitchId": "vsw-5rqswx1trlsj9",
"PrivateIpSets": {
"PrivateIpSet": [
{
"PrivateIpAddress": "192.XXX.XXX.130",
"Primary": true,
"PrivateIpStatus": "Available"
}
]
},
"NetworkInterfaceName": "primaryTest",
"Description": "test-description",
"SecurityGroupIds": {
"SecurityGroup": [
"sg-5p1bozeiw711a1***"
]
},
"Type": "Primary",
"Ipv6Sets": {
"Ipv6Set": [
{
"Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6\n"
}
]
},
"VmncLearn": true
}
]
},
"PageNumber": 1,
"PageSize": 50,
"TotalCount": 49,
"RequestId": "708AF9CE-FF92-5DF9-93F8-B7754AB1061A"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Missing%s | You must specify the parameter %s. | |
| 400 | Invalid%s | The specified parameter %s is invalid. | |
| 400 | ens.interface.error | Failed to call API. | 接口调用发生异常。 |
| 400 | NoPermission | Permission denied. | |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。