この API を呼び出して、1 つや複数のインスタンスの詳細を表示できます。

説明

AND 演算子は、複数のリクエストパラメータ間の関係を定義するために使用されます。 パラメータの値が null の場合、リクエストは失敗します。 ただし、InstanceIds が空の JSON 配列に設定されている場合、有効と見なされ、null が返されます。

デバッグ

API Explorer でデバッグを実行できます。 API Explorer で各種操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成ができます。

リクエストパラメーター

名前 データ型 必須/省略可能 説明
RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID 。 DescribeRegions を実行すると、最新のリージョンリストが表示されます。

Action String 省略可能 DescribeInstances

実行する操作。 値を DescribeInstances に設定します。

InstanceIds String 省略可能 ["ds-xxxxxxxxx", "ds-yyyyyyyyy", … "ds-zzzzzzzzz"]

インスタンス ID。 複数のインスタンス ID で構成される JSON 配列にすることができます。 複数のインスタンス ID はコンマ(、)で区切ります。 一度に最大 100 個のインスタンス ID を入力できます。

VpcId String 省略可能 v-vpcid1

VPC の ID。

VSwitchId String 省略可能 vsw-vswitchid1

VSwitch の ID。

InstanceNetworkType String 省略可能 VPC

インスタンスのネットワークタイプ。 有効値:

  • クラシック
  • VPC。
SecurityGroupId String 省略可能 sg-securitygroupid1

インスタンスが属するリソースグループの ID 。

ZoneId String 省略可能 cn-hangzhou-d

インスタンスのゾーン ID 。

PageNumber Integer No 1

ページ番号。 この値は 1 から始まります。 既定値:1。

PageSize Integer 省略可能 10

1 ページあたりの行数。 最大値:100。 デフォルト値: 10。

InnerIpAddresses String 省略可能 ["10.1.1.1", "10.1.2.1", … "10.1.10.1"]

クラシックインスタンスのプライベート IP アドレスリスト。 InstanceNetworkType が classic に設定されている場合に有効です。 値は、複数の IP アドレスで構成される JSON 配列にすることができます。 複数の IP アドレスはカンマ (,) で区切ります。 一度に最大 100 個の IP アドレスを入力できます。

PrivateIpAddresses String 省略可能 ["172.16.1.1", "172.16.2.1", … "172.16.10.1"]

VPC タイプインスタンスのプライベート IP アドレスリスト。 InstanceNetworkType が VPC に設定されている場合に有効です。 値は、複数の IP アドレスで構成される JSON 配列にすることができます。 複数の IP アドレスはカンマ (,) で区切ります。 一度に最大 100 個の IP アドレスを入力できます。

PublicIpAddresses String 省略可能 ["42.1.1.1", "42.1.2.1", … "42.1.10.1"]

インスタンスのパブリック IP アドレスリスト。 InstanceNetworkType が classic に設定されている場合に有効です。 値は、複数の IP アドレスで構成される JSON 配列にすることができます。 複数の IP アドレスはカンマ (,) で区切ります。 一度に最大 100 個の IP アドレスを入力できます。

EipAddresses String 省略可能 ["42.1.1.1", "42.1.2.1", … "42.1.10.1"]

インスタンスの EIP アドレスリスト。 InstanceNetworkType が VPC に設定されている場合に有効です。 値は、複数の IP アドレスで構成される JSON 配列にすることができます。 複数の IP アドレスはカンマ (,) で区切ります。 一度に最大 100 個の IP アドレスを入力できます。

InstanceChargeType String 省略可能 PostPaid

インスタンスの課金方法。 有効値:

  • PostPaid: 従量課金
  • PrePaid:サブスクリプション
InternetChargeType String 省略可能 PayByTraffic

インスタンスの課金方法。 既定値 : PayByTraffic 有効値:

  • PayByTraffic:実際のトラフィックに基づいて課金されます。
InstanceName String 省略可能 *Joshua

インスタンスの名前。 ワイルドカード「*」を使用したファジー検索がサポートされています。

ImageId String 省略可能 m-imageid1

イメージ ID。

Status String 省略可能 Running

インスタンスのステータス。 有効値:

  • Running.
  • Starting.
  • Stopping.
  • Stopped.
LockReason String 省略可能 security

リソースがロックされている理由。

IoOptimized Boolean 省略可能 true

最適化インスタンスであるかを示します。

