DescribeDedicatedHosts - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

1 つ以上の専用ホストの詳細を照会します。物理パフォーマンスメトリクス、マシンコード、使用量ステータス、作成された ECS インスタンスのリストなどの情報を取得できます。専用ホスト ID、専用ホストクラスター ID、ホスト名、ステータスなどのパラメーターを指定して、結果をフィルターできます。

操作説明

操作の説明

以下のいずれかのメソッドを使用して、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

専用ホスト。

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

専用ホスト。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	専用ホストのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ZoneId	string	任意	ゾーン ID。 DescribeZones 操作を呼び出して、最新のゾーンリストをクエリできます。	cn-hangzhou-g
DedicatedHostIds	string	任意	専用ホストの ID。最大 100 個の ID を指定できます。複数の 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****
NeedHostDetail	string	任意	専用ホストの詳細を返すかどうかを指定します。	false
Tag	array<object>	任意	タグのリスト。リストには 0～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 インスタンスを作成できるかどうかを判断できます。有効な値: true: 情報を表示します。ソケットレベルのリソース情報の表示をサポートするのは、特定のタイプの専用ホストのみです。詳細については、「専用ホスト情報の表示とエクスポート」を参照してください。 false: 情報を表示しません。重要通常、各専用ホストには 2 つの CPU があり、各 CPU の ID は Socket 0 または Socket 1 です。排他的専用ホストでは、専用ホスト上の ECS インスタンスが最大のパフォーマンスを発揮するようにするため、ECS インスタンスはソケットをまたいで作成されません。つまり、ECS インスタンスは 1 つのソケットのみに基づいて作成されます。 1 つのソケットの残りのコンピューティングリソースが、作成する ECS インスタンスタイプの要件以上である場合、ECS インスタンスが作成されます。各ソケットの残りのコンピューティングリソースが、作成する ECS インスタンスタイプの要件未満である場合、ECS インスタンスの作成に失敗します。専用ホスト上の 2 つのソケットの合計残りリソースが ECS インスタンスタイプの要件を満たしている場合でも、ECS インスタンスは作成できません。	true
NextToken	string	任意	クエリトークン。この操作の前回の呼び出しで返された NextToken 値に設定します。この操作を初めて呼び出すとき、このパラメーターを指定する必要はありません。	e71d8a535bd9cc11
MaxResults	integer	任意	ページングクエリの 1 ページあたりの最大エントリ数。このパラメーターを指定すると、MaxResults と NextToken の組み合わせを使用してクエリが実行されます。最大値: 100。デフォルト値: 10。	10
QueryInventory	boolean	任意

レスポンスフィールド

フィールド	型	説明	例
	object
DedicatedHosts	object
DedicatedHost	array<object>	専用ホストの詳細。
	array<object>	専用ホストが属する管理された非公開スペースの ID。
ActionOnMaintenance	string	エラー発生時の専用ホスト上でホストされているインスタンスの移行ポリシー。有効な値: Migrate: 専用ホストは別の物理サーバーに移行され、エラー発生前にシャットダウンされなかったインスタンスが起動されます。 Stop: 現在の専用ホスト上でインスタンスが停止されます。専用ホストが修復できないことが確認された後、インスタンスは別の物理サーバーに移行されて再起動されます。専用ホストにクラウドディスクがアタッチされている場合、デフォルト値は Migrate です。専用ホストにローカルディスクがアタッチされている場合、デフォルト値は Stop です。	Migrate
AutoPlacement	string	専用ホストを自動デプロイリソースプールに追加するかどうかを指定します。有効な値: on: 専用ホストが自動デプロイリソースプールに追加されます。 off: 専用ホストは自動デプロイリソースプールに追加されません。自動デプロイの詳細については、「自動デプロイ」を参照してください。	on
AutoReleaseTime	string	自動リリース時間。時間は、ISO 8601 標準に従い、協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 形式で表示されます。	2017-01-01T12:00Z
Capacity	object	専用ホストのパフォーマンスメトリクス。
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	利用可能なインスタンスタイプのリスト。
	object	利用可能なインスタンスタイプ情報。
