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

Consulta os detalhes de um ou mais recursos de Elastic Network Interface (ENI).

Descrição da operação

A operação DescribeNetworkInterfaces oferece suporte à paginação especificando o parâmetro MaxResults ou NextToken. Notas de uso:

Ao consultar a primeira página, você só precisa especificar MaxResults para limitar o número de entradas a serem retornadas. O valor NextToken na resposta pode ser usado como o token para consultar a próxima página.
Ao consultar as páginas subsequentes, defina o parâmetro NextToken com o valor NextToken retornado da solicitação anterior e especifique MaxResults para limitar o número de entradas a serem retornadas.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
Tag	array<object>	Não	As tags.
	object	Não
Key	string	Não	A chave da tag da Elastic Network Interface (ENI). Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag da Elastic Network Interface (ENI). Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, o número de recursos que correspondem à tag não pode exceder 1.000. Se você usar várias tags para filtrar recursos, o número de recursos anexados com várias tags não pode exceder 1.000. Se o número de recursos exceder 1.000, chame a operação ListTagResources para consultar os recursos.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos. Ao usar este parâmetro para filtrar recursos, o número de recursos não pode exceder 1.000. Nota A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
VSwitchId	string	Não	O ID do vSwitch da Elastic Network Interface (ENI).	vsw-bp16usj2p27htro3****
VpcId	string	Não	O ID da VPC da Elastic Network Interface (ENI).	vpc-bp1j7w3gc1cexjqd****
PrimaryIpAddress	string	Não	O endereço IPv4 da rede privada primária da Elastic Network Interface (ENI).	192.168..
SecurityGroupId	string	Não	O ID do grupo de segurança da ENI secundária. Para consultar as informações sobre ENIs secundárias por ID de grupo de segurança, especifique este parâmetro. Para consultar as informações sobre ENIs primárias por ID de grupo de segurança, chame a operação DescribeInstances e especifique o parâmetro `SecurityGroupId`.	sg-bp144yr32sx6ndw****
NetworkInterfaceName	string	Não	O nome da Elastic Network Interface (ENI). O nome deve ter de 2 a 128 caracteres e pode conter caracteres na categorização de letras do Unicode (incluindo inglês, chinês e dígitos). Também pode conter dois-pontos (:), sublinhados (_), pontos (.) e hifens (-).	test-eni-name
Type	string	Não	O tipo de Elastic Network Interface (ENI). Valores válidos: Primary: controlador de interface de rede (NIC) primário. Secondary: ENI secundária. Valor padrão: vazio, o que indica que Elastic Network Interfaces (ENIs) de todos os tipos são consultadas.	Secondary
InstanceId	string	Não	O ID da instância à qual a Elastic Network Interface (ENI) está atualmente anexada.	i-bp1e2l6djkndyuli****
ServiceManaged	boolean	Não	Especifica se a Elastic Network Interface (ENI) é usada por um serviço do Alibaba Cloud ou por um Virtual Network Operator (VNO).	true
Status	string	Não	O status da Elastic Network Interface (ENI). Valores válidos: Available: ativa. Attaching: sendo anexada. InUse: anexada. Detaching: sendo desanexada. Deleting: sendo excluída. Valor padrão: vazio, o que indica que Elastic Network Interfaces (ENIs) em todos os estados são consultadas.	Available
PageNumber `deprecated`	integer	Não	Nota [Deprecated] Recomendamos que você use os parâmetros `MaxResults` e `NextToken` para paginação.	1
PageSize `deprecated`	integer	Não	Nota [Deprecated] Recomendamos que você use os parâmetros `MaxResults` e `NextToken` para paginação.	100
NextToken	string	Não	O token de paginação. Defina o valor como o valor `NextToken` retornado da chamada de API anterior. Para obter mais informações sobre como configurar os parâmetros de paginação, consulte a seção "Descrição da operação".	AAAAAdDWBF2****
MaxResults	integer	Não	O número máximo de entradas por página para uma consulta paginada. Valores válidos: 10 a 500. Valor padrão: Se este parâmetro não for especificado ou o valor especificado for menor que 10, o valor padrão é 10. Se o valor especificado for maior que 500, o valor padrão é 500.	50
PrivateIpAddress	array	Não	O endereço IPv4 do IP privado secundário da Elastic Network Interface (ENI). Valores válidos de N: 1 a 100.	192.168..
	string	Não	O endereço IPv4 do IP privado secundário da Elastic Network Interface (ENI). Valores válidos de N: 1 a 100.	192.168..
