DescribeNetworkInterfaceAttribute - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma Interface de Rede Elástica (ENI) pelo ID da ENI.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribeNetworkInterfaceAttribute

get

*Interface de rede.

acs:ecs:{#regionId}:{#accountId}:eni/{#eniId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do controlador de interface de rede (NIC). Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
Tag	array<object>	Não	Nota Este parâmetro não está disponível para uso.
	object	Não	Nota Este parâmetro não está disponível para uso.
Key	string	Não	Nota Este parâmetro não está disponível para uso.	TestKey
Value	string	Não	Nota Este parâmetro não está disponível para uso.	TestValue
NetworkInterfaceId	string	Sim	O ID do controlador de interface de rede (NIC).	eni-bp67acfmxazb4p****
Attribute	string	Não	A propriedade da Interface de Rede Elástica (ENI). Valores válidos:\n\nattachment: consulta as informações de anexação dos controladores de interface de rede (NICs) membros para um controlador de interface de rede (NIC) tronco. Este parâmetro está em visualização por convite e não está disponível para uso.\n\nconnectionTrackingConfiguration: consulta a configuração de rastreamento de conectividade de rede.\n\nValor padrão: vazio.	attachment

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A coleção de informações da ENI.
CreationTime	string	A hora em que a interface de rede (NIC) foi criada. A hora está no formato ISO 8601 e é exibida em UTC.	2019-12-25T12:31:31Z
VpcId	string	O ID da VPC à qual a interface de rede (NIC) pertence.	vpc-bp67acfmxazb4p****
Type	string	O tipo da Elastic Network Interface (ENI). Valores válidos: Primary: interface de rede (NIC) primária. Secondary: Elastic Network Interface (ENI) secundária.	Secondary
Status	string	O status da interface de rede (NIC). Valores válidos: Available: disponível. Attaching: sendo anexada. InUse: em uso. Detaching: sendo desanexada. Deleting: sendo excluída. Valor padrão: vazio, o que indica que as interfaces de rede (NICs) em todos os estados são consultadas.	Available
NetworkInterfaceTrafficMode	string	O modo de comunicação da interface de rede (NIC). Valores válidos: Standard: o modo de comunicação TCP é usado. HighPerformance: a Elastic RDMA Interface (ERI) está ativada e o modo de comunicação RDMA é usado. Nota O valor do parâmetro HighPerformance é compatível apenas com a família de instâncias aprimoradas para RDMA c7re.	Standard
NetworkInterfaceName	string	O nome da interface de rede (NIC).	my-eni-name
MacAddress	string	O endereço MAC da interface de rede (NIC).	00:16:3e:12::
QueuePairNumber	integer	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	22
NetworkInterfaceId	string	O ID do controlador de interface de rede (NIC).	eni-bp125p95hhdhn3ot****
ServiceID	integer	O ID do Operador de Rede Virtual (VNO) associado à interface de rede (NIC).	12345678910
InstanceId	string	O ID da instância à qual a interface de rede (NIC) está anexada. Nota As interfaces de rede (NICs) que são gerenciadas e controladas por outros serviços da Alibaba Cloud não retornam IDs de instância.	i-bp1e2l6djkndyuli****
OwnerId	string	O ID da conta que possui a interface de rede (NIC).	123456****
ServiceManaged	boolean	Indica se o usuário da interface de rede (NIC) é um serviço da Alibaba Cloud ou um VNO.	true
VSwitchId	string	O ID do vSwitch ao qual a interface de rede (NIC) pertence.	vsw-bp1s5fnvk4gn2tws0****
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Description	string	A descrição da interface de rede (NIC).	testDescription
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância pertence. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1000. Nota A filtragem pelo grupo de recursos padrão não é compatível.	rg-bp67acfmxazb4p****
ZoneId	string	O ID da zona.	cn-hangzhou-g
PrivateIpAddress	string	O endereço IP privado da interface de rede (NIC).	10.1..
QueueNumber	integer	O número de filas para a Elastic Network Interface (ENI). Se a ENI for uma interface de rede (NIC) primária: o número padrão de filas para a NIC primária que o tipo de instância permite é retornado. Se a ENI for uma ENI secundária: Se a ENI secundária estiver no estado InUse: Se o número de filas para a ENI secundária não tiver sido modificado, o número padrão de filas para a ENI secundária que o tipo de instância permite é retornado. Se o número de filas para a ENI secundária tiver sido modificado, o número modificado de filas é retornado. Se a ENI secundária estiver no estado disponível (Available): Se o número de filas para a ENI secundária não tiver sido modificado, um valor vazio é retornado. Se o número de filas para a ENI secundária tiver sido modificado, o número modificado de filas é retornado.	8
SecurityGroupIds	object
SecurityGroupId	array	A coleção de grupos de segurança aos quais a interface de rede (NIC) pertence.
	string	O grupo de segurança ao qual a interface de rede (NIC) pertence.	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	O Elastic IP Address (EIP) associado ao endereço IP privado secundário da interface de rede (NIC).
PublicIpAddress	string	O endereço EIP.	116.62..
AllocationId	string	O ID do EIP.	null
Attachment	object	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.
DeviceIndex	integer	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	hide
InstanceId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	hide
TrunkNetworkInterfaceId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	hide
MemberNetworkInterfaceIds	object
MemberNetworkInterfaceId	array	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.
	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	hide
NetworkCardIndex	integer	O índice da placa de rede à qual a ENI está anexada. Se a ENI estiver no estado Available ou se o índice não foi especificado durante a anexação, este valor não é retornado. Se a ENI estiver no estado InUse e o índice foi especificado durante a anexação, este valor indica o índice da placa de rede à qual a ENI está anexada.	0
PrivateIpSets	object
PrivateIpSet	array<object>	A coleção de informações de endereços IP privados da interface de rede (NIC).
	array<object>	As informações de endereço IP privado da interface de rede (NIC).
PrivateIpAddress	string	O endereço IP privado da interface de rede (NIC).	172.17..
Primary	boolean	Indica se o endereço IP é o endereço IP privado primário. Valores válidos: true: endereço IP privado primário. false: endereço IP privado secundário.	true
AssociatedPublicIp	object	O Elastic IP Address (EIP) associado ao endereço IP privado secundário da interface de rede (NIC).
PublicIpAddress	string	O endereço EIP.	116.62..
AllocationId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
Ipv6Sets	object
Ipv6Set	array<object>	A lista de endereços IPv6 alocados à interface de rede (NIC).
	object	O endereço IPv6 alocado à interface de rede (NIC).
Ipv6Address	string	O endereço IPv6 atribuído à interface de rede (NIC).	2001:db8:1234:1a00::****
Primary	boolean
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	A coleção de prefixos IPv4 alocados à interface de rede (NIC).
	object	O prefixo IPv4 atribuído à ENI.
Ipv4Prefix	string	O prefixo IPv4 alocado para o controlador de interface de rede (NIC).	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	A coleção de prefixos IPv6 alocados à interface de rede (NIC).
	object
Ipv6Prefix	string	O prefixo IPv6 alocado para o controlador de interface de rede (NIC).	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	A coleção de tags da interface de rede (NIC).
	object	As informações de tag da interface de rede (NIC).
TagValue	string	O valor da tag.	TestValue
TagKey	string	A chave da tag.	TestKey
BondInterfaceSpecification	object	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.
BondMode	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
SlaveInterfaceSpecification	object
SlaveInterfaceSpecificationSet	array<object>	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.
	object	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.
SlaveNetworkInterfaceId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
WorkState	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
BondNetworkInterfaceId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
SlaveInterfaceSpecification	object	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.
SlaveNetworkInterfaceId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
WorkState	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
BondNetworkInterfaceId	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
DeleteOnRelease	boolean	Indica se a ENI é retida quando a instância associada é liberada. Valores válidos: true: A ENI não é retida. false: A ENI é retida.	true
TcpOptionAddressEnabled	string	Nota Este parâmetro está em versão prévia por convite e não está disponível publicamente.	null
NetworkInterfaceTrafficConfig	object	Os parâmetros de tráfego do controlador de interface de rede (NIC).
NetworkInterfaceTrafficMode	string	O modo de comunicação do controlador de interface de rede (NIC).	HighPerformance
QueueNumber	integer	O número de filas do controlador de interface de rede (NIC).	8
QueuePairNumber	integer	O número de pares de filas RDMA.	8
ConnectionTrackingConfiguration	object	A coleção de informações de configuração de rastreamento de conectividade de rede. Antes de usar este parâmetro, leia Gerenciamento de tempo limite de conexão. Nota Este parâmetro é retornado apenas quando o parâmetro de entrada Attribute é definido como connectionTrackingConfiguration.
TcpEstablishedTimeout	integer	O período de tempo limite para conexões TCP no estado ESTABLISHED. Unidade: segundos. Valores válidos: [30, 60, 80, 100, 200, 300, 500, 700, 910].	910
TcpClosedAndTimeWaitTimeout	integer	O período de tempo limite para conexões TCP nos estados TIME_WAIT e CLOSED. Unidade: segundos. Valores válidos: um número inteiro de 3 a 15. Nota Se a sua instância ECS for usada com NLB ou CLB, o período de tempo limite padrão para conexões no estado `TIME_WAIT` é de 15 segundos.	3
UdpTimeout	integer	O período de tempo limite para fluxos UDP. Unidade: segundos. Valores válidos: [10, 20, 30, 60, 80, 100]. Nota Se a sua instância ECS for usada com NLB ou CLB, o valor padrão é de 100 segundos.	30
SourceDestCheck	boolean	Este parâmetro não está disponível publicamente.	false
EnhancedNetwork	object	Este parâmetro não está disponível publicamente.
EnableSriov	boolean	Este parâmetro não está disponível publicamente.	false
EnableRss	boolean	Nota Este parâmetro não está disponível para uso.	true
VirtualFunctionTotalQueueNumber	integer
VirtualFunctionQuantity	integer
EnableExpress	boolean
QoSConfig	object	As configurações de limite de taxa de QoS.
EnableQoS	boolean	Indica se a limitação de taxa de QoS está ativada.
QoS	object	As configurações de limite de taxa de QoS.
BandwidthTx	integer	O limite máximo de largura de banda interna de saída.	50000
BandwidthRx	integer	O limite máximo de largura de banda interna de entrada.	50000
PpsTx	integer	A taxa de encaminhamento de pacotes da rede interna de saída.	50000
PpsRx	integer	A taxa de encaminhamento de pacotes da rede interna de entrada.	50000
ConcurrentConnections	integer	O número máximo de sessões.	50000

Exemplos

Resposta de sucesso

JSON formato

{
  "CreationTime": "2019-12-25T12:31:31Z",
  "VpcId": "vpc-bp67acfmxazb4p****",
  "Type": "Secondary",
  "Status": "Available",
  "NetworkInterfaceTrafficMode": "Standard",
  "NetworkInterfaceName": "my-eni-name",
  "MacAddress": "00:16:3e:12:**:**",
  "QueuePairNumber": 22,
  "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
  "ServiceID": 12345678910,
  "InstanceId": "i-bp1e2l6djkndyuli****",
  "OwnerId": "123456****",
  "ServiceManaged": true,
  "VSwitchId": "vsw-bp1s5fnvk4gn2tws0****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Description": "testDescription",
  "ResourceGroupId": "rg-bp67acfmxazb4p****",
  "ZoneId": "cn-hangzhou-g",
  "PrivateIpAddress": "10.1.**.**",
  "QueueNumber": 8,
  "SecurityGroupIds": {
    "SecurityGroupId": [
      "sg-bp18kz60mefsicfg****"
    ]
  },
  "AssociatedPublicIp": {
    "PublicIpAddress": "116.62.**.**",
    "AllocationId": "null"
  },
  "Attachment": {
    "DeviceIndex": 0,
    "InstanceId": "hide",
    "TrunkNetworkInterfaceId": "hide",
    "MemberNetworkInterfaceIds": {
      "MemberNetworkInterfaceId": [
        "hide"
      ]
    },
    "NetworkCardIndex": 0
  },
  "PrivateIpSets": {
    "PrivateIpSet": [
      {
        "PrivateIpAddress": "172.17.**.**",
        "Primary": true,
        "AssociatedPublicIp": {
          "PublicIpAddress": "116.62.**.**",
          "AllocationId": "null"
        }
      }
    ]
  },
  "Ipv6Sets": {
    "Ipv6Set": [
      {
        "Ipv6Address": "2001:db8:1234:1a00::****",
        "Primary": false
      }
    ]
  },
  "Ipv4PrefixSets": {
    "Ipv4PrefixSet": [
      {
        "Ipv4Prefix": "192.168.**.0/28"
      }
    ]
  },
  "Ipv6PrefixSets": {
    "Ipv6PrefixSet": [
      {
        "Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
      }
    ]
  },
  "Tags": {
    "Tag": [
      {
        "TagValue": "ValorTeste",
        "TagKey": "ChaveTeste"
      }
    ]
  },
  "BondInterfaceSpecification": {
    "BondMode": "null",
    "SlaveInterfaceSpecification": {
      "SlaveInterfaceSpecificationSet": [
        {
          "SlaveNetworkInterfaceId": "null",
          "WorkState": "null",
          "BondNetworkInterfaceId": "null"
        }
      ]
    }
  },
  "SlaveInterfaceSpecification": {
    "SlaveNetworkInterfaceId": "null",
    "WorkState": "null",
    "BondNetworkInterfaceId": "null"
  },
  "DeleteOnRelease": true,
  "TcpOptionAddressEnabled": "null",
  "NetworkInterfaceTrafficConfig": {
    "NetworkInterfaceTrafficMode": "HighPerformance",
    "QueueNumber": 8,
    "QueuePairNumber": 8
  },
  "ConnectionTrackingConfiguration": {
    "TcpEstablishedTimeout": 910,
    "TcpClosedAndTimeWaitTimeout": 3,
    "UdpTimeout": 30
  },
  "SourceDestCheck": false,
  "EnhancedNetwork": {
    "EnableSriov": false,
    "EnableRss": true,
    "VirtualFunctionTotalQueueNumber": 0,
    "VirtualFunctionQuantity": 0,
    "EnableExpress": false
  },
  "QoSConfig": {
    "EnableQoS": false,
    "QoS": {
      "BandwidthTx": 50000,
      "BandwidthRx": 50000,
      "PpsTx": 50000,
      "PpsRx": 50000,
      "ConcurrentConnections": 50000
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	%s	Um parâmetro obrigatório está ausente.
400	UnsupportedParameter	%s	O parâmetro especificado não é suportado. Verifique se o parâmetro está correto.
400	InvalidParameter	%s	Os parâmetros da solicitação atual são inválidos. Tente novamente.
400	InvalidInstanceID.Malformed	%s
400	Forbidden.RegionId	%s	O serviço está atualmente indisponível nesta região.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.
403	InvalidUserType.NotSupported	%s	O tipo de usuário é inválido.
403	Abs.InvalidAccount.NotFound	%s	A conta não foi encontrada ou a AccessKey expirou.
403	Forbidden.NotSupportRAM	%s	Não há suporte para a execução desta operação por usuários do Resource Access Management (RAM).
403	Forbidden.SubUser	%s	Seu usuário RAM atual não tem permissão para realizar operações neste recurso.
403	InvalidParameter	%s
404	InvalidEniId.NotFound	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.