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

Elastic Compute Service:DescribeInstanceAttribute

最終更新日:Jul 31, 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

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

Running

SerialNumber

string

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

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

CreationTime

string

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

2017-12-10T04:04Z

RequestId

string

リクエスト ID

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

Description

string

インスタンスの説明。

testDescription

InstanceName

string

インスタンス名。

testInstanceName

InstanceNetworkType

string

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

vpc

Memory

integer

メモリサイズ。単位: MiB。

16384

ImageId

string

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

m-bp1h46wfpjsjastc****

ClusterId

string

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

cls-bp67acfmxazb4p****

VlanId

string

インスタンスの VLAN ID。

10

StoppedMode

string

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

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

IoOptimized

string

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

optimized

Cpu

integer

vCPU コア数。

8

ExpiredTime

string

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

2017-12-10T04:04Z

ZoneId

string

インスタンスのゾーン ID

cn-hangzhou-g

InternetChargeType

string

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

PayByTraffic

CreditSpecification

string

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

標準

SecurityGroupIds

object

SecurityGroupId

array

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

string

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

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

Elastic IP Address (EIP) のバインド情報。

InternetChargeType

string

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

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

EnableJumboFrame

boolean

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

false

EnableNetworkEncryption

boolean

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

True

NetworkOptions

object

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

EnableJumboFrame

boolean

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

false

EnableNetworkEncryption

boolean

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

False

BandwidthWeighting

string

帯域幅の重み。

列挙値:

  • Vpc-L1 :

    Vpc-L1

  • Vpc-L2 :

    Vpc-L2

  • Ebs-L1 :

    Ebs-L1

  • Ebs-L2 :

    Ebs-L2

  • Default :

    Default。

Vpc-L1

SecurityOptions

object

EnableSecureBoot

boolean

例

成功レスポンス

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": "標準",
  "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 が無効です。

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

変更履歴

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