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

Observações de uso

Chame a operação DescribeNetworkInterfaces para consultar dados paginados especificando o parâmetro MaxResults ou NextToken. Na primeira chamada para obter a página inicial de resultados, defina MaxResults com o número máximo de entradas a retornar. O valor retornado em NextToken é um token de paginação utilizável na próxima chamada para recuperar uma nova página. Para obter páginas subsequentes, defina NextToken com o valor retornado na chamada anterior e configure MaxResults com o número máximo de entradas desejadas nessa nova chamada.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeNetworkInterfaces	A operação a ser executada. Defina o valor como DescribeNetworkInterfaces.
RegionId	String	Yes	cn-hangzhou	O ID da região da ENI. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
Tag.N.Key	String	No	TestKey	A chave da tag N da ENI. Valores válidos de N: 1 a 20.
Tag.N.Value	String	No	TestValue	O valor da tag N da ENI. Valores válidos de N: 1 a 20. Ao especificar uma única tag na consulta, a resposta exibe até 1.000 recursos associados a ela. Caso especifique múltiplas tags, a resposta mostra até 1.000 recursos que contenham todas as tags informadas. Para consultar mais de 1.000 ENIs com tags específicas, chame a operação ListTagResources.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	O ID do grupo de recursos. Se especificado, a consulta retorna até 1.000 recursos pertencentes ao grupo indicado. Nota As ENIs do grupo de recursos padrão aparecem na resposta independentemente da configuração deste parâmetro.
VSwitchId	String	No	vsw-bp16usj2p27htro3****	O ID do vSwitch ao qual a ENI está conectada.
VpcId	String	No	vpc-bp1j7w3gc1cexjqd****	O ID da virtual private cloud (VPC) à qual a ENI pertence.
PrimaryIpAddress	String	No	192.168..	O endereço IPv4 privado primário da ENI.
SecurityGroupId	String	No	sg-bp144yr32sx6ndw****	O ID do grupo de segurança ao qual a ENI secundária pertence. Especifique este parâmetro para consultar detalhes de ENIs secundárias com base no ID de um grupo de segurança. Para consultar detalhes de ENIs primárias com base no ID de um grupo de segurança, chame a operação DescribeInstances com o parâmetro `SecurityGroupId` especificado.
NetworkInterfaceName	String	No	test-eni-name	O nome da ENI.
Type	String	No	Secondary	O tipo da ENI. Valores válidos: Primary Secondary Por padrão, este parâmetro fica vazio e indica a consulta tanto de ENIs primárias quanto secundárias.
InstanceId	String	No	i-bp1e2l6djkndyuli****	O ID da instância à qual a ENI está anexada.
ServiceManaged	Boolean	No	true	Indica se o usuário da ENI é um serviço da Alibaba Cloud ou um distribuidor.
Status	String	No	Available	O status da ENI. Valores válidos: Available: A ENI está disponível. Attaching: A ENI está sendo anexada a uma instância. InUse: A ENI está anexada a uma instância. Detaching: A ENI está sendo desanexada de uma instância. Deleting: A ENI está sendo excluída. Por padrão, este parâmetro fica vazio e indica a consulta de ENIs em todos os estados.
PageNumber	Integer	No	1	Nota Parâmetro descontinuado. Recomendamos especificar MaxResults ou NextToken para consultas paginadas.
PageSize	Integer	No	100	Nota Parâmetro descontinuado. Recomendamos especificar MaxResults ou NextToken para consultas paginadas.
NextToken	String	No	AAAAAdDWBF2****	Token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Não é necessário especificá-lo na primeira solicitação. Nas solicitações seguintes, use o token obtido na consulta anterior como valor de `NextToken`. Para verificar as respostas retornadas por esta operação, consulte a seção "Observações de uso" neste tópico.
MaxResults	Integer	No	50	Número máximo de entradas por página. Valores válidos: 10 a 500. Valor padrão: Se omitido ou definido com valor menor que 10, o padrão será 10. Se definido com valor maior que 500, o sistema usará 500 como padrão.
PrivateIpAddress.N	String	No	192.168..	Endereço IPv4 privado secundário N da ENI. Valores válidos de N: 1 a 100.
NetworkInterfaceId.N	String	No	eni-bp125p95hhdhn3ot****	ID da ENI N. Valores válidos de N: 1 a 100.
Ipv6Address.N	String	No	2408:4321:180:1701:94c7:bc38:3bfa:****	Endereço IPv6 N da ENI. Valores válidos de N: 1 a 100.

Parâmetros de resposta

