物理パフォーマンス仕様、マシンコード、専用ホストのサービスステータス、専用ホスト上に作成されたElastic Compute service (ECS) インスタンスなど、1つ以上の専用ホストの詳細を照会します。
説明
次のいずれかの方法を使用して、1つ以上の専用ホストの詳細を照会できます。
DedicatedHostIds
パラメーターを指定して、専用ホストの詳細を照会します。- Specify the
DedicatedHostClusterId
parameter to query the details of the dedicated hosts in a dedicated host cluster.
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
操作 | String | 必須 | DescribeDedicatedHosts |
実行する操作です。 値をDescribeDedicatedHostsに設定します。 |
RegionId | String | 必須 | cn-hangzhou |
専用ホストのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
ZoneId | String | 任意 | cn-hangzhou |
専用ホストのゾーンID。 |
DedicatedHostIds | String | 任意 | ["dh-bp165p6xk2tlw61e ****" 、"dh-bp1f9vxmno7emy96 ****"] |
専用ホストのID。 1回のリクエストで最大100個の専用ホストIDを指定できます。 ID が複数ある場合は、カンマ (,) で区切ります。 |
DedicatedHostName | String | 任意 | MyDDHTestName |
専用ホストの名前。 |
ステータス | String | 任意 | Available |
専用ホストのサービスステータス。 設定可能な値は以下のとおりです。
デフォルト値: Available。 |
DedicatedHostType | String | 任意 | ddh.g5 |
専用ホストのタイプ。 |
LockReason | String | 任意 | financial |
専用ホストがロックされている理由。 設定可能な値は以下のとおりです。
|
PageNumber | Integer | 任意 | 1 |
返されるページ数。 デフォルト: 1。 |
PageSize | Integer | 任意 | 10 |
各ページで返されるエントリ数。 最大値:100。 Default value: 10. |
ResourceGroupId | String | 任意 | rg-aek3b6jzp66 **** |
専用ホストが属するリソースグループのID。 |
DedicatedHostClusterId | String | 任意 | dc-bp12wlf6am0vz9v2**** |
The ID of the dedicated host cluster. |
Tag.N.Key | String | 任意 | TestKey |
The tag key of the dedicated host. N の有効値:1 ~ 20。 タグキーを空の文字列にすることはできません。 長さは最大128文字で、 |
Tag.N.Value | String | 任意 | TestValue |
専用ホストのタグ値。 N の有効値:1 ~ 20。 タグ値は、空の文字列が使用可能です。 長さは最大128文字で、 |
レスポンスパラメーター
パラメーター | データ型 | 例 | 説明 |
---|---|---|---|
PageSize | Integer | 1 |
1 ページあたりで返されるエントリ数。 |
RequestId | String | 7654525A-9964-4ABB-8BCD-98F8835E809A |
リクエストの ID です。 |
PageNumber | Integer | 5 |
返されたページの数です。 |
TotalCount | Integer | 3 |
The total number of dedicated hosts. |
DedicatedHosts | DedicatedHostの配列 |
専用ホストの詳細。 |
|
DedicatedHost | |||
CreationTime | String | 2018-01-01T12:00Z |
専用ホストが作成された時刻。 時間は |
ステータス | String | Available |
専用ホストのサービスステータス。 設定可能な値は以下のとおりです。
|
コア | Integer | 3 |
1つのCPU内の物理コアの数。 |
自動配置 | String | on |
Indicates whether the dedicated host was added to the resource pool for automatic deployment. 設定可能な値は以下のとおりです。
自動デプロイの詳細については、「自動デプロイ」をご参照ください。 |
GPUSpec | String | gpu |
GPU モデルです。 |
AutoReleaseTime | String | 2017-01-01T12:00Z |
専用ホストの自動リリース時間。 時間は |
ChargeType | String | Prepaid |
専用ホストの課金方法。 |
CpuOverCommitRatio | Float | 1 |
CPUオーバーコミット率。 |
ActionOnMaintenance | String | 移行 |
The policy used to migrate the instances deployed on the dedicated host when the dedicated host fails or needs to be repaired online. 設定可能な値は以下のとおりです。
|
SaleCycle | String | 月 |
サブスクリプション期間の単位を設定します。 設定可能な値は以下のとおりです。
|
PhysicalGpus | Integer | 10 |
The number of physical GPUs. |
RegionId | String | cn-hangzhou |
The region ID of the dedicated host. |
DedicatedHostName | String | MyDDHTestName |
専用ホストの名前。 |
説明 | String | this-is-my-DDH |
The description of the dedicated host. |
DedicatedHostClusterId | String | dc-bp12wlf6am0vz9v2**** |
専用ホストが属する専用ホストクラスタのID。 |
ExpiredTime | String | 2019-01-01T12:00Z |
サブスクリプション専用ホストの有効期限。 時間は |
DedicatedHostType | String | ddh.g5 |
専用ホストのタイプ。 |
ResourceGroupId | String | rg-aek3b6jzp66 **** |
専用ホストが属するリソースグループのID。 |
ZoneId | String | cn-hangzhou |
The zone ID of the dedicated host. |
DedicatedHostId | String | dh-bp165p6xk2tlw61e **** |
専用ホストの ID。 |
ソケット | Integer | 5 |
物理CPUの数。 |
MachineId | String | 12aaa123456ff19dec12345d3026e **** |
The machine code of the dedicated host. |
インスタンス | Array of Instance |
専用ホストに作成されたECSインスタンス。 |
|
インスタンス | |||
InstanceType | String | ecs.g5.large |
The instance type of the ECS instance created on the dedicated host. |
InstanceId | String | i-bp14ot0ykf8w13a1**** |
専用ホストに作成されたECSインスタンスのID。 |
OperationLocks | OperationLockの配列 |
専用ホストのリソースがロックされた理由。 |
|
OperationLock | |||
LockReason | String | financial |
専用ホストがロックされた理由。 設定可能な値は以下のとおりです。
|
タグ | タグの配列 |
The tags of the dedicated host. |
|
タグ | |||
TagValue | String | TestValue |
The tag value of the dedicated host. |
TagKey | String | TestKey |
The tag key of the dedicated host. |
SupportedInstanceTypeFamilies | 文字列の配列 | ecs.g5 |
専用ホストでサポートされているECSインスタンスファミリー。 |
SupportedCustomInstanceTypeFamilies | Array of String | ecs.ddh6s.custom |
専用ホストでサポートされているカスタムECSインスタンスファミリー。 |
SupportedInstanceTypesList | 文字列の配列 | ecs.g5.large |
専用ホストでサポートされているECSインスタンスタイプ。 |
容量 | オブジェクト |
専用ホストのパフォーマンス仕様。 |
|
AvailableMemory | Float | 25 |
メモリの使用可能なスペース。 単位: GiB。 |
LocalStorageCategory | String | i2 |
ローカルディスクのカテゴリ。 |
TotalMemory | Float | 1024 |
メモリの総容量。 単位: GiB。 |
TotalLocalStorage | Integer | 512 |
ローカルディスクの総容量。 単位: GiB。 |
TotalVcpus | Integer | 56 |
vCPUの総数。 |
TotalVgpus | Integer | 10 |
vGPUの総数。 |
AvailableLocalStorage | Integer | 65 |
ローカルディスクの使用可能なスペース。 単位: GiB。 |
AvailableVcpus | Integer | 5 |
使用可能なvCPUの数。 |
AvailableVgpus | Integer | 2 |
使用可能なvGPUの数。 |
ネットワーク属性 | オブジェクト |
The network attributes of the dedicated host. |
|
UdpTimeout | Integer | 60 |
The timeout period of the UDP session that was established between a user and an Alibaba Cloud service on the dedicated host. |
SlbUdpTimeout | Integer | 60 |
Server Load Balancer (SLB) と専用ホスト間に確立されたUDPセッションのタイムアウト時間。 |
HostDetailInfo | オブジェクト |
このパラメーターは削除予定です。 今後、互換性を確保するために、他のパラメーターを使用することを推奨します。 |
|
SerialNumber | String | null |
このパラメーターは削除予定です。 今後、互換性を確保するために、他のパラメーターを使用することを推奨します。 |
例
リクエストの例
https://ecs.aliyuncs.com/?Action=DescribeDedicatedHosts
&RegionId=cn-hangzhou
&<Common request parameters>
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDedicatedHostsResponse>
<TotalCount>1</TotalCount>
<DedicatedHosts>
<DedicatedHost>
<PhysicalGpus>0</PhysicalGpus>
<MachineId>73aaa79494ff19dec79446d3026e ****</MachineId>
<DedicatedHostId>dh-bp165p6xk2tlw61e ****</DedicatedHostId>
<Description/>
<ResourceGroupId />
<SupportedCustomInstanceTypeFamilies>
</SupportedCustomInstanceTypeFamilies>
<NetworkAttributes/>
<GPUSpec />
<DedicatedHostName>MyDDHTestName</DedicatedHostName>
<容量>
<AvailableVgpus>0</AvailableVgpus>
<LocalStorageCategory/>
<TotalVgpus>0</TotalVgpus>
<TotalMemory>768</TotalMemory>
<AvailableMemory>768</AvailableMemory>
<AvailableVcpus>104</AvailableVcpus>
<TotalVcpus>104</TotalVcpus>
<AvailableLocalStorage>0</AvailableLocalStorage>
<TotalLocalStorage>0</TotalLocalStorage>
</容量>
<ExpiredTime>2999-09-08T16:00Z</ExpiredTime>
<SaleCycle/>
<Status>Available</Status>
<ZoneId>cn-hangzhou-h</ZoneId>
<AutoPlacement>on</AutoPlacement>
<DedicatedHostType>ddh.r6</DedicatedHostType>
<OperationLocks>
</OperationLocks>
<コア> 52</コア>
<Instances>
</Instances>
<Sockets>2</Sockets>
<ChargeType>PostPaid</ChargeType>
<SupportedInstanceTypeFamilies>
<SupportedInstanceTypeFamily>ecs.c6</SupportedInstanceTypeFamily>
<SupportedInstanceTypeFamily>ecs.g6</SupportedInstanceTypeFamily>
<SupportedInstanceTypeFamily>ecs.ic6</SupportedInstanceTypeFamily>
<SupportedInstanceTypeFamily>ecs.r6</SupportedInstanceTypeFamily>
</SupportedInstanceTypeFamilies>
<ActionOnMaintenance> 移行 </ActionOnMaintenance>
<CreationTime>2020-04-15T07:12Z</CreationTime>
<RegionId>cn-hangzhou</RegionId>
<SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.26xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.3xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.2xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.13xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.6xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.4xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.16xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.13xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.26xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.26xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.3xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.13xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.16xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.4xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.16xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.6xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6.large</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.2xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.2xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.3xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.6xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.4xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6.large</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.large</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.4xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.3xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.6xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.2xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.ic6.large</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6-dbeni.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6nv.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.c6vn.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.r6vn.8xlarge</SupportedInstanceTypesList>
<SupportedInstanceTypesList>ecs.g6-nfveni.large</SupportedInstanceTypesList>
</SupportedInstanceTypesList>
<DedicatedHostClusterId/>
<AutoReleaseTime />
</DedicatedHost>
</DedicatedHosts>
<RequestId>9E9354D4-C89E-4A82-A70E-3EEAD6007885</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
</DescribeDedicatedHostsResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1、
"DedicatedHosts" : {
"DedicatedHost" : [ {
"PhysicalGpus" : 0、
"MachineId" : "73aaa79494ff19dec79446d3026e ****" 、
"DedicatedHostId" : "dh-bp165p6xk2tlw61e ****" 、
"Description" : "" 、
"ResourceGroupId" : "" 、
"SupportedCustomInstanceTypeFamilies" : {
"SupportedCustomInstanceTypeFamily" : [ ]
},
"NetworkAttributes" : { },
"GPUSpec" : "" 、
"DedicatedHostName" : "MyDDHTestName" 、
"容量" : {
"AvailableVgpus" : 0、
"LocalStorageCategory" : "" 、
"TotalVgpus" : 0、
"TotalMemory" : 768、
"AvailableMemory" : 768、
"AvailableVcpus" : 104,
"TotalVcpus" : 104、
"AvailableLocalStorage" : 0、
"TotalLocalStorage" : 0
},
"ExpiredTime" : "2999-09-08T16:00Z" 、
"SaleCycle" : "" 、
"Status" : "Available",
"ZoneId" : "cn-hangzhou-h",
"AutoPlacement" : "on" 、
"DedicatedHostType" : "ddh.r6" 、
"OperationLocks" : {
"OperationLock" : [ ]
},
"コア" : 52、
"インスタンス" : {
"インスタンス" : [ ]
},
"ソケット" : 2、
"ChargeType" : "PostPaid" 、
"SupportedInstanceTypeFamilies" : {
"SupportedInstanceTypeFamily" : [ "ecs.c6", "ecs.g6", "ecs.ic6", "ecs.r6" ]
},
"ActionOnMaintenance" : "Migrate",
"CreationTime" : "2020-04-15T07:12Z" 、
"RegionId" : "cn-hangzhou" 、
"SupportedInstanceTypesList" : {
"SupportedInstanceTypesList" : [ "ecs.g6.26xlarge" 、"ecs.g6.3xlarge" 、"ecs.g6.8xlarge" 、"ecs.g6.13xlarge" 、"ecs.g6.8xlarge" 、"ecs.c6.8xlarge" 、"" 6.ecgs. "ecs.r6.xlarge" 、"ecs.r6.26xlarge" 、"ecs.r6.3xlarge" 、"ecs.r6.13xlarge" 、"ecs.r6.16xlarge" 、"ecs.c6.6xlarge. xlarge" 、"ecs. crs" 6.xlarge "、" 6.ecs. cs "、" 6.ecs "" ecs.c6.6xlarge "、" ecs.c6.4xlarge "、" ecs.c6.large "、" ecs.r6.large "、" ecs.r6.8xlarge "、" ecs.ic6.xlarge "、" ecs.ic6.xlarge "、" r6-dbeni.8xlarge. ic6.xlarge "、" ecs.ic6.xlarge "" "" "" "、" 、"ecs. ecs." "" "" "、" ecs "ecs.g6nv.8xlarge" 、"ecs.c6vn.8xlarge" 、"ecs.r6vn.8xlarge" 、"ecs.g6-nfveni.large"]
},
"DedicatedHostClusterId" : "" 、
"AutoReleaseTime" : "
} ]
},
"RequestId" : "9E9354D4-C89E-4A82-A70E-3EEAD6007885" 、
"PageSize" : 10,
"PageNumber" : 1
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | InvalidStatus.ValueNotSupported | 指定された専用ホストステータスはサポートされていません。 | この操作が、現在のステータスにある専用ホストではサポートされていない場合に返されるエラーメッセージ。 |
400 | MissingParamter.RegionId | The regionId should not be null. | RegionIdパラメーターが指定されていない場合に返されるエラーメッセージ。 |
400 | InvalidParameter.DedicatedHostIds | 指定されたパラメーターdedicatedHostIdsは無効です。 | 指定されたDedicatedHostIdsパラメーターが無効な場合に返されるエラーメッセージ。 |
400 | InvalidRegion.NotFound | 指定されたパラメータ RegionId は無効です。 | 指定された RegionId パラメーターが無効な場合に返されるエラーメッセージ。 |
400 | InvalidZone.NotFound | 指定されたパラメーターZoneIdは無効です。 | 指定されたZoneIdパラメーターが無効な場合に返されるエラーメッセージ。 |
403 | InvalidDedicatedHostIds.Malformed | 指定されたdedicatedHostIdの量が制限を超えています。 | DedicatedHostIds値に100を超える専用ホストIDが指定されている場合に返されるエラーメッセージ。 |
404 | InvalidLockReason.NotFound | The specified LockReason is not found | 指定されたLockReasonパラメーターが存在しない場合に返されるエラーメッセージ。 |
エラーコードリストについては、「API エラーセンター」をご参照ください。