DescribeNetworkInterfaces - ENS: Central de Documentação do Alibaba Cloud

Chama DescribeNetworkInterfaces para obter uma lista de interfaces de rede.

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

ens:DescribeNetworkInterfaces

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NetworkInterfaceId	string	Não	O ID da interface de rede elástica (ENI).	eni-58z57orgmt6d1****
InstanceId	string	Não	O ID da instância.	i-5t7z99n32gplriv
NetworkId	string	Não	O ID da rede.	n-2zeuphj08tt7q3brd****
VSwitchId	string	Não	O ID do vSwitch.	vsw-12345
EnsRegionId	string	Não	O ID da região da instância.	cn-tianjin-cmcc
SecurityGroupId	string	Não	O ID do grupo de segurança associado à ENI secundária. Especifique este parâmetro para consultar ENIs secundárias por ID de grupo de segurança.	sg-5p1fg655nh68xyz9i***
PrimaryIpAddress	string	Não	O endereço IP principal da ENI.	10.XXX.XXX.5
Type	string	Não	O tipo da ENI. Valores válidos: Primary: interface de rede principal. Secondary: ENI secundária. Se você não especificar este parâmetro, ENIs de todos os tipos serão consultadas.	Secondary
NetworkInterfaceName	string	Não	O nome da ENI.	test-01
Status	string	Não	O status da ENI. Valores válidos: Available: disponível. Attaching: sendo anexada. InUse: em uso. Detaching: sendo desanexada. Deleting: sendo excluída. Se você não especificar este parâmetro, ENIs em todos os estados serão consultadas.	Available
PageNumber	string	Não	O número da página. As páginas começam em 1. O valor padrão é 1.	1
PageSize	string	Não	O número de entradas a serem retornadas em cada página. Valor máximo: 100. Valor padrão: 50.	50
Ipv6Address	array	Não	Os endereços IPv6 da ENI. Você pode especificar até 100 endereços.
	string	Não	Um endereço IPv6 da ENI.	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
EnsRegionIds	array	Não	Os IDs das zonas de borda do ENS. Você pode especificar até 100 IDs.
	string	Não	O ID do nó do ENS.	cn-fuzhou-1
NetworkInterfaceIds	array	Não	Os IDs das ENIs. Você pode especificar até 100 IDs.
	string	Não	O ID de uma ENI.	eni-5****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes das ENIs.
NetworkInterfaceSets	object
NetworkInterfaceSet	array<object>	Os detalhes das ENIs.
	array<object>	Os detalhes das ENIs.
CreationTime	string	The time when the ENI was created. The time is displayed in UTC and follows the ISO 8601 standard in the `yyyy-MM-ddThh:mmZ` format.	2022-02-22T03:53:25Z
EnsRegionId	string	The ID of the ENS edge zone.	id-jakarta-1
InstanceId	string	The ID of the instance to which the ENI is attached.	i-5siavnr3
MacAddress	string	The MAC address of the ENI.	00:16:XXX:XXX:60:0a
NetworkInterfaceId	string	The ID of the ENI.	eni-uf686a5
PrimaryIp	string	The primary private IP address.	10.XXX.XXX.25
PrimaryIpType	string	The type of the primary IP address. Valid values: Public: A public IP address. Private: A private IP address.	Private
Status	string	The status of the network interface. Valid values: Available: available. Attaching: being attached. InUse: in use. Detaching: being detached. Deleting: being deleted.	InUse
NetworkId	string	The ID of the network.	n-5w0qd03adw****
VSwitchId	string	The ID of the vSwitch.	vsw-5rqswx1trlsj9
PrivateIpSets	object
PrivateIpSet	array<object>	A collection of `PrivateIpSet` objects.
	object	A collection of `PrivateIpSet` objects.
PrivateIpAddress	string	The private IP address.	192.XXX.XXX.130
Primary	boolean	Indicates whether the IP address is the primary private IP address. Valid values: true: The IP address is the primary private IP address. false: The IP address is a secondary private IP address.	true
PrivateIpStatus	string	The status of the private IP address. Valid values: Available: available. Creating: being created. Deleting: being deleted.	Available
NetworkInterfaceName	string	The name of the ENI.	primaryTest
Description	string	The description of the ENI.	test-description
SecurityGroupIds	object
SecurityGroup	array	The ID of the security group.
	string	The ID of the security group.	sg-5p1bozeiw711a1***
Type	string	The type of the ENI. Valid values: Primary: The primary network interface. Secondary: The secondary ENI.	Primary
Ipv6Sets	object
Ipv6Set	array<object>	The assigned IPv6 addresses of the ENI.
	object	The assigned IPv6 addresses of the ENI.
Ipv6Address	string	The assigned IPv6 address of the ENI.	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
VmncLearn	boolean
PageNumber	integer	O número da página. As páginas começam em 1. O valor padrão é 1.	1
PageSize	integer	O número de entradas retornadas por página. Valor máximo: 50. Valor padrão: 10.	50
TotalCount	integer	O número total de entradas.	49
RequestId	string	O ID da solicitação.	708AF9CE-FF92-5DF9-93F8-B7754AB1061A

Exemplos

Resposta de sucesso

JSON formato

{
  "NetworkInterfaceSets": {
    "NetworkInterfaceSet": [
      {
        "CreationTime": "2022-02-22T03:53:25Z",
        "EnsRegionId": "id-jakarta-1",
        "InstanceId": "i-5siavnr3",
        "MacAddress": "00:16:XXX:XXX:60:0a",
        "NetworkInterfaceId": "eni-uf686a5",
        "PrimaryIp": "10.XXX.XXX.25",
        "PrimaryIpType": "Private",
        "Status": "InUse",
        "NetworkId": "n-5w0qd03adw****",
        "VSwitchId": "vsw-5rqswx1trlsj9",
        "PrivateIpSets": {
          "PrivateIpSet": [
            {
              "PrivateIpAddress": "192.XXX.XXX.130",
              "Primary": true,
              "PrivateIpStatus": "Available"
            }
          ]
        },
        "NetworkInterfaceName": "primaryTest",
        "Description": "test-description",
        "SecurityGroupIds": {
          "SecurityGroup": [
            "sg-5p1bozeiw711a1***"
          ]
        },
        "Type": "Primary",
        "Ipv6Sets": {
          "Ipv6Set": [
            {
              "Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6\n"
            }
          ]
        },
        "VmncLearn": false
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 49,
  "RequestId": "708AF9CE-FF92-5DF9-93F8-B7754AB1061A"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Missing%s	You must specify the parameter %s.
400	Invalid%s	The specified parameter %s is invalid.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.