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

1 つ以上の専用ホストクラスターの詳細を照会します。

操作説明

注意事項

複数のリクエストパラメーターを指定して、クエリ結果をフィルターできます。指定されたリクエストパラメーターは論理 AND 関係にあります。指定されたパラメーターのみがフィルター条件に含まれます。ただし、DedicatedHostClusterIds が空の JSON 配列 ([]) に設定されている場合、このパラメーターは有効なフィルター条件と見なされ、空の結果が返されます。

今すぐお試しください

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

get

DedicatedHostCluster

acs:ecs:{#regionId}:{#accountId}:ddhcluster/{#ddhclusterId}

DedicatedHostCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Status	string	任意	説明このパラメーターは使用できません。	null
LockReason	string	任意	説明このパラメーターは使用できません。	null
ResourceGroupId	string	任意	ホストグループが属するリソースグループの ID です。この ID を使用して、最大 1,000 個のホストグループをフィルターできます。説明デフォルトのリソースグループはサポートされていません。	rg-bp67acfmxazb4p****
Tag	array<object>	任意	ホストグループのタグ。
	object	任意	ホストグループのタグ。
Key	string	任意	タグキー。N の有効値：1～20。タグキーは空の文字列にできません。長さは 64 文字までで、`http://`、`https://`、`acs:`、`aliyun` を含めることはできません。使用するタグの数に関係なく、フィルターできる専用ホストクラスターは 1,000 個以下です。1,000 個を超える専用ホストクラスターを照会するには、ListTagResources API オペレーションを呼び出します。	TestKey
Value	string	任意	タグ値。N の有効値：1～20。タグ値は空の文字列にできません。長さは 64 文字までで、`http://` または `https://` を含めることはできません。	TestValue
RegionId	string	必須	専用ホストクラスターのリージョン ID。DescribeRegions オペレーションを呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
ZoneId	string	任意	専用ホストクラスターのゾーン ID。DescribeZones オペレーションを呼び出して、最新のゾーンリストを照会できます。	cn-hangzhou-f
DedicatedHostClusterIds	string	任意	専用ホストクラスター ID のリスト。値は、`["dc-xxxxxxxxx", "dc-yyyyyyyyy",..., "dc-zzzzzzzzz"]` 形式の複数の ID で構成される JSON 配列です。ID はコンマ (,) で区切ります。	["dc-bp12wlf6am0vz9v2**", "dc-bp12wlf6am0vz9v3**"]
DedicatedHostClusterName	string	任意	ホストグループの名前。	myDDHCluster
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1	1
PageSize	integer	任意	各ページに返すエントリ数。有効値：1～100。デフォルト値：10。	5

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	1 ページあたりのエントリ数。	5
RequestId	string	リクエスト ID。	214A2187-B06F-4E49-A081-4D053466A8C7
PageNumber	integer	ページ番号。	1
TotalCount	integer	専用ホストクラスターの総数。	2
DedicatedHostClusters	object
DedicatedHostCluster	array<object>	専用ホストクラスター情報で構成される配列。
	array<object>
Description	string	専用ホストクラスターの説明。	This-is-my-DDHCluster
DedicatedHostClusterId	string	専用ホストクラスターの ID。	dc-bp12wlf6am0vz9v2****
ResourceGroupId	string	専用ホストクラスターのリソースグループ ID。	rg-bp67acfmxazb4p****
ZoneId	string	専用ホストクラスターのゾーン ID。	cn-hangzhou-f
RegionId	string	専用ホストクラスターのリージョン ID。	cn-hangzhou
DedicatedHostClusterName	string	専用ホストクラスターの名前。	myDDHCluster
Tags	object
Tag	array<object>	専用ホストクラスターのタグ。
	object
TagValue	string	タグ値。	TestValue
TagKey	string	タグキー。	TestKey
DedicatedHostIds	object
DedicatedHostId	array	専用ホストクラスター内の専用ホストの ID。
	string	専用ホストの ID。	dh-bp181e5064b5sotr****
DedicatedHostClusterCapacity	object	専用ホストクラスターのキャパシティ。
AvailableVcpus	integer	使用可能な vCPU 数。	2
AvailableMemory	integer	使用可能なメモリのサイズ。単位：GiB	4
TotalMemory	integer	合計メモリサイズ。単位：GiB	8
TotalVcpus	integer	合計 vCPU 数。	4
LocalStorageCapacities	object
LocalStorageCapacity	array<object>	ローカルストレージ容量。
	object
DataDiskCategory	string	データディスクのカテゴリ。有効値： cloud：基本ディスク cloud_efficiency：Ultra ディスク cloud_ssd：標準 SSD ephemeral_ssd：ローカル SSD cloud_essd：ESSD (エンタープライズ SSD)	cloud
AvailableDisk	integer	ローカルディスクの使用可能な容量。単位：GiB	20
TotalDisk	integer	ローカルディスクの合計容量。単位：GiB	40
AvailableInstanceTypes	object
AvailableInstanceType	array<object>	専用ホストクラスター内の ECS インスタンスの使用可能なキャパシティ。
	object
InstanceType	string	ECS インスタンスタイプ。	ecs.c6.26xlarge
AvailableInstanceCapacity	integer	ECS インスタンスタイプの使用可能なキャパシティ。	0

例

成功レスポンス

JSONJSON

{
  "PageSize": 5,
  "RequestId": "214A2187-B06F-4E49-A081-4D053466A8C7",
  "PageNumber": 1,
  "TotalCount": 2,
  "DedicatedHostClusters": {
    "DedicatedHostCluster": [
      {
        "Description": "This-is-my-DDHCluster",
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ZoneId": "cn-hangzhou-f",
        "RegionId": "cn-hangzhou",
        "DedicatedHostClusterName": "myDDHCluster",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "DedicatedHostIds": {
          "DedicatedHostId": [
            "dh-bp181e5064b5sotr****"
          ]
        },
        "DedicatedHostClusterCapacity": {
          "AvailableVcpus": 2,
          "AvailableMemory": 4,
          "TotalMemory": 8,
          "TotalVcpus": 4,
          "LocalStorageCapacities": {
            "LocalStorageCapacity": [
              {
                "DataDiskCategory": "cloud",
                "AvailableDisk": 20,
                "TotalDisk": 40
              }
            ]
          },
          "AvailableInstanceTypes": {
            "AvailableInstanceType": [
              {
                "InstanceType": "ecs.c6.26xlarge",
                "AvailableInstanceCapacity": 0
              }
            ]
          }
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParamter.RegionId	The regionId should not be null.
400	InvalidParameter.DedicatedHostClusterIds	The specified parameter dedicatedHostClusterIds 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 dedicatedHostClusterIds exceeds the limit.

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

変更履歴

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