すべてのプロダクト
Search
ドキュメントセンター

Elastic Compute Service:DescribeInstanceAttribute

最終更新日:Oct 16, 2026

指定された ECS インスタンスの属性を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeInstanceAttribute

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

InstanceId

string

必須

インスタンスの ID。

i-uf6f5trc95ug8t33****

レスポンスフィールド

フィールド

型

説明

例

object

Status

string

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

  • Pending: インスタンスの作成中です。

  • Running: インスタンスは実行中です。

  • Starting: インスタンスは起動中です。

  • Stopping: インスタンスは停止中です。

  • Stopped: インスタンスは停止しています。

Running

SerialNumber

string

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

51d1353b-22bf-4567-a176-8b3e12e4****

CreationTime

string

インスタンスが作成された時間。時間は協定世界時 (UTC) で表示され、ISO 8601 規格の yyyy-MM-ddTHH:mmZ 形式に従います。詳細については、「ISO 8601」を参照してください。

2017-12-10T04:04Z

RequestId

string

リクエスト ID

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Description

string

インスタンスの説明

testDescription

InstanceName

string

インスタンス名

testInstanceName

InstanceNetworkType

string

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

  • vpc: VPC。

  • classic: クラシックネットワーク。クラシックネットワークは廃止されました。詳細については、「廃止のお知らせ」を参照してください。

vpc

Memory

integer

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

16384

ImageId

string

インスタンスが実行中のイメージの ID。

m-bp1h46wfpjsjastc****

ClusterId

string

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

説明

[非推奨] このパラメーターはまもなく非推奨になります。互換性を確保するため、代わりに他のパラメーターを使用してください。

cls-bp67acfmxazb4p****

VlanId

string

インスタンスの VLAN ID。

説明

[非推奨] このパラメーターはまもなく非推奨になります。互換性を確保するため、代わりに他のパラメーターを使用してください。

10

StoppedMode

string

インスタンス停止後も課金が継続されるかどうかを指定します。有効な値:

  • KeepCharging: インスタンス停止後も課金が継続され、在庫リソースが予約されます。

  • StopCharging: インスタンス停止後は課金されません。インスタンス停止後、vCPU、メモリ、パブリック IP アドレスなどのリソースがリリースされます。インスタンスを再起動できるかどうかは、現在のリージョンのリソースインベントリに依存します。

  • Not-applicable: インスタンスは節約モードをサポートしていません。

KeepCharging

HostName

string

インスタンスのホスト名

testHostName

InstanceId

string

インスタンス ID

i-uf6f5trc95ug8t33****

InstanceType

string

インスタンスタイプ

ecs.g5.large

InternetMaxBandwidthIn

integer

インバウンドパブリック帯域幅の最大値。単位: Mbit/s。

50

InternetMaxBandwidthOut

integer

アウトバウンドパブリック帯域幅の最大値。単位: Mbit/s。

5

RegionId

string

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

cn-hangzhou

InstanceChargeType

string

インスタンスの支払い方法。有効な値:

  • PrePaid: サブスクリプション。

  • PostPaid: 従量課金。

PrePaid

IoOptimized

string

インスタンスが I/O 最適化されているかどうかを指定します。有効な値:

  • optimized: インスタンスは I/O 最適化されています。

  • none: インスタンスは I/O 最適化されていません。

optimized

Cpu

integer

vCPU のコア数。

8

ExpiredTime

string

有効期限。時間は協定世界時 (UTC) で表示され、ISO 8601 規格の yyyy-MM-ddTHH:mmZ 形式に従います。詳細については、「ISO 8601」を参照してください。

2017-12-10T04:04Z

ZoneId

string

インスタンスのゾーン。

cn-hangzhou-g

InternetChargeType

string

パブリック帯域幅の支払い方法。有効な値:

  • PayByBandwidth: 帯域幅課金。

  • PayByTraffic: トラフィック課金。

説明

トラフィック課金モードでは、ピーク時のインバウンドおよびアウトバウンド帯域幅の値は帯域幅の最大値であり、保証されません。リソース競合が発生した場合、ピーク帯域幅が制限される可能性があります。ビジネスで帯域幅の保証が必要な場合は、帯域幅課金モードを使用してください。