AvailableInstanceCapacity	integer	インスタンスタイプの利用可能な容量。	0
InstanceType	string	インスタンスタイプ。有効な値については、「インスタンスファミリー」を参照してください。説明このパラメーターは必須です。
AvailableLocalStorage	integer	利用可能なローカルディスク容量。単位: GiB。	65
AvailableMemory	number	使用可能なメモリ容量。単位: GiB。	25
AvailableVcpus	integer	利用可能な vCPU の数。	5
AvailableVgpus	integer	利用可能な vGPU の数。	2
LocalStorageCategory	string	ローカルディスクのカテゴリ。	i2
SocketCapacities	object
SocketCapacity	array<object>	ソケットごとの容量情報のリスト。
	object
AvailableMemory	number	使用可能なメモリ容量。単位: GiB。	65
AvailableVcpu	integer	利用可能な vCPU の数。	64
SocketId	integer	ソケット ID。	1
TotalMemory	number	合計メモリ容量。単位: GiB。	128
TotalVcpu	integer	vCPU の合計数。	128
TotalLocalStorage	integer	ローカルディスクの合計ディスク容量。単位: GiB。	512
TotalMemory	number	合計メモリ容量。単位: GiB。	1024
TotalVcpus	integer	vCPU の合計数。	56
TotalVgpus	integer	vGPU の合計数。	10
ChargeType	string	専用ホストの支払い方法。	Prepaid
Cores	integer	CPU あたりのコア数。	3
CpuOverCommitRatio	number	CPU のオーバーコミット率。有効な値: 1～5。	1
CreationTime	string	専用ホストが作成された時間。時間は、ISO 8601 標準に従い、協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 形式で表示されます。	2018-01-01T12:00Z
DedicatedHostClusterId	string	専用ホストが属する専用ホストクラスターの ID。	dc-bp12wlf6am0vz9v2****
DedicatedHostId	string	専用ホストの ID。	dh-bp165p6xk2tlw61e****
DedicatedHostName	string	専用ホスト名。	MyDDHTestName
DedicatedHostOwnerId	integer	専用ホストオーナーのユーザー ID。	100************7
DedicatedHostType	string	専用ホストのタイプ。	ddh.g5
Description	string	専用ホストの説明。	this-is-my-DDH
ExpiredTime	string	サブスクリプション専用ホストの有効期限。時間は、ISO 8601 標準に従い、協定世界時 (UTC) の `yyyy-MM-ddTHH:mmZ` 形式で表示されます。	2019-01-01T12:00Z
GPUSpec	string	GPU モデル。	gpu
HostDetailInfo	object	このパラメーターは非推奨になります。互換性を確保するため、代わりに他のパラメーターを使用してください。
SerialNumber	string	このパラメーターは非推奨になります。互換性を確保するため、代わりに他のパラメーターを使用してください。	null
VgpuVersion	string	このパラメーターは非推奨になります。互換性を確保するため、代わりに他のパラメーターを使用してください。	null
Instances	object
Instance	array<object>	専用ホスト上に作成された ECS インスタンスのリスト。
	object	専用ホスト上に作成された ECS インスタンス。
InstanceId	string	専用ホスト上に作成された ECS インスタンスのインスタンス ID。	i-bp14ot0ykf8w13a1****
InstanceOwnerId	integer	ECS インスタンス所有者のユーザー ID。	128************0
InstanceType	string	専用ホスト上に作成されたインスタンスの ECS インスタンスタイプ情報。	ecs.g5.large
SocketId	string	インスタンスが配置されているソケット ID。	0,1
MachineId	string	専用ホストのマシン ID。	12aaa123456ff19dec12345d3026e****
NetworkAttributes	object	専用ホストのネットワーク属性。
SlbUdpTimeout	integer	Server Load Balancer (SLB) の UDP タイムアウト期間。単位: 秒。60 秒のみサポートされています。	60
UdpTimeout	integer	UDP タイムアウト期間。単位: 秒。60 秒のみサポートされています。	60
OperationLocks	object
OperationLock	array<object>	専用ホストがロック済みである理由のリスト。
	object
