调用DescribeNetworkInterfaces查看网卡列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 地址。N 表示可以设置多个 IPv6 地址，N 的取值范围：1~100。 | 2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6 |
返回参数
示例
正常返回示例
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
}
]
},
"NetworkInterfaceName": "primaryTest",
"Description": "test-description",
"SecurityGroupIds": {
"SecurityGroup": [
"sg-5p1bozeiw711a1***"
]
},
"Type": "Primary",
"Ipv6Sets": {
"Ipv6Set": [
{
"Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6\n"
}
]
}
}
]
},
"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. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-10-19 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-09-21 | OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |