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

Consulta os detalhes de uma ou mais Elastic Network Interfaces (ENIs).

Descrição da operação

A operação DescribeNetworkInterfaces suporta paginação através da especificação do parâmetro MaxResults ou NextToken. Notas de uso:

Ao consultar a primeira página, defina apenas MaxResults para limitar o número de entradas retornadas. O valor NextToken na resposta é usado como credencial para consultar as páginas subsequentes.
Ao consultar páginas subsequentes, defina NextToken com o valor NextToken obtido na resposta anterior e defina MaxResults para limitar o número de entradas 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

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:DescribeNetworkInterfaces

get

NetworkInterface.

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. Você pode chamar 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 do controlador de interface de rede (NIC). Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag do controlador de interface de rede (NIC). Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, a contagem de recursos com a tag especificada não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos que possuem todas as tags especificadas não pode exceder 1.000. Se a contagem 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. Se você usar este parâmetro para filtrar recursos, a contagem 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 do controlador de interface de rede (NIC).	vsw-bp16usj2p27htro3****
VpcId	string	Não	O ID da Virtual Private Cloud (VPC) do controlador de interface de rede (NIC).	vpc-bp1j7w3gc1cexjqd****
PrimaryIpAddress	string	Não	O endereço IP privado primário do controlador de interface de rede (NIC).	192.168..
SecurityGroupId	string	Não	O ID do grupo de segurança da ENI secundária. Para consultar informações sobre uma ENI secundária por ID de grupo de segurança, especifique este parâmetro. Para consultar informações sobre uma ENI primária por ID de grupo de segurança, chame DescribeInstances e especifique o parâmetro `SecurityGroupId`.	sg-bp144yr32sx6ndw****
NetworkInterfaceName	string	Não	O nome do controlador de interface de rede (NIC). O nome deve ter de 2 a 128 caracteres e pode conter caracteres da categorização de letras Unicode (que inclui letras em inglês, caracteres chineses e dígitos). O nome pode conter dois-pontos (:), sublinhados (_), pontos (.) ou hifens (-).	test-eni-name
Type	string	Não	O tipo da Elastic Network Interface (ENI). Valores válidos: Primary: controlador de interface de rede (NIC) primário. Secondary: ENI secundária. Valor padrão: null, que indica que todos os tipos são consultados.	Secondary
InstanceId	string	Não	O ID da instância à qual o controlador de interface de rede (NIC) está anexado.	i-bp1e2l6djkndyuli****
ServiceManaged	boolean	Não	Indica se o usuário do controlador de interface de rede (NIC) é um serviço da Alibaba Cloud ou um Operador de Rede Virtual (VNO).	true
Status	string	Não	O status do controlador de interface de rede (NIC). Valores válidos: Available: disponível. Attaching: sendo anexado. InUse: anexado. Detaching: sendo desanexado. Deleting: sendo excluído. Valor padrão: null, que indica que todos os status são consultados.	Available
PageNumber `deprecated`	integer	Não	Nota Este parâmetro está obsoleto. Use os parâmetros MaxResults e NextToken para paginação.	1
PageSize `deprecated`	integer	Não	Nota Este parâmetro está obsoleto. Use os parâmetros MaxResults e NextToken para paginação.	100
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor `NextToken` retornado na chamada de API anterior. Para obter informações sobre como visualizar os dados retornados, consulte a descrição da operação acima.	AAAAAdDWBF2****
MaxResults	integer	Não	O número máximo de entradas por página para paginação. Valores válidos: 10 a 500. Valor padrão: Se você não definir este parâmetro ou defini-lo com um valor menor que 10, o valor padrão será 10. Se você definir este parâmetro com um valor maior que 500, o valor padrão será 500.	50
PrivateIpAddress	array	Não	O endereço IP privado secundário do controlador de interface de rede (NIC). Valores válidos de N: 1 a 100.	192.168..
	string	Não	O endereço IP privado secundário do controlador de interface de rede (NIC). Valores válidos de N: 1 a 100.	192.168..
NetworkInterfaceId	array	Não	O ID do controlador de interface de rede (NIC). Valores válidos de N: 1 a 100.	eni-bp125p95hhdhn3ot****
	string	Não	O ID do controlador de interface de rede (NIC). Valores válidos de N: 1 a 100.	eni-bp125p95hhdhn3ot****
Ipv6Address	array	Não	O endereço IPv6 do controlador de interface de rede (NIC). N indica que você pode especificar vários endereços IPv6. Valores válidos de N: 1 a 100.	2408:4321:180:1701:94c7:bc38:3bfa:****
	string	Não	O endereço IPv6 do controlador de interface de rede (NIC). N indica que você pode especificar vários endereços IPv6. 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 nesta chamada.	AAAAAdDWBF2****
PageSize	integer	O parâmetro de paginação. Nota Este parâmetro está sendo descontinuado. Use NextToken e MaxResults para paginação.	1
PageNumber	integer	O parâmetro de paginação. Nota Este parâmetro está sendo descontinuado. Use 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 Elastic Network Interfaces (ENIs) retornadas. Nota Quando você usa os parâmetros `MaxResults` e `NextToken` para paginação, o valor `TotalCount` retornado não tem significado.	2
NetworkInterfaceSets	object
NetworkInterfaceSet	array<object>	A coleção de informações do controlador de interface de rede (NIC).
	array<object>
CreationTime	string	A hora de criação. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC+0.	2019-12-25T12:31:31Z
VpcId	string	O ID da Virtual Private Cloud (VPC) do controlador de interface de rede (NIC).	vpc-bp1j7w3gc1cexjqd****
Type	string	O tipo da 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 do controlador de interface de rede (NIC). Valores válidos: Available: disponível. Attaching: sendo anexado. InUse: anexado. Detaching: sendo desanexado. Deleting: sendo excluído.	Available
NetworkInterfaceTrafficMode	string	O modo de comunicação do controlador de 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 HighPerformance é suportado apenas pela família de instâncias aprimoradas para RDMA c7re. Atualmente, este valor só pode ser especificado na Zona K da região China (Pequim).	Standard
NetworkInterfaceName	string	O nome do controlador de interface de rede (NIC).	my-eni-name
MacAddress	string	O endereço MAC do controlador de interface de rede (NIC).	00:16:3e:12::
QueuePairNumber	integer	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.	0
NetworkInterfaceId	string	O ID do controlador de interface de rede (NIC).	eni-bp125p95hhdhn3ot****
ServiceID	integer	O ID do Operador de Rede Virtual (VNO) ao qual o controlador de interface de rede (NIC) pertence.	12345678910
InstanceId	string	O ID da instância à qual o controlador de interface de rede (NIC) está anexado. Nota Controladores de interface de rede (NICs) gerenciados e controlados por outros serviços da Alibaba Cloud não retornam um ID de instância.	i-bp1e2l6djkndyuli****
OwnerId	string	O ID da conta proprietária do controlador de interface de rede (NIC).	123456****
ServiceManaged	boolean	Indica se o usuário do controlador de interface de rede (NIC) é um serviço da Alibaba Cloud ou um Operador de Rede Virtual (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 do controlador de interface de rede (NIC).	172.17..
QueueNumber	integer	O número de filas da Elastic Network Interface (ENI). Se o controlador de interface de rede (NIC) secundário estiver no estado anexado (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 controlador de interface de rede (NIC) secundário tiver tido seu número de filas modificado, o número de filas modificado será retornado. Se o controlador de interface de rede (NIC) secundário estiver no estado não anexado (Available) e o número de filas não tiver sido modificado, um valor vazio será retornado. Para controladores de interface de rede (NICs) primários, o número padrão de filas para NICs primários do tipo de instância será retornado.	8
PrivateIpSets	object
PrivateIpSet	array<object>	A coleção de objetos PrivateIpSet.
	array<object>
PrivateIpAddress	string	O endereço IP privado da instância.	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 controlador de interface de rede (NIC).
PublicIpAddress	string	O endereço EIP.	116.62..
AllocationId	string	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.	null
PrivateDnsName	string	O nome de domínio privado da instância. Nota Este valor é retornado apenas quando o tipo de hostname `HostnameType` da instância está definido como formato `IP` ou formato `InstanceId`.	DnsTestName
Ipv6Sets	object
Ipv6Set	array<object>	Os endereços IPv6 alocados ao controlador de interface de rede (NIC).
	object
Ipv6Address	string	O endereço IPv6 alocado ao controlador de interface de rede (NIC).	2408:4321:180:1701:94c7:bc38:3bfa:****
Primary	boolean
Ipv4PrefixSets	object
Ipv4PrefixSet	array<object>	Os prefixos IPv4 alocados ao controlador de interface de rede (NIC).
	object
Ipv4Prefix	string	O prefixo IPv4 alocado ao controlador de interface de rede (NIC).	192.168.**.0/28
Ipv6PrefixSets	object
Ipv6PrefixSet	array<object>	Os prefixos IPv6 alocados ao controlador de interface de rede (NIC).
	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	Os grupos de segurança aos quais a ENI pertence.
	string	O ID do grupo de segurança.	sg-bp18kz60mefsicfg****
AssociatedPublicIp	object	O EIP associado ao endereço IP privado secundário do controlador de interface de rede (NIC).
PublicIpAddress	string	O endereço EIP.	116.62..
AllocationId	string	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.	null
Attachment	object	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.
DeviceIndex	integer	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.	0
InstanceId	string	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.	null
TrunkNetworkInterfaceId	string	Nota Este parâmetro está em prévia por convite e não está disponível publicamente.	null
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 tiver sido especificado durante a anexação, este valor não será retornado. Se a ENI estiver no estado InUse e o índice tiver sido especificado durante a anexação, este valor indicará o índice da placa de rede à qual a ENI está anexada.	0
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
SourceDestCheck	boolean	Indica se a verificação de origem/destino está ativada. Recomendamos que você ative esse 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 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	Pelo menos um dos parâmetros especificados deve ser fornecido. Eles não podem estar todos vazios.
400	UnsupportedParameter	%s	O parâmetro especificado não é suportado.
400	InvalidParameter	%s	A combinação de parâmetros especificada é inválida.
400	InvalidInstanceID.Malformed	%s
400	InvalidOperation.InvalidEcsState	%s	O status atual da instância não suporta esta operação.
400	InvalidOperation.InvalidEniState	%s	O status atual da ENI não permite a modificação dos atributos da ENI.
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	Não é permitido desanexar a ENI primária de uma instância.
400	Forbidden.RegionId	%s	Este serviço está temporariamente indisponível na região atual.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.
403	InvalidUserType.NotSupported	%s	O parâmetro de tipo de usuário é inválido.
403	Abs.InvalidAccount.NotFound	%s	Sua conta Alibaba Cloud não existe ou sua AccessKey expirou.
403	Forbidden.NotSupportRAM	%s	Usuários do Resource Access Management (RAM) não têm suporte para executar esta operação.
403	Forbidden.SubUser	%s	Sua conta não tem permissão para operar neste recurso. Solicite as permissões necessárias à conta Alibaba Cloud.
403	InvalidParameter	%s
403	MaxEniCountExceeded	%s	O número máximo de Elastic Network Interfaces (ENIs) que podem ser operadas foi excedido.
403	EniPerInstanceLimitExceeded	%s	O número de Elastic Network Interfaces (ENIs) anexadas à instância atingiu o máximo. Nenhuma outra Elastic Network Interface (ENI) pode ser anexada à instância.
403	InvalidOperation.AvailabilityZoneMismatch	%s	O controlador de interface de rede (NIC) e a instância ECS não estão na mesma zona porque seus vSwitches estão em zonas diferentes.
403	InvalidOperation.VpcMismatch	%s	A VPC do controlador de interface de rede (NIC) não corresponde à VPC do grupo de segurança.
403	SecurityGroupInstanceLimitExceed	%s	O número de instâncias no grupo de segurança atingiu o limite máximo.
403	InvalidSecurityGroupId.NotVpc	%s	O parâmetro SecurityGroupId é inválido. O tipo de rede do grupo de segurança não é VPC.
403	InvalidOperation.InvalidEniType	%s	O tipo atual da Elastic Network Interface (ENI) não suporta esta operação.
403	InvalidVpc.Empty	%s	Nenhum vSwitch foi criado na VPC especificada. Para mais informações, consulte o resultado de retorno real do espaço reservado %s na mensagem de erro.
403	Forbidden.RegionId	%s
403	InvalidOperation.InvalidEniPageNumber	%s
403	InvalidVpc.Indeterminacy	%s
404	InvalidEcsId.NotFound	%s	O ID da instância especificado não existe.
404	InvalidEniId.NotFound	%s
404	InvalidVSwitchId.NotFound	%s	O vSwitch especificado não existe.
404	InvalidSecurityGroupId.NotFound	%s	O grupo de segurança especificado não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.