NeedSaleCycle Boolean 省略可能 false

サブスクリプションインスタンスの販売サイクルを返すかどうかを示します。 デフォルト値:false。

Tag.N.Key String 省略可能 FinanceDept

インスタンスのタグキー。 n の範囲は 1〜20 です。 このパラメーターを指定する場合、空にすることはできません。 長さは 64 文字以下である必要があります。 先頭文字列を ”aliyun”、”acs:”、”http://“ 、または “https://“ にすることはできません。

Tag.N.Value String 省略可能 FinanceDeptJoshua

インスタンスのタグ値。 n の範囲は 1〜20 です。 このパラメーターを指定する場合、空にすることができます。 長さは 128 文字以下である必要があります。 先頭文字列を ”aliyun”、”acs:”、”http://“ 、または “https://“ にすることはできません。

InstanceType String 省略可能 ecs.g5.larger

インスタンスの種類

InstanceTypeFamily String 省略可能 ecs.g5

インスタンスのタイプファミリー

KeyPairName String 省略可能 FinanceJoshua

インスタンスの SSH キーペアの名前。

ResourceGroupId String 省略可能 rg-resourcegroupid1

インスタンスが属するリソースグループの ID 。

HpcClusterId String 省略可能 hpc-hpclusterid1

インスタンスが属する HPC クラスターの ID。

RdmaIpAddresses String 省略可能 10.10.10.102

HPC インスタンスの RDMA IP アドレス。

DryRun Boolean 省略可能 false

チェックリクエストのみを送信するかを示します。 既定値:false

  • true:チェックリクエストのみが送信され、クエリは実行されません。 システムが AccessKey の有効性、RAM ユーザーの権限の有無、必要なパラメーターの設定有無を確認します。 チェックが失敗した場合、対応するエラーコードが返されます。 チェックが成功した場合、DryRunOperation と返されます。
  • false:2XX HTTP ステータスコードが返された場合、リクエストが送信され、クエリが実行されます。

レスポンスパラメータ

名前 データ型 説明
インスタンス

返されたインスタンス情報。 これは、InstanceAttributesType データで構成される配列です。

 └AutoReleaseTime String 2017-12-10T04:04Z

従量課金インスタンスの自動リリース時間。

 └ClusterId String c-clusterid1

インスタンスが属するクラスターの ID。

このパラメーターは削除予定です。 互換性を確保するために他のパラメーターを使用することを推奨します。
 └Cpu Integer 8

vCPU の数。

 └CreationTime String 2017-12-10T04:04Z

インスタンスが作成された時刻。

 └CreditSpecification String Standard

バースト可能なインスタンスの実行モード (t5)。 有効値:

 └DedicatedHostAttribute

DedicatedHostId および DedicatedHostName で構成されるホストの配列。

 └DedicatedHostId String dh-dedicatedhostid1

DDH の ID。

 └DedicatedHostName String FinanceDept

DDH の名前。

 └DeletionProtection Boolean false

インスタンスのリリース保護の属性。 ECS コンソールでインスタンスのリリースが可能か、または DeleteInstance 操作でインスタンスのリリースが可能かを示します。、

  • true:リリース保護を有効化します。
  • false:リリース保護を無効化します。
この属性は従量課金のインスタンスに適用可能です。 手動のリリース操作をブロックする際に使用できます。システムによる自動リリース操作はブロックできません。
 └DeploymentSetId String ds-deploymentid1

デプロイメントセットの ID。

 └Description String FinanceJoshua

インスタンスの説明。

 └EcsCapacityReservationAttr

インスタンスの容量予約属性。

 └ EipAddress

EIP アドレスバインディング情報。

 └AllocationId String i-instanceid1

EIP アドレスにバインドされたインスタンスの ID。

 └Bandwidth Integer 5

EIP アドレスのピーク速度。 単位:Mbit/秒

既定値:5。

 └InternetChargeType String PayByTraffic

EIP アドレスの課金方法。

 └IpAddress String xxx.xx.xxx.xx

EIP アドレス。

 └IsSupportUnassociate Boolean true

EIP アドレスをバインド解除できるかどうかを示します。

 └ExpiredTime String 2017-12-10T04:04Z

インスタンスの有効期限。 時間は、ISO 8601標準、UTC 時間です。 形式:yyyy-MM-ddTHH:mm:ssZ。

 └GPUAmount Integer 4

インスタンスタイプの GPU の数。

 └GPUSpec String NVIDIA V100

インスタンスタイプの GPU のカテゴリ。

 └HostName String JoshuaHost

インスタンスのホスト名。

 └HpcClusterId String hpc-hpcclusterid1

インスタンスが属する HPC クラスターの ID。

 └ImageId String m-imageid1

インスタンスが実行されているイメージの ID。

 └InnerIpAddress 10.170. XX.XXX

インスタンスのプライベート IP アドレス。

 └InstanceChargeType String PostPaid

インスタンスの課金方法。 有効値:

  • PrePaid:サブスクリプション
  • PostPaid:従量課金
 └InstanceId String i-instanceid1

インスタンス ID。

 └InstanceName String FinanceJoshua

インスタンスの名前。

 └InstanceNetworkType String VPC

インスタンスのネットワークタイプ。 有効値:

  • classic。
  • VPC。
 └InstanceType String ecs.g5.large

インスタンスのタイプ。

 └InstanceTypeFamily String ecs.g5

インスタンスのタイプファミリー。

 └InternetChargeType String PayByTraffic

インスタンスの課金方法。 有効値:

  • PayByTraffic:実際のトラフィックに基づいて課金されます。
 └InternetMaxBandwidthIn Integer 100

パブリックネットワークのインバウンド帯域幅の最大値。

 └InternetMaxBandwidthOut Integer 5

パブリックネットワークのアウトバウンド帯域幅の最大値。

 └IoOptimized Boolean true

最適化インスタンスであるかを示します。

 └KeyPairName String FinanceJoshua

キーペアの名前。

 └LocalStorageAmount Integer 2

インスタンスが接続されているローカルディスクの数。

 └LocalStorageCapacity Long 1000

インスタンスが接続されているローカルディスクの容量。

 └Memory Integer 1024

インスタンスのメモリーサイズ。 単位:MiB。

 └NetworkInterfaces

インスタンスの ENI リスト。

 └MacAddress String 00:16:3e:32:b4:dc

ENI の MAC アドレス。

 └NetworkInterfaceId String eni-2zeh9atclduxvf1zcyal

ENI の ID。

 └PrimaryIpAddress String 172.17. XX.XXX

プライマリ ENI のプライベート IP アドレス。

 └OSName String Ubuntu 16.04 64

インスタンスのオペレーティングシステムの名前。

 └OSType String Linux

インスタンスのオペレーティングシステムのタイプ。 有効値:Windows、Linux。

 └OperationLocks

インスタンスがロックされている理由。

 └LockMsg String ファイナンシャル上の理由により、指定されたインスタンスはロックされています。

インスタンスがロックされている場合に表示されるエラーメッセージ。

 └LockReason String recycling

インスタンスがロックされている理由のタイプ。 有効値:

  • financial:期限切れの支払い。
  • security:セキュリティに関する考慮事項。
  • recycling:プリエンプティブインスタンスは、リリース保護のためロックされています。
  • dedicatedhostfinancial:ECS インスタンスは、DDH の期限切れの支払いのためにロックされています。
 └PublicIpAddress 172.17. XX.XXX

インスタンスのパブリック IP アドレス。

 └RdmaIpAddress 10.10.10.102

HPC インスタンスの RDMA IP アドレス。

 └Recyclable Boolean false

インスタンスがリサイクル可能かを示します。

 └RegionId String cn-hangzhou

インスタンスのリージョン ID 。

 └ResourceGroupId String rg-resourcegroupid1

インスタンスが属するリソースグループの ID 。

 └SaleCycle String month

サブスクリプションインスタンスの購入サイクルの単位。 有効値:

  • week
  • month
  • year
 └SecurityGroupIds sg-securitygroupid1

インスタンスが属するセキュリティグループの ID 。

 └SerialNumber String 51d1353b-22bf-4567-a176-8b3e12e43135

インスタンスのシリアル番号。

 └SpotPriceLimit Float 0.98

インスタンスの最高価格/時。 小数点以下 3 桁まで正確です。 SpotStrategy が SpotWithPriceLimit に設定されている場合にのみ有効です。

 └SpotStrategy String NoSpot

従量課金インスタンスのプリエンプティブポリシー。 有効値:

  • NoSpot:通常の従量課金インスタンス。
  • SpotWithPriceLimit:価格上限が定義されたプリエンプティブインスタンス。
  • SpotAsPriceGo:現在の市場価格に基づいた従量課金のインスタンス。