NetworkInterfaceId	array	Não	O ID da Elastic Network Interface (ENI). Valores válidos de N: 1 a 100.	eni-bp125p95hhdhn3ot****
	string	Não	O ID da Elastic Network Interface (ENI). Valores válidos de N: 1 a 100.	eni-bp125p95hhdhn3ot****
Ipv6Address	array	Não	O endereço IPv6 da Elastic Network Interface (ENI). N indica que vários endereços IPv6 podem ser configurados. Valores válidos de N: 1 a 100.	2408:4321:180:1701:94c7:bc38:3bfa:****
	string	Não	O endereço IPv6 da Elastic Network Interface (ENI). N indica que vários endereços IPv6 podem ser configurados. Valores válidos de N: 1 a 100.	2408:4321:180:1701:94c7:bc38:3bfa:****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação retornado pela chamada atual.	AAAAAdDWBF2****
PageSize	integer	O parâmetro de consulta paginada. Nota Este parâmetro será descontinuado em breve. Recomendamos que você use os parâmetros `NextToken` e `MaxResults` para paginação.	1
PageNumber	integer	O parâmetro de consulta paginada. Nota Este parâmetro será descontinuado em breve. Recomendamos que você use os parâmetros `NextToken` e `MaxResults` para paginação.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de recursos de Elastic Network Interface (ENI) retornados. Nota Ao usar os parâmetros `MaxResults` e `NextToken` para uma consulta paginada, o valor `TotalCount` retornado não tem significado.	2
NetworkInterfaceSets	object
NetworkInterfaceSet	array<object>	A coleção de informações da Elastic Network Interface (ENI).
	array<object>
CreationTime	string	A hora de criação. A hora é exibida no formato yyyy-MM-ddTHH:mm:ssZ de acordo com o padrão ISO 8601 em UTC.	2019-12-25T12:31:31Z
VpcId	string	O ID da VPC da Elastic Network Interface (ENI).	vpc-bp1j7w3gc1cexjqd****
Type	string	O tipo de Elastic Network Interface (ENI). Valores válidos: Primary: controlador de interface de rede (NIC) primário. Secondary: ENI secundária.	Secondary
Status	string	O status da Elastic Network Interface (ENI). Valores válidos: Available: ativa. Attaching: sendo anexada. InUse: anexada. Detaching: sendo desanexada. Deleting: sendo excluída.	Available
NetworkInterfaceTrafficMode	string	O modo de comunicação da Elastic Network Interface (ENI). Valores válidos: Standard: modo de comunicação TCP. HighPerformance: modo de comunicação RDMA com Elastic RDMA Interface (ERI) ativada. Nota O valor HighPerformance é suportado apenas pela família de instâncias com RDMA aprimorado c7re e, atualmente, este valor só pode ser definido na Zona K da região da China (Pequim).	Standard
NetworkInterfaceName	string	O nome da Elastic Network Interface (ENI).	my-eni-name
MacAddress	string	O endereço MAC da Elastic Network Interface (ENI).	00:16:3e:12::
QueuePairNumber	integer	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.	0
NetworkInterfaceId	string	O ID da Elastic Network Interface (ENI).	eni-bp125p95hhdhn3ot****
ServiceID	integer	O ID do VNO da Elastic Network Interface (ENI).	12345678910
InstanceId	string	O ID da instância à qual a Elastic Network Interface (ENI) está anexada. Nota O ID da instância não é retornado para uma Elastic Network Interface (ENI) que é gerenciada e controlada por outros serviços do Alibaba Cloud.	i-bp1e2l6djkndyuli****
OwnerId	string	O ID da conta do Alibaba Cloud à qual a Elastic Network Interface (ENI) pertence.	123456****
ServiceManaged	boolean	Especifica se a Elastic Network Interface (ENI) é usada por um serviço do Alibaba Cloud ou por um Virtual Network Operator (VNO).	true
VSwitchId	string	O ID do vSwitch da VPC.	vsw-bp16usj2p27htro3****
Description	string	A descrição.	DescriptionTest
ResourceGroupId	string	O ID do grupo de recursos.	rg-2ze88m67qx5z****
ZoneId	string	O ID da zona.	cn-hangzhou-e
PrivateIpAddress	string	O endereço IP privado da Elastic Network Interface (ENI).	172.17..
QueueNumber	integer	O número de filas para a Elastic Network Interface (ENI). Se a ENI secundária estiver no estado anexada (InUse) e o número de filas não tiver sido modificado, o número padrão de filas para ENIs secundárias do tipo de instância será retornado. Se o número de filas para a ENI secundária tiver sido modificado, o número modificado será retornado. Se a ENI secundária estiver no estado não anexada (Available) e o número de filas não tiver sido modificado, um valor vazio será retornado. Para um controlador de interface de rede (NIC) primário, o número padrão de filas para o controlador de interface de rede (NIC) primário do tipo de instância é retornado.	8
PrivateIpSets	object
PrivateIpSet	array<object>	A coleção PrivateIpSet.
	array<object>