PayByTraffic

CreditSpecification

string

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

  • Standard: 標準モード。インスタンスのパフォーマンスの詳細については、「パフォーマンスモード」を参照してください。

  • Unlimited: 無制限版。インスタンスのパフォーマンスの詳細については、「パフォーマンスモード」を参照してください。

Standard

SecurityGroupIds

object

SecurityGroupId

array

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

string

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

sg-bp1fg655nh68xyz9i****

PublicIpAddress

object

IpAddress

array

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

string

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

121.40.**.**

InnerIpAddress

object

IpAddress

array

クラシックネットワーク内のインスタンスの内部 IP アドレス。

説明

クラシックネットワークの機能は廃止されました。詳細については、「廃止のお知らせ」を参照してください。

string

クラシックネットワーク内のインスタンスの内部 IP アドレス。

192.168.**.**

VpcAttributes

object

VPC の属性。

VpcId

string

VPC ID。

vpc-wz9e4e9pmbcnj6ki6****

NatIpAddress

string

クラウドサービスの IP アドレス。VPC 内のクラウドサービス間のネットワーク接続性に使用されます。

172.17.**.**

VSwitchId

string

vSwitch ID。

vsw-uf6ixacqz8osrwnqb****

PrivateIpAddress

object

IpAddress

array

非公開 IP アドレス。

string

非公開 IP アドレス。

192.168.**.**

EipAddress

object

EIP のバインド情報。

InternetChargeType

string

パブリック帯域幅の支払い方法。有効な値:

  • PayByBandwidth: 帯域幅課金。

  • PayByTraffic: トラフィック課金。

説明

トラフィック課金モードでは、ピーク時のインバウンドおよびアウトバウンド帯域幅の値は帯域幅の最大値であり、保証されません。リソース競合が発生した場合、ピーク帯域幅が制限される可能性があります。ビジネスで帯域幅の保証が必要な場合は、帯域幅課金モードを使用してください。

PayByTraffic

IpAddress

string

EIP。

30.21.**.**

Bandwidth

integer

EIP のパブリック帯域幅制限。単位: Mbit/s。

8

AllocationId

string

EIP の ID。

eip-wz9uilio26dfscamm****

DedicatedHostAttribute

object

専用ホストの属性。専用ホストクラスター ID (DedicatedHostClusterId)、専用ホスト ID (DedicatedHostId)、専用ホスト名 (DedicatedHostName) が含まれます。

DedicatedHostName

string

専用ホストの名前。

ecs-autoui-create-ddh-temp

DedicatedHostId

string

専用ホストの ID。

dh-2ze7qrzz6lvbfhr0****

OperationLocks

object

LockReason

array<object>

ロックの理由。

object

ロックの理由。

LockReason

string

ロックの理由。有効な値:

  • financial: 料金滞納によりインスタンスはロック済みです。

  • security: セキュリティ上の理由によりインスタンスはロック済みです。

  • Recycling: スポットインスタンスはロック済みであり、リリース待ちです。

  • dedicatedhostfinancial: 専用ホストの料金滞納により ECS インスタンスはロック済みです。

  • refunded: 返金によりインスタンスはロック済みです。

financial

EnableJumboFrame

boolean

ECS インスタンスでジャンボフレームの機能が有効になっているかどうかを指定します。有効な値:

  • true: 機能が有効になっています。

  • false: 機能が無効になっています。

詳細については、「ECS インスタンスの MTU」を参照してください。

false

EnableNetworkEncryption

boolean

インスタンスで VPC ネットワークトラフィックの暗号化が有効になっているかどうかを指定します。有効な値:

  • true: 有効。

  • false: 無効。

説明

このパラメーターは招待プレビュー中であり、一般公開されていません。

True

NetworkOptions

object

ネットワーク関連の属性。

説明

このパラメーターは招待プレビュー中であり、一般公開されていません。

EnableJumboFrame

boolean

インスタンスでジャンボフレームの機能が有効になっているかどうかを指定します。有効な値:

  • true: 機能が有効になっています。

  • false: 機能が無効になっています。

