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

Elastic Compute Service:DescribeDedicatedHosts

最終更新日:Apr 04, 2026

この操作を呼び出して、1 つ以上の専用ホストの詳細を照会します。物理パフォーマンスメトリクス、マシンコード、ステータス、ホスト上の ECS インスタンスのリストなどの情報が返されます。専用ホスト ID、専用ホストクラスター ID、ホスト名、ステータスなどのパラメーターで結果をフィルタリングして、特定のホストを見つけることができます。この機能は、クラウドコンピューティングリソースを効率的に管理および最適化するのに役立ちます。

操作説明

API

以下のいずれかの方法で、1 つ以上の専用ホストの詳細を照会できます。

  • DedicatedHostIds を指定して、特定の専用ホストを照会します。

  • DedicatedHostClusterId を指定して、専用ホストクラスター内のすべての専用ホストを照会します。

今すぐお試しください

この 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:DescribeDedicatedHosts

get

DedicatedHost

acs:ecs:{#regionId}:{#accountId}:ddh/*

DedicatedHost

acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

専用ホストが所在するリージョンの ID。`DescribeRegions` 操作を呼び出して、Alibaba Cloud リージョンの最新リストを取得します。

cn-hangzhou

ZoneId

string

任意

ゾーン ID。`DescribeZones` 操作を呼び出して、Alibaba Cloud ゾーンの最新リストを取得します。

cn-hangzhou-g

DedicatedHostIds

string

任意

専用ホストの ID。JSON 配列で最大 100 個の専用ホスト ID を指定できます。

["dh-bp165p6xk2tlw61e****", "dh-bp1f9vxmno7emy96****"]

DedicatedHostName

string

任意

専用ホストの名前。

MyDDHTestName

Status

string

任意

専用ホストの状態。有効な値:

  • Available:専用ホストは正常に実行されています。

  • UnderAssessment:専用ホストは物理ハードウェアのリスク評価中です。ホストは利用可能ですが、ECS インスタンスに影響を与える可能性のあるハードウェアの問題がある場合があります。

  • PermanentFailure:専用ホストに永続的な障害が発生し、利用できません。

  • TempUnavailable:専用ホストは一時的に利用できません。

  • Redeploying:専用ホストは再デプロイ中です。

デフォルト値は Available です。

Available

DedicatedHostType

string

任意

専用ホストタイプ。`DescribeDedicatedHostTypes` 操作を呼び出して、専用ホストタイプの最新リストを取得します。

ddh.g5

LockReason

string

任意

専用ホストがロックされている理由。有効な値:

  • financial:支払い遅延のため、専用ホストはロックされています。

  • security:セキュリティ上の理由により、専用ホストはロックされています。

financial

PageNumber

integer

任意

説明

このパラメーターは非推奨です。ページネーションには `NextToken` と `MaxResults` を使用してください。

1

PageSize

integer

任意

説明

このパラメーターは非推奨です。ページネーションには `NextToken` と `MaxResults` を使用してください。

10

ResourceGroupId

string

任意

専用ホストが属するリソースグループの ID。このパラメーターを使用してリソースをフィルタリングする場合、リソースの数は 1,000 を超えることはできません。

説明

デフォルトのリソースグループによるフィルタリングはサポートされていません。

rg-aek3b6jzp66****

Tag

array<object>

任意

専用ホストをフィルタリングするために使用されるタグ。最大 20 個のタグを指定できます。

object

任意

Key

string

任意

タグキー。キーは最大 128 文字です。空の文字列にしたり、aliyun または acs: で始めたり、http:// または https:// を含めたりすることはできません。

TestKey

Value

string

任意

タグ値。値は最大 128 文字で、http:// または https:// を含めることはできません。値を空のままにすることができます。

TestValue

DedicatedHostClusterId

string

任意

専用ホストクラスターの ID。

dc-bp12wlf6am0vz9v2****

SocketDetails

string

任意

ソケットレベルのキャパシティ情報を返すかどうかを指定します。この情報を使用して、残りの vCPU およびメモリリソースを確認し、特定の ECS インスタンスタイプの ECS インスタンスを専用ホスト上に作成できるかどうかを判断できます。有効な値:

重要

通常、専用ホストには 2 つの CPU があり、それぞれソケット 0 とソケット 1 に対応します。パフォーマンスを最大化するため、専用ホスト上に作成された ECS インスタンスは単一のソケットに割り当てられ、ソケットをまたぐことはありません。

  • ソケットの残りのリソースが指定された ECS インスタンスタイプに対して十分である場合、インスタンスを作成できます。

  • 各ソケットの残りのリソースが指定された ECS インスタンスタイプに対して不十分である場合、両方のソケットの合計残存リソースが十分であっても、インスタンスは作成できません。

true

NextToken

string

任意

次のページの結果を取得するために使用されるトークン。最初のリクエストではこのパラメーターを設定しないでください。後続のリクエストでは、このパラメーターを前の応答から返された `NextToken` 値に設定します。

e71d8a535bd9cc11

MaxResults

integer

任意

ページごとに返す結果の最大数。

最大値:100。

デフォルト値:10。

10

QueryInventory

boolean

任意

レスポンスフィールド

フィールド

説明

object

PageSize

integer

各ページで返されるエントリの数。

1

RequestId

string

リクエスト ID。

7654525A-9964-4ABB-8BCD-98F8835E809A

PageNumber

integer

現在のページ番号。

5

TotalCount

integer

専用ホストの総数。

3

NextToken

string

次のページの結果を取得するために使用されるトークン。空の値は、これ以上結果がないことを示します。

e71d8a535bd9cc11

DedicatedHosts

object

DedicatedHost

array<object>

専用ホストの詳細。

array<object>

専用ホストの詳細。

CreationTime

string

専用ホストが作成された時刻。時刻は協定世界時 (UTC) で、ISO 8601 標準に準拠した `yyyy-MM-ddTHH:mmZ` 形式です。

2018-01-01T12:00Z

SchedulerOptions.ManagedPrivateSpaceId

string

専用ホストが属する管理されたプライベートスペースの ID。

mps-iq81z6pkbqjx61php46e

Status

string

専用ホストの状態。有効な値:

  • Available:専用ホストは正常に実行されています。

  • UnderAssessment:専用ホストはリスク評価中です。基盤となる物理マシンは利用可能ですが、その上で実行されている ECS インスタンスに影響を与える可能性のある潜在的な問題があります。

  • PermanentFailure:専用ホストに永続的な障害が発生し、利用できません。

Available

Cores

integer

物理 CPU あたりのコア数。

3

AutoPlacement

string

専用ホストが自動配置リソースプールにあるかどうかを指定します。有効な値:

  • on:専用ホストは自動配置のためにリソースプールに追加されます。

  • off:専用ホストは自動配置のためにリソースプールに追加されません。

自動配置の詳細については、「自動配置」をご参照ください。

on

GPUSpec

string

GPU モデル。

gpu

AutoReleaseTime

string

専用ホストが自動的にリリースされる時刻。時刻は協定世界時 (UTC) で、ISO 8601 標準に準拠した `yyyy-MM-ddTHH:mmZ` 形式です。

2017-01-01T12:00Z

ChargeType

string

専用ホストの支払い方法。

Prepaid

CpuOverCommitRatio

number

CPU オーバーコミット率。有効な値:1 から 5。

1

ActionOnMaintenance

string

ホスト障害時の専用ホスト上のインスタンスの移行ポリシー。有効な値:

  • Migrate:インスタンスを別の物理マシンに移行します。障害発生前に実行中だったインスタンスは再起動されます。

  • Stop:障害が発生した専用ホスト上のインスタンスを停止します。ホストが修復不可能であることが確認された後、インスタンスは別の物理マシンに移行されてから再起動されます。

専用ホストがクラウドディスクを使用している場合のデフォルト値は Migrate、ローカルディスクを使用している場合は Stop です。

Migrate

SaleCycle

string

サブスクリプションの課金サイクルの単位。有効な値:

  • Month

  • Year

Month

PhysicalGpus

integer

物理 GPU の数。

10

RegionId

string

専用ホストが所在するリージョンの ID。

cn-hangzhou

DedicatedHostName

string

専用ホストの名前。

MyDDHTestName

Description

string

専用ホストの説明。

this-is-my-DDH

DedicatedHostClusterId

string

専用ホストが属する専用ホストクラスターの ID。

dc-bp12wlf6am0vz9v2****

ExpiredTime

string

専用ホストの有効期限。時刻は協定世界時 (UTC) で、ISO 8601 標準に準拠した `yyyy-MM-ddTHH:mmZ` 形式です。

2019-01-01T12:00Z

DedicatedHostType

string

専用ホストのタイプ。

ddh.g5

ResourceGroupId

string

専用ホストが属するリソースグループの ID。

rg-aek3b6jzp66****

ZoneId

string

専用ホストが配置されているゾーンの ID。

cn-hangzhou-g

DedicatedHostId

string

専用ホストの ID。

dh-bp165p6xk2tlw61e****

Sockets

integer

物理 CPU (ソケット) の数。

5

MachineId

string

専用ホストのマシンコード。

12aaa123456ff19dec12345d3026e****

Instances

object

Instance

array<object>

専用ホスト上の ECS インスタンスのリスト。

object

専用ホスト上の ECS インスタンス。

InstanceType

string

ECS インスタンスのインスタンスタイプ。

ecs.g5.large

InstanceId

string

ECS インスタンスの ID。

i-bp14ot0ykf8w13a1****

SocketId

string

インスタンスをホストするソケットのインデックス。

0,1

InstanceOwnerId

integer

ECS インスタンス所有者のユーザー ID。

128************0

OperationLocks

object

OperationLock

array<object>

専用ホストのロック理由。

object

LockReason

string

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

  • financial:支払い遅延のため、専用ホストはロックされました。

  • security:セキュリティ上の理由により、専用ホストはロックされました。

financial

Tags

object

Tag

array<object>

専用ホストのタグ。

object

タグを構成するキーと値のペア。

TagValue

string

タグの値。

TestValue

TagKey

string

タグのキー。

TestKey

SupportedInstanceTypeFamilies

object

SupportedInstanceTypeFamily

array

専用ホストでサポートされている ECS インスタンスファミリー。

string

専用ホストでサポートされているインスタンスファミリー。

ecs.g5

SupportedCustomInstanceTypeFamilies

object

SupportedCustomInstanceTypeFamily

array

専用ホストでサポートされているカスタムインスタンスファミリー。

string

専用ホストでサポートされているカスタムインスタンスファミリー。

ecs.ddh6s.custom

SupportedInstanceTypesList

object

SupportedInstanceTypesList

array

専用ホストでサポートされている ECS インスタンスタイプ。

string

専用ホストでサポートされているインスタンスタイプ。

ecs.g5.large

Capacity

object

専用ホストのリソースキャパシティ。

AvailableMemory

number

使用可能なメモリ容量。単位:GiB。

25

LocalStorageCategory

string

ローカルディスクのカテゴリ。

i2

TotalMemory

number

合計メモリ容量。単位:GiB。

1024

TotalLocalStorage

integer

ローカルディスクの合計容量。単位:GiB。

512

TotalVcpus

integer

vCPU の総数。

56

TotalVgpus

integer

vGPU の総数。

10

AvailableLocalStorage

integer

ローカルディスクの使用可能な容量。単位:GiB。

65

AvailableVcpus

integer

使用可能な vCPU の数。

5

AvailableVgpus

integer

使用可能な vGPU の数。

2

SocketCapacities

object

SocketCapacity

array<object>

各ソケットのキャパシティ。

object

SocketId

integer

ソケットのインデックス。

1

AvailableMemory

number

使用可能なメモリ容量。単位:GiB。

65

TotalMemory

number

合計メモリ容量。単位:GiB。

128

AvailableVcpu

integer

使用可能な vCPU の数。

64

TotalVcpu

integer

vCPU の総数。

128

AvailableInstanceTypes

object

AvailableInstanceType

array<object>

利用可能なインスタンスタイプに関する情報。

object

利用可能なインスタンスタイプに関する情報。

InstanceType

string

インスタンスタイプ。詳細については、「インスタンスファミリー」をご参照ください。

説明

AvailableInstanceCapacity

integer

指定されたインスタンスタイプの利用可能なインスタンス数。

NetworkAttributes

object

専用ホストのネットワーク属性。

UdpTimeout

integer

UDP セッションのタイムアウト期間。単位:秒。60 のみがサポートされています。

60

SlbUdpTimeout

integer

SLB UDP セッションのタイムアウト期間。単位:秒。60 のみがサポートされています。

60

HostDetailInfo

object

このパラメーターは非推奨です。将来の互換性を確保するために、他のパラメーターを使用することを推奨します。

SerialNumber

string

このパラメーターは非推奨です。将来の互換性を確保するために、他のパラメーターを使用することを推奨します。

null

DedicatedHostOwnerId

integer

専用ホスト所有者のユーザー ID。

100************7

成功レスポンス

JSONJSON

{
  "PageSize": 1,
  "RequestId": "7654525A-9964-4ABB-8BCD-98F8835E809A",
  "PageNumber": 5,
  "TotalCount": 3,
  "NextToken": "e71d8a535bd9cc11",
  "DedicatedHosts": {
    "DedicatedHost": [
      {
        "CreationTime": "2018-01-01T12:00Z",
        "SchedulerOptions.ManagedPrivateSpaceId": "mps-iq81z6pkbqjx61php46e",
        "Status": "Available",
        "Cores": 3,
        "AutoPlacement": "on",
        "GPUSpec": "gpu",
        "AutoReleaseTime": "2017-01-01T12:00Z",
        "ChargeType": "Prepaid",
        "CpuOverCommitRatio": 1,
        "ActionOnMaintenance": "Migrate",
        "SaleCycle": "Month",
        "PhysicalGpus": 10,
        "RegionId": "cn-hangzhou",
        "DedicatedHostName": "MyDDHTestName",
        "Description": "this-is-my-DDH",
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
        "ExpiredTime": "2019-01-01T12:00Z",
        "DedicatedHostType": "ddh.g5",
        "ResourceGroupId": "rg-aek3b6jzp66****",
        "ZoneId": "cn-hangzhou-g",
        "DedicatedHostId": "dh-bp165p6xk2tlw61e****",
        "Sockets": 5,
        "MachineId": "12aaa123456ff19dec12345d3026e****",
        "Instances": {
          "Instance": [
            {
              "InstanceType": "ecs.g5.large",
              "InstanceId": "i-bp14ot0ykf8w13a1****",
              "SocketId": "0,1",
              "InstanceOwnerId": 0
            }
          ]
        },
        "OperationLocks": {
          "OperationLock": [
            {
              "LockReason": "financial"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SupportedInstanceTypeFamilies": {
          "SupportedInstanceTypeFamily": [
            "ecs.g5"
          ]
        },
        "SupportedCustomInstanceTypeFamilies": {
          "SupportedCustomInstanceTypeFamily": [
            "ecs.ddh6s.custom"
          ]
        },
        "SupportedInstanceTypesList": {
          "SupportedInstanceTypesList": [
            "ecs.g5.large"
          ]
        },
        "Capacity": {
          "AvailableMemory": 25,
          "LocalStorageCategory": "i2",
          "TotalMemory": 1024,
          "TotalLocalStorage": 512,
          "TotalVcpus": 56,
          "TotalVgpus": 10,
          "AvailableLocalStorage": 65,
          "AvailableVcpus": 5,
          "AvailableVgpus": 2,
          "SocketCapacities": {
            "SocketCapacity": [
              {
                "SocketId": 1,
                "AvailableMemory": 65,
                "TotalMemory": 128,
                "AvailableVcpu": 64,
                "TotalVcpu": 128
              }
            ]
          },
          "AvailableInstanceTypes": {
            "AvailableInstanceType": [
              {
                "InstanceType": "",
                "AvailableInstanceCapacity": 0
              }
            ]
          }
        },
        "NetworkAttributes": {
          "UdpTimeout": 60,
          "SlbUdpTimeout": 60
        },
        "HostDetailInfo": {
          "SerialNumber": "null"
        },
        "DedicatedHostOwnerId": 0
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidStatus.ValueNotSupported The pecified dedicated host status is not supported.
400 MissingParamter.RegionId The regionId should not be null.
400 InvalidParameter.DedicatedHostIds The specified parameter dedicatedHostIds is not valid.
400 InvalidRegion.NotFound The specified parameter RegionId is not valid.
400 InvalidZone.NotFound The specified parameter ZoneId is not valid.
403 InvalidDedicatedHostIds.Malformed The amount of specified dedicatedHostIds exceeds the limit.
404 InvalidLockReason.NotFound The specified LockReason is not found.

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

変更履歴

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