describeNetworkInterfaces
描述
查询弹性网卡列表
请求方式
GET
请求地址
https://yunding.jdcloud-api.com/v2/regions/{regionId}/ydNetworkInterfaces
| 名称 | 类型 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|---|
| regionId | String | True | Region ID |
请求参数
| 名称 | 类型 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|---|
| pageNumber | Integer | False | 1 | 页码, 默认为1, 取值范围：[1,∞), 页码超过总页数时, 显示最后一页 |
| pageSize | Integer | False | 20 | 分页大小，默认为20，取值范围：[10,100] |
| filters | Filter[] | False | networkInterfaceIds - 弹性网卡ID列表，支持多个 networkInterfaceNames - 弹性网卡名称列表，支持多个 vpcId - 弹性网卡所属vpc Id，支持单个 subnetId - 弹性网卡所属子网Id，支持单个 role - 网卡角色，取值范围：Primary（主网卡）、Secondary（辅助网卡）、Managed （受管网卡），支持单个 |
Filter
| 名称 | 类型 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|---|
| name | String | True | 过滤条件的名称 | |
| operator | String | False | 过滤条件的操作符，默认eq | |
| values | String[] | True | 过滤条件的值 |
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| result | Result | 返回结果 |
| requestId | String | 请求ID |
Result
| 名称 | 类型 | 描述 |
|---|---|---|
| networkInterfaces | NetworkInterface[] | networkInterface资源信息列表 |
| totalCount | Number | 总数量 |
NetworkInterface
| 名称 | 类型 | 描述 |
|---|---|---|
| networkInterfaceName | String | 弹性网卡名称 |
| networkInterfaceId | String | 弹性网卡ID |
| azType | String | 网卡所在az类型，取值：standard(标准Az)，edge(边缘Az) |
| az | String | 网卡所在Az, 标准为""， 边缘为边缘az |
| role | String | 网卡角色，取值范围：Primary（主网卡）、Secondary（辅助网卡） |
| macAddress | String | 以太网地址 |
| vpcId | String | 虚拟网络ID |
| subnetId | String | 子网ID |
| networkSecurityGroupIds | String[] | 安全组ID列表 |
| sanityCheck | Integer | 源和目标IP地址校验，取值为0或者1 |
| primaryIp | NetworkInterfacePrivateIp | 网卡主IP |
| secondaryIps | NetworkInterfacePrivateIp[] | 网卡附属IP列表 |
| secondaryCidrs | String[] | 网卡附属IP网段 |
| secondaryCidrsEx | NetworkInterfaceCidr[] | 网卡附属IP网段 |
| instanceType | String | 关联实例类型，取值范围：compute、lb、container、pod |
| instanceId | String | 关联实例ID |
| instanceOwnerId | String | 实例所属的账号 |
| deviceIndex | Integer | 网卡在实例上的设备索引号，取值范围：[0,8]，0：辅助网卡未绑定设备，1：主网卡，2-8：辅助网卡已绑定设备 |
| description | String | 网卡描述信息 |
| attachmentStatus | String | 弹性网卡绑定实例状态，attached（已绑定）、detached（未绑定） |
| networkInterfaceStatus | String | 弹性网卡可用状态，enabled（启用）、disabled（停用） |
| createdTime | String | 弹性网卡创建时间 |
| tags | Tag[] | Tag信息 |
| resourceGroupId | String | 资源所属资源组ID |
Tag
| 名称 | 类型 | 描述 |
|---|---|---|
| key | String | Tag键 |
| value | String | Tag值 |
NetworkInterfaceCidr
| 名称 | 类型 | 描述 |
|---|---|---|
| secondaryCidr | String | cidr |
| subnetId | String | cidr所属子网 |
NetworkInterfacePrivateIp
| 名称 | 类型 | 描述 |
|---|---|---|
| privateIpAddress | String | 私有IP的IPV4地址 |
| elasticIpId | String | 弹性IP实例ID |
| elasticIpAddress | String | 弹性IP实例地址 |
| subnetId | String | ip所在子网ID |
返回码
| HTTP状态码 | 错误码 | 描述 |
|---|---|---|
| 200 | OK |