Parameter	Type	Example	Description
NextToken	String	AAAAAdDWBF2****	Token de paginação utilizável na próxima solicitação para recuperar uma nova página de resultados.
PageSize	Integer	1	Número de entradas por página. Nota Este parâmetro será removido futuramente. Recomendamos usar NextToken e MaxResults para consultas paginadas.
PageNumber	Integer	1	Número da página. Nota Este parâmetro será removido futuramente. Recomendamos usar NextToken e MaxResults para consultas paginadas.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID da solicitação.
TotalCount	Integer	2	Total de ENIs retornadas. Nota Ao usar `MaxResults` e `NextToken` para paginação, o valor do parâmetro de resposta `TotalCount` torna-se inválido.
NetworkInterfaceSets	Array of NetworkInterfaceSet		Detalhes das ENIs.
NetworkInterfaceSet
CreationTime	String	2019-12-25T12:31:31Z	Data e hora de criação da ENI.
VpcId	String	vpc-bp1j7w3gc1cexjqd****	ID da VPC à qual a ENI pertence.
Type	String	Secondary	Tipo da ENI.
Status	String	Available	Status da ENI.
NetworkInterfaceTrafficMode	String	Standard	Modo de comunicação da ENI. Valores válidos: Standard: usa o modo de comunicação TCP. HighPerformance: usa o modo de comunicação remote direct memory access (RDMA) com Elastic RDMA Interface (ERI) ativado. Nota O valor HighPerformance aplica-se apenas quando a ENI está anexada a uma instância c7re otimizada para RDMA na Zona K de Pequim.
NetworkInterfaceName	String	my-eni-name	Nome da ENI.
MacAddress	String	00:16:3e:12::	Endereço media access control (MAC) da ENI.
QueuePairNumber	Integer	0	Nota Parâmetro em visualização por convite, indisponível publicamente.
NetworkInterfaceId	String	eni-bp125p95hhdhn3ot****	ID da ENI.
ServiceID	Long	12345678910	ID do distribuidor ao qual a ENI pertence.
InstanceId	String	i-bp1e2l6djkndyuli****	ID da instância à qual a ENI está vinculada. Nota Se outros serviços da Alibaba Cloud gerenciarem e controlarem a ENI, nenhum ID de instância será retornado.
OwnerId	String	123456****	ID da conta à qual a ENI pertence.
ServiceManaged	Boolean	true	Indica se o usuário da ENI é um serviço da Alibaba Cloud ou um distribuidor.
VSwitchId	String	vsw-bp16usj2p27htro3****	ID do vSwitch associado à ENI.
Description	String	DescriptionTest	Descrição da ENI.
ResourceGroupId	String	rg-2ze88m67qx5z****	ID do grupo de recursos ao qual a ENI pertence.
ZoneId	String	cn-hangzhou-e	ID da zona da ENI.
PrivateIpAddress	String	172.17..	Endereço IP privado da ENI.
QueueNumber	Integer	8	Número de filas suportadas pela ENI. Para ENIs secundárias no estado InUse sem modificação prévia nas filas, retorna o número padrão suportado pelo tipo de instância. Caso o número de filas da ENI secundária tenha sido modificado, retorna o novo valor configurado. Para ENIs secundárias no estado Available sem modificação prévia nas filas, retorna um valor vazio. Para ENIs primárias, retorna o número padrão de filas suportado pelo tipo de instância.
PrivateIpSets	Array of PrivateIpSet		Endereços IP privados da ENI.
PrivateIpSet
PrivateIpAddress	String	172.17..	Endereço IP privado da ENI.
Primary	Boolean	true	Indica se o endereço IP é o endereço IP privado primário. Valores válidos: true: O endereço IP é o endereço IP privado primário. false: O endereço IP é um endereço IP privado secundário.
AssociatedPublicIp	Object		Detalhes sobre o elastic IP address (EIP) associado à ENI.
PublicIpAddress	String	116.62..	EIP da ENI.
AllocationId	String	null	Nota Parâmetro em visualização por convite, indisponível publicamente.
Ipv6Sets	Array of Ipv6Set		Endereços IPv6 atribuídos à ENI.
Ipv6Set
Ipv6Address	String	2408:4321:180:1701:94c7:bc38:3bfa:****	Endereço IPv6 atribuído à ENI.
Ipv4PrefixSets	Array of Ipv4PrefixSet		Prefixos IPv4 atribuídos à ENI.
Ipv4PrefixSet
Ipv4Prefix	String	192.168.**.0/28	Prefixo IPv4 atribuído à ENI.
Ipv6PrefixSets	Array of Ipv6PrefixSet		Prefixos IPv6 atribuídos à ENI.
Ipv6PrefixSet
Ipv6Prefix	String	2001:db8:1234:1a00:****::/80	Prefixos IPv6 atribuídos à ENI.
Tags	Array of Tag		Tags da ENI.
Tag
TagValue	String	TestValue	Valor da tag da ENI.
TagKey	String	TestKey	Chave da tag da ENI.
SecurityGroupIds	Array of String	sg-bp18kz60mefsicfg****	IDs dos grupos de segurança aos quais a ENI pertence.
AssociatedPublicIp	Object		EIP associado ao endereço IP privado secundário da ENI.
PublicIpAddress	String	116.62..	EIP da ENI.
AllocationId	String	null	Nota Parâmetro em visualização por convite, indisponível publicamente.
Attachment	Object		Nota Parâmetro em visualização por convite, indisponível publicamente.
DeviceIndex	Integer	0	Nota Parâmetro em visualização por convite, indisponível publicamente.
InstanceId	String	null	Nota Parâmetro em visualização por convite, indisponível publicamente.
TrunkNetworkInterfaceId	String	null	Nota Parâmetro em visualização por convite, indisponível publicamente.
NetworkCardIndex	Integer	0	Índice da placa de rede. Se a ENI estiver no estado Available ou se nenhum índice de placa de rede tiver sido especificado durante a anexo, este parâmetro não terá valor. Se a ENI estiver no estado InUse e um índice de placa de rede tiver sido especificado durante a anexo, o valor retornado corresponderá ao índice informado.
DeleteOnRelease	Boolean	true	Indica se a ENI deve ser liberada quando a instância associada for liberada. Valores válidos: true false

