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

説明

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

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeDedicatedHostClusters

実行する操作です。 値をDescribeDedicatedHostClustersに設定します。

RegionId String 必須 cn-hangzhou

専用ホストクラスターのリージョンID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

Tag.N.Key String 任意 TestKey

専用ホストクラスターのタグNのキー。 N の有効値:1 ~ 20。 タグキーを空の文字列にすることはできません。 長さは最大64文字で、先頭をacs: またはaliyunとすることはできません。 http:// またはhttps:// は使用できません。

リソースを照会するタグが1つ指定されている場合、このタグが追加されたリソースを最大1,000個まで応答に表示できます。 リソースのクエリに複数のタグが指定されている場合、これらすべてのタグが追加された最大1,000個のリソースを応答に表示できます。 指定されたタグが追加された1,000を超えるリソースをクエリするには、ListTagResources操作を呼び出します。

Tag.N.Value String 任意 TestValue

専用ホストクラスターのタグNの値。 N の有効値:1 ~ 20。 タグ値を空の文字列にすることはできません。 長さは最大64文字で、先頭をacs: またはaliyunとすることはできません。 http:// またはhttps:// は使用できません。

ResourceGroupId String 任意 rg-bp67acfmxazb4p****

専用ホストクラスターが属するリソースグループのID。 このパラメーターを指定してリソースを照会した場合、指定したリソースグループに属する最大1,000個のリソースを応答に表示できます。

ZoneId String 任意 cn-hangzhou-f

専用ホストクラスターのゾーンID。 DescribeZones操作を呼び出して、最新のゾーンリストを照会できます。

DedicatedHostClusterIds String 任意 ["dc-bp12wlf6am0vz9v2 ****" 、"dc-bp12wlf6am0vz9v3 ****"]

専用ホストクラスターのID。 この値は、["dc-xxxxxxxxx" 、"dc-yyyyyyyy" 、... "dc-zzzzzzzzz"] の形式で最大100個の専用ホストクラスターIDで構成されるJSON配列にすることができます。 IDはコンマ (,) で区切ります。

DedicatedHostClusterName String 任意 myDDHCluster

専用ホストクラスターの名前。

PageNumber Integer 任意 1

返されるページ数。

ページ番号は 1 から始まります。

デフォルト値:1。

PageSize Integer 任意 5

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

最大値:100。

Default value: 10.

レスポンスパラメーター

パラメーター データ型 説明
DedicatedHostClusters DedicatedHostClusterの配列

専用ホストクラスターの詳細。

DedicatedHostCluster
DedicatedHostClusterCapacity Struct

専用ホストクラスターの容量。

AvailableInstanceTypes AvailableInstanceTypeの配列

専用ホストクラスター内のElastic Compute Service (ECS) インスタンスタイプの使用可能な容量。

AvailableInstanceType
AvailableInstanceCapacity Integer 0

ECSインスタンスタイプの使用可能な容量。

InstanceType String ecs.c6.26xlarge

ECSインスタンスタイプ。

AvailableMemory Integer 4

使用可能なメモリのサイズ。 単位: GiB。

AvailableVcpus Integer 2

使用可能なvCPUの数。

LocalStorageCapacities LocalStorageCapacityの配列

ローカルストレージ容量。

LocalStorageCapacity
AvailableDisk Integer 20

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

DataDiskCategory String cloud

データディスクのカテゴリ。 設定可能な値は以下のとおりです。

  • cloud:基本クラウドディスク
  • cloud_efficiency:Ultra クラウドディスク。
  • cloud_ssd: standard SSD
  • ephemeral_ssd: ローカル SSD
  • cloud_essd: 拡張SSD (ESSD)
TotalDisk Integer 40

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

TotalMemory Integer 8

総メモリサイズ。 単位: GiB。

TotalVcpus Integer 4

vCPUの総数。

DedicatedHostClusterId String dc-bp12wlf6am0vz9v2 ****

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

DedicatedHostClusterName String myDDHCluster

専用ホストクラスターの名前。

DedicatedHostIds List ["dh-bp181e5064b5sotr ****" 、"dh-bp18064b5sotrr9c ****"]

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