詳細については、「ECS インスタンスの MTU」を参照してください。

説明

このパラメーターは招待プレビュー中であり、一般公開されていません。

false

EnableNetworkEncryption

boolean

インスタンスで VPC ネットワークトラフィックの暗号化が有効になっているかどうかを指定します。有効な値:

  • true: 有効。

  • false: 無効。

説明

このパラメーターは招待プレビュー中であり、一般公開されていません。

False

BandwidthWeighting

string

帯域幅の重み。

サポートされる値はインスタンスタイプによって異なります。 DescribeInstanceTypes 操作を呼び出して、現在のインスタンスタイプでサポートされている帯域幅の重みの値をクエリできます。

列挙値:

  • Vpc-L1 :

    Vpc-L1

  • Vpc-L2 :

    Vpc-L2

  • Ebs-L1 :

    Ebs-L1

  • Ebs-L2 :

    Ebs-L2

  • Default :

    Default。

Vpc-L1

SecurityOptions

object

EnableSecureBoot

boolean

UEFI セキュアブートが有効になっているかどうかを指定します。

例

成功レスポンス

JSONJSON

{
  "Status": "Running",
  "SerialNumber": "51d1353b-22bf-4567-a176-8b3e12e4****",
  "CreationTime": "2017-12-10T04:04Z",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Description": "testDescription",
  "InstanceName": "testInstanceName",
  "InstanceNetworkType": "vpc",
  "Memory": 16384,
  "ImageId": "m-bp1h46wfpjsjastc****",
  "ClusterId": "cls-bp67acfmxazb4p****",
  "VlanId": "10",
  "StoppedMode": "KeepCharging",
  "HostName": "testHostName",
  "InstanceId": "i-uf6f5trc95ug8t33****",
  "InstanceType": "ecs.g5.large",
  "InternetMaxBandwidthIn": 50,
  "InternetMaxBandwidthOut": 5,
  "RegionId": "cn-hangzhou",
  "InstanceChargeType": "PrePaid",
  "IoOptimized": "optimized",
  "Cpu": 8,
  "ExpiredTime": "2017-12-10T04:04Z",
  "ZoneId": "cn-hangzhou-g",
  "InternetChargeType": "PayByTraffic",
  "CreditSpecification": "Standard",
  "SecurityGroupIds": {
    "SecurityGroupId": [
      "sg-bp1fg655nh68xyz9i****"
    ]
  },
  "PublicIpAddress": {
    "IpAddress": [
      "121.40.**.**"
    ]
  },
  "InnerIpAddress": {
    "IpAddress": [
      "192.168.**.**"
    ]
  },
  "VpcAttributes": {
    "VpcId": "vpc-wz9e4e9pmbcnj6ki6****",
    "NatIpAddress": "172.17.**.**",
    "VSwitchId": "vsw-uf6ixacqz8osrwnqb****",
    "PrivateIpAddress": {
      "IpAddress": [
        "192.168.**.**"
      ]
    }
  },
  "EipAddress": {
    "InternetChargeType": "PayByTraffic",
    "IpAddress": "30.21.**.**",
    "Bandwidth": 8,
    "AllocationId": "eip-wz9uilio26dfscamm****"
  },
  "DedicatedHostAttribute": {
    "DedicatedHostName": "ecs-autoui-create-ddh-temp",
    "DedicatedHostId": "dh-2ze7qrzz6lvbfhr0****"
  },
  "OperationLocks": {
    "LockReason": [
      {
        "LockReason": "financial"
      }
    ]
  },
  "EnableJumboFrame": false,
  "EnableNetworkEncryption": true,
  "NetworkOptions": {
    "EnableJumboFrame": false,
    "EnableNetworkEncryption": true,
    "BandwidthWeighting": "Vpc-L1"
  },
  "SecurityOptions": {
    "EnableSecureBoot": false
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

500 InternalError The request processing has failed due to some unknown error.
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定されたインスタンスが存在しません。インスタンス ID が正しいかどうかを確認してください。

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

変更履歴

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