VPC環境で利用できます。
概要
Fabric Clusterリストを照会します。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| regionCode | No | String | - リージョンコード Fabric Clusterリスト照会対象のリージョン(Region)を決定可能 regionCodeはgetRegionListアクションを通じて取得可能 デフォルト: getRegionList照会結果の最初のリージョンを選択 |
|
| fabricClusterPoolNo | No | String | Fabric Cluster Pool番号で絞り込み fabricClusterPoolNoはgetFabricClusterPoolListアクションを通じて取得可能 |
|
| fabricClusterPoolName | No | String | Fabric Cluster Pool名で絞り込み | |
| fabricClusterNoList | No | List<String> | - Fabric Cluster番号リスト Fabric Cluster番号で絞り込んで検索可能 fabricClusterNoはgetFabricClusterListアクションを通じて取得可能 例) --fabricClusterNoList 123 124 |
|
| fabricClusterName | No | String | Fabric Cluster名で絞り込み | |
| zoneCode | No | String | - Zoneコード Zoneコードで絞り込んで検索可能 zoneCodeはgetZoneListアクションを通じて取得可能 |
|
| vpcNo | No | String | - VPC番号 VPC番号で絞り込んで検索可能 vpcNoはgetVpcListアクションを通じて取得可能 |
|
| serverInstanceNo | No | String | サーバインスタンス番号で絞り込み | |
| pageNo | No | Integer | - ページングされた結果のページ番号 結果値を pageNo、pageSizeを利用してページング処理可能 |
|
| pageSize | Conditional | Integer | - ページング時に表示する各ページサイズ 結果値を pageNo、pageSizeを利用してページング処理可能 pageNo入力時、必ず入力 |
|
| sortedBy | No | String | - ソート対象 結果値を Fabric Cluster番号、Fabric Cluster Poolコード、Zoneコードでソート可能 オプション: fabricClusterNo | fabricClusterPoolCode | zoneCode |
|
| sortingOrder | No | String | - ソート順序 sortedByの利用時、昇順または降順のソートを設定 オプション: ASC(昇順) | DESC(降順) デフォルト: ASC |
|
| output | No | String | レスポンス結果の形式タイプ
|
レスポンス
レスポンスデータタイプ
- getFabricClusterListタイプ
| getFabricClusterList extends CommonResponse |
|---|
| private Integer totalRows; |
| private List<FabricCluster> fabricClusterList = new ArrayList<>(); |
| FabricCluster |
|---|
| private String fabricClusterNo; |
| private String fabricClusterName; |
| private CommonCode fabricClusterStatus; |
| private String fabricClusterDescription; |
| private String regionCode; |
| private String zoneCode; |
| private String vpcNo; |
| private String fabricClusterPoolNo; |
| private String fabricClusterPoolName; |
| private String fabricClusterPoolCode; |
| private Date createDate; |
| private Long serverCount; |
| private List<FabricClusterServerInstance> fabricClusterServerInstanceList; |
例
リクエスト例
ncloud vserver getFabricClusterList --regionCode KR --zoneCode KR-1 --vpcNo ***84 --fabricClusterNoList 13** --pageNo 1 --pageSize 10
レスポンス例
{
"getFabricClusterListResponse": {
"totalRows": 1,
"fabricClusterList": [
{
"fabricClusterNo": "13**",
"fabricClusterName": "test-***",
"fabricClusterStatus": {
"code": "RUN",
"codeName": "実行中"
},
"regionCode": "KR",
"zoneCode": "KR-1",
"vpcNo": "***84",
"fabricClusterPoolNo": "***01",
"fabricClusterPoolName": "test-***",
"fabricClusterPoolCode": "test-***",
"createDate": "2025-12-12T13:36:17+0900",
"serverCount": 5
}
],
"requestId": "9b0ed68f-b044-4fd8-b138-22397fba64df",
"returnCode": "0",
"returnMessage": "success"
}
}
<getFabricClusterListResponse>
<requestId>9b0ed68f-b044-4fd8-b138-22397fba64df</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<fabricClusterList>
<fabricCluster>
<fabricClusterNo>13**</fabricClusterNo>
<fabricClusterName>test-***</fabricClusterName>
<fabricClusterStatus>
<code>RUN</code>
<codeName>実行中</codeName>
</fabricClusterStatus>
<regionCode>KR</regionCode>
<zoneCode>KR-1</zoneCode>
<vpcNo>***84</vpcNo>
<fabricClusterPoolNo>***01</fabricClusterPoolNo>
<fabricClusterPoolName>test-***</fabricClusterPoolName>
<fabricClusterPoolCode>test-***</fabricClusterPoolCode>
<createDate>2025-12-12T13:36:17+0900</createDate>
<serverCount>5</serverCount>
</fabricCluster>
</fabricClusterList>
</getFabricClusterListResponse>