説明 String This-is-my-DDHCluster

専用ホストクラスターの説明。

RegionId String cn-hangzhou

専用ホストクラスターのリージョンID。

ResourceGroupId String rg-bp67acfmxazb4p****

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

タグ タグの配列

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

タグ
TagKey String TestKey

専用ホストクラスターのタグキー。

TagValue String TestValue

専用ホストクラスターのタグ値。

ZoneId String cn-hangzhou-f

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

PageNumber Integer 1

返されたページの数です。

PageSize Integer 5

1 ページあたりで返されるエントリ数。

RequestId String 214A2187-B06F-4E49-A081-4D053466A8C7

リクエストの ID です。

TotalCount Integer 1

専用ホストクラスターの総数。

リクエストの例

https://ecs.aliyuncs.com/?Action=DescribeDedicatedHostClusters
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-f
&DedicatedHostClusterName=myDDHCluster
&PageNumber=1
&PageSize=5
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

<DescribeDedicatedHostClustersResponse>
      <DedicatedHostClusters>
            <DedicatedHostCluster>
                  <説明> This-is-my-DDHCluster</Description>
                  <ZoneId>cn-hangzhou-f</ZoneId>
                  <DedicatedHostClusterName>myDDHCluster</DedicatedHostClusterName>
                  <ResourceGroupId>rg-bp67acfmxazb4p ****</ResourceGroupId>
                  <DedicatedHostClusterCapacity>
                        <TotalMemory>0</TotalMemory>
                        <AvailableMemory>0</AvailableMemory>
                        <AvailableVcpus>0</AvailableVcpus>
                        <TotalVcpus>0</TotalVcpus>
                        <LocalStorageCapacities>
                </LocalStorageCapacities>
                  </DedicatedHostClusterCapacity>
                  <RegionId>cn-hangzhou</RegionId>
                  <DedicatedHostIds>
            </DedicatedHostIds>
                  <DedicatedHostClusterId>dc-bp12wlf6am0vz9v2 ****</DedicatedHostClusterId>
                  <Tags>
                        <Tag>
                              <TagKey>TestKey</TagKey>
                              <TagValue> テスト値 </TagValue>
                        </Tag>
                  </Tags>
            </DedicatedHostCluster>
      </DedicatedHostClusters>
      <TotalCount>1</TotalCount>
      <RequestId>214A2187-B06F-4E49-A081-4D053466A8C7</RequestId>
      <PageSize>5</PageSize>
      <PageNumber>1</PageNumber>
</DescribeDedicatedHostClustersResponse>

JSON 形式

{
  "DedicatedHostClusters": {
    "DedicatedHostCluster": [
      {
        "説明": "This-is-my-DDHCluster" 、
        "ZoneId": "cn-hangzhou-f",
        "DedicatedHostClusterName": "myDDHCluster" 、
        "ResourceGroupId": "rg-bp67acfmxazb4p ****" 、
        "DedicatedHostClusterCapacity": {
          "TotalMemory": 0、
          "AvailableMemory": 0、
          "AvailableVcpus": 0,
          "TotalVcpus": 0、
          "LocalStorageCapacities": {
            "LocalStorageCapacity": []
          }
        },
        "RegionId": "cn-hangzhou",
        "DedicatedHostIds": {
          "DedicatedHostId": []
        },
        "DedicatedHostClusterId": "dc-bp12wlf6am0vz9v2 ****" 、
        "Tags": {
          "Tag": [
            {
              "TagKey": "TestKey" 、
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "214A2187-B06F-4E49-A081-4D053466A8C7" 、
  "PageSize": 5、
  "PageNumber": 1
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 MissingParamter.RegionId regionIdはnullであってはなりません。 RegionIdパラメーターが指定されていない場合に返されるエラーメッセージ。
400 InvalidRegion.NotFound 指定されたパラメータ RegionId は無効です。 指定された RegionId パラメーターが無効な場合に返されるエラーメッセージ。
400 InvalidZone.NotFound 指定されたパラメーターZoneIdは無効です。 指定されたZoneIdパラメーターが無効な場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。