1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
查询弹性网卡列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNetworkInterfaces。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
NetworkInterfaceIds.N | 否 | Array of String | 弹性网卡实例ID查询。形如:eni-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定NetworkInterfaceIds和Filters。 |
Filters.N | 否 | Array of Filter | 过滤条件,参数不支持同时指定NetworkInterfaceIds和Filters。 vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。 subnet-id - String - (过滤条件)所属子网实例ID,形如:subnet-f49l6u0z。 network-interface-id - String - (过滤条件)弹性网卡实例ID,形如:eni-5k56k7k7。 attachment.instance-id - String - (过滤条件)绑定的云服务器实例ID,形如:ein-3nqpdn3i。 groups.security-group-id - String - (过滤条件)绑定的安全组实例ID,例如:sg-f9ekbxeq。 network-interface-name - String - (过滤条件)网卡实例名称。 network-interface-description - String - (过滤条件)网卡实例描述。 address-ip - String - (过滤条件)内网IPv4地址。 tag-key - String -是否必填:否- (过滤条件)按照标签键进行过滤。 tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 is-primary - Boolean - 是否必填:否 - (过滤条件)按照是否主网卡进行过滤。值为true时,仅过滤主网卡;值为false时,仅过滤辅助网卡;次过滤参数为提供时,同时过滤主网卡和辅助网卡。 |
Offset | 否 | Integer | 偏移量,默认为0。 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。 |
EcmRegion | 否 | String | ECM 地域,形如ap-xian-ecm。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的实例数量。 |
NetworkInterfaceSet | Array of NetworkInterface | 实例详细信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询弹性网卡列表
输入示例
https://ecm.tencentcloudapi.com/?Action=DescribeNetworkInterfaces
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"NetworkInterfaceSet": [
{
"NetworkInterfaceId": "eni-dqcedwp7",
"NetworkInterfaceName": "TEST",
"NetworkInterfaceDescription": "TEST",
"SubnetId": "subnet-o6pv7si8",
"VpcId": "vpc-j8s8351p",
"GroupSet": [
"esg-fcx8o80o"
],
"Primary": true,
"MacAddress": "20:90:6F:34:59:4F",
"State": "AVAILABLE",
"PrivateIpAddressSet": [
{
"PrivateIpAddress": "11.171.73.41",
"Primary": true,
"PublicIpAddress": "60.28.209.138",
"AddressId": "",
"Description": "TEST",
"IsWanIpBlocked": true,
"State": "AVAILABLE"
}
],
"Attachment": {
"InstanceId": "ein-05ihbvco",
"DeviceIndex": 1,
"InstanceAccountId": "1257940589",
"AttachTime": "2022-11-17 08:49:10"
},
"Zone": "ap-guangzhou-yunyou-cm-1",
"CreatedTime": "2022-11-17 08:49:10",
"Ipv6AddressSet": [
{
"Address": " 2409:8c50:a00:2035:0:9b58:a740:5945",
"Primary": true,
"AddressId": "",
"Description": "TEST",
"IsWanIpBlocked": true,
"State": "PENDING"
}
],
"TagSet": [
{
"Key": "abc",
"Value": "abc"
}
],
"EniType": 1,
"EcmRegion": "ap-ningbo-ecm-ct2",
"Business": "cvm"
}
],
"RequestId": "8f7fb33d-642f-43d7-bc8f-2d17efbfb49c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnauthorizedOperation | 鉴权失败。 |
FailedOperation.InternalOperationFailure | 内部操作错误。 |
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameterValue.InvalidFilter | 无效过滤器。 |
InvalidParameterValue.InvalidRegion | ecm region不合法。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.ParameterValueTooLarge | 参数值超出限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
UnsupportedOperation | 操作不支持。 |