PrivateIpAddress	string	O endereço IP privado da instância.	172.17..
Primary	boolean	Especifica se o endereço IP privado é o endereço IP privado primário. Valores válidos: true: O endereço IP privado é o endereço IP privado primário. false: O endereço IP privado é um endereço IP privado secundário.	true
AssociatedPublicIp	object	O Elastic IP Address (EIP) associado à Elastic Network Interface (ENI).
PublicIpAddress	string	O EIP.	116.62..
AllocationId	string	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.	null
PrivateDnsName	string	O nome de domínio privado da instância. Nota Um nome de domínio privado em um formato fixo é retornado apenas quando o parâmetro `HostnameType` da instância é definido como `IP` ou `InstanceId`.	DnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	A coleção de endereços IPv6 alocados à Elastic Network Interface (ENI).
	object
Ipv6Address	string	O endereço IPv6 alocado à Elastic Network Interface (ENI).	2408:4321:180:1701:94c7:bc38:3bfa:****
Primary	boolean
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	A coleção de prefixos IPv4 alocados à Elastic Network Interface (ENI).
	object
Ipv4Prefix	string	O prefixo IPv4 alocado ao controlador de interface de rede (NIC).	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	A coleção de prefixos IPv6 alocados à Elastic Network Interface (ENI).
	object
Ipv6Prefix	string	O prefixo IPv6 alocado ao controlador de interface de rede (NIC).	2001:db8:1234:1a00:****::/80
Tags	object
Tag	array<object>	As tags.
	object
TagValue	string	O valor da tag.	TestValue
TagKey	string	A chave da tag.	TestKey
SecurityGroupIds	object
SecurityGroupId	array	A coleção de grupos de segurança aos quais a ENI pertence.
	string	O ID do grupo de segurança.	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	O Elastic IP Address (EIP) associado ao endereço IP privado secundário da Elastic Network Interface (ENI).
