この API を呼び出して、クラスターのホストグループを照会できます。
デバッグ
リクエストパラメーター
| パラメーター | 型 | 必須 / 任意 | 例 | 説明 |
|---|---|---|---|---|
| Action | String | 必須 | ListClusterHostGroup |
実行する API (ListClusterHostGroup) に設定します。 |
| ClusterId | String | 必須 | C-D7958B72E59B**** |
クラスターの ID を設定します。 |
| RegionId | String | 必須 | cn-hangzhou |
リージョンの ID を設定します。 |
| AccessKeyId | String | 任意 | LTAI8ljWyu7y**** |
Alibaba Cloud から提供された AccessKey ID を設定します。 |
| HostGroupId | String | 任意 | G-76D09CF110A3**** |
照会するホストグループの ID を設定します。 |
| HostGroupName | String | 任意 | core_group |
照会するホストグループの名前 を設定します。 |
| HostGroupType | String | 任意 | CORE |
照会するホストグループのタイプ を設定します。 設定可能な値は、MASTER、CORE、およびTASKです。 |
| PageNumber | Integer | 任意 | 1 |
返されるページ数を設定します。 |
| PageSize | Integer | 任意 | 10 |
返される各ページのエントリ数を設定します。 |
| StatusList.N | RepeatList | 任意 | NORMAL |
照会するホストグループのステータスのリストを設定します。 設定可能な値は、NORMAL、ABNORMAL、およびDELETED。 |
レスポンスパラメーター
| パラメーター | 型 | 例 | 説明 |
|---|---|---|---|
| ClusterId | String | C-D7958B72E59B**** |
クラスターの ID を示します。 |
| HostGroupList |
クラスター内のホストグループのリストを示します。 |
||
| ChargeType | String | PostPaid |
ホストグループの課金方法を示します。 |
| Comment | String | Remarks |
ホストグループに関する備考を示します。 |
| Cpu | Integer | 4 |
ホストグループ内のノードの CPU 仕様を示します。 |
| DataDiskCount | Integer | 4 |
ホストグループ内のノードで使用されるデータディスクの数を示します。 |
| DataDiskSize | Integer | 100 |
ホストグループ内のノードで使用されるデータディスク 1 つのサイズを示します。 単位は GB です。 |
| DataDiskType | String | CLOUD_SSD |
ホストグループのノードで使用されるデータディスクのタイプを示します。 |
| HostGroupChangeStatus | String | IN_PROGRESS |
構成アップグレードタスクの実行ステータスを示します。 想定される値は、IN_PROGRESS、COMPLETED、または FAILEDです。 |
| HostGroupChangeType | String | RESIZE_DISK |
ホストグループでの構成アップグレード操作のタイプを示します。 想定される値は、RESIZE_DISK、MODIFY_INSTANCE_TYPE、または RESTART_HOST_GROUPです。 |
| HostGroupId | String | G-EBAA5D6566E76F55 |
ホストグループの IDを示します。 |
| HostGroupName | String | Core_Group |
ホストグループ名を示します。 |
| HostGroupSubType | String | AutoScaling |
ホストグループのサブタイプを示します。例：AutoScaling。 |
| HostGroupType | String | CORE |
ホストグループのタイプを示します。 想定される値は、MASTER、CORE、またはTASKです。 |
| InstanceType | String | ecs.c5.xlarge |
ホストグループ内のノードの仕様を示します。 |
| LockReason | String | Your account balance is insufficient |
ホストグループがロックされている理由を示します。 |
| LockType | String | ACCOUNTARREARS |
ホストグループのロックタイプを示します。 想定される値は、CLUSTER_EXPIRED (クラスターの有効期限切れ) 、またはACCOUNT_ARREARS (アカウントの残高不足) です。 |
| Memory | Integer | 8 |
ホストグループ内のノードのメモリ仕様を示します。 |
| NodeCount | Integer | 3 |
ホストグループ内のノード数を示します。 |
| PayType | String | PostPaid |
ホストグループの課金方法を示します。 |
| SecurityGroupId | String | sg-xxx |
セキュリティグループの ID を示します。 |
| Status | String | NORMAL |
ホストグループのステータスを示します。 |
| SystemDiskCount | Integer | 1 |
ホストグループ内のノードで使用されているシステムディスクの数を示します。 |
| SystemDiskSize | Integer | 40 |
ホストグループ内のノードで使用されているシステムディスク 1 つのサイズを示します。 単位は GB です。 |
| SystemDiskType | String | CLOUD_SSD |
ホストグループ内のノードで使用されているシステムディスクのタイプを示します。 |
| VswitchId | String | vsw-bp161s00cryyb4bs1**** |
VSwitch の ID を示します。 |
| gmtCreate | String | 1564472329000 |
ホストグループの作成日時を示します。 |
| gmtModified | String | 1564472889000 |
ホストグループの変更日時を示します。 |
| PageNumber | Integer | 1 |
返されたページ数を示します。 |
| PageSize | Integer | 10 |
返された各ページのエントリ数を示します。 |
| RequestId | String | BF4FBAC6-B03E-4BFB-B6DB-EB53C34F2E22 |
リクエストの ID を示します。 |
| Total | Integer | 15 |
照会したホストグループの総数を示します。 |
例
リクエストの例
http(s)://[Endpoint]/? Action=ListClusterHostGroup
&ClusterId=C-D7958B72E59B****
&RegionId=cn-hangzhou
&<Common request parameters>
通常のレスポンスの例
XML 形式
<ListClusterHostGroupResponse>
<code>200</code>
<data>
<hostGroupList>
<chargeType>PostPaid</chargeType>
<cpu>4</cpu>
<dataDiskCount>4</dataDiskCount>
<dataDiskSize>100</dataDiskSize>
<dataDiskType>CLOUD_SSD</dataDiskType>
<gmtCreate>1564472329000</gmtCreate>
<gmtModified>1564472889000</gmtModified>
<hostGroupId>G-EBAA5D6566E7****</hostGroupId>
<hostGroupName>Core_Group</hostGroupName>
<hostGroupType>CORE</hostGroupType>
<instanceType>ecs.c5.xlarge</instanceType>
<memory>8</memory>
<nodeCount>3</nodeCount>
<payType>PostPaid</payType>
<status>NORMAL</status>
<systemDiskSize>200</systemDiskSize>
<systemDiskType>CLOUD_SSD</systemDiskType>
<vswitchId>vsw-bp161s00cryyb4bs1****</vswitchId>
</hostGroupList>
<hostGroupList>
<chargeType>PostPaid</chargeType>
<cpu>4</cpu>
<dataDiskCount>3</dataDiskCount>
<dataDiskSize>500</dataDiskSize>
<dataDiskType>CLOUD_SSD</dataDiskType>
<gmtCreate>1564472329000</gmtCreate>
<gmtModified>1564472889000</gmtModified>
<hostGroupId>G-3379C5DEBA14****</hostGroupId>
<hostGroupName>Master_Group</hostGroupName>
<hostGroupType>MASTER</hostGroupType>
<instanceType>ecs.g5.xlarge</instanceType>
<memory>16</memory>
<nodeCount>3</nodeCount>
<payType>PostPaid</payType>
<status>NORMAL</status>
<systemDiskSize>200</systemDiskSize>
<systemDiskType>CLOUD_SSD</systemDiskType>
<vswitchId>vsw-bp161s00cryyb4bs1****</vswitchId>
</hostGroupList>
<pageNumber>1</pageNumber>
<pageSize>500</pageSize>
<requestId>9E395024-CE21-42F7-A777-69DD7AFFBE1F</requestId>
</data>
<success>true</success>
</ListClusterHostGroupResponse>JSON 形式
{
"data":{
"hostGroupList":[
{
"gmtModified":"1564472889000",
"gmtCreate":"1564472329000",
"status":"NORMAL",
"dataDiskType":"CLOUD_SSD",
"cpu":4,
"dataDiskCount":4,
"hostGroupId":"G-EBAA5D6566E7****",
"hostGroupName":"Core_Group",
"dataDiskSize":100,
"memory":8,
"instanceType":"ecs.c5.xlarge",
"systemDiskSize":200,
"systemDiskType":"CLOUD_SSD",
"payType":"PostPaid",
"vswitchId":"vsw-bp161s00cryyb4bs1****",
"chargeType":"PostPaid",
"nodeCount":3,
"hostGroupType":"CORE"
},
{
"gmtModified":"1564472889000",
"gmtCreate":"1564472329000",
"status":"NORMAL",
"dataDiskType":"CLOUD_SSD",
"cpu":4,
"dataDiskCount":3,
"hostGroupId":"G-3379C5DEBA14****",
"hostGroupName":"Master_Group",
"dataDiskSize":500,
"memory":16,
"instanceType":"ecs.g5.xlarge",
"systemDiskSize":200,
"systemDiskType":"CLOUD_SSD",
"payType":"PostPaid",
"vswitchId":"vsw-bp161s00cryyb4bs1****",
"chargeType":"PostPaid",
"nodeCount":3,
"hostGroupType":"MASTER"
}
],
"requestId":"9E395024-CE21-42F7-A777-69DD7AFFBE1F",
"pageSize":500,
"pageNumber":1
},
"code":"200",
"success":true
}エラーコード
エラーコードの詳細については、「API エラーセンター」をご参照ください。