LockReason	string	専用ホストがロック済みである理由。有効な値: financial: 料金滞納により専用ホストがロック済みです。 security: セキュリティ上の理由により専用ホストがロック済みです。	financial
PhysicalGpus	integer	物理 GPU の数。	10
RegionId	string	専用ホストのリージョン ID。	cn-hangzhou
ResourceGroupId	string	専用ホストが属するリソースグループの ID。	rg-aek3b6jzp66****
SaleCycle	string	サブスクリプション専用ホストの課金サイクル。有効な値: Month Year	Month
SchedulerOptions.ManagedPrivateSpaceId	string	専用ホストが属する管理された非公開スペースの ID。	mps-iq81z6pkbqjx61php46e
Sockets	integer	物理 CPU の数。	5
Status	string	専用ホストのステータス。有効な値: Available: 実行中。専用ホストは正常に実行されています。 UnderAssessment: 物理サーバーのリスク。物理サーバーは潜在的な障害期間にあり、利用可能なままですが、これにより専用ホスト上の ECS インスタンスに問題が発生する可能性があります。 PermanentFailure: 失敗。永続的な障害が発生し、専用ホストは利用できません。	Available
SupportedCustomInstanceTypeFamilies	object
SupportedCustomInstanceTypeFamily	array	専用ホストでサポートされているカスタムインスタンスタイプのインスタンスファミリー。
	string	専用ホストでサポートされているカスタムインスタンスタイプのインスタンスファミリー。	ecs.ddh6s.custom
SupportedInstanceTypeFamilies	object
SupportedInstanceTypeFamily	array	専用ホストでサポートされている ECS インスタンスタイプファミリーのリスト。
	string	専用ホストでサポートされている ECS インスタンスファミリー。	ecs.g5
SupportedInstanceTypesList	object
SupportedInstanceTypesList	array	専用ホストでサポートされている ECS インスタンスタイプのリスト。
	string	専用ホストでサポートされている ECS インスタンスタイプ。	ecs.g5.large
Tags	object
Tag	array<object>	専用ホストのタグのリスト。
	object	タグキーと値のペア。
TagKey	string	専用ホストのタグキー。	TestKey
TagValue	string	専用ホストのタグ値。	TestValue
ZoneId	string	ゾーン ID。	cn-hangzhou-g
NextToken	string	現在の呼び出しによって返されるクエリトークン。ページングクエリに MaxResults と NextToken を使用し、このページングトークンが空の場合、それ以上のデータは返されません。	e71d8a535bd9cc11
PageNumber	integer	専用ホストリストのページ番号。	5
PageSize	integer	ページあたりのエントリ数	1
RequestId	string	リクエスト ID	7654525A-9964-4ABB-8BCD-98F8835E809A
TotalCount	integer	専用ホストの総数。	3

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidStatus.ValueNotSupported	The pecified dedicated host status is not supported.	指定されたディスクステータスでは、この操作はサポートされていません。
400	MissingParamter.RegionId	The regionId should not be null.	RegionId パラメーターは空にできません。
400	InvalidParameter.DedicatedHostIds	The specified parameter dedicatedHostIds is not valid.	指定された DedicatedHostIds (専用) パラメーターは無効です。
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	RegionId パラメーターが無効です。
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	指定された ZoneId が無効です。
403	InvalidDedicatedHostIds.Malformed	The amount of specified dedicatedHostIds exceeds the limit.	DedicatedHostIds (専用ホスト ID) パラメーターに含めることができるエントリの最大値は 100 です。
404	InvalidLockReason.NotFound	The specified LockReason is not found.	指定されたロックタイプは存在しません。

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

変更履歴

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