:DescribeInstances

Notas de uso

• Você pode especificar múltiplos parâmetros de solicitação para filtrar resultados de consulta. Os parâmetros de solicitação especificados têm relação lógica AND. Somente os parâmetros especificados são incluídos nas condições de filtro. No entanto, se InstanceIds estiver definido como um array JSON vazio, isso é considerado uma condição de filtro válida e um resultado vazio é retornado.
• Se você estiver usando um usuário ou função do Resource Access Management (RAM) sem permissões para chamar esta operação, uma lista vazia é retornada. Inclua o parâmetro DryRun na sua solicitação para verificar se a lista vazia é causada por falta de permissões.
• Ao chamar uma operação de API usando a Alibaba Cloud CLI, especifique os valores dos parâmetros de solicitação de diferentes tipos de dados nos formatos exigidos. Para mais informações, consulte Visão geral do formato de parâmetros.
• Você pode usar um dos seguintes métodos para verificar as respostas:
  • Método 1: Em uma consulta paginada, ao chamar a operação DescribeInstances para recuperar a primeira página de resultados, defina MaxResults para especificar o número máximo de entradas a retornar na chamada. O valor de retorno de NextToken é um token de paginação que pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Ao chamar a operação DescribeInstances para recuperar uma nova página de resultados, defina NextToken como o valor de NextToken retornado na chamada anterior e defina MaxResults para especificar o número máximo de entradas a retornar nesta chamada.

  • Método 2: Use PageSize para especificar o número de entradas por página e, em seguida, use PageNumber para especificar o número da página a retornar.

    Você pode usar apenas um dos métodos anteriores. Se um grande número de entradas for retornado, recomendamos o método 1. Quando MaxResults ou NextToken é especificado, os parâmetros de solicitação PageSize e PageNumber não têm efeito e o parâmetro de resposta TotalCount é inválido.

Parâmetros de solicitação

Parâmetros de resposta

Exemplos

Exemplo de solicitação

https://ecs.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&PageSize=1
&PageNumber=1
&<Common request parameters>

Exemplo de resposta bem-sucedida

XML formato

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

<DescribeInstancesResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>1</TotalCount>
    <Instances>
        <Instance>
            <CreationTime>2017-12-10T04:04Z</CreationTime>
            <SerialNumber>51d1353b-22bf-4567-a176-8b3e12e4****</SerialNumber>
            <Status>Running</Status>
            <DeploymentSetId>ds-bp67acfmxazb4p****</DeploymentSetId>
            <KeyPairName>testKeyPairName</KeyPairName>
            <SaleCycle>month</SaleCycle>
            <SpotStrategy>NoSpot</SpotStrategy>
            <DeviceAvailable>true</DeviceAvailable>
            <LocalStorageCapacity>1000</LocalStorageCapacity>
            <Description>testDescription</Description>
            <SpotDuration>1</SpotDuration>
            <InstanceNetworkType>vpc</InstanceNetworkType>
            <InstanceName>InstanceNameTest</InstanceName>
            <OSNameEn>CentOS  7.4 64 bit</OSNameEn>
            <HpcClusterId>hpc-bp67acfmxazb4p****</HpcClusterId>
            <SpotPriceLimit>0.98</SpotPriceLimit>
            <Memory>16384</Memory>
            <OSName>CentOS  7.4 64-bit</OSName>
            <DeploymentSetGroupNo>1</DeploymentSetGroupNo>
            <ImageId>m-bp67acfmxazb4p****</ImageId>
            <VlanId>10</VlanId>
            <ClusterId>c-bp67acfmxazb4p****</ClusterId>
            <GPUSpec>NVIDIA V100</GPUSpec>
            <AutoReleaseTime>2017-12-10T04:04Z</AutoReleaseTime>
            <DeletionProtection>false</DeletionProtection>
            <StoppedMode>KeepCharging</StoppedMode>
            <GPUAmount>4</GPUAmount>
            <HostName>testHostName</HostName>
            <InstanceId>i-bp67acfmxazb4p****</InstanceId>
            <InternetMaxBandwidthOut>5</InternetMaxBandwidthOut>
            <InternetMaxBandwidthIn>50</InternetMaxBandwidthIn>
            <InstanceType>ecs.g5.large</InstanceType>
            <InstanceChargeType>PostPaid</InstanceChargeType>
            <RegionId>cn-hangzhou</RegionId>
            <IoOptimized>true</IoOptimized>
            <StartTime>2017-12-10T04:04Z</StartTime>
            <Cpu>8</Cpu>
            <LocalStorageAmount>2</LocalStorageAmount>
            <ExpiredTime>2017-12-10T04:04Z</ExpiredTime>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <InternetChargeType>PayByTraffic</InternetChargeType>
            <ZoneId>cn-hangzhou-g</ZoneId>
            <Recyclable>false</Recyclable>
            <ISP>null</ISP>
            <CreditSpecification>Standard</CreditSpecification>
            <InstanceTypeFamily>ecs.g5</InstanceTypeFamily>
            <OSType>linux</OSType>
            <NetworkInterfaces>
                <NetworkInterface>
                    <Type>Primary</Type>
                    <MacAddress>00:16:3e:32:b4:**</MacAddress>
                    <PrimaryIpAddress>172.17.**.***</PrimaryIpAddress>
                    <NetworkInterfaceId>eni-2zeh9atclduxvf1z****</NetworkInterfaceId>
                    <PrivateIpSets>
                        <PrivateIpSet>
                            <PrivateIpAddress>172.17.**.**</PrivateIpAddress>
                            <Primary>true</Primary>
                        </PrivateIpSet>
                    </PrivateIpSets>
                    <Ipv6Sets>
                        <Ipv6Set>
                            <Ipv6Address>2408:4321:180:1701:94c7:bc38:3bfa:***</Ipv6Address>
                        </Ipv6Set>
                    </Ipv6Sets>
                    <Ipv4PrefixSets>
                        <Ipv4PrefixSet>
                            <Ipv4Prefix>192.168.*.*/28</Ipv4Prefix>
                        </Ipv4PrefixSet>
                    </Ipv4PrefixSets>
                    <Ipv6PrefixSets>
                        <Ipv6PrefixSet>
                            <Ipv6Prefix>2001:1111:*:*::/80</Ipv6Prefix>
                        </Ipv6PrefixSet>
                    </Ipv6PrefixSets>
                    <OperationLocks>
                        <OperationLock>
                            <LockMsg>The specified instance is locked due to financial reason.</LockMsg>
                            <LockReason>Recycling</LockReason>
                        </OperationLock>
                    </OperationLocks>
                    <Tags>
                        <Tag>
                            <TagValue>TestValue</TagValue>
                            <TagKey>TestKey</TagKey>
                        </Tag>
                    </Tags>
                    <RdmaIpAddresses>
                        <RdmaIpAddress>10.10.10.102</RdmaIpAddress>
                    </RdmaIpAddresses>
                    <SecurityGroupIds>
                        <SecurityGroupId>sg-bp67acfmxazb4p****</SecurityGroupId>
                    </SecurityGroupIds>
                    <PublicIpAddress>
                        <PublicIpAddres>121.40.**.**</PublicIpAddres>
                    </PublicIpAddress>
                    <InnerIpAddress>
                        <InnerIpAddres>10.170.**.**</InnerIpAddres>
                    </InnerIpAddress>
                    <VpcAttributes>
                        <VpcId>vpc-2zeuphj08tt7q3brd****</VpcId>
                        <NatIpAddress>172.17.**.**</NatIpAddress>
                        <VSwitchId>vsw-2zeh0r1pabwtg6wcs****</VSwitchId>
                        <PrivateIpAddress>
                            <PrivateIpAddres>172.17.**.**</PrivateIpAddres>
                        </PrivateIpAddress>
                    </VpcAttributes>
                    <EipAddress>
                        <IsSupportUnassociate>true</IsSupportUnassociate>
                        <InternetChargeType>PayByTraffic</InternetChargeType>
                        <IpAddress>42.112.**.**</IpAddress>
                        <Bandwidth>5</Bandwidth>
                        <AllocationId>eip-2ze88m67qx5z****</AllocationId>
                    </EipAddress>
                    <HibernationOptions>
                        <Configured>false</Configured>
                    </HibernationOptions>
                    <DedicatedHostAttribute>
                        <DedicatedHostId>dh-bp67acfmxazb4p****</DedicatedHostId>
                        <DedicatedHostName>testDedicatedHostName</DedicatedHostName>
                        <DedicatedHostClusterId>dc-bp67acfmxazb4h****</DedicatedHostClusterId>
                    </DedicatedHostAttribute>
                    <EcsCapacityReservationAttr>
                        <CapacityReservationPreference>cr-bp67acfmxazb4p****</CapacityReservationPreference>
                        <CapacityReservationId>cr-bp67acfmxazb4p****</CapacityReservationId>
                    </EcsCapacityReservationAttr>
                    <DedicatedInstanceAttribute>
                        <Affinity>default</Affinity>
                        <Tenancy>default</Tenancy>
                    </DedicatedInstanceAttribute>
                    <CpuOptions>
                        <Numa>2</Numa>
                        <CoreCount>2</CoreCount>
                        <ThreadsPerCore>4</ThreadsPerCore>
                    </CpuOptions>
                    <MetadataOptions>
                        <HttpEndpoint>enabled</HttpEndpoint>
                        <HttpPutResponseHopLimit>0</HttpPutResponseHopLimit>
                        <HttpTokens>optional</HttpTokens>
                    </MetadataOptions>
                    <ImageOptions>
                        <LoginAsNonRoot>false</LoginAsNonRoot>
                    </ImageOptions>
                </NetworkInterface>
            </NetworkInterfaces>
        </Instance>
    </Instances>
</DescribeInstancesResponse>

JSON formato

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

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize" : 10,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 1,
  "Instances" : {
    "Instance" : [ {
      "CreationTime" : "2017-12-10T04:04Z",
      "SerialNumber" : "51d1353b-22bf-4567-a176-8b3e12e4****",
      "Status" : "Running",
      "DeploymentSetId" : "ds-bp67acfmxazb4p****",
      "KeyPairName" : "testKeyPairName",
      "SaleCycle" : "month",
      "SpotStrategy" : "NoSpot",
      "DeviceAvailable" : true,
      "LocalStorageCapacity" : 1000,
      "Description" : "testDescription",
      "SpotDuration" : 1,
      "InstanceNetworkType" : "vpc",
      "InstanceName" : "InstanceNameTest",
      "OSNameEn" : "CentOS  7.4 64 bit",
      "HpcClusterId" : "hpc-bp67acfmxazb4p****",
      "SpotPriceLimit" : 0.98,
      "Memory" : 16384,
      "OSName" : "CentOS  7.4 64-bit",
      "DeploymentSetGroupNo" : 1,
      "ImageId" : "m-bp67acfmxazb4p****",
      "VlanId" : "10",
      "ClusterId" : "c-bp67acfmxazb4p****",
      "GPUSpec" : "NVIDIA V100",
      "AutoReleaseTime" : "2017-12-10T04:04Z",
      "DeletionProtection" : false,
      "StoppedMode" : "KeepCharging",
      "GPUAmount" : 4,
      "HostName" : "testHostName",
      "InstanceId" : "i-bp67acfmxazb4p****",
      "InternetMaxBandwidthOut" : 5,
      "InternetMaxBandwidthIn" : 50,
      "InstanceType" : "ecs.g5.large",
      "InstanceChargeType" : "PostPaid",
      "RegionId" : "cn-hangzhou",
      "IoOptimized" : true,
      "StartTime" : "2017-12-10T04:04Z",
      "Cpu" : 8,
      "LocalStorageAmount" : 2,
      "ExpiredTime" : "2017-12-10T04:04Z",
      "ResourceGroupId" : "rg-bp67acfmxazb4p****",
      "InternetChargeType" : "PayByTraffic",
      "ZoneId" : "cn-hangzhou-g",
      "Recyclable" : false,
      "ISP" : "null",
      "CreditSpecification" : "Standard",
      "InstanceTypeFamily" : "ecs.g5",
      "OSType" : "linux",
      "NetworkInterfaces" : {
        "NetworkInterface" : [ {
          "Type" : "Primary",
          "MacAddress" : "00:16:3e:32:b4:**",
          "PrimaryIpAddress" : "172.17.**.***",
          "NetworkInterfaceId" : "eni-2zeh9atclduxvf1z****",
          "PrivateIpSets" : {
            "PrivateIpSet" : [ {
              "PrivateIpAddress" : "172.17.**.**",
              "Primary" : true
            } ]
          },
          "Ipv6Sets" : {
            "Ipv6Set" : [ {
              "Ipv6Address" : "2408:4321:180:1701:94c7:bc38:3bfa:***"
            } ]
          },
          "Ipv4PrefixSets" : {
            "Ipv4PrefixSet" : [ {
              "Ipv4Prefix" : "192.168.*.*/28"
            } ]
          },
          "Ipv6PrefixSets" : {
            "Ipv6PrefixSet" : [ {
              "Ipv6Prefix" : "2001:1111:*:*::/80"
            } ]
          },
          "OperationLocks" : {
            "OperationLock" : [ {
              "LockMsg" : "The specified instance is locked due to financial reason.",
              "LockReason" : "Recycling"
            } ]
          },
          "Tags" : {
            "Tag" : [ {
              "TagValue" : "TestValue",
              "TagKey" : "TestKey"
            } ]
          },
          "RdmaIpAddresses" : {
            "RdmaIpAddress" : [ "10.10.10.102" ]
          },
          "SecurityGroupIds" : {
            "SecurityGroupId" : [ "sg-bp67acfmxazb4p****" ]
          },
          "PublicIpAddress" : {
            "PublicIpAddres" : [ "121.40.**.**" ]
          },
          "InnerIpAddress" : {
            "InnerIpAddres" : [ "10.170.**.**" ]
          },
          "VpcAttributes" : {
            "VpcId" : "vpc-2zeuphj08tt7q3brd****",
            "NatIpAddress" : "172.17.**.**",
            "VSwitchId" : "vsw-2zeh0r1pabwtg6wcs****",
            "PrivateIpAddress" : {
              "PrivateIpAddres" : [ "172.17.**.**" ]
            }
          },
          "EipAddress" : {
            "IsSupportUnassociate" : true,
            "InternetChargeType" : "PayByTraffic",
            "IpAddress" : "42.112.**.**",
            "Bandwidth" : 5,
            "AllocationId" : "eip-2ze88m67qx5z****"
          },
          "HibernationOptions" : {
            "Configured" : false
          },
          "DedicatedHostAttribute" : {
            "DedicatedHostId" : "dh-bp67acfmxazb4p****",
            "DedicatedHostName" : "testDedicatedHostName",
            "DedicatedHostClusterId" : "dc-bp67acfmxazb4h****"
          },
          "EcsCapacityReservationAttr" : {
            "CapacityReservationPreference" : "cr-bp67acfmxazb4p****",
            "CapacityReservationId" : "cr-bp67acfmxazb4p****"
          },
          "DedicatedInstanceAttribute" : {
            "Affinity" : "default",
            "Tenancy" : "default"
          },
          "CpuOptions" : {
            "Numa" : "2",
            "CoreCount" : 2,
            "ThreadsPerCore" : 4
          },
          "MetadataOptions" : {
            "HttpEndpoint" : "enabled",
            "HttpPutResponseHopLimit" : 0,
            "HttpTokens" : "optional"
          },
          "ImageOptions" : {
            "LoginAsNonRoot" : false
          }
        } ]
      }
    } ]
  }
}

Códigos de erro

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