デフォルト値 : NoSpot。

 └StartTime String 2017-12-10T04:04Z

インスタンスのプリエンプションモードの開始時刻。

 └Status String Running

インスタンスのステータス。

 └StoppedMode String KeepCharging

ECSインスタンスが停止後もまだ請求されているかどうかを示します。 有効値:

  • KeepCharging:インスタンスの停止後も引き続き請求され、現有のリソースを予約します。
  • StopCharging:インスタンスの停止後に請求されません。 ECS インスタンスが停止すると、vCPU、メモリ、パブリック IP アドレスなどのリソースがリリースされます。 リソースの一部が現行リージョンで不足している場合、インスタンスを再起動できないことがあります。
  • Not-applicable:StopCharging のみがサポートされます。
 └Tags

インスタンスのタグリスト。

 └TagKey String FinanceDept

インスタンスのタグキー。

 └TagValue String FinanceDept.Joshua

インスタンスのタグ値。

 └VlanId String 10

インスタンスの VLAN ID 。

このパラメーターは削除予定です。 互換性を確保するために他のパラメーターを使用することを推奨します。
 └VpcAttributes

インスタンスの VPC 属性。

 └NatIpAddress String 172.17. XX.XXX

インスタンスのパブリック IP アドレス。 異なる VPC の ECS インスタンスが互いに通信するために使用されます。

 └PrivateIpAddress 172.17. XX.XXX

インスタンスのプライベート IP アドレス。

 └VSwitchId String vsw-2zeh0r1pabwtg6wcssgca

VSwitch の ID。

 └VpcId String vpc-2zeuphj08tt7q3brdb36x

VPC の ID。

 └ZoneId String cn-hangzhou-d

インスタンスのゾーン ID 。

PageNumber Integer 1

ページ番号。

PageSize Integer 10

1 ページあたりの行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエスト ID 。

TotalCount Integer 6

インスタンスの総数。

リクエストの例


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

通常のレスポンスの例

XML 形式

<DescribeInstancesResponse>
  <PageNumber>1</PageNumber> 
  <TotalCount>6</TotalCount> 
  <PageSize>10</PageSize>
  <RequestId>8EF01A45-FFFA-497B-B5C3-1DE1B74DB32D</RequestId> 
  <Instances>
    <Instance>
      <InnerIpAddress/> 
      <ImageId>ubuntu_16_0402_64_20G_alibase_20170818.vhd</ImageId> 
      <InstanceTypeFamily>ecs.g5</InstanceTypeFamily> 
      <VlanId/> 
      <NetworkInterfaces> 
        <NetworkInterface> 
          <MacAddress>00:16:3e:32:b4:dc</MacAddress> 
          <PrimaryIpAddress>172.17. XX.XXX</PrimaryIpAddress> 
          <NetworkInterfaceId>eni-2zeh9atclduxvf1zcyal</NetworkInterfaceId> 
        </NetworkInterface> 
      </NetworkInterfaces> 
      <InstanceId>XXXXXXXXXXX</InstanceId> 
      <EipAddress> 
        <IpAddress/> 
        <AllocationId/> 
        <InternetChargeType/> 
      </EipAddress> 
      <InternetMaxBandwidthIn>1000</InternetMaxBandwidthIn> 
      <ZoneId>cn-beijing-e</ZoneId> 
      <InternetChargeType>PayByBandwidth</InternetChargeType>
      <SpotStrategy>NoSpot</SpotStrategy> 
      <StoppedMode>Not-applicable</StoppedMode> 
      <SerialNumber>d9bd1cdc-624d-4736-9da5-2ba2f741a304</SerialNumber> 
      <IoOptimized>true</IoOptimized> 
      <Memory>8192</Memory> 
      <Cpu>2</Cpu> 
      <VpcAttributes> 
        <NatIpAddress/>
        <PrivateIpAddress> 
          <IpAddress>172.17. XX.XXX</IpAddress> 
        </PrivateIpAddress> 
        <VSwitchId>vsw-2zeh0r1pabwtg6wcssgca</VSwitchId> 
        <VpcId>vpc-2zeuphj08tt7q3brdb36x</VpcId>
      </VpcAttributes> 
      <InternetMaxBandwidthOut>1</InternetMaxBandwidthOut> 
      <SecurityGroupIds> 
        <SecurityGroupId>sg-2ze21r9qb638hvtrvsus</SecurityGroupId> 
      </SecurityGroupIds> 
      <SpotPriceLimit>0.0</SpotPriceLimit> 
      <SaleCycle>Week</SaleCycle> 
      <AutoReleaseTime/> 
      <InstanceName>ECS-BUY-2017-57-10</InstanceName> 
      <Description/>
      <ResourceGroupId/>
      <OSType>linux</OSType> 
      <OSName>Ubuntu 16.04 64</OSName> 
      <InstanceNetworkType>vpc</InstanceNetworkType> 
      <PublicIpAddress> 
        <IpAddress>47.94. XX.XX</IpAddress>
      </PublicIpAddress> 
      <HostName>iZ2zeh9atclduxvf1zxuylZ</HostName> 
      <InstanceType>ecs.g5.large</InstanceType> 
      <CreationTime>2017-12-10T04:04Z</CreationTime> 
      <Tags> 
        <Tag>
          <TagValue>fqwfew</TagValue> 
          <TagKey>fefqe</TagKey> 
        </Tag>
        <Tag>
          <TagValue> weqfwq </ TagValue> 
          <TagKey>fqewfwqewf</TagKey> 
        </Tag>
        <Tag>
          <TagValue>ewqffeqw</TagValue> 
          <TagKey>fqfwewfqw</TagKey> 
        </Tag>
      </Tags> 
      <Status>Running</Status> 
      <ClusterId/> 
      <Recyclable>false</Recyclable> 
      <RegionId>cn-beijing</RegionId>
      <GPUSpec/> 
      <OperationLocks/> 
      <GPUAmount>0</GPUAmount> 
      <InstanceChargeType>PrePaid</InstanceChargeType> 
      <ExpiredTime>2017-12-17T16:00Z</ExpiredTime> 
    </Instance>
  </Instances>
