全部产品
Search
文档中心

资源编排:DATASOURCE::ECS::NetworkInterfaces

更新时间:Oct 29, 2024

DATASOURCE::ECS::NetworkInterfaces类型用于查询弹性网卡(ENI)的详细信息。

语法

{
  "Type": "DATASOURCE::ECS::NetworkInterfaces",
  "Properties": {
    "Status": String,
    "PrivateIpAddresses": List,
    "ServiceManaged": Boolean,
    "ResourceGroupId": String,
    "InstanceId": String,
    "SecurityGroupId": String,
    "VSwitchId": String,
    "NetworkInterfaceName": String,
    "NetworkInterfaceIds": List,
    "PrimaryIpAddress": String,
    "Ipv6Addresses": List,
    "Type": String,
    "VpcId": String,
    "Tags": List,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

Status

String

否

是

弹性网卡的状态。

取值:

  • Available:可用。

  • Attaching:绑定中。

  • InUse:已绑定。

  • Detaching:解绑中。

  • Deleting:删除中。

说明

如果不指定该参数,则查询所有状态的弹性网卡。

PrivateIpAddresses

List

否

是

弹性网卡的辅助私网IPv4地址。

最多支持指定100个IP地址,多个IP地址间用半角逗号(,)分隔。

ServiceManaged

Boolean

否

是

弹性网卡的使用者是否为云产品或虚商。

取值:

  • true:使用者是云产品或虚商。

  • false:使用者不是云产品或虚商。

ResourceGroupId

String

否

是

资源组ID。

无

InstanceId

String

否

是

弹性网卡关联的ECS实例ID。

无

SecurityGroupId

String

否

是

辅助网卡对应的安全组ID。

如果您需要通过安全组ID查询辅助网卡的信息,请指定该参数。

VSwitchId

String

否

是

弹性网卡所属的交换机ID。

无

NetworkInterfaceName

String

否

是

弹性网卡的名称。

无

NetworkInterfaceIds

List

否

是

弹性网卡ID。

最多支持指定100个弹性网卡ID,多个弹性网卡ID间用半角逗号(,)分隔。

PrimaryIpAddress

String

否

是

弹性网卡主私网IPv4地址。

无

Ipv6Addresses

List

否

是

弹性网卡的IPv6地址。

最多支持指定100个IP地址,多个IP地址间用半角逗号(,)分隔。

Type

String

否

是

弹性网卡的类型。

取值:

  • Primary:主网卡。

  • Secondary:辅助网卡。

说明

如果不指定该参数,则查询所有类型的弹性网卡。

VpcId

String

否

是

弹性网卡所属的专有网络ID。

无

Tags

List

否

是

弹性网卡的标签。

最多支持指定20个标签。

更多信息,请参见Tags属性。

RefreshOptions

String

否

是

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Value

String

否

否

弹性网卡的标签值。

无

Key

String

是

否

弹性网卡的标签键。

无

返回数据(Fn::GetAtt)

  • NetworkInterfaceIds:弹性网卡实例ID列表。

  • NetworkInterfaces:弹性网卡实例详情列表。

属性名称

类型

描述

约束

NetworkInterfaceIds

List

弹性网卡实例ID列表。

无

NetworkInterfaces

List

弹性网卡实例详情列表。

无

VpcId

String

弹性网卡所属的专有网络ID。

无

Type

String

弹性网卡的类型。

取值:

  • Primary:主网卡。

  • Secondary:辅助网卡。

Status

String

弹性网卡的状态。

取值:

  • Available:可用。

  • Attaching:绑定中。

  • InUse:已绑定。

  • Detaching:解绑中。

  • Deleting:删除中。

NetworkInterfaceTrafficMode

String

弹性网卡的通讯模式。

取值:

  • Standard:TCP通讯模式。

  • HighPerformance:RDMA通讯模式。

NetworkInterfaceId

String

弹性网卡ID。

无

InstanceId

String

弹性网卡关联的ECS实例ID。

无

OwnerId

String

弹性网卡所属的阿里云账号ID。

无

VSwitchId

String

弹性网卡所属的交换机ID。

无

ResourceGroupId

String

资源组ID。

无

ZoneId

String

可用区ID。

无

PrivateIpAddress

String

弹性网卡的辅助私网IPv4地址列表。

无

QueueNumber

Number

弹性网卡的队列数。

取值:

  • 如果辅助网卡是已挂载(InUse)状态且没有修改过队列数,则返回实例规格默认的辅助网卡队列数。

  • 如果辅助网卡修改过队列数,则返回修改后的队列数。

  • 如果辅助网卡是未挂载(Available)状态且未修改过队列数,则返回值为空。

  • 主网卡返回实例规格默认的主网卡队列数。

PrivateIpSets

List

实例的私网IP地址信息列表。

无

Ipv6Sets

List

为弹性网卡分配的IPv6地址列表。

无

Tags

List

标签。

无

SecurityGroupIds

List

弹性网卡所属的安全组列表。

无

AssociatedPublicIp

List

弹性网卡辅助私有IP地址关联的弹性公网IP地址列表。

无

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Tags": {
      "Type": "Json",
      "Default": {"Key": "acs:privatelink:serviceType", "Value": "natgw"}
    }
  },
  "Resources": {
    "NetworkInterfaces": {
      "Type": "DATASOURCE::ECS::NetworkInterfaces",
      "Properties": {
        "RegionId": {
          "Ref": "ALIYUN::Region"
        },
        "Tags": {
          "Ref": "Tags"
        }
      }
    }
  },
  "Outputs": {
    "Images": {
      "Value": {
        "Fn::GetAtt": [
          "NetworkInterfaces",
          "NetworkInterfaceIds"
        ]
      }
    },
    "ImageIds": {
      "Value": {
        "Fn::GetAtt": [
          "NetworkInterfaces",
          "NetworkInterfaces"
        ]
      }
    }
  }
}