Exemplos

Exemplos de solicitações

https://ecs.aliyuncs.com/?Action=DescribeNetworkInterfaces
&RegionId=cn-hangzhou
&PrivateIpAddress.1=192.168.**.**
&PrivateIpAddress.2=192.168.**.**
&NextToken=AAAAAdDWBF2****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "AAAAAdDWBF2****",
  "PageSize" : 1,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 2,
  "NetworkInterfaceSets" : [ {
    "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" : [ {
      "PrivateIpAddress" : "172.17.**.**",
      "Primary" : true,
      "AssociatedPublicIp" : {
        "PublicIpAddress" : "116.62.**.**",
        "AllocationId" : "null"
      }
    } ],
    "Ipv6Sets" : [ {
      "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:****"
    } ],
    "Ipv4PrefixSets" : [ {
      "Ipv4Prefix" : "192.168.**.0/28"
    } ],
    "Ipv6PrefixSets" : [ {
      "Ipv6Prefix" : "2001:db8:1234:1a00:****::/80"
    } ],
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ],
    "SecurityGroupIds" : [ "sg-bp18kz60mefsicfg****" ],
    "AssociatedPublicIp" : {
      "PublicIpAddress" : "116.62.**.**",
      "AllocationId" : "null"
    },
    "Attachment" : {
      "DeviceIndex" : 0,
      "InstanceId" : "null",
      "TrunkNetworkInterfaceId" : "null",
      "NetworkCardIndex" : 0,
      "DeleteOnRelease" : "true"
    }
  } ]
}

Códigos de erro

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s	Um parâmetro obrigatório não foi especificado.
400	UnsupportedParameter	%s	Um parâmetro especificado não é suportado.
400	InvalidParameter	%s	Valor de parâmetro inválido.
400	InvalidInstanceID.Malformed	%s	Formato de InstanceId inválido.
400	InvalidOperation.InvalidEcsState	%s	Esta operação não pode ser executada na instância no estado atual.
400	InvalidOperation.InvalidEniState	%s	Esta operação não pode ser executada na ENI no estado atual.
400	InvalidOperation.DetachPrimaryEniNotAllowed	%s	A ENI primária não pode ser desanexada da instância.
400	Forbidden.RegionId	%s	O serviço está indisponível na região no momento.
400	InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	Valor de RegionId inválido.
403	InvalidUserType.NotSupported	%s	Sua conta não suporta esta operação.
403	Abs.InvalidAccount.NotFound	%s	Sua conta da Alibaba Cloud não foi encontrada ou seu par de AccessKey expirou.
403	Forbidden.NotSupportRAM	%s	Usuários do Resource Access Management (RAM) não têm permissões para executar esta operação.
403	Forbidden.SubUser	%s	Você não tem acesso ao recurso. Entre em contato com o proprietário da conta da Alibaba Cloud.
403	MaxEniCountExceeded	%s	O número máximo de ENIs que podem ser gerenciadas foi excedido.
403	EniPerInstanceLimitExceeded	%s	O número máximo de ENIs que podem ser anexadas à instância foi excedido.
403	InvalidOperation.AvailabilityZoneMismatch	%s	A operação é inválida.
403	InvalidOperation.VpcMismatch	%s	A operação é inválida. Verifique se a VPC na operação corresponde aos outros parâmetros.
403	SecurityGroupInstanceLimitExceed	%s	O número máximo de instâncias no grupo de segurança foi excedido.
403	InvalidSecurityGroupId.NotVpc	%s	ID de grupo de segurança inválido. O tipo de rede do grupo de segurança especificado não é VPC.
403	InvalidOperation.InvalidEniType	%s	Esta operação não pode ser executada neste tipo de ENI.
403	InvalidVpc.Empty	%s	Não existem vSwitches na VPC especificada. Para mais informações, consulte o valor retornado no placeholder %s da mensagem de erro.
404	InvalidEcsId.NotFound	%s	O ID da instância não foi encontrado.
404	InvalidEniId.NotFound	%s	O ID da ENI não foi encontrado.
404	InvalidVSwitchId.NotFound	%s	O ID do vSwitch especificado não foi encontrado.
404	InvalidSecurityGroupId.NotFound	%s	O ID do grupo de segurança especificado não foi encontrado.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.