すべてのプロダクト
Search

このプロダクト

    ENS:DescribeInstances

    ドキュメントセンター

    ENS:DescribeInstances

    最終更新日:Mar 20, 2026

    1 つ以上のインスタンスの詳細情報を取得します。

    操作説明

    • API リクエストレート：1 秒あたり 800 リクエスト。

    • 単一ユーザーのリクエストレート：1 秒あたり 100 リクエスト。

    • リクエストパラメーターはフィルターとして機能し、論理 AND で結合されます。空のパラメーターは無視されます。ただし、InstanceIds パラメーターが空の JSON 配列の場合、このフィルターが適用され、空のリストが返されます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ens:DescribeInstances

    list

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    EnsRegionId

    string

    任意

    エッジノードの ID です。

    cn-beijing-cmcc
    InstanceId

    string

    任意

    インスタンスの ID です。

    i-5iqczfxps7csjrxeca****
    EnsRegionIds

    string

    任意

    エッジノード ID の JSON 配列です。最大 100 個の ID を指定できます。

    ["cn-suzhou-telecom","cn-chengdu-telecom"]
    InstanceIds

    string

    任意

    インスタンス ID の JSON 配列です。最大 100 個の ID を指定できます。

    ["i-5iqczfxps7csjrxeca07****", "i-5iqczfxps7csjrxeca07****"]
    InstanceName

    string

    任意

    インスタンスの名前です。

    TestName
    ImageId

    string

    任意

    イメージの ID です。

    centos_6_08_64_20G_alibase_****
    PageNumber

    integer

    任意

    ページ番号です。ページは 1 から開始します。

    デフォルト値：1

    1
    PageSize

    string

    任意

    1 ページあたりのエントリ数です。最大値：100

    デフォルト値：10

    10
    Status

    string

    任意

    インスタンスのステータスです。有効な値：

    • Running

    • Stopped

    • Expired

    Running
    OrderByParams

    string

    任意

    結果のソート順を JSON 形式で指定します。

    インスタンス名、有効期限、エッジノード ID、作成時刻でソートできます。

    { "InstanceNameSort": "asc", "ExpireTimeSort": "asc", "CreationTimeSort": "desc", "EnsRegionId": "desc" }
    EnsServiceId

    string

    任意

    エッジサービスの ID です。このパラメーターを使用して、そのサービスによって作成されたインスタンスを検索します。

    ens-20190730202316s****
    InstanceResourceType

    string

    任意

    フィルターに使用するリソースタイプです。有効な値：

    • EnsInstance：個別に購入したインスタンス。

    • EnsService：エッジサービスによって作成されたインスタンス。

    • BuildMachine：ビルドマシン。

    • EnsPostPaidInstance：個別に購入した従量課金インスタンス。

    EnsService
    SearchKey

    string

    任意

    検索キーワードです。IP アドレス、インスタンス名、またはインスタンス IDで検索できます。

    Joshua
    NetworkId

    string

    任意

    ネットワークの ID です。

    n-2zeuphj08tt7q3brd****
    VSwitchId

    string

    任意

    vSwitch の ID です。

    vsw-2zeh0r1pabwtg6wcs****
    SecurityGroupId

    string

    任意

    セキュリティグループの ID です。

    sg-5kyicq2kfcapxrdds6tar7jqb
    IntranetIp

    string

    任意

    プライベート IP アドレスです。

    47.100.XX.XX
    Tags

    array<object>

    任意

    リソースをフィルターするためのタグです。最大 20 個のタグを指定できます。この操作ではこれらのタグを使用してフィルターを行いますが、応答には含まれません。タグの管理には、専用のタグ API オペレーションをご利用ください。

    object

    任意

    タグのキーと値のペアです。

    Key

    string

    任意

    タグのキーです。

    tag
    Value

    string

    任意

    タグの値です。

    2
    InstanceType

    string

    任意

    インスタンスタイプです。

    ens.se1.tiny
    ServiceStatus

    array

    任意

    インスタンスのサービスステータスです。これはインスタンスの実際のランタイムステータスを表すものではありません。

    string

    任意

    有効な値：

    • Expired：インスタンスの有効期限が切れています。

    • Arrears：インスタンスの支払いが遅延しています。

    Expired
    EipAddresses

    array

    任意

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    integer

    応答コードです。値が 0 の場合、リクエストは成功しています。

    0
    PageSize

    integer

    1 ページあたりに返されるエントリ数です。

    60
    PageNumber

    integer

    返されたページのページ番号です。

    1
    RequestId

    string

    リクエスト ID です。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    TotalCount

    integer

    クエリに一致するインスタンスの総数です。

    2
    Instances

    object

    Instance

    array<object>

    インスタンスとその詳細情報のリストです。

    array<object>

    インスタンスの詳細情報です。

    CreationTime

    string

    インスタンスの作成時刻です。時刻は協定世界時 (UTC) で表示され、ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ の形式でフォーマットされます。

    2019-07-26T06:40:43Z
    Status

    string

    インスタンスのステータスです。有効な値：

    • Running

    • Expired

    • Stopped

    Running
    SpecName

    string

    インスタンスタイプです。

    ens.sn1.stiny
    InstanceTypeFamily

    string

    インスタンスファミリーです。有効な値：

    • x86_vm：x86 コンピュート

    • x86_pm：x86 ベアメタル

    • x86_bmi：x86 ベアメタルインスタンス

    • x86_bm：スマート NIC 搭載ベアメタルインスタンス

    • pc_bmi：ヘテロジニアスベアメタルインスタンス

    • pc_vm：ヘテロジニアス仮想マシン

    • arm_bmi：ARM コンピュート

    x86_vm
    InstanceResourceType

    string

    インスタンスのリソースタイプです。有効な値：

    • EnsInstance：個別に購入したインスタンス。

    • EnsService：エッジサービスによって作成されたインスタンス。

    • BuildMachine：イメージのビルドに使用するマシン。

    • EnsPostPaidInstance：個別に購入した従量課金インスタンス。

    EnsService
    HostName

    string

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

    • ピリオド (.) またはハイフン (-) は、最初または最後の文字に使用できず、連続して使用することもできません。

    • Windows インスタンスの場合、ホスト名は 2～15 文字で、ピリオド (.) を含めることはできず、数字のみで構成することはできません。大文字、小文字、数字、ハイフン (-) を使用できます。

    • Linux などの他のインスタンスタイプの場合、ホスト名は 2～64 文字で、複数のピリオド (.) を含めることができます。ピリオドで区切られた各セグメントには、大文字、小文字、数字、ハイフン (-) を使用できます。

    testHostName
    InstanceId

    string

    インスタンスの ID です。

    i-instanc****
    InternetMaxBandwidthIn

    integer

    パブリックインバウンドトラフィックの最大帯域幅（Mbit/s）です。

    40
    InternetMaxBandwidthOut

    integer

    パブリックアウトバウンドトラフィックの最大帯域幅（Mbit/s）です。

    100
    EnsRegionId

    string

    インスタンスが配置されているリージョンの ID です。

    cn-hangzhou-telecom
    Cpu

    string

    vCPU の数です。

    2
    ExpiredTime

    string

    有効期限です。時刻は協定世界時 (UTC) で表示され、ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ の形式でフォーマットされます。

    2119-07-13T02:38:57Z
    InstanceName

    string

    インスタンスの名前です。

    i-5itef0f28t17bcdw9deu6meub
    Disk

    integer

    ディスクの合計サイズ（MiB）です。

    71680
    OSName

    string

    オペレーティングシステムの名前です。

    centos 6.8 x86_64
    Memory

    integer

    メモリサイズ（MiB）です。

    2048
    ImageId

    string

    イメージの ID です。

    m-****
    DataDisk

    object

    データディスクです。

    DataDisk

    array<object>

    データディスクのリストです。

    object

    データディスクの詳細情報です。

    device_type

    string

    Category の拡張フィールドです。有効な値：

    • file：ローカルディスク

    • pangu：Ultra Disk

    • local_hdd：ローカル HDD

    pangu
    disk_type

    string

    ディスクのタイプです。有効な値：

    system：システムディスク data：データディスク

    system
    Size

    integer

    ディスクのサイズ（MiB）です。

    51200
    DiskName

    string

    ディスクの名前です。

    DiskName
    uuid

    string

    ディスクの UUID です。

    5431f898-1323-4e64-8ce1-6cad50ed****
    storage

    integer

    ディスクのサイズ（MiB）です。

    20480
    DiskId

    string

    ディスクの ID です。

    d-5ip4c2dhmas0vjd5u1r****
    Category

    string

    ディスクのカテゴリです。有効な値：

    • file：ローカルディスク

    • pangu：Ultra Disk

    • local_hdd：ローカル HDD

    file
    name

    string

    ディスクの名前です。

    name
    DiskSize

    integer

    ディスクのサイズ（GiB）です。

    100
    EncryptKeyId

    string

    ディスクに使用される KMS キーの ID です。

    0e478b7a-4262-4802-b8cb-00d3fxxxxx
    Encrypted

    boolean

    ディスクが暗号化されているかどうかを示します。

    true
    PublicIpAddresses

    object

    パブリック IP アドレスです。

    PublicIpAddress

    array<object>

    パブリック IP アドレスのリストです。

    object

    パブリック IP アドレスの詳細情報です。

    Ip

    string

    パブリック IP アドレスです。

    119.147.xx.xx
    GateWay

    string

    ゲートウェイです。

    119.147.xx.xx
    Isp

    string

    インターネットサービスプロバイダー (ISP) です。

    unicom
    PrivateIpAddresses

    object

    プライベート IP アドレスです。

    PrivateIpAddress

    array<object>

    プライベート IP アドレスのリストです。

    object

    プライベート IP アドレスの詳細情報です。

    Ip

    string

    プライベート IP アドレスです。

    119.147.xx.xx
    GateWay

    string

    ゲートウェイです。

    119.147.xx.xx
    Isp

    string

    ISP です。

    cmcc
    SecurityGroupIds

    object

    インスタンスに関連付けられているセキュリティグループの ID です。

    SecurityGroupId

    array

    セキュリティグループ ID のリストです。

    string

    セキュリティグループの ID です。

    sg-5kyicq2kfcapxrdds6ta****
    InnerIpAddress

    object

    プライベート IP アドレスです。

    IpAddress

    array

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

    string

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

    10.170.xx.xx
    PublicIpAddress

    object

    パブリック IP アドレスです。

    IpAddress

    array

    パブリック IP アドレスのリストです。

    string

    パブリック IP アドレスです。

    119.147.xx.xx
    SystemDisk

    object

    システムディスクの詳細情報です。

    device_type

    string

    Category の拡張フィールドです。有効な値：

    • file：ローカルディスク

    • pangu：Ultra Disk

    • local_hdd：ローカル HDD

    pangu
    disk_type

    string

    ディスクのタイプです。有効な値：

    • system：システムディスク

    • data：データディスク

    system
    Size

    integer

    ディスクのサイズ（MiB）です。

    51200
    DiskName

    string

    ディスクの名前です。

    DiskName
    uuid

    string

    ディスクの UUID です。

    5431f898-1323-4e64-8ce1-6cad50ed****
    storage

    integer

    ディスクのサイズ（MiB）です。

    20480
    DiskId

    string

    ディスクの ID です。

    d-5ip4c2dhmas0rn7rt0p9****
    Category

    string

    ディスクのカテゴリです。有効な値：

    • file：ローカルディスク

    • pangu：Ultra Disk

    • local_hdd：ローカル HDD

    file
    name

    string

    ディスクの名前です。

    DiskName
    NetworkAttributes

    object

    ネットワーク属性です。

    NetworkId

    string

    ネットワーク ID です。

    n-2zeuphj08tt7q3brd****
    VSwitchId

    string

    VSwitch ID です。

    vsw-2zeh0r1pabwtg6wcs****
    PrivateIpAddress

    object

    IpAddress

    array

    インスタンスのプライベートネットワーク情報です。

    string

    インスタンスのプライベート IP アドレスです。最大 1 つのプライベート IP アドレスを指定できます。IP アドレスは、VSwitch (VSwitchId) の CIDR ブロック内で利用可能なアドレスである必要があります。

    172.17.**.**
    Tags

    object

    Tags

    array<object>

    インスタンスのタグのコレクションです。

    重要 この API は現在、タグ情報を返しません。タグの管理には、タグディレクトリ内の API を使用してください。

    object

    タグ情報です。

    重要 この API は現在、タグ情報を返しません。タグ情報を取得するには、タグセクションの API を使用してください。

    TagValue

    string

    タグ値です。

    value1
    TagKey

    string

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

    key1
    AutoReleaseTime

    string

    インスタンスが自動的にリリースされる時刻です。

    2023-06-28T14:38:52Z
    SpotStrategy

    string

    プリエンプティブインスタンス戦略です。

    NoSpot
    KeyPairName

    string

    キーペアの名前です。

    TestKeyPairName
    NetworkInterfaces

    object

    NetworkInterfaces

    array<object>

    Elastic Network Interface (ENI) に関する情報です。

    array<object>

    Elastic Network Interface (ENI) オブジェクトの配列です。

    Type

    string

    Elastic Network Interface (ENI) のタイプです。有効な値：

    • Primary：プライマリ ENI。

    • Secondary：セカンダリ ENI。

    Primary
    MacAddress

    string

    Elastic Network Interface (ENI) の MAC アドレスです。

    00:16:XXX:XXX:60:0a
    PrimaryIpAddress

    string

    プライマリプライベート IP アドレスです。

    10.XXX.XXX.25
    NetworkInterfaceId

    string

    Elastic Network Interface (ENI) の ID です。

    eni-53afk8a0t5lklbi8m7j8iczdg
    PrivateIpSets

    object

    PrivateIpSet

    array<object>

    PrivateIpSet オブジェクトのコレクションです。

    object

    PrivateIpSet オブジェクトの配列です。

    PrivateIpAddress

    string

    プライベート IP アドレスです。

    192.XXX.XXX.130
    Primary

    boolean

    IP アドレスがプライマリプライベート IP アドレスであるかどうかを示します。有効な値：

    • true：プライマリプライベート IP アドレス。

    • false：セカンダリプライベート IP アドレス。

    true
    Ipv6Sets

    object

    Ipv6Set

    array<object>

    Elastic Network Interface (ENI) に割り当てられた IPv6 アドレスです。

    object

    Elastic Network Interface (ENI) に割り当てられた IPv6 アドレスのセットです。

    Ipv6Address

    string

    Elastic Network Interface (ENI) に割り当てられた IPv6 アドレスです。

    2605:340:cdb1:XXXX:XXXX:XXXX:XXXX:e2d6
    ServiceStatus

    string

    インスタンスのサービスステータスです。これはインスタンスの実際の実行状態を表すものではありません。

    Expired
    DeletionProtection

    boolean

    例

    成功レスポンス

    JSONJSON

    {
  "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"
                  }
                ]
              }
            }
          ]
        },
        "ServiceStatus": "Expired",
        "DeletionProtection": false
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。