PublicIpAddress	string	O EIP.	116.62..
AllocationId	string	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.	null
Attachment	object	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.
DeviceIndex	integer	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.	0
InstanceId	string	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.	null
TrunkNetworkInterfaceId	string	Nota Este parâmetro está em pré-visualização por convite e não está disponível para uso público.	null
NetworkCardIndex	integer	O índice da placa de rede física à qual a ENI está anexada. Se a ENI estiver no estado Available ou nenhum índice tiver sido especificado quando a ENI foi anexada, este valor não será retornado. Se a ENI estiver no estado InUse e um índice tiver sido especificado quando a ENI foi anexada, este valor indicará o índice da placa de rede física à qual a ENI está anexada.	0
DeleteOnRelease	boolean	Especifica se a ENI deve ser retida quando a instância for liberada. Valores válidos: true: A ENI não é retida. false: A ENI é retida.	true
SourceDestCheck	boolean	Especifica se a verificação de origem/destino deve ser ativada. Recomendamos que você ative este recurso para melhorar a segurança da rede. Valores válidos: true: Ativado. false: Desativado. Valor padrão: false. Nota Antes de usar este parâmetro, leia atentamente Verificação de origem/destino.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "AAAAAdDWBF2****",
  "PageSize": 1,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "NetworkInterfaceSets": {
    "NetworkInterfaceSet": [
      {
        "CreationTime": "2019-12-25T12:31:31Z",
        "VpcId": "vpc-bp1j7w3gc1cexjqd****",
        "Type": "Secondary",
        "Status": "Available",
        "NetworkInterfaceTrafficMode": "Standard",
        "NetworkInterfaceName": "my-eni-name",
        "MacAddress": "00:16:3e:12:**:**",
        "QueuePairNumber": 0,
        "NetworkInterfaceId": "eni-bp125p95hhdhn3ot****",
        "ServiceID": 12345678910,
        "InstanceId": "i-bp1e2l6djkndyuli****",
        "OwnerId": "123456****",
        "ServiceManaged": true,
        "VSwitchId": "vsw-bp16usj2p27htro3****",
        "Description": "DescriptionTest",
        "ResourceGroupId": "rg-2ze88m67qx5z****",
        "ZoneId": "cn-hangzhou-e",
        "PrivateIpAddress": "172.17.**.**",
        "QueueNumber": 8,
        "PrivateIpSets": {
          "PrivateIpSet": [
            {
              "PrivateIpAddress": "172.17.**.**",
              "Primary": true,
              "AssociatedPublicIp": {
                "PublicIpAddress": "116.62.**.**",
                "AllocationId": "null"
              },
              "PrivateDnsName": "DnsTestName"
            }
          ]
        },
        "Ipv6Sets": {
          "Ipv6Set": [
            {
              "Ipv6Address": "2408:4321:180:1701:94c7:bc38:3bfa:****",
              "Primary": false
            }
          ]
        },
        "Ipv4PrefixSets": {
          "Ipv4PrefixSet": [
            {
              "Ipv4Prefix": "192.168.**.0/28"
            }
          ]
        },
        "Ipv6PrefixSets": {
          "Ipv6PrefixSet": [
            {
              "Ipv6Prefix": "2001:db8:1234:1a00:****::/80"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-bp18kz60mefsicfg****"
          ]
        },
        "AssociatedPublicIp": {
          "PublicIpAddress": "116.62.**.**",
          "AllocationId": "null"
        },
        "Attachment": {
          "DeviceIndex": 0,
          "InstanceId": "null",
          "TrunkNetworkInterfaceId": "null",
          "NetworkCardIndex": 0
        },
        "DeleteOnRelease": true,
        "SourceDestCheck": false
      }
    ]
  }
}

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 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	InvalidOperation.InvalidEcsState	%s	Esta operação não é permitida no estado atual do serviço de nuvem.
400	InvalidOperation.InvalidEniState	%s	O status atual da ENI não oferece suporte a esta operação.
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	Você não tem permissão para desanexar a ENI primária de uma instância.
400	Forbidden.RegionId	%s	O serviço não está disponível na região atual.
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	Os usuários do Resource Access Management (RAM) não podem executar esta operação.
403	Forbidden.SubUser	%s	O usuário RAM atual não tem as permissões para gerenciar este recurso.
403	InvalidParameter	%s
403	MaxEniCountExceeded	%s	O número de ENIs excede o limite.
403	EniPerInstanceLimitExceeded	%s	O número de ENIs para o tipo de instância excedeu o limite máximo.
403	InvalidOperation.AvailabilityZoneMismatch	%s	Esta operação não é permitida devido a uma incompatibilidade de zona.
403	InvalidOperation.VpcMismatch	%s	Esta operação não é permitida.
403	SecurityGroupInstanceLimitExceed	%s	O número máximo de instâncias no grupo de segurança foi atingido.
403	InvalidSecurityGroupId.NotVpc	%s	O grupo de segurança especificado é inválido.
403	InvalidOperation.InvalidEniType	%s	Esta operação não é permitida para o tipo de interface de rede atual.
403	InvalidVpc.Empty	%s	Nenhum vSwitch foi criado na VPC especificada. Para obter mais informações, consulte o resultado de retorno real do placeholder %s na mensagem de erro.
403	Forbidden.RegionId	%s
403	InvalidOperation.InvalidEniPageNumber	%s
403	InvalidVpc.Indeterminacy	%s
404	InvalidEcsId.NotFound	%s	A instância é inválida.
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s	O ID do vSwitch especificado não existe.
404	InvalidSecurityGroupId.NotFound	%s	O grupo de segurança especificado não existe na conta do usuário. Verifique se o ID do grupo de segurança está correto.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.