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

Consulta os detalhes de uma ou mais instâncias.

Descrição da operação

Frequência de chamadas de API: 800 chamadas por segundo.

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

list

*Instance.

acs:ens:*:{#accountId}:instance/{#InstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EnsRegionId	string	Não	O ID da região.	cn-beijing-cmcc
InstanceId	string	Não	O ID da instância.	i-5iqczfxps7csjrxeca****
EnsRegionIds	string	Não	A lista de IDs de zonas de borda. Este parâmetro é um array JSON formatado que contém até 100 IDs separados por vírgulas (,).	["cn-suzhou-telecom","cn-chengdu-telecom"]
InstanceIds	string	Não	A lista de IDs de instâncias. Este parâmetro é um array JSON formatado que contém até 100 IDs separados por vírgulas (,).	["i-5iqczfxps7csjrxeca07**", "i-5iqczfxps7csjrxeca07**"]
InstanceName	string	Não	O nome da instância.	TestName
ImageId	string	Não	O ID da imagem.	centos_6_08_64_20G_alibase_****
PageNumber	integer	Não	O número da página da lista de status da instância. O valor começa em 1.	1
PageSize	string	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100.	10
Status	string	Não	O status da instância. Valores válidos: Running: Em execução. Stopped: Parado. Expired: Expirado.	Running
OrderByParams	string	Não	O parâmetro de ordenação no formato JSON.	{
EnsServiceId	string	Não	O ID do Edge Node Service. Você pode usar este ID para consultar as instâncias criadas sob o serviço de borda.	ens-20190730202316s****
InstanceResourceType	string	Não	O tipo de filtro. Valores válidos:	EnsService
SearchKey	string	Não	A palavra-chave de pesquisa. Suporta parâmetros como ip, InstanceName e InstanceId.	Joshua
NetworkId	string	Não	O ID da rede.	n-2zeuphj08tt7q3brd****
VSwitchId	string	Não	O ID do vSwitch.	vsw-2zeh0r1pabwtg6wcs****
SecurityGroupId	string	Não	O ID do grupo de segurança.	sg-5kyicq2kfcapxrdds6tar7jqb
IntranetIp	string	Não	O endereço IP interno.	47.100.XX.XX
Tags	array<object>	Não	As tags de recurso. Esta operação não retorna informações de tag. Use este parâmetro em combinação com as APIs na categoria de tags.
	object	Não	O conjunto de tags da instância. Esta operação não retorna informações de tag. Use este parâmetro em combinação com as APIs na categoria de tags.
Key	string	Não	A chave da tag da instância. Valores válidos de N: 1 a 20.	tag
Value	string	Não	O valor da tag da instância. Valores válidos de N: 1 a 20.	2
InstanceType	string	Não	O tipo da instância.	ens.se1.tiny
ServiceStatus	array	Não	O status de negócios da instância, que não representa o status real de execução da instância.
	string	Não	O status do serviço da instância. Isso não representa o status real de execução da instância. Expired Arrears (pagamento em atraso)	Expired
EipAddresses	array	Não	A lista de endereços EIP usada para filtrar instâncias.
	string	Não	A lista de endereços EIP usada para filtrar instâncias.	120.XX.XX.10
VpdId	string	Não	O ID da rede VPD.	vpd-5s7xxxxxxx
VpdVSwitchId	string	Não	O ID do vSwitch VPD.	vsw-5s7xxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de negócio retornado. Um valor 0 indica sucesso.	0
PageSize	integer	O número de entradas por página especificado na solicitação.	60
PageNumber	integer	O número da página da lista de instâncias.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de instâncias retornadas.	2
Instances	object
Instance	array<object>	Um array de objetos InstanceAttributesType que contém informações da instância.
	array<object>	Esquema da resposta.
CreationTime	string	A hora em que a instância foi criada. A hora está em UTC e usa o formato ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`.	2019-07-26T06:40:43Z
Status	string	O status da instância. Valores válidos: `Running`: A instância está em execução. `Expired`: A instância expirou. `Stopped`: A instância está parada.	Running
SpecName	string	O tipo de instância.	ens.sn1.stiny
InstanceTypeFamily	string	A família de tipos de instância. Valores válidos: `x86_vm`: computação X86 `x86_pm`: bare metal X86 `x86_bmi`: instância bare metal X86 `x86_bm`: bare metal com Smart NIC `pc_bmi`: instância bare metal heterogênea `pc_vm`: máquina virtual heterogênea `arm_bmi`: computação ARM	x86_vm
InstanceResourceType	string	O tipo de recurso da instância. Valores válidos: `EnsInstance`: uma instância independente. `EnsService`: uma instância de serviço de borda. `BuildMachine`: uma máquina de criação de imagem. `EnsPostPaidInstance`: uma instância independente pós-paga.	EnsService
HostName	string	O nome do host da instância. Um ponto (.) ou hífen (-) não pode ser o primeiro ou o último caractere e não pode ser usado consecutivamente. Para instâncias Windows, o nome do host deve ter de 2 a 15 caracteres, consistindo em letras, dígitos e hífens (-). Não pode conter pontos (.) nem ser composto apenas por dígitos. Para outros tipos de instância (como Linux), o nome do host deve ter de 2 a 64 caracteres. Você pode usar pontos (.) para separar o nome em segmentos. Cada segmento pode consistir em letras, dígitos e hífens (-).	testHostName
InstanceId	string	O ID da instância.	i-instanc****
InternetMaxBandwidthIn	integer	A largura de banda pública de entrada máxima. Unidade: Mbit/s.	40
InternetMaxBandwidthOut	integer	A largura de banda pública de saída máxima. Unidade: Mbit/s.	100
EnsRegionId	string	O ID da região da instância.	cn-hangzhou-telecom
Cpu	string	O número de núcleos de vCPU.	2
ExpiredTime	string	A hora de expiração. A hora está em UTC e usa o formato ISO 8601: `yyyy-MM-ddTHH:mm:ssZ`.	2119-07-13T02:38:57Z
InstanceName	string	O nome da instância.	i-5itef0f28t17bcdw9deu6meub
Disk	integer	O tamanho total dos discos. Unidade: MiB.	71680
OSName	string	O nome da imagem.	centos 6.8 x86_64
Memory	integer	O tamanho da memória. Unidade: MB.	2048
ImageId	string	O ID da imagem.	m-****
DataDisk	object
DataDisk	array<object>	As informações sobre os discos de dados.
	object	Os detalhes de um disco de dados.
device_type	string	A categoria do disco. Valores válidos: file: disco local. pangu: disco em nuvem Efficiency. local_hdd: HDD local.	pangu
disk_type	string	O tipo do disco em nuvem ou disco local. Valores válidos: system: disco do sistema. data: disco de dados.	system
Size	integer	O tamanho do disco. Unidade: MiB.	51200
DiskName	string	O nome do disco.	DiskName
uuid	string	O UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	O tamanho do disco. Unidade: MiB.	20480
DiskId	string	O ID do disco.	d-5ip4c2dhmas0vjd5u1r****
Category	string	A categoria do disco em nuvem ou disco local. Valores válidos: file: disco local. pangu: disco em nuvem Efficiency. local_hdd: HDD local.	file
name	string	O nome do disco.	name
DiskSize	integer	O tamanho do disco. Unidade: GiB.	100
EncryptKeyId	string	O ID da chave KMS usada para o disco em nuvem.	0e478b7a-4262-4802-b8cb-00d3fxxxxx
Encrypted	boolean	Indica se o disco em nuvem está criptografado.	true
PublicIpAddresses	object
PublicIpAddress	array<object>	As informações sobre os endereços IP públicos.
	object	As informações sobre os endereços IP públicos.
Ip	string	O endereço IP.	119.147.xx.xx
GateWay	string	O gateway.	119.147.xx.xx
Isp	string	O ISP.	unicom
PrivateIpAddresses	object
PrivateIpAddress	array<object>	As informações sobre os endereços IP privados da instância.
	object
Ip	string	O endereço IP.	119.147.xx.xx
GateWay	string	O gateway.	119.147.xx.xx
Isp	string	O ISP.	cmcc
SecurityGroupIds	object
SecurityGroupId	array	O ID do grupo de segurança.
	string	O ID do grupo de segurança.	sg-5kyicq2kfcapxrdds6ta****
InnerIpAddress	object
IpAddress	array	O endereço IP privado da instância.
	string	Um endereço IP privado da instância.	10.170.xx.xx
PublicIpAddress	object
IpAddress	array	O endereço IP público.
	string	Um endereço IP público.	119.147.xx.xx
SystemDisk	object	Os detalhes do disco do sistema.
device_type	string	A categoria do disco. Valores válidos: file: disco local. pangu: disco em nuvem Efficiency. local_hdd: HDD local.	pangu
disk_type	string	O tipo do disco em nuvem ou disco local. Valores válidos: system: disco do sistema. data: disco de dados.	system
Size	integer	O tamanho do disco. Unidade: MiB.	51200
DiskName	string	O nome do disco.	DiskName
uuid	string	O UUID.	5431f898-1323-4e64-8ce1-6cad50ed****
storage	integer	A capacidade do disco. Unidade: MiB.	20480
DiskId	string	O ID do disco.	d-5ip4c2dhmas0rn7rt0p9****
Category	string	A categoria do disco em nuvem ou disco local. Valores válidos: file: disco local. pangu: disco em nuvem Efficiency. local_hdd: HDD local.	file
name	string	O nome do disco.	DiskName
NetworkAttributes	object	As informações de rede.
NetworkId	string	O ID da rede.	n-2zeuphj08tt7q3brd****
VSwitchId	string	O ID do VSwitch.	vsw-2zeh0r1pabwtg6wcs****
PrivateIpAddress	object
IpAddress	array	As informações sobre os endereços IP privados da instância.
	string	O endereço IP privado da instância. Você pode especificar apenas um endereço IP privado. O endereço IP deve ser um endereço disponível dentro do bloco CIDR do VSwitch especificado (`VSwitchId`).	172.17..
Tags	object
Tags	array<object>	As tags da instância. Importante Esta operação não retorna informações de tags. Para recuperar tags, você deve chamar uma API de tags dedicada.
	object	As informações da tag. Importante Esta operação não retorna informações de tags. Para recuperar tags, você deve chamar uma API de tags dedicada.
TagValue	string	O valor da tag.	value1
TagKey	string	A chave da tag.	key1
AutoReleaseTime	string	A hora em que a instância é liberada automaticamente.	2023-06-28T14:38:52Z
SpotStrategy	string	A política de lances para a instância spot.	NoSpot
KeyPairName	string	O nome do par de chaves.	TestKeyPairName
NetworkInterfaces	object
NetworkInterfaces	array<object>	Uma lista de interfaces de rede elásticas.
	array<object>	Os detalhes de uma interface de rede elástica.
Type	string	O tipo da interface de rede elástica. Valores válidos: `Primary`: A interface de rede primária. `Secondary`: A interface de rede secundária.	Primary
MacAddress	string	O endereço MAC da interface de rede elástica.	00:16:XXX:XXX:60:0a
PrimaryIpAddress	string	O endereço IP privado primário.	10.XXX.XXX.25
NetworkInterfaceId	string	O ID da interface de rede elástica.	eni-53afk8a0t5lklbi8m7j8iczdg
PrivateIpSets	object
PrivateIpSet	array<object>	Uma coleção de objetos `PrivateIpSet`.
	object	Uma coleção de objetos `PrivateIpSet`.
PrivateIpAddress	string	O endereço IP privado.	192.XXX.XXX.130
Primary	boolean	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.	true
Ipv6Sets	object
Ipv6Set	array<object>	Uma coleção de endereços IPv6 atribuídos à interface de rede elástica.
	object	Uma coleção de endereços IPv6 atribuídos à interface de rede elástica.
Ipv6Address	string	O endereço IPv6 atribuído à interface de rede elástica.	2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
VpdVSwitchId	string		vsw-5s7xxxxxxx
VpdId	string		vpd-5s7xxxxxxx
ServiceStatus	string	O status de serviço da instância, em vez do status de execução.	Expired
DeletionProtection	boolean

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 0,
  "PageSize": 60,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2,
  "Instances": {
    "Instance": [
      {
        "CreationTime": "2019-07-26T06:40:43Z",
        "Status": "Running",
        "SpecName": "ens.sn1.stiny",
        "InstanceTypeFamily": "x86_vm",
        "InstanceResourceType": "EnsService",
        "HostName": "testHostName",
        "InstanceId": "i-instanc****",
        "InternetMaxBandwidthIn": 40,
        "InternetMaxBandwidthOut": 100,
        "EnsRegionId": "cn-hangzhou-telecom",
        "Cpu": "2",
        "ExpiredTime": "2119-07-13T02:38:57Z",
        "InstanceName": "i-5itef0f28t17bcdw9deu6meub",
        "Disk": 71680,
        "OSName": "centos 6.8 x86_64",
        "Memory": 2048,
        "ImageId": "m-****",
        "DataDisk": {
          "DataDisk": [
            {
              "device_type": "pangu",
              "disk_type": "system",
              "Size": 51200,
              "DiskName": "DiskName",
              "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
              "storage": 20480,
              "DiskId": "d-5ip4c2dhmas0vjd5u1r****",
              "Category": "file",
              "name": "name",
              "DiskSize": 100,
              "EncryptKeyId": "0e478b7a-4262-4802-b8cb-00d3fxxxxx",
              "Encrypted": true
            }
          ]
        },
        "PublicIpAddresses": {
          "PublicIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "unicom"
            }
          ]
        },
        "PrivateIpAddresses": {
          "PrivateIpAddress": [
            {
              "Ip": "119.147.xx.xx",
              "GateWay": "119.147.xx.xx",
              "Isp": "cmcc"
            }
          ]
        },
        "SecurityGroupIds": {
          "SecurityGroupId": [
            "sg-5kyicq2kfcapxrdds6ta****"
          ]
        },
        "InnerIpAddress": {
          "IpAddress": [
            "10.170.xx.xx"
          ]
        },
        "PublicIpAddress": {
          "IpAddress": [
            "119.147.xx.xx"
          ]
        },
        "SystemDisk": {
          "device_type": "pangu",
          "disk_type": "system",
          "Size": 51200,
          "DiskName": "DiskName",
          "uuid": "5431f898-1323-4e64-8ce1-6cad50ed****",
          "storage": 20480,
          "DiskId": "d-5ip4c2dhmas0rn7rt0p9****",
          "Category": "file",
          "name": "DiskName"
        },
        "NetworkAttributes": {
          "NetworkId": "n-2zeuphj08tt7q3brd****",
          "VSwitchId": "vsw-2zeh0r1pabwtg6wcs****",
          "PrivateIpAddress": {
            "IpAddress": [
              "172.17.**.**"
            ]
          }
        },
        "Tags": {
          "Tags": [
            {
              "TagValue": "value1",
              "TagKey": "key1"
            }
          ]
        },
        "AutoReleaseTime": "2023-06-28T14:38:52Z",
        "SpotStrategy": "NoSpot",
        "KeyPairName": "TestKeyPairName",
        "NetworkInterfaces": {
          "NetworkInterfaces": [
            {
              "Type": "Primary",
              "MacAddress": "00:16:XXX:XXX:60:0a",
              "PrimaryIpAddress": "10.XXX.XXX.25",
              "NetworkInterfaceId": "eni-53afk8a0t5lklbi8m7j8iczdg",
              "PrivateIpSets": {
                "PrivateIpSet": [
                  {
                    "PrivateIpAddress": "192.XXX.XXX.130",
                    "Primary": true
                  }
                ]
              },
              "Ipv6Sets": {
                "Ipv6Set": [
                  {
                    "Ipv6Address": "2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6"
                  }
                ]
              },
              "VpdVSwitchId": "vsw-5s7xxxxxxx",
              "VpdId": "vpd-5s7xxxxxxx"
            }
          ]
        },
        "ServiceStatus": "Expired",
        "DeletionProtection": false
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	MissingParameter	The input parameter domainName that is mandatory for processing this request is not supplied.
400	InstanceIdNotFound	The input parameter instancdId that is not found.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.
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.