</DescribeInstancesResponse>

JSON 形式

{
	"PageNumber":"1",
	"TotalCount":"1",
	"PageSize":"10",
	"RequestId":"14A07460-EBE7-47CA-9757-12CC4761D47A",
	"Instances":{
		"Instance":[
			{
				"ImageId":"centos6u5_64_20G_aliaegis_20150130.vhd",
				"InnerIpAddress":{
					"IpAddress":[
						"10.170. XX.XXX"
					]
				},
				"InstanceId":"XXXXXXXXX",
				"EipAddress":{},
				"InternetMaxBandwidthIn":"-1",
				"ZoneId":"cn-shenzhen-a",
				"InstanceNetworkType":"classic",
				"PublicIpAddress":{
					"IpAddress":[
						"120.25. XX.XXX"
					]
				},
				"InternetChargeType":"PayByTraffic",
				"HostName":"iZ94t3s0jxkZ",
				"InstanceType":"ecs.s2.large",
				"SerialNumber":"51d1353b-22bf-4567-a176-8b3e12e43135",
				"IoOptimized":"false",
				"CreationTime":"2015-07-27T07:08Z",
				"Status":"Running",
				"VpcAttributes":{
					"PrivateIpAddress":{
						"IpAddress":[]
					}
				},
				"InternetMaxBandwidthOut":"1",
				"SecurityGroupIds":{
					"SecurityGroupId":[
						"sg-94kd0cyg0"
					]
				},
				"RegionId":"cn-shenzhen",
				"OperationLocks":{
					"LockReason":[]
				},
				"InstanceChargeType":"PostPaid",
				"ExpiredTime":"2011-09-08T16:00Z",
				"InstanceName":"dd performance test"
			}
		]
	}
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
404 InvalidInstanceChargeType.NotFound The InstanceChargeType does not exist in our records 指定されたインスタンスタイプが存在しない場合に返されるエラーメッセージ。
404 InvalidInternetChargeType.ValueNotSupported The specified InternetChargeType is not valid 指定された請求方法が無効な場合に返されるエラーメッセージ。
404 InvalidNetworkType.NotFound The specified InstanceNetworkType is not found 指定された帯域幅タイプが存在しない場合に返されるエラーメッセージ。
400 InvalidHpcClusterId.NotFound The specified HpcClusterId is not found. 指定された HPC クラスター ID が存在しない場合に返されるエラーメッセージ。
400 InvalidHpcClusterId.Creating The specified HpcClusterId is creating. 指定された HPC クラスターが無効な場合に返されるエラーメッセージ。